Enruta eventos de Cloud Storage a Workflows

Un activador de Eventarc declara tu interés en un evento o conjunto de eventos determinado. Si deseas configurar el enrutamiento del evento, establece filtros para el activador, lo que incluye al origen del evento y al flujo de trabajo de destino.

Los eventos se entregan en el formato de CloudEvents a través de una solicitud HTTP. El servicio de Workflows convierte el evento en un objeto JSON (según la especificación de CloudEvents) y pasa el evento a la ejecución del flujo de trabajo como un argumento del entorno de ejecución del flujo de trabajo. Asegúrate de que el tamaño del evento no supere los 512 KB. Los eventos que superen el tamaño máximo de argumentos de Workflows no activarán las ejecuciones de flujos de trabajo.

En estas instrucciones, se muestra cómo configurar el enrutamiento de eventos para que se active una ejecución del flujo de trabajo en respuesta a un evento directo Cloud Storage . Esto se aplica a un proveedor de eventos de Cloud Storage. Para obtener más detalles, consulta la lista de eventos directos compatibles.

Prepárate para crear un activador

Antes de crear un activador de Eventarc para un flujo de trabajo de destino, completa las siguientes tareas.

Console

  1. En la página del selector de proyectos de la consola de Google Cloud, elige o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  2. Habilitar las APIs de Eventarc, publicación de Eventarc, Workflows y Workflow Executions.

    Habilita las API

  3. Si corresponde, habilita la API relacionada con los eventos directos. Por ejemplo, para eventos Cloud Storage , habilita la APICloud Storage .

  4. Si aún no tienes una, crea una cuenta de servicio administrada por el usuario y, luego, otórgale los roles y los permisos necesarios para que Eventarc pueda administrar los eventos para el servicio de destino.

    1. En la consola de Google Cloud, ve a la página Cuentas de servicio.

      Ir a Cuentas de servicio

    2. Elige tu proyecto.

    3. Escribe un nombre en el campo Nombre de cuenta de servicio. La consola de Google Cloud completa el campo ID de la cuenta de servicio en función de este nombre.

      Opcional: en el campo Descripción de la cuenta de servicio, escribe una descripción. Por ejemplo, Service account for event trigger.

    4. Haz clic en Crear y continuar.

    5. Para proporcionar el acceso adecuado, en la lista Seleccionar un rol, elige los roles de Identity and Access Management (IAM) necesarios para otorgar a tu cuenta de servicio. Si deseas obtener más información, consulta Roles y permisos para destinos de Workflows.

      Para obtener roles adicionales, haz clic en Agregar otro rol y agrega cada rol adicional.

    6. Haz clic en Continuar.

    7. Para terminar de crear la cuenta, haz clic en Listo.

  5. Otorga el rol de publicador de Pub/Sub al agente de servicio de Cloud Storage. Por lo general, es service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com. Puedes recuperar la dirección de correo electrónico del agente de servicio de Cloud Storage.

    1. En la consola de Google Cloud, ve a la página IAM.

      Ir a IAM

    2. En la fila del agente de servicio de Cloud Storage, haz clic en Editar principal. (Si el agente de servicio no aparece en la lista, continúa con el siguiente paso). Se abrirá el panel Editar acceso.

      1. Haz clic en Agregar otro rol y, a continuación, busca el rol del Publicador de Pub/Sub.
      2. Elige el rol.
      3. Haz clic en Guardar.
    3. Si el agente de servicio no aparece en la lista, haz clic en Otorgar acceso. Se abrirá el panel Otorgar acceso.

      1. En el campo Principales nuevas, escribe la dirección de correo electrónico del agente de servicio.
      2. En la lista Elige un rol, busca el rol Publicador de Pub/Sub.
      3. Elige el rol.
      4. Haz clic en Guardar.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Habilitar las APIs de Eventarc, publicación de Eventarc, Workflows y Workflow Executions:

    gcloud services enable eventarc.googleapis.com \
        eventarcpublishing.googleapis.com \
        workflows.googleapis.com \
        workflowexecutions.googleapis.com

  3. Si corresponde, habilita la API relacionada con los eventos directos. Por ejemplo, para los eventos Cloud Storage , habilita storage.googleapis.com.

  4. Si aún no tienes una, crea una cuenta de servicio administrada por el usuario y, luego, otórgale los roles y los permisos necesarios para que Eventarc pueda administrar los eventos para el servicio de destino.

    1. Cree la cuenta de servicio:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Reemplaza SERVICE_ACCOUNT_NAME por el nombre de la cuenta de servicio. Debe tener entre 6 y 30 caracteres y puede contener guiones y caracteres alfanuméricos en minúscula. Después de crear una cuenta de servicio, no podrás cambiar su nombre.

    2. Otorga los roles o los permisos de Identity and Access Management (IAM) necesarios. Si deseas obtener más información, consulta Roles y permisos para destinos de Workflows.

  5. Si creas un activador para un evento directo de Cloud Storage, otorga el rol pubsub.publisher a la cuenta de servicio de Cloud Storage:

    SERVICE_ACCOUNT="$(gsutil kms serviceaccount -p PROJECT_ID)"
    
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member="serviceAccount:${SERVICE_ACCOUNT}" \
        --role="roles/pubsub.publisher"
    

