Publicar y recibir eventos creando un bus y una inscripción (CLI de gcloud)

Publicar y recibir eventos creando un bus y una inscripción (CLI de gcloud)

Avanzado

En esta guía de inicio rápido se muestra cómo publicar y recibir mensajes de eventos creando un bus avanzado de Eventarc y registrándote en tu proyecto de Google Cloud.

• Un bus te permite centralizar el flujo de mensajes a través de tu sistema y actúa como un router. Recibe mensajes de eventos de una fuente de mensajes o publicados por un proveedor y los evalúa según un registro.

• Una inscripción identifica una suscripción a un autobús concreto y define los criterios de coincidencia de los mensajes, lo que hace que se dirijan a uno o varios destinos.

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

1. Crea un repositorio estándar de Artifact Registry.

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

3. Crea un bus avanzado de Eventarc.

4. Crea un registro avanzado de Eventarc.

5. Publica un mensaje de evento en el bus.

6. Consulta los datos de eventos en los registros de Cloud Run.

Puedes completar esta guía de inicio rápido con la CLI de gcloud. Para completar los pasos con la consola Google Cloud , consulta Publicar y recibir eventos creando un bus y una inscripción (consola).

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 Artifact Registry, Cloud Build, Cloud Run, Compute Engine, 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 artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.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 Artifact Registry, Cloud Build, Cloud Run, Compute Engine, 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 artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

1. Actualiza los componentes de gcloud:

   gcloud components update

2. Inicia sesión con tu cuenta:

   gcloud auth login

3. Defina la variable de configuración que se usa en esta guía de inicio rápido:

   REGION=REGION

   Sustituye REGION por una ubicación admitida para el autobús.

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

   Ten en cuenta que, de forma predeterminada, los permisos de Cloud Build incluyen permisos para subir y descargar artefactos de Artifact Registry.

   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:

   • Editor de Cloud Build (roles/cloudbuild.builds.editor)
   • Administrador de Cloud Run (roles/run.admin)
   • Desarrollador de Eventarc (roles/eventarc.developer)
   • Administrador de bus de mensajes de Eventarc (roles/eventarc.messageBusAdmin)
   • Usuario con permiso para ver registros (roles/logging.viewAccessor)
   • Administrador de gestión de identidades y accesos del proyecto (roles/resourcemanager.projectIamAdmin)
   • 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. Concede los siguientes roles en el proyecto a la cuenta de servicio predeterminada de Compute Engine. Estos roles son necesarios para crear e implementar tu imagen de contenedor:
   • Artifact Registry Writer: para subir artefactos de Artifact Registry
   • Escritor de registros: para escribir registros en Cloud Logging
   • Objeto de almacenamiento Usuario: para acceder a objetos de Cloud Storage

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/artifactregistry.writer
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/logging.logWriter
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/storage.objectUser

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

6. De forma predeterminada, solo los propietarios y editores de proyectos, así como los administradores e invocadores de Cloud Run, pueden llamar a los servicios de Cloud Run. Para configurar la autenticación, asigna el rol Invocador de Cloud Run (run.invoker) en tu proyecto Google Cloud a una cuenta de servicio:
   1. Crea una cuenta de servicio. Para hacer pruebas, adjuntarás esta cuenta de servicio a una canalización avanzada de Eventarc para representar la identidad de la canalización.

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Sustituye SERVICE_ACCOUNT_NAME por el nombre de tu cuenta de servicio.
   2. Asigna el rol de roles/run.invoker gestión de identidades y accesos a la cuenta de servicio:

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
          --role=roles/run.invoker

   Ten en cuenta que puedes configurar quién puede acceder a tu servicio de Cloud Run de cualquiera de las siguientes formas:

   • Concede permiso a determinadas cuentas de servicio o grupos para que puedan acceder al servicio. Todas las solicitudes deben tener un encabezado de autorización HTTP que contenga un token de OpenID Connect firmado por Google para una de las cuentas de servicio autorizadas. Así se configura el acceso en esta guía de inicio rápido.
   • Concede permiso a allUsers para permitir el acceso sin autenticar.

   Para obtener más información, consulta Control de acceso para Cloud Run.

