Recibir eventos mediante mensajes de Pub/Sub (gcloud CLI)

Recibir eventos mediante mensajes de Pub/Sub (gcloud CLI)

Estándar

En esta guía de inicio rápido se muestra cómo desplegar un servicio de Cloud Run sin autenticar que recibe eventos mediante Pub/Sub.

Nota: Todos los servicios de Cloud Run se implementan de forma privada de forma predeterminada, lo que significa que no se puede acceder a ellos sin proporcionar credenciales de autenticación en la solicitud. En los proyectos con políticas de organización de uso compartido restringido al dominio, usa un servicio de destino de Cloud Run autenticado en lugar de uno que permita el acceso público (sin autenticar).

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

1. Despliega un servicio de receptor de eventos en Cloud Run.

2. Crea un activador de Eventarc.

3. Publica un mensaje en un tema de Pub/Sub para generar un evento y verlo en los registros de Cloud Run.

Antes de empezar

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 .

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.

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

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Run, Cloud Logging, Pub/Sub, and Eventarc APIs:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable run.googleapis.com logging.googleapis.com pubsub.googleapis.com eventarc.googleapis.com

Install the Google Cloud CLI.

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

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Run, Cloud Logging, Pub/Sub, and Eventarc APIs:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable run.googleapis.com logging.googleapis.com pubsub.googleapis.com eventarc.googleapis.com

1. Actualiza los componentes de Google Cloud CLI:

   gcloud components update

2. Inicia sesión con tu cuenta:

   gcloud auth login

3. Define las variables de configuración que se usan en esta guía de inicio rápido:

   gcloud config set run/region us-central1
   gcloud config set run/platform managed
   gcloud config set eventarc/location us-central1

4. 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:

   • Administrador de Cloud Run (roles/run.admin)
   • Administrador de Eventarc (roles/eventarc.admin)
   • Usuario con permiso para ver registros (roles/logging.viewAccessor)
   • Administrador de gestión de identidades y accesos del proyecto (roles/resourcemanager.projectIamAdmin)
   • Editor de Pub/Sub (roles/pubsub.publisher)
   • Administrador de cuentas de servicio (roles/iam.serviceAccountAdmin)
   • Usuario de cuenta de servicio (roles/iam.serviceAccountUser)
   • Administrador de Uso de Servicio (roles/serviceusage.serviceUsageAdmin)

   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.

5. 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:[e-mail] \
       --role=roles/iam.serviceAccountTokenCreator

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)'

Desplegar un receptor de eventos en Cloud Run

Despliega un servicio de Cloud Run que recibirá y registrará eventos mediante una imagen prediseñada, us-docker.pkg.dev/cloudrun/container/hello:

gcloud run deploy helloworld-events-pubsub-quickstart \
    --image=us-docker.pkg.dev/cloudrun/container/hello \
    --allow-unauthenticated

Cuando veas la URL del servicio, el despliegue se habrá completado.

Crear un activador de Eventarc

El activador de eventos envía mensajes al servicio receptor de eventos desplegado en Cloud Run cuando se publica un mensaje en el tema de Pub/Sub.

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

   Nuevo tema de Pub/Sub

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-run-service=helloworld-events-pubsub-quickstart \
       --destination-run-region=us-central1 \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished"
   

   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-run-service=helloworld-events-pubsub-quickstart \
       --destination-run-region=us-central1 \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID
   

   Haz los cambios siguientes:

   • PROJECT_ID: tu ID de proyecto Google Cloud
   • TOPIC_ID: ID del tema de Pub/Sub

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

   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 list --location=us-central1
   

   El events-pubsub-trigger se muestra con un destino que es el servicio de Cloud Run, helloworld-events-pubsub-quickstart.

Nota: Aunque el activador se crea inmediatamente, puede tardar hasta dos minutos en estar totalmente operativo.

Generar y ver un evento de tema de Pub/Sub

Puedes generar un evento de Eventarc publicando un mensaje en un tema de Pub/Sub.

1. Busca y define el tema de Pub/Sub como variable de entorno:

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

2. Publica un mensaje en el tema de Pub/Sub para generar un evento:

   gcloud pubsub topics publish $RUN_TOPIC --message "Hello World!"
   

   El evento se enruta al servicio de Cloud Run, que registra el mensaje del evento.

3. Para ver las entradas de registro relacionadas con eventos creadas por tu servicio, ejecuta el siguiente comando:

   gcloud logging read 'jsonPayload.message: "Received event of type google.cloud.pubsub.topic.v1.messagePublished"'
   

4. Busca una entrada de registro similar a la siguiente:

   jsonPayload:
   ...
   message: 'Received event of type google.cloud.pubsub.topic.v1.messagePublished.
       Event data: Hello World!'
   

   Nota: Si no ves ninguna entrada de registro, espera unos minutos y vuelve a ejecutar el comando gcloud logging read. El activador puede tardar hasta dos minutos en empezar a filtrar eventos después de crearse.

¡Enhorabuena! Has desplegado correctamente un servicio receptor de eventos en Cloud Run, has creado un activador de Eventarc, has generado un evento desde Pub/Sub y lo has visto en los registros de Cloud Run.

Limpieza

Cuando termines las tareas que se describen en este documento, puedes evitar que se te siga facturando eliminando los recursos que has creado.

Puedes hacer lo siguiente:

1. Elimina el servicio de Cloud Run.

2. Elimina el activador de Eventarc.

   También se elimina el tema de Pub/Sub asociado.

También puedes eliminar tu Google Cloud proyecto para evitar que se te apliquen cargos. Al eliminar tu Google Cloud proyecto, se detendrá la facturación de todos los recursos utilizados en él.

Precaución: Eliminar un proyecto tiene los siguientes efectos:

• Se elimina todo el contenido del proyecto. Si has usado un proyecto que ya existía para las tareas de este documento, cuando lo elimines, también se eliminará cualquier otro trabajo que hayas realizado en él.
• Se pierden los IDs de proyecto personalizados. Cuando creaste este proyecto, es posible que hayas creado un ID de proyecto personalizado que quieras usar en el futuro. Para conservar las URLs que usan el ID del proyecto, como una URL appspot.com, elimina los recursos seleccionados dentro del proyecto en lugar de eliminar todo el proyecto.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Si tienes previsto consultar varios tutoriales y guías de inicio rápido, reutilizar los proyectos puede ayudarte a no superar los límites de cuota de proyectos.

Siguientes pasos

• Recibir eventos de Pub/Sub mediante un servicio de Cloud Run autenticado
• Crear contenedores para Cloud Run
• Desarrollar servicios para Cloud Run