Crear un activador

Puedes crear un activador de Eventarc con un flujo de trabajo implementado como receptor de eventos con Google Cloud CLI (gcloud o Terraform) o la consola de Google Cloud.

Console

  1. En la consola de Google Cloud, ve a la página Activadores de Eventarc.

    Ir a Activadores

  2. Haz clic en Crear activador.
  3. Escribe un nombre de activador.

    Este es el ID del activador y debe empezar con una letra. Puede contener hasta 63 letras en minúscula, números o guiones.

  4. Para el Tipo de activador, elige Fuentes de Google.
  5. En la lista Proveedor del evento, elige Cloud Storage.

    Ten en cuenta que el nombre del proveedor de eventos que se usa en la documentación de Google Cloud asociada podría no tener el prefijo Cloud o Google Cloud. Por ejemplo, en la consola, Memorystore for Redis se denomina Google Cloud Memorystore para Redis.

  6. En la lista Tipo de evento, en los eventos Directos, selecciona un tipo de evento:
    • google.cloud.storage.object.v1.archived: el evento se envía cuando se archiva o se borra una versión publicada de un objeto. Este evento solo se envía para depósitos con control de versiones.
    • google.cloud.storage.object.v1.delete: el evento se envía cuando se borra un objeto de manera permanente. Según la configuración del control de versiones del objeto de un bucket , esto significa lo siguiente:
      • En el caso de los buckets con control de versiones, este solo se envía cuando se borra una versión de manera permanente (pero no cuando se archiva un objeto).
      • En el caso de los buckets sin control de versiones, este se envía cuando se borra o se reemplaza un objeto.
    • google.cloud.storage.object.v1.finalized: el evento se envía cuando se crea un objeto nuevo (o se reemplaza un objeto existente y se crea una generación nueva de ese objeto) en el bucket.
    • google.cloud.storage.object.v1.metadataUpdated: el evento se envía cuando los [metadata](/storage/docs/metadata) de un objeto existente cambian.
  7. En la lista Tipo de contenido de datos de eventos, elige la codificación de la carga útil del evento.

    Para los eventos directos de Cloud Storage, debe ser application/json.

  8. Especifica o busca el identificador único global del bucket de Cloud Storage.

    El bucket de Cloud Storage debe residir en el mismo proyecto de Google Cloud y región o multirregión que el activador de Eventarc.

  9. Elige una Región.

    Los activadores de Cloud Storage para Eventarc están disponibles en ubicaciones de una sola región, birregionales y multirregionales]. Ten en cuenta que el bucket de Cloud Storage debe residir en el mismo proyecto de Google Cloud y región o multirregión que el activador de Eventarc.

    Los eventos se entregan a través de las notificaciones de Pub/Sub desde Cloud Storage. La configuración de demasiadas notificaciones registradas en el mismo bucket puede agotar el límite de notificaciones de este, como se indica en el error Cloud Storage bucket ...: Pub/Sub notification limit reached. El bucket puede tener hasta 10 parámetros de configuración de notificación definidas para activar un evento específico. Consulta más cuotas y limitaciones en la página de cuotas y límites de Cloud Storage .

  10. Elige la cuenta de servicio que invocará el servicio o el flujo de trabajo.

    O bien, puedes crear una cuenta de servicio nueva.

    Esto especifica el correo electrónico de la cuenta de servicio de Identity and Access Management (IAM) asociado con el activador y al que otorgaste antes roles específicos que requiere Eventarc.

  11. En la lista Destino del evento, elige Workflows.
  12. Elige un flujo de trabajo.

    Este es el nombre del flujo de trabajo al que se pasan los eventos. Los eventos para una ejecución del flujo de trabajo se transforman y se pasan al flujo de trabajo como argumentos del entorno de ejecución.

    Para obtener más información, consulta Crea un activador para Workflows.

  13. Haz clic en Crear.
  14. Después de que se crea un activador, los filtros de fuente del evento no se pueden cambiar. En su lugar, crea un activador nuevo y borra el anterior. Para obtener más información, consulta Administra activadores.

gcloud

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-workflow=DESTINATION_WORKFLOW  \
    --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="bucket=BUCKET" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