Crear un repositorio estándar de Artifact Registry

Crea un repositorio estándar de Artifact Registry para almacenar tu imagen de contenedor.

gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=$REGION

Sustituye REPOSITORY por un nombre único para el repositorio de Artifact Registry. Por ejemplo, my-repo.

Desplegar un servicio de receptor de eventos en Cloud Run

Despliega un servicio de Cloud Run que registre el contenido de un evento. Se admiten otros destinos de eventos, como un tema de Pub/Sub, Workflows o un endpoint HTTP. Para obtener más información, consulta Proveedores y destinos de eventos.

1. Clona el repositorio de GitHub:

   git clone https://github.com/GoogleCloudPlatform/eventarc-samples.git

2. Cambia al directorio que contiene el código de ejemplo de Cloud Run:

   cd eventarc-samples/eventarc-advanced-quickstart/

3. Crea una imagen de contenedor Docker y transfiérela a tu repositorio:

   gcloud builds submit \
       --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1

4. Despliega la imagen de contenedor en Cloud Run:

   gcloud run deploy SERVICE_NAME \
       --image $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1 \
       --platform managed \
       --ingress all \
       --no-allow-unauthenticated \
       --region=$REGION

   Sustituye SERVICE_NAME por el nombre de tu servicio (por ejemplo, my-service).

   El ajuste de entrada de all permite todas las solicitudes, incluidas las que se envían directamente desde Internet a la URL run.app. Para obtener más información, consulta el artículo Restringir el acceso de red a Cloud Run.

   La marca --no-allow-unauthenticated configura el servicio para que solo permita invocaciones autenticadas.

Cuando veas la URL del servicio de Cloud Run, el despliegue se habrá completado. Anota esta URL para usarla en un paso posterior.

Crear un bus de Eventarc Advanced

Un bus recibe mensajes de eventos de una fuente de mensajes o publicados por un proveedor y actúa como un enrutador de mensajes.

Para obtener más información, consulta el artículo Crear un bus para enrutar mensajes.

Nota: Puedes crear un bus por Google Cloud proyecto por región admitida.

Crea un bus avanzado de Eventarc en tu proyecto con el comando gcloud eventarc message-buses create:

gcloud eventarc message-buses create BUS_NAME \
    --location=$REGION

Sustituye BUS_NAME por el ID o el identificador completo de tu autobús (por ejemplo, my-bus).

Crear un registro de Eventarc Advanced

Una inscripción determina qué mensajes se enrutan a un destino y también especifica la canalización que se usa para configurar un destino para los mensajes de eventos.

Para obtener más información, consulta Crear un registro para recibir eventos.

Nota: La creación de una canalización puede tardar más de 10 minutos.

Cuando usas gcloud CLI, primero creas una canalización y, después, una inscripción:

1. Crea una canalización con el comando gcloud eventarc pipelines create:

   gcloud eventarc pipelines create PIPELINE_NAME \
       --destinations=http_endpoint_uri='CLOUD_RUN_SERVICE_URL',google_oidc_authentication_service_account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
       --location=$REGION

   Haz los cambios siguientes:

   • PIPELINE_NAME: el ID de la canalización o un nombre completo.
   • CLOUD_RUN_SERVICE_URL: la URL completa de tu servicio de Cloud Run. Por ejemplo, https://SERVICE_NAME-abcdef-uc.a.run.app. Este es el destino de los mensajes de eventos.

   Ten en cuenta que la clave google_oidc_authentication_service_account especifica una dirección de correo de cuenta de servicio que se usa para generar un token de OIDC.

