Activa flujos de trabajo con eventos directos desde Cloud Storage (CLI de gcloud)

En esta guía de inicio rápido, se muestra cómo ejecutar un flujo de trabajo con un activador de Eventarc que recibe eventos de Cloud Storage.

El activador ejecuta el flujo de trabajo al escuchar un evento de creación de objeto en un bucket de Cloud Storage y pasa el evento como un argumento de entorno de ejecución a un flujo de trabajo de destino.

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

Crear un bucket de Cloud Storage como fuente del evento
Usar Workflows para crear e implementar un flujo de trabajo que extraiga y muestre el nombre del bucket de almacenamiento y el nombre de un archivo subido
Crear un activador de Eventarc que conecte el bucket de Cloud Storage al receptor de eventos de Workflows.
Generar un evento al subir un archivo de texto al bucket de Cloud Storage. este evento se pasa como un argumento de entorno de ejecución al flujo de trabajo de destino
Visualizar el nombre del bucket y el nombre del archivo de texto como resultado de la ejecución del flujo de trabajo

Para seguir la guía paso a paso sobre esta tarea de forma directa en la consola de Google Cloud, haz clic en Guiarme:

GUIARME

Antes de comenzar

Es posible que las restricciones de seguridad que define tu organización no te permitan completar los siguientes pasos. Para obtener información sobre la solución de problemas, consulta Desarrollar aplicaciones en un entorno de Google Cloud restringido.

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.

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

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.

Make sure that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

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.

Make sure that billing is enabled for your Google Cloud project.

Habilita las APIs de 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

Actualiza los componentes de gcloud:
```
gcloud components update
```

Accede con tu cuenta:
```
gcloud auth login
```

Configura las variables de entorno

Establece las variables de configuración utilizadas en esta guía de inicio rápido.

export PROJECT_ID=PROJECT_ID
export WORKFLOW_LOCATION=us-central1
export TRIGGER_LOCATION=us-central1
gcloud config set project ${PROJECT_ID}
gcloud config set workflows/location ${WORKFLOW_LOCATION}
gcloud config set eventarc/location ${TRIGGER_LOCATION}

Puedes buscar el ID del proyecto en la página de bienvenida de la consola de Google Cloud.

Configura las cuentas de servicio

Otorga los permisos requeridos a las cuentas de servicio que se usan en esta guía de inicio rápido.

Si eres el creador del proyecto, se te otorga el rol de propietario básico (roles/owner). De forma predeterminada, este rol de Identity and Access Management (IAM) incluye los permisos necesarios para obtener acceso completo a la mayoría de los recursos de Google Cloud, pero puedes omitir este paso.

Si no eres el creador del proyecto, se deben otorgar los permisos necesarios en el proyecto a la principal correspondiente. Por ejemplo, una principal puede ser una Cuenta de Google (para usuarios finales) o una cuenta de servicio (para aplicaciones y cargas de trabajo de procesamiento). Para obtener más información, consulta la página Roles y permisos para el destino del evento.
Permisos necesarios

Si quieres obtener los permisos que necesitas para completar esta guía de inicio rápido, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:
- Administrador de Eventarc (roles/eventarc.admin)
- Descriptor de acceso de vista de registros (roles/logging.viewAccessor)
- Administrador de IAM de proyecto (roles/resourcemanager.projectIamAdmin)
- Administrador de cuenta de servicio (roles/iam.serviceAccountAdmin)
- Usuario de cuenta de servicio (roles/iam.serviceAccountUser)
- Administrador de Service Usage (roles/serviceusage.serviceUsageAdmin)
- Administrador de almacenamiento (roles/storage.admin)
- Administrador de flujos de trabajo (roles/workflows.admin)
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
Toma nota del recurso Compute Engine predeterminada, ya que la conectará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 de Google Cloud que use Compute Engine, y con la siguiente formato de correo electrónico:
```
PROJECT_NUMBER-compute@developer.gserviceaccount.com
```
Reemplaza PROJECT_NUMBER por el número de proyecto de Google Cloud. Para encontrar el número del proyecto, ve a la página de bienvenida de la consola de Google Cloud o ejecuta el siguiente comando:
```
gcloud projects describe PROJECT_ID --format='value(projectNumber)'
```
Para entornos de producción, recomendamos crear una cuenta de servicio nueva y otorgarle una o más funciones de IAM que contengan los permisos mínimos requeridos y seguir el principio de privilegio mínimo.