Reemplaza lo siguiente:

  • TRIGGER: el ID del activador o un identificador completamente calificado.
  • LOCATION: Es la ubicación del activador de Eventarc y está disponible en ubicaciones de una sola región, birregionales y multirregionales. No puedes crear un activador global de Eventarc. Ten en cuenta que el bucket de Cloud Storage debe residir en el mismo proyecto de Google Cloud y la misma región que el activador de Eventarc. Para obtener más información, consulta Ubicaciones de Eventarc.
  • DESTINATION_WORKFLOW: Es el ID del flujo de trabajo implementado que recibe los eventos del activador. El flujo de trabajo puede estar en cualquiera de las ubicaciones compatibles con Workflows y no necesita estar en la misma ubicación que el activador. Sin embargo, el flujo de trabajo debe estar en el mismo proyecto que el activador.
  • DESTINATION_WORKFLOW_LOCATION (opcional): la ubicación en la que se implementa el flujo de trabajo de destino. Si no se especifica, se supone que el flujo de trabajo se encuentra en la misma ubicación que el activador.
  • EVENT_FILTER_TYPE es el identificador del evento de Cloud Storage y puede ser una de las siguientes opciones:
    • google.cloud.storage.object.v1.finalized: Este evento se envía cuando se crea un objeto nuevo (o se sobrescribe un objeto existente y se crea una generación nueva de ese objeto) en el bucket.
    • google.cloud.storage.object.v1.archived: este evento se envía cuando una versión publicada de un objeto se archiva o se borra. Este evento solo se envía para bucket con control de versiones.
    • google.cloud.storage.object.v1.deleted: este evento se envía cuando se borra un objeto de manera permanente. Según la configuración del control de versiones del objeto de un bucket , esto significa lo siguiente:
      • En el caso de los buckets con control de versiones, este solo se envía cuando se borra una versión de manera permanente (pero no cuando se archiva un objeto).
      • En el caso de los buckets sin control de versiones, este se envía cuando se borra o se reemplaza un objeto.
    • google.cloud.storage.object.v1.metadataUpdated: este evento se envía cuando los metadatos de un objeto existente cambian.
  • BUCKET: Es el identificador único global del bucket de Cloud Storage.
  • SERVICE_ACCOUNT_NAME: El nombre de la cuenta de servicio de IAM que creaste a la que otorgaste roles específicos que requieren los flujos de trabajo.
  • PROJECT_ID: El ID del proyecto de Google Cloud.

Notas:

  • Para los eventos directos de Cloud Storage, la codificación de la carga útil del evento es application/json.
  • Estas marcas son obligatorias:
    • --event-filters="type=EVENT_FILTER_TYPE"
    • --event-filters="bucket=BUCKET"
  • Después de crear un activador, EVENT_FILTER_TYPE no se puede cambiar. Para un tipo de evento diferente, debes crear un activador nuevo.
  • --service-account: El correo electrónico de la cuenta de servicio de IAM que el activador Eventarc usará para invocar las ejecuciones del flujo de trabajo. Recomendamos usar una cuenta de servicio con los privilegios mínimos necesarios para acceder a los recursos requeridos. Para obtener más información sobre las cuentas de servicio, consulta Crea y administra cuentas de servicio.
  • Los eventos se entregan mediante las notificaciones de Pub/Sub desde Cloud Storage. La configuración de demasiadas notificaciones registradas en el mismo bucket puede agotar el límite de notificaciones de este, como se indica en el error Cloud Storage bucket ...: Pub/Sub notification limit reached. El bucket puede tener hasta 10 configuraciones de notificación definidas para activar un evento específico. Consulta más cuotas y limitaciones en la página de cuotas y límites de Cloud Storage.
  • Cada activador tiene varios filtros de eventos, delimitados por comas en una marca --event-filters=[ATTRIBUTE=VALUE,…], o puedes repetir la marca para agregar más filtros. Solo los eventos que coinciden con todos los filtros se envían al destino. No se admiten comodines ni expresiones regulares.
  • El bucket de Cloud Storage debe residir en el mismo proyecto de Google Cloud y región o multirregión que el activador de Eventarc.
  • De forma predeterminada, las suscripciones de Pub/Sub creadas para Eventarc persisten, independientemente de la actividad, y no vencen. Para cambiar la duración de la inactividad, consulta Propiedades de la suscripción.

Ejemplo:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-workflow=my-workflow \
    --destination-workflow-location=europe-west4 \
    --event-filters="type=google.cloud.storage.object.v1.finalized" \
    --event-filters="bucket=my-project-bucket" \
    --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

Con este comando, se crea un activador llamado helloworld-trigger para el bucket de Cloud Storage my-project-bucket y el evento identificado como google.cloud.storage.object.v1.finalized.

Terraform

Puedes crear un activador para un flujo de trabajo con Terraform. Para obtener más detalles, consulta Activa un flujo de trabajo con Eventarc y Terraform.

Enumera un activador

Para confirmar la creación de un activador, enumera los activadores de Eventarc con Google Cloud CLI o a través de la consola de Google Cloud.

Console

  1. En la consola de Google Cloud, ve a la página Activadores de Eventarc.

    Ir a Activadores

    En esta página, se enumeran tus activadores en todas las ubicaciones y se incluyen detalles, como nombres, regiones, proveedores de eventos, destinos y mucho más.

  2. Para filtrar tus activadores, haz lo siguiente:

    1. Haz clic en Filtrar o en el campo Filtrar activadores.
    2. En la lista Propiedades, elige una opción para filtrar los activadores.

    Puedes elegir una sola propiedad o usar el operador lógico OR para agregar más propiedades.

  3. Para ordenar los activadores, junto con el encabezado de la columna compatible, haz clic en Ordenar.

gcloud

Ejecuta el siguiente comando para enumerar los activadores:

gcloud eventarc triggers list --location=-

Este comando enumera tus activadores en todas las ubicaciones y, además, incluye detalles como nombres, tipos, destinos y estados.

¿Qué sigue?