Es posible que tu flujo de trabajo tenga que esperar a que se complete un proceso externo. Puedes usar retrollamadas HTTP para esperar a que otro servicio haga una solicitud a un endpoint de retrollamada. Esa solicitud reanuda la ejecución del flujo de trabajo. También puedes esperar usando el sondeo.
En lugar de usar el sondeo, en este tutorial se muestra cómo puedes esperar eventos o mensajes de Pub/Sub mediante retrollamadas HTTP y activadores de Eventarc. Aunque puedes activar un flujo de trabajo con eventos o mensajes de Pub/Sub, puede que quieras detener la ejecución para esperar otro evento antes de continuar. Por ejemplo, un evento activa un flujo de trabajo para iniciar un proceso, pero el flujo de trabajo debe esperar a otro evento que indique que el proceso se ha completado. Para ello, puedes hacer que un flujo de trabajo devuelva la llamada a otro.
Objetivos
En este tutorial, ocurre lo siguiente:
Se implementa y ejecuta un flujo de trabajo principal que debe esperar eventos. Como debe esperar a que se produzcan los eventos, almacena los detalles de su retrollamada en una base de datos de Firestore para que el flujo de trabajo secundario pueda recuperar los detalles. El flujo de trabajo principal espera las llamadas HTTP.
Los eventos activan un flujo de trabajo secundario, que obtiene los detalles de la retrollamada de la base de datos de Firestore cuando se generan los eventos. A continuación, el flujo de trabajo secundario vuelve a llamar al flujo de trabajo principal, que reanuda su ejecución.
A continuación, se ofrece un resumen de todo el proceso:
Flujo de trabajo principal:
- Un flujo de trabajo de
callback-event-sample
crea endpoints de retrollamada para dos fuentes de eventos: un tema de Pub/Sub y un segmento de Cloud Storage. - Este flujo de trabajo almacena ambos endpoints de retrollamada en un documento de Firestore.
- Este flujo de trabajo detiene su ejecución y espera a que lleguen solicitudes HTTP a los endpoints de retrollamada.
Eventos:
- Se producen eventos: se publica un mensaje en un tema de Pub/Sub y se sube un archivo a un segmento de Cloud Storage.
Flujo de trabajo secundario:
- Eventarc enruta los eventos al flujo de trabajo
callback-event-listener
y activa su ejecución. - Este flujo de trabajo obtiene las URLs de endpoint de retrollamada adecuadas del documento de Firestore.
- Este flujo de trabajo ejecuta las retrollamadas a los endpoints correspondientes del flujo de trabajo de ejemplo.
Flujo de trabajo principal:
- El flujo de trabajo
callback-event-sample
recibe los eventos en los endpoints de retrollamada y reanuda su ejecución. - Este flujo de trabajo elimina las URLs de retrollamada del documento de Firestore y completa su ejecución.
Costes
En este documento, se utilizan los siguientes componentes facturables de Google Cloud:
Para generar una estimación de costes basada en el uso previsto,
utiliza la calculadora de precios.
Antes de empezar
Puedes ejecutar los siguientes comandos en la Google Cloud consola o mediante la CLI de Google Cloud en tu terminal o en Cloud Shell.
Es posible que las restricciones de seguridad definidas por tu organización te impidan completar los siguientes pasos. Para obtener información sobre cómo solucionar problemas, consulta el artículo Desarrollar aplicaciones en un entorno limitado Google Cloud .
Consola
En la Google Cloud consola, en la página del selector de proyectos, selecciona o crea un Google Cloud proyecto.
Comprueba que la facturación esté habilitada en tu Google Cloud proyecto. Consulta cómo comprobar si la facturación está habilitada en un proyecto.
Habilita las APIs App Engine, Eventarc, Firestore, Pub/Sub y Workflows.
Crea una cuenta de servicio para que tu flujo de trabajo la use para autenticarse con otros servicios de Google Cloud y concédele los roles adecuados:
En la Google Cloud consola, ve a la página Cuentas de servicio.
Para ir a la página Crear cuenta de servicio, selecciona tu proyecto.
En el campo Nombre de cuenta de servicio, escribe un nombre. La Google Cloud consola rellena el campo ID de cuenta de servicio con este nombre.
En el campo Descripción de la cuenta de servicio, escribe una descripción. Por ejemplo,
Service account for tutorial
.Haz clic en Crear y continuar.
En la lista Selecciona un rol, filtra los siguientes roles para asignarlos a la cuenta de servicio gestionada por el usuario que has creado en el paso anterior:
- Usuario de Cloud Datastore: para acceder a los datos de Firestore en el modo de Datastore (Datastore).
- Receptor de evento Eventarc: para recibir eventos de proveedores de eventos.
- Editor de registros: para escribir registros.
- Invocador de flujos de trabajo: para ejecutar flujos de trabajo y gestionar las ejecuciones.
Para añadir más roles, haz clic en
Añadir otro rol y añade cada rol adicional.Haz clic en Continuar.
Para terminar de crear la cuenta, haga clic en Hecho.
Para crear un activador de Eventarc que enrute eventos de Cloud Storage, concede el rol Editor de Pub/Sub al agente de servicio de Cloud Storage. Normalmente, es
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
. Puedes obtener la dirección de correo del agente de servicio de Cloud Storage.En la consola, ve a la página IAM. Google Cloud
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, ve al paso siguiente. Se abrirá el panel Editar acceso.- Haz clic en addAñadir otro rol y, a continuación, busca el rol Editor de Pub/Sub.
- Selecciona el rol.
- Haz clic en Guardar.
Si el agente de servicio no aparece en la lista, haz clic en
Dar acceso. Se abrirá el panel Dar acceso.- En el campo Principales nuevos, introduce la dirección de correo del agente de servicio.
- En la lista Selecciona un rol, busca el rol Editor de Pub/Sub.
- Selecciona el rol.
- Haz clic en Guardar.
gcloud
In the Google Cloud console, 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.
Comprueba que la facturación esté habilitada en tu Google Cloud proyecto. Consulta cómo comprobar si la facturación está habilitada en un proyecto.
Habilita las APIs App Engine, Eventarc, Firestore, Pub/Sub y Workflows.
gcloud services enable \ appengine.googleapis.com \ eventarc.googleapis.com \ firestore.googleapis.com \ pubsub.googleapis.com \ workflows.googleapis.com
Crea una cuenta de servicio para que tu flujo de trabajo la use para autenticarse con otros servicios de Google Cloud y concédele los roles adecuados.
Crea la cuenta de servicio:
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
Sustituye
SERVICE_ACCOUNT_NAME
por el nombre de la cuenta de servicio.Asigna roles a la cuenta de servicio gestionada por el usuario que has creado en el paso anterior. Ejecuta el siguiente comando una vez por cada uno de los siguientes roles de gestión de identidades y accesos:
roles/datastore.user
: para acceder a los datos de Firestore en el modo de Datastore (Datastore).roles/eventarc.eventReceiver
: para recibir eventos de proveedores de eventos.roles/logging.logWriter
: para escribir registros.roles/workflows.invoker
: para ejecutar flujos de trabajo y gestionar las ejecuciones.
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role=ROLE
Haz los cambios siguientes:
PROJECT_ID
: el ID del proyecto en el que has creado la cuenta de servicio.ROLE
: el rol que se va a conceder
Para crear un activador de Eventarc que enrute eventos de Cloud Storage, asigna el rol Editor de Pub/Sub al agente de servicio de Cloud Storage. Normalmente, es
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
. Usagcloud storage service-agent
para recuperar primero el agente de servicio de Cloud Storage.SERVICE_ACCOUNT_STORAGE="$(gcloud storage service-agent --project=PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$SERVICE_ACCOUNT_STORAGE \ --role=roles/pubsub.publisher
Crear una base de datos de Firestore
Firestore almacena los datos en documentos que contienen campos que se asignan a valores. Estos documentos se almacenan en colecciones, que son contenedores de documentos que puedes usar para organizar tus datos y crear consultas. Consulta más información sobre Firestore.
Ten en cuenta que cada proyecto está limitado a una base de datos de Firestore. Google Cloud Sigue estos pasos si necesitas crear una base de datos.
Consola
En la Google Cloud consola, ve a la página de Firestore Empezar.
Haz clic en Seleccionar modo nativo.
Para obtener información sobre cómo seleccionar un modo de base de datos y ver una comparación de las funciones, consulta Elegir entre el modo nativo y el modo de Datastore.
En la lista Seleccionar una ubicación, selecciona nam5 (Estados Unidos).
La ubicación se aplica tanto a la base de datos de Firestore como a la aplicación de App Engine de tu Google Cloud proyecto. Una vez que hayas creado la base de datos, no podrás cambiar la ubicación.
Haz clic en Crear base de datos.
gcloud
Para crear una base de datos de Firestore, primero debes crear una aplicación de App Engine y, a continuación, ejecutar el comando gcloud firestore databases create
:
gcloud app create --region=us-central gcloud firestore databases create --region=us-central
Puedes ignorar la advertencia de us-central is not a valid Firestore location
.
App Engine y Firestore admiten las mismas ubicaciones, pero la región us-central
(Iowa) de App Engine se corresponde con la región múltiple nam5
(Estados Unidos) de Firestore.
Crear un tema de Pub/Sub
En este tutorial se usa Pub/Sub como fuente de eventos. Crea un tema de Pub/Sub para poder publicar un mensaje en él. Más información sobre cómo crear y gestionar temas
Consola
En la Google Cloud consola, ve a la página Pub/Sub Temas.
Haz clic en
Crear tema.En el campo ID de tema, introduce
topic-callback
.Acepta los demás valores predeterminados.
Haz clic en Crear tema.
gcloud
Para crear un tema, ejecuta el comando
gcloud pubsub topics create
:
gcloud pubsub topics create topic-callback
Crea un segmento de Cloud Storage
En este tutorial se usa Cloud Storage como origen de eventos. Crea un segmento de Cloud Storage para poder subir un archivo. Más información sobre cómo crear grupos de almacenamiento
Consola
En la Google Cloud consola, ve a la página Segmentos de Cloud Storage.
Haz clic en
Crear.En Nombre del contenedor, introduce
PROJECT_ID-bucket-callback
.El ID de proyecto se usa en el flujo de trabajo
callback-event-sample
para identificar el contenedor.Haz clic en Continuar.
En Tipo de ubicación, selecciona Región y, a continuación, us-central1 (Iowa).
Acepta los demás valores predeterminados.
Haz clic en Crear.
gcloud
Para crear un contenedor, ejecuta el comando
gcloud storage buckets create
gcloud storage buckets create gs://PROJECT_ID-bucket-callback \ --location=us-central1
El ID de proyecto se usa en el flujo de trabajo callback-event-sample
para identificar el contenedor.
Una vez creadas las fuentes de eventos, puedes implementar el flujo de trabajo del receptor de eventos.
Desplegar un flujo de trabajo que detecte eventos
El flujo de trabajo callback-event-listener
se activa cuando se publica un mensaje en un tema de Pub/Sub o cuando se sube un archivo a un segmento de Cloud Storage. El flujo de trabajo recibe el evento, obtiene los detalles de la retrollamada correspondientes de la base de datos de Firestore y, a continuación, envía una solicitud HTTP al endpoint de retrollamada.
Consola
En la Google Cloud consola, ve a la página Flujos de trabajo:
Haz clic en
Crear.Escribe un nombre para el nuevo flujo de trabajo:
callback-event-listener
.En la lista Región, selecciona us-central1.
Selecciona la cuenta de servicio que has creado anteriormente.
Haz clic en Siguiente.
En el editor del flujo de trabajo, introduce la siguiente definición para tu flujo de trabajo:
Haz clic en Desplegar.
gcloud
Crea un archivo de código fuente para tu flujo de trabajo:
touch callback-event-listener.yaml
En un editor de texto, copia el siguiente flujo de trabajo en tu archivo de código fuente:
Para desplegar el flujo de trabajo, introduce el siguiente comando:
gcloud workflows deploy callback-event-listener \ --source=callback-event-listener.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Sustituye
SERVICE_ACCOUNT_NAME
por el nombre de la cuenta de servicio que has creado anteriormente.
Desplegar un flujo de trabajo que espera eventos
El flujo de trabajo callback-event-sample
almacena los detalles de su retrollamada en una base de datos de Firestore, detiene su ejecución y, a continuación, espera a que se produzcan eventos específicos.
Consola
En la Google Cloud consola, ve a la página Flujos de trabajo:
Haz clic en
Crear.Escribe un nombre para el nuevo flujo de trabajo:
callback-event-sample
.En la lista Región, selecciona us-central1.
Selecciona la cuenta de servicio que has creado anteriormente.
Haz clic en Siguiente.
En el editor del flujo de trabajo, introduce la siguiente definición para tu flujo de trabajo:
Haz clic en Desplegar.
gcloud
Crea un archivo de código fuente para tu flujo de trabajo:
touch callback-event-sample.yaml
En un editor de texto, copia el siguiente flujo de trabajo en tu archivo de código fuente:
Para desplegar el flujo de trabajo, introduce el siguiente comando:
gcloud workflows deploy callback-event-sample \ --source=callback-event-sample.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Sustituye
SERVICE_ACCOUNT_NAME
por el nombre de la cuenta de servicio que has creado anteriormente.
Crear un activador de Eventarc para enrutar eventos de Pub/Sub
Un activador de Eventarc te permite enrutar eventos especificando filtros para el activador, como el origen del evento y el flujo de trabajo de destino.
Crea un activador de Eventarc para ejecutar el flujo de trabajo callback-event-listener
como resultado de la publicación de un mensaje en un tema de Pub/Sub.
Más información sobre cómo activar un flujo de trabajo
Consola
En la Google Cloud consola, ve a la página Eventarc.
Haz clic en
Crear activador.Escribe un Nombre del activador.
Por ejemplo,
trigger-pubsub-events-listener
.En la lista Proveedor de eventos, selecciona Cloud Pub/Sub.
En la lista Evento, en Personalizado, selecciona google.cloud.pubsub.topic.v1.messagePublished.
En la lista Seleccionar un tema de Cloud Pub/Sub, elija el tema que haya creado anteriormente.
En la lista Región, selecciona us-central1 (Iowa).
Si se te pide, otorga el rol
iam.serviceAccountTokenCreator
a la cuenta de servicio de Pub/Sub.Selecciona la cuenta de servicio que has creado anteriormente.
En la lista Destino del evento, selecciona Workflows (Flujos de trabajo).
En la lista Select a workflow (Seleccionar un flujo de trabajo), selecciona el flujo de trabajo callback-event-listener.
Haz clic en Crear.
gcloud
Para crear un activador, ejecuta el comando
gcloud eventarc triggers create
gcloud eventarc triggers create trigger-pubsub-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --transport-topic=topic-callback \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Los eventos se transforman y se transfieren a la ejecución del flujo de trabajo como argumentos del entorno de ejecución. Ten en cuenta que el nuevo activador puede tardar hasta 2 minutos en activarse.
Crear un activador de Eventarc para enrutar eventos de Cloud Storage
Un activador de Eventarc te permite enrutar eventos especificando filtros para el activador, como el origen del evento y el flujo de trabajo de destino.
Crea un activador de Eventarc para ejecutar el flujo de trabajo callback-event-listener
como resultado de la subida de un archivo a un segmento de Cloud Storage.
Más información sobre cómo activar un flujo de trabajo
Consola
En la Google Cloud consola, ve a la página Eventarc.
Haz clic en
Crear activador.Escribe un Nombre del activador.
Por ejemplo,
trigger-storage-events-listener
.En la lista Proveedor de eventos, selecciona Cloud Storage.
En la lista Event (Evento), en Direct (Directo), selecciona google.cloud.storage.object.v1.finalized.
En la lista Segmento, busca el segmento que has creado anteriormente y selecciónalo.
En la lista Región, en función de tu segmento de Cloud Storage, acepta el valor predeterminado us-central1 (Iowa).
Si se te pide, otorga el rol
iam.serviceAccountTokenCreator
a la cuenta de servicio de Pub/Sub.Selecciona la cuenta de servicio que has creado anteriormente.
En la lista Destino del evento, selecciona Workflows (Flujos de trabajo).
En la lista Select a workflow (Seleccionar un flujo de trabajo), selecciona el flujo de trabajo callback-event-listener.
Haz clic en Crear.
gcloud
Para crear un activador, ejecuta el comando
gcloud eventarc triggers create
gcloud eventarc triggers create trigger-storage-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=PROJECT_ID-bucket-callback" \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Los eventos se transforman y se transfieren a la ejecución del flujo de trabajo como argumentos del entorno de ejecución. Ten en cuenta que el nuevo activador puede tardar hasta 2 minutos en activarse.
Ejecutar el flujo de trabajo principal
Al ejecutar un flujo de trabajo, se ejecuta la definición del flujo de trabajo actual asociada al flujo de trabajo. Ejecuta el flujo de trabajo callback-event-sample
. Este es el flujo de trabajo principal, que espera a que se produzcan eventos específicos y solo reanuda su ejecución cuando el flujo de trabajo secundario realiza las solicitudes de retrollamada adecuadas.
Consola
En la Google Cloud consola, ve a la página Flujos de trabajo.
En la página Flujos de trabajo, haz clic en el flujo de trabajo callback-event-sample para ir a su página de detalles.
En la página Detalles del flujo de trabajo, haz clic en play_arrow Ejecutar.
Vuelve a hacer clic en Ejecutar.
Se inicia la ejecución del flujo de trabajo. Mientras se ejecuta, deberías ver el estado de ejecución
Running
y una entrada de registro similar a la siguiente:Started waiting 1hr for an event from source topic-callback
.
gcloud
Para ejecutar un flujo de trabajo, ejecuta el comando
gcloud workflows run
:
gcloud workflows run callback-event-sample \ --location=us-central1
Se inicia la ejecución del flujo de trabajo. Mientras se ejecuta, debería ver un estado de ejecución similar al siguiente:
Waiting for execution [a848a164-268a-449c-b2fe-396f32f2ed66] to complete...working...
Generar eventos y comprobar el estado de ejecución
Para confirmar que los resultados son los esperados, genere eventos, consulte las entradas de registro y compruebe el estado de ejecución del flujo de trabajo.
Publicar un mensaje
Publica un mensaje en el tema de Pub/Sub que has creado anteriormente.
Consola
En la Google Cloud consola, ve a la página Pub/Sub Temas.
Haz clic en topic-callback.
Haz clic en la pestaña Mensajes.
Haz clic en Publicar mensaje.
En el campo Cuerpo del mensaje, introduce
Hello World
.Haz clic en Publicar.
gcloud
Para publicar un mensaje, usa el comando gcloud pubsub topics publish:
gcloud pubsub topics publish topic-callback \ --message="Hello World"
Subir un objeto
Sube un archivo al segmento de Cloud Storage que has creado anteriormente.
Consola
- En la Google Cloud consola, ve a la página Segmentos de Cloud Storage.
Haz clic en el nombre del segmento que creaste anteriormente.
En la pestaña Objetos, haga una de las siguientes acciones:
Arrastra el archivo que quieras desde el escritorio o el gestor de archivos hasta el panel principal de la Google Cloud consola.
Haz clic en Subir archivos, selecciona el archivo que quieras subir y, a continuación, haz clic en Abrir.
gcloud
Para subir un archivo, ejecuta el comando gcloud storage cp
:
gcloud storage cp OBJECT_LOCATION gs://PROJECT_ID-bucket-callback/
Sustituye OBJECT_LOCATION
por la ruta local a tu objeto. Por ejemplo, random.txt
.
Ver entradas de registro y estado de ejecución
Confirma que el flujo de trabajo callback-event-sample
se ha completado correctamente.
Consola
En la Google Cloud consola, ve a la página Flujos de trabajo.
En la página Flujos de trabajo, haz clic en el flujo de trabajo callback-event-sample para ir a su página de detalles.
En la página Detalles del flujo de trabajo, para obtener los detalles de una ejecución concreta, haz clic en el ID de ejecución correspondiente.
El Estado de ejecución debe ser Correcto y, en el panel de salida, debe ver los eventos de Pub/Sub y Cloud Storage recibidos.
gcloud
Filtra las entradas de registro y devuelve el resultado en formato JSON:
gcloud logging read "resource.type=workflows.googleapis.com/Workflow AND textPayload:calling OR textPayload:waiting" \ --format=json
Busca entradas de registro similares a las siguientes:
"textPayload": "Stopped waiting for an event from source..." "textPayload": "Calling back url https://workflowexecutions.googleapis.com/v1/projects/..." "textPayload": "Started waiting 1hr for an event from source..."
Comprueba el estado del último intento de ejecución:
gcloud workflows executions wait-last
El resultado debería ser similar al siguiente:
Using cached execution name: projects/1085953646031/locations/us-central1/workflows/callback-event-sample/executions/79929e4e-82c1-4da1-b068-f828034c01b7 Waiting for execution [79929e4e-82c1-4da1-b068-f828034c01b7] to complete...done. [...] state: SUCCEEDED
Limpieza
Si has creado un proyecto para este tutorial, elimínalo. Si has usado un proyecto y quieres conservarlo sin los cambios que se han añadido en este tutorial, elimina los recursos creados para el tutorial.
Eliminar el proyecto
La forma más fácil de evitar que te cobren es eliminar el proyecto que has creado para el tutorial.
Para ello, sigue las instrucciones que aparecen a continuación:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Eliminar los recursos creados en este tutorial
Siguientes pasos
- Prueba el tutorial Crear un flujo de trabajo con intervención humana mediante retrollamadas.