Activar flujos de trabajo con mensajes de Pub/Sub (CLI de gcloud)

En esta guía de inicio rápido se muestra cómo ejecutar un flujo de trabajo mediante un activador de Eventarc que recibe eventos mediante Pub/Sub. El activador ejecuta el flujo de trabajo transfiriendo los eventos enviados a través de Pub/Sub como argumentos de tiempo de ejecución a un flujo de trabajo de destino.

En esta guía de inicio rápido, harás lo siguiente:

  1. Usa Workflows para crear e implementar un flujo de trabajo que decodifique y devuelva mensajes de Pub/Sub.
  2. Crea un activador de Eventarc que conecte un tema de Pub/Sub a un receptor de eventos de Workflows.
  3. Publica un mensaje en el tema de Pub/Sub para generar un evento. Este evento se transfiere como argumento de tiempo de ejecución al flujo de trabajo de destino.
  4. Consulta el mensaje de Pub/Sub como resultado de la ejecución del flujo de trabajo.

Antes de empezar

Para asegurarte de que tienes acceso a esta función, solicita que se añada tu proyecto a las versiones preliminares privadas de Google Cloud Workflows.

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. Install the Google Cloud CLI.

  3. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  4. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  5. Create or select a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    • Create a Google Cloud project:

      gcloud projects create PROJECT_ID

      Replace PROJECT_ID with a name for the Google Cloud project you are creating.

    • Select the Google Cloud project that you created:

      gcloud config set project PROJECT_ID

      Replace PROJECT_ID with your Google Cloud project name.

  6. Verify that billing is enabled for your Google Cloud project.

  7. Install the Google Cloud CLI.

  8. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  9. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  10. Create or select a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    • Create a Google Cloud project:

      gcloud projects create PROJECT_ID

      Replace PROJECT_ID with a name for the Google Cloud project you are creating.

    • Select the Google Cloud project that you created:

      gcloud config set project PROJECT_ID

      Replace PROJECT_ID with your Google Cloud project name.

  11. Verify that billing is enabled for your Google Cloud project.

  12. Actualiza los componentes de gcloud: 
    gcloud components update
  13. Habilita las APIs Compute Engine, Eventarc, Pub/Sub y Workflows. 
    gcloud services enable \
compute.googleapis.com \
eventarc.googleapis.com \
pubsub.googleapis.com \
workflows.googleapis.com \
workflowexecutions.googleapis.com
  14. Defina las variables de configuración que se usan en este tutorial: 
    export WORKFLOW_LOCATION=us-central1