2. Crea un registro con el comando gcloud eventarc enrollments create:

   gcloud eventarc enrollments create ENROLLMENT_NAME \
       --cel-match=MATCH_EXPRESSION \
       --destination-pipeline=PIPELINE_NAME \
       --message-bus=BUS_NAME \
       --message-bus-project=PROJECT_ID \
       --location=$REGION

   Haz los cambios siguientes:

   • ENROLLMENT_NAME: el ID de la inscripción o un nombre completo.

   • MATCH_EXPRESSION: la expresión coincidente de esta inscripción con CEL. Por ejemplo:

     "message.type == 'hello-world-type'"
     

Publicar un mensaje de evento en el bus

Para publicar un mensaje directamente en tu bus, puedes usar el comando gcloud eventarc message-buses publish o enviar una solicitud a la API REST de publicación de Eventarc. Para obtener más información, consulta Publicar eventos directamente.

El mensaje debe estar en formato CloudEvents, que es una especificación para describir datos de eventos de forma común. El elemento data es la carga útil de tu evento. En este campo se puede incluir cualquier JSON con el formato correcto. Para obtener más información sobre los atributos de contexto de CloudEvents, consulta el artículo Formato de evento.

A continuación, se muestran ejemplos de cómo publicar directamente un evento en un bus avanzado de Eventarc:

Ejemplo 1

Puedes publicar un evento en un bus mediante la CLI de gcloud y un --event-data, así como otros indicadores de atributos de evento:

gcloud eventarc message-buses publish BUS_NAME \
    --event-data='{"key": "hello-world-data"}' \
    --event-id=hello-world-id-1234 \
    --event-source=hello-world-source \
    --event-type=hello-world-type \
    --event-attributes="datacontenttype=application/json" \
    --location=$REGION

Ejemplo 2

Puedes publicar un evento en un bus como mensaje JSON con gcloud CLI y la marca --json-message:

gcloud eventarc message-buses publish BUS_NAME \
    --location=$REGION \
    --json-message='{"id": "hello-world-id-1234", "type":
 "hello-world-type", "source":
 "hello-world-source", "specversion": "1.0", "data":
 {"key": "hello-world-data"}}'

Después de publicar un evento, deberías recibir el mensaje "Evento publicado correctamente".

Ver los datos de eventos en los registros de Cloud Run

Después de publicar un evento en tu bus avanzado de Eventarc, puedes consultar los registros de tu servicio de Cloud Run para verificar que el evento se ha recibido correctamente.

1. Filtra las entradas de registro y devuelve el resultado con el comando gcloud logging read:

   gcloud logging read 'textPayload: "hello-world-data"'
   

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

   insertId: 670808e70002b5c6477709ae
   labels:
   instanceId: 007989f2a10a4a33c21024f2c8e06a9de65d9b4fdc2ee27697a50379b3fab2f975b9233dc357d50b06270829b9b479d5a1ee54a10fa2cb2d98c5f77a0895e2be0f9e6e4b20
   logName: projects/PROJECT_ID/logs/run.googleapis.com%2Fstderr
   receiveTimestamp: '2024-10-10T17:03:35.424659450Z'
   resource:
   labels:
   ...
   type: cloud_run_revision
   textPayload: "[2024-10-21 15:33:19,581] INFO in server: Body: b'{\"value\":\"hello-world-data\"\
     }'"
   timestamp: '2024-10-10T17:03:35.177606Z'
   

   Nota: Si no ves ninguna entrada de registro, espera unos minutos y vuelve a ejecutar el comando gcloud logging read.

Has creado y registrado correctamente un bus avanzado de Eventarc, has publicado un mensaje de evento en el bus y has verificado el resultado esperado en los registros del servicio receptor de eventos.

Limpieza

Cuando hayas completado las tareas descritas en esta guía de inicio rápido, puedes evitar que se te siga facturando eliminando los recursos que has creado:

1. Eliminar un repositorio de Artifact Registry

2. Elimina un servicio de Cloud Run.

3. Elimina los recursos avanzados de Eventarc:

   1. Eliminar una inscripción.

   2. Eliminar una canalización

   3. Eliminar un autobús

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.

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

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Siguientes pasos

• Publicar eventos de fuentes de Google
• Publicar eventos directamente
• Transformar eventos recibidos
• Dar formato a los eventos recibidos