Nota:
La restricción de la política de la organización iam.automaticIamGrantsForDefaultServiceAccounts evita que el rol Editor se otorgue de forma automática a las cuentas de servicio predeterminadas. Si creaste tu organización después del 3 de mayo de 2024, esta restricción se aplica de forma predeterminada.

Recomendamos que apliques esta restricción para inhabilitar la concesión automática de roles. Si inhabilitas la concesión automática de roles, debes decidir qué roles se deben otorgar a las cuentas de servicio predeterminadas y, luego, otorgar estos roles a ti mismo.

Si la cuenta de servicio predeterminada ya tiene el rol de editor, te recomendamos que reemplaces el rol de editor por roles menos permisivos. Para modificar de forma segura los roles de la cuenta de servicio, usa Policy Simulator para ver el impacto del cambio y, luego, otorga y revoca los roles adecuados.
Otorga el rol de receptor de eventos de Eventarc (roles/eventarc.eventReceiver) en el proyecto a la cuenta de servicio predeterminada de Compute Engine para que el activador de Eventarc pueda recibir eventos de proveedores de eventos.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/eventarc.eventReceiver
```
Otorga la función de invocador de flujos de trabajo (roles/workflows.invoker) del proyecto a la cuenta de servicio predeterminada de Compute Engine para que la cuenta tenga permiso para activar tu flujo de trabajo ejecución.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/workflows.invoker
```
Otorga el Rol de escritor de registros de Logging (roles/logging.logWriter) en el proyecto a la cuenta de servicio predeterminada de Compute Engine para que el flujo de trabajo pueda enviar registros a Cloud Logging.
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/logging.logWriter
```

Antes de crear un activador para eventos directos desde Cloud Storage, otorga el rol de publicador de Pub/Sub (roles/pubsub.publisher) al agente de servicio de Cloud Storage:

SERVICE_ACCOUNT="$(gcloud storage service-agent --project=PROJECT_ID)"

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:${SERVICE_ACCOUNT}" \
    --role='roles/pubsub.publisher'

Si habilitaste el agente de servicio de Cloud Pub/Sub el 8 de abril de 2021 o antes de esa fecha, para admitir las solicitudes de envío de Pub/Sub autenticadas, otorga el rol de creador de tokens de cuenta de servicio (roles/iam.serviceAccountTokenCreator) al agente de servicio. De lo contrario, este rol se otorga 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
```

Crea un bucket de Cloud Storage

Crea un bucket de Cloud Storage para usar como fuente del evento:

  gcloud storage buckets create gs://${PROJECT_ID}-bucket/ --location=us-central1

Crea e implementa un flujo de trabajo

Crea y, luego, implementa un flujo de trabajo que se ejecute cuando un objeto creado en el bucket de Cloud Storage active un flujo de trabajo con una solicitud HTTP.

En tu directorio principal, crea un archivo nuevo que se llame myEventWorkflow.yaml o myEventWorkflow.json.

Copia y pega el siguiente flujo de trabajo en el archivo nuevo y guárdalo:

YAML

  main:
    params: [event]
    steps:
        - log_event:
            call: sys.log
            args:
                text: ${event}
                severity: INFO
        - extract_bucket_object:
            assign:
            - bucket: ${event.data.bucket}
            - object: ${event.data.name}
        - return_bucket_object:
                return:
                    bucket: ${bucket}
                    object: ${object}

JSON

{
"main": {
"params": [
  "event"
],
"steps": [
  {
    "log_event": {
      "call": "sys.log",
      "args": {
        "text": "${event}",
        "severity": "INFO"
      }
    }
  },
  {
    "extract_bucket_object": {
      "assign": [
        {
          "bucket": "${event.data.bucket}"
        },
        {
          "object": "${event.data.name}"
        }
      ]
    }
  },
  {
    "return_bucket_object": {
      "return": {
        "bucket": "${bucket}",
        "object": "${object}"
      }
    }
  }
]
}
}

Implementa el flujo de trabajo:
```
export MY_WORKFLOW=myEventWorkflow
gcloud workflows deploy ${MY_WORKFLOW} --source=myEventWorkflow.yaml
```
Reemplaza .yaml por .json si copiaste la versión JSON del flujo de trabajo de ejemplo.