export TRIGGER_LOCATION=us-central1
export PROJECT_ID=PROJECT_ID
gcloud config set project ${PROJECT_ID}
gcloud config set workflows/location ${WORKFLOW_LOCATION}
gcloud config set eventarc/location ${TRIGGER_LOCATION}

  15. Si has creado el proyecto, se te asignará el rol básico Propietario (roles/owner). De forma predeterminada, este rol de gestión de identidades y accesos (IAM) incluye los permisos necesarios para acceder por completo a la mayoría de los recursos Google Cloud, por lo que puedes saltarte este paso.

    Si no eres el creador del proyecto, debes conceder los permisos necesarios al principal correspondiente. Por ejemplo, una entidad principal puede ser una cuenta de Google (para usuarios finales) o una cuenta de servicio (para aplicaciones y cargas de trabajo de computación). Para obtener más información, consulta la página Roles y permisos de tu destino de evento.

    Permisos obligatorios

    Para obtener los permisos que necesitas para completar esta guía de inicio rápido, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

    Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

    También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

  16. Anota la cuenta de servicio predeterminada de Compute Engine, ya que la asociarás a un activador de Eventarc para representar la identidad del activador con fines de prueba. Esta cuenta de servicio se crea automáticamente después de habilitar o usar un servicio que utiliza Compute Engine y tiene el siguiente formato de correo electrónico: Google Cloud 

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Sustituye PROJECT_NUMBER por el número de tu proyecto. Google Cloud Puedes encontrar el número de tu proyecto en la página Bienvenido de la consola Google Cloud o ejecutando el siguiente comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

    En los entornos de producción, te recomendamos que crees una cuenta de servicio y le asignes uno o varios roles de IAM que contengan los permisos mínimos necesarios y que sigas el principio de privilegio mínimo.

  17. Concede el rol Invocador de Workflows (roles/workflows.invoker) en el proyecto a la cuenta de servicio predeterminada de Compute Engine para que la cuenta tenga permiso para activar la ejecución del flujo de trabajo. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/workflows.invoker
  18. Si habilitaste el agente de servicio de Cloud Pub/Sub el 8 de abril del 2021 o antes para admitir solicitudes push de Pub/Sub autenticadas, asigna el rol Creador de tokens de cuenta de servicio (roles/iam.serviceAccountTokenCreator) al agente de servicio. De lo contrario, este rol se asigna de forma predeterminada: 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator

    19. Crear y desplegar un flujo de trabajo

    Crea e implementa un flujo de trabajo que se ejecute cuando un mensaje publicado en un tema de Pub/Sub active un flujo de trabajo con una solicitud HTTP.

    1. Abre un terminal o Cloud Shell.
    2. En tu directorio principal, crea un archivo llamado myFirstWorkflow.yaml o myFirstWorkflow.json.
    3. Copia y pega lo siguiente en el nuevo archivo y guárdalo:

      YAML

      main:
  params: [event]
  steps:
    - decode_pubsub_message:
        assign:
           - base64: ${base64.decode(event.data.message.data)}
           - message: ${text.decode(base64)}
    - return_pubsub_message:
        return: ${message}

      JSON

      {
  "main": {
    "params": [
      "event"
    ],
    "steps": [
      {
        "decode_pubsub_message": {
          "assign": [
            {
              "base64": "${base64.decode(event.data.message.data)}"
            },
            {
              "message": "${text.decode(base64)}"
            }
          ]
        }
      },
      {
        "return_pubsub_message": {
          "return": "${message}"
        }
      }
    ]
  }
}
    4. Despliega el flujo de trabajo: 
      export MY_WORKFLOW=myFirstWorkflow
gcloud workflows deploy ${MY_WORKFLOW} --source=myFirstWorkflow.yaml
       Sustituye .yaml por .json si has copiado la versión JSON del flujo de trabajo de ejemplo.

    Crear un activador de Eventarc

    Cuando se publica un mensaje en el tema de Pub/Sub, el evento activa el flujo de trabajo.

    1. Crea un activador para escuchar mensajes de Pub/Sub:

      Nuevo tema de Pub/Sub

      gcloud eventarc triggers create events-pubsub-trigger \
    --destination-workflow=${MY_WORKFLOW} \
    --destination-workflow-location=${WORKFLOW_LOCATION} \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"

      De esta forma, se crea un tema de Pub/Sub y un activador para él llamado events-pubsub-trigger.

      Tema de Pub/Sub

      gcloud eventarc triggers create events-pubsub-trigger \
    --destination-workflow=${MY_WORKFLOW} \
    --destination-workflow-location=${WORKFLOW_LOCATION} \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
    --transport-topic=TOPIC_ID

      Sustituye TOPIC_ID por el ID del tema de Pub/Sub.

      De esta forma, se crea un activador llamado events-pubsub-trigger para un tema de Pub/Sub que ya tengas.

      Ten en cuenta que, cuando crees un activador de Eventarc por primera vez en un proyecto de Google Cloud , puede haber un retraso en el aprovisionamiento del agente de servicio de Eventarc. Este problema suele resolverse intentando crear el activador de nuevo. Para obtener más información, consulta Errores de permiso denegado.

    2. Confirma que el activador se ha creado correctamente: 
      gcloud eventarc triggers describe events-pubsub-trigger --location=${TRIGGER_LOCATION}

      La salida debería ser similar a la siguiente, que muestra la hora de creación y la ubicación del activador:

      createTime: '2021-10-14T15:15:43.872360951Z'