Crea un activador de Eventarc

El activador de Eventarc envía eventos desde el bucket de Cloud Storage al destino de Workflows.

Crea un activador que filtre los eventos de Cloud Storage:
```
gcloud eventarc triggers create storage-events-trigger \
    --destination-workflow=${MY_WORKFLOW} \
    --event-filters="type=google.cloud.storage.object.v1.finalized" \
    --event-filters="bucket=${PROJECT_ID}-bucket" \
    --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"
```
Esto crea un activador llamado storage-events-trigger.

Ten en cuenta que, cuando creas un activador de Eventarc por primera vez en un proyecto de Google Cloud, es posible que haya un retraso en el aprovisionamiento del agente de servicio de Eventarc. Por lo general, este problema se puede resolver si intentas crear el activador de nuevo. Para obtener más información, consulta Errores de permiso denegado.

Para confirmar que storage-events-trigger se creó de forma correcta, ejecuta el siguiente comando:

gcloud eventarc triggers describe storage-events-trigger --location=${TRIGGER_LOCATION}

El resultado debería ser similar al siguiente ejemplo de 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/storage-events-trigger

Genera y visualiza un evento

Para generar un evento, sube un archivo de texto a Cloud Storage:
```
echo "Hello World" > random.txt
gcloud storage cp random.txt gs://${PROJECT_ID}-bucket/random.txt
```
La carga genera un evento que se pasa como argumento de entorno de ejecución al flujo de trabajo y que muestra los nombres del bucket de almacenamiento y del archivo subido.

Para verificar que se activó una ejecución de flujo de trabajo, enumera las últimas cinco ejecuciones:

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

El resultado debería ser similar al siguiente, con 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-10-13T03:38:03.019148617Z
END_TIME: 2021-10-13T03:38:03.249705805Z
NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
STATE: SUCCEEDED
START_TIME: 2021-10-13T17:28:51.492864252Z
END_TIME: 2021-10-13T17:28:52.227212414Z

Ten 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 la ejecución, ya que se usará en el siguiente paso.

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

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

Reemplaza WORKFLOW_EXECUTION_ID por el ID de la ejecución del flujo de trabajo que corresponde a la hora en la que se subió el archivo al bucket.

El resultado es similar al siguiente:

argument: [...]
name: projects/218898424763/locations/us-central1/workflows/myEventWorkflow/executions/86d2567b-0f1e-49b3-8b10-cdac5d0f6239
result: '{"bucket":"PROJECT_ID-bucket","object":"random.txt"}'
startTime: '2021-10-13T03:38:03.019148617Z'
state: SUCCEEDED

Verifica que la hora,"timeCreated": "2021-10-13T03:38" en la que se actualizó el bucket de Cloud Storage y el startTime de la ejecución del flujo de trabajo correspondan entre sí.

Generaste con éxito un evento de Cloud Storage que activó un receptor de eventos de flujos de trabajo mediante Eventarc.

Realiza una limpieza

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que se usaron en esta página, borra el proyecto de Cloud que tiene los recursos.

Borra el flujo de trabajo que creaste:
```
gcloud workflows delete ${MY_WORKFLOW}
```
Cuando se te pregunte si deseas continuar, ingresa y.

Borrar el bucket de almacenamiento.

gcloud storage rm gs://${PROJECT_ID}-bucket/ --recursive

Borra el activador que se creó en este instructivo:

gcloud eventarc triggers delete storage-events-trigger

Como alternativa, puedes borrar el proyecto de Cloud para evitar que se generen cargos. Si borras tu proyecto de Google Cloud, se dejan de facturar todos los recursos que usaste en ese proyecto.
Precaución: Borrar un proyecto tiene las siguientes consecuencias:
- Se borra todo en el proyecto. Si usaste un proyecto existente para las tareas de este documento, cuando lo borres, también se borrará cualquier otro trabajo que hayas realizado en el proyecto.
- Se pierden los ID personalizados de proyectos. Cuando creaste este proyecto, es posible que hayas creado un ID del proyecto personalizado que desees utilizar en el futuro. Para conservar las URL que utilizan el ID del proyecto, como una URL appspot.com, borra los recursos seleccionados dentro del proyecto en lugar de borrar todo el proyecto.
Delete a Google Cloud project:
```
gcloud projects delete PROJECT_ID
```