[...]
name: projects/PROJECT_ID/locations/us-central1/triggers/events-pubsub-trigger

    Generar y ver un evento

    Publica un mensaje en el tema de Pub/Sub para generar un evento y activar el flujo de trabajo. El evento generado se transfiere como un argumento de tiempo de ejecución al flujo de trabajo, que devuelve el mensaje de Pub/Sub como resultado de la ejecución del flujo de trabajo. Asegúrate de que el tamaño de los eventos que envías al flujo de trabajo no supere los 512 KB.

    1. Si has creado un activador para un nuevo tema de Pub/Sub, busca y define el tema de Pub/Sub creado como variable de entorno:

      export TOPIC_ID=$(basename $(gcloud eventarc triggers describe events-pubsub-trigger --format='value(transport.pubsub.topic)'))

    2. Para activar el flujo de trabajo, envía un mensaje al tema de Pub/Sub:

      gcloud pubsub topics publish $TOPIC_ID --message "Hello there"

      El evento generado se transfiere como argumento de tiempo de ejecución al flujo de trabajo, que devuelve el mensaje "Hola".

    3. Para verificar que se ha activado la ejecución de un flujo de trabajo, enumera las cinco últimas ejecuciones:

      gcloud workflows executions list ${MY_WORKFLOW} --limit=5

      La salida debería ser similar a la siguiente, con un valor de NAME y STATE igual a SUCCEEDED para cada ejecución del flujo de trabajo:

      NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/8c02b8f1-8836-4a6d-99d9-fc321eb9668f
STATE: SUCCEEDED
START_TIME: 2021-09-13T19:15:10.275677049Z
END_TIME: 2021-09-13T19:15:10.963136883Z
NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
STATE: SUCCEEDED
START_TIME: 2021-09-13T17:28:51.492864252Z
END_TIME: 2021-09-13T17:28:52.227212414Z

      Tenga en cuenta que, en el campo NAME del ejemplo anterior, a6319d9d-36a6-4117-904e-3d1118bdc90a es el ID de la ejecución del flujo de trabajo. Copia el ID de ejecución para usarlo en el siguiente paso.

    4. Para ver el estado de la ejecución, ejecuta el siguiente comando:

      gcloud workflows executions describe WORKFLOW_EXECUTION_ID --workflow=${MY_WORKFLOW}

      Sustituye WORKFLOW_EXECUTION_ID por el ID de la ejecución del flujo de trabajo que corresponde a la hora de publicación del tema de Pub/Sub. El resultado debería ser similar al siguiente:

      argument: [...]
endTime: '2021-09-13T17:28:47.301012152Z'
name: projects/1234567/locations/us-central1/workflows/myFirstWorkflow/executions/f72bc6d4-5ea0-4dfb-bb14-2dae82303120
result: 'Hello there'
startTime: '2021-09-13T17:28:51.492864252Z'
state: SUCCEEDED

    5. Verifica que la publish_time en la que se publicó el mensaje de Pub/Sub y la startTime de la ejecución del flujo de trabajo se correspondan.

    Enhorabuena, has generado correctamente un evento mediante un tema de Pub/Sub que ha activado un receptor de eventos de Workflows mediante Eventarc.

    Limpieza

    1. Elimina el flujo de trabajo que has creado: 
      gcloud workflows delete ${MY_WORKFLOW}
       Cuando se te pregunte si quieres continuar, escribe y.
    2. Elimina el activador que has creado: 
      gcloud eventarc triggers delete events-pubsub-trigger
    3. También puedes eliminar tu Google Cloud proyecto para evitar que se te apliquen cargos. Al eliminar tu proyecto Google Cloud , se detendrá la facturación de todos los recursos utilizados en ese proyecto.

      Delete a Google Cloud project:

      gcloud projects delete PROJECT_ID

    Siguientes pasos