Publica y recibe eventos creando un bus y una inscripción (gcloud CLI)

En esta guía de inicio rápido, se muestra cómo publicar y recibir mensajes de eventos creando un bus de Eventarc Advanced y una inscripción en tu proyecto de Google Cloud.

  • Un bus actúa como un enrutador central que recibe mensajes de fuentes de eventos o que publican los proveedores.

  • Una inscripción enruta los mensajes que recibe el bus a uno o más destinos a través de una canalización de procesamiento.

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

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

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

  3. Crea un bus de Eventarc Advanced.

  4. Crea un registro avanzado de Eventarc.

  5. Publica un mensaje de evento en el bus.

  6. Visualizar los datos del evento en los registros de Cloud Run

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

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 Desarrolla aplicaciones en un entorno de Google Cloud restringido.

  1. Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

  2. Instala Google Cloud CLI.

  3. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  4. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  5. Crea o selecciona un Google Cloud proyecto.

    Roles necesarios para seleccionar o crear un proyecto

    • Selecciona un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
    • Crear un proyecto: Para crear un proyecto, necesitas el rol de Creador de proyectos (roles/resourcemanager.projectCreator), que contiene el permiso resourcemanager.projects.create. Obtén más información para otorgar roles.

    • Crea un Google Cloud proyecto:

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto Google Cloud que estás creando.

    • Selecciona el proyecto Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre de tu Google Cloud proyecto.

  6. Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .

  7. Habilita las APIs de Artifact Registry, Cloud Build, Cloud Run, Compute Engine y Eventarc:

    Roles necesarios para habilitar las APIs

    Para habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin), que contiene el permiso serviceusage.services.enable. Obtén más información para otorgar roles. 

    gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

  8. Instala Google Cloud CLI.

  9. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  10. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  11. Crea o selecciona un Google Cloud proyecto.

    Roles necesarios para seleccionar o crear un proyecto

    • Selecciona un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
    • Crear un proyecto: Para crear un proyecto, necesitas el rol de Creador de proyectos (roles/resourcemanager.projectCreator), que contiene el permiso resourcemanager.projects.create. Obtén más información para otorgar roles.

    • Crea un Google Cloud proyecto:

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto Google Cloud que estás creando.

    • Selecciona el proyecto Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre de tu Google Cloud proyecto.

  12. Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .

  13. Habilita las APIs de Artifact Registry, Cloud Build, Cloud Run, Compute Engine y Eventarc:

    Roles necesarios para habilitar las APIs

    Para habilitar las APIs, necesitas el rol de IAM de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin), que contiene el permiso serviceusage.services.enable. Obtén más información para otorgar roles. 

    gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com
    14.

  14. Actualiza los componentes de gcloud: 
    gcloud components update

  15. Accede con tu cuenta: 
    gcloud auth login

  16. Establece la variable de configuración que se usa en esta guía de inicio rápido: 
    REGION=REGION

    Reemplaza REGION por una ubicación compatible para el autobús.

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

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

    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:

    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 a través de roles personalizados o cualquier otro rol predefinido.

  18. Para realizar pruebas, crea una cuenta de servicio y otórgale los roles necesarios para completar esta guía de inicio rápido.
    1. Crea una cuenta de servicio: 
      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
       Reemplaza SERVICE_ACCOUNT_NAME por un nombre para tu cuenta de servicio.
    2. Otorga los roles necesarios para compilar e implementar una imagen de contenedor, y para representar la identidad de una canalización avanzada de Eventarc: 
      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
    --role=roles/artifactregistry.writer
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
    --role=roles/logging.logWriter
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
    --role=roles/storage.admin
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 maneras:

    • Otorga permiso para seleccionar cuentas de servicio o grupos para permitir el acceso 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. Esta es la forma en que se configura el acceso en esta guía de inicio rápido.
    • Otorga permiso a allUsers para permitir el acceso sin autenticar.

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

Crea 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

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

Implementa un servicio del receptor de eventos en Cloud Run

Implementa 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 extremo 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. Ve al directorio que contiene el código de muestra de Cloud Run:

    cd eventarc-samples/eventarc-advanced-quickstart/

  3. Compila una imagen de contenedor de Docker y envíala a tu repositorio:

    gcloud builds submit \
    --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1 \
    --service-account=projects/PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
    --default-buckets-behavior=regional-user-owned-bucket

  4. Implementa la imagen del 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

    Reemplaza SERVICE_NAME por el nombre de tu servicio, por ejemplo, my-service.

    El parámetro de configuración de entrada de all permite todas las solicitudes, incluidas las solicitudes directas desde Internet a la URL run.app. Para obtener más información, consulta Restringe la entrada de red para 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, la implementación estará completa. Anota esta URL para que puedas usarla en un paso posterior.

Crea 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 Crea un bus para enrutar mensajes.

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

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

Reemplaza BUS_NAME por el ID o el identificador completamente calificado de tu bus, por ejemplo, my-bus.

Crea una inscripción en 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 Cómo crear un registro para recibir eventos.

Cuando usas gcloud CLI, primero creas una canalización y, luego, creas 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

    Reemplaza lo siguiente:

    • PIPELINE_NAME: Es el ID de la canalización o un nombre completamente calificado.
    • CLOUD_RUN_SERVICE_URL: Es la URL completamente calificada 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 un correo electrónico de la cuenta de servicio que se usa para generar un token de OIDC.

  2. Crea una inscripción 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

    Reemplaza lo siguiente:

    • ENROLLMENT_NAME: Es el ID de la inscripción o un nombre completamente calificado.

    • MATCH_EXPRESSION: Es la expresión de coincidencia para esta inscripción con CEL. Por ejemplo:

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

Publica 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 de REST de Eventarc Publishing. Para obtener más información, consulta Cómo publicar eventos directamente.

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

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

Ejemplo 1

Puedes publicar un evento en un bus con gcloud CLI y una marca --event-data, además de otras marcas de atributos de eventos:

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 un mensaje JSON con gcloud CLI y una 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 un mensaje que diga "Se publicó el evento correctamente".

Visualiza los datos del evento en los registros de Cloud Run

Después de publicar un evento en tu bus de Eventarc Advanced, puedes verificar los registros de tu servicio de Cloud Run para comprobar que el evento se haya recibido según lo esperado.

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

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

  2. Busca una entrada de registro similar a la que se muestra a continuación:

    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'

Creaste correctamente un bus y una inscripción de Eventarc Advanced, publicaste un mensaje de evento en el bus y verificaste el resultado esperado en los registros del servicio de receptor de eventos.

Realiza una limpieza

Cuando finalices las tareas que se describen en esta guía de inicio rápido, puedes borrar los recursos que creaste para evitar que continúe la facturación:

  1. Borra un repositorio de Artifact Registry.

  2. Borra un servicio de Cloud Run.

  3. Borra los recursos de Eventarc Advanced:

    1. Borra una inscripción.

    2. Borra una canalización.

    3. Borra un autobús.

Como alternativa, puedes borrar el proyecto Google Cloud para evitar que se generen cargos. Si borras tu proyecto de Google Cloud , se detendrá la facturación de todos los recursos que se usaron en él.

Borra un Google Cloud proyecto:

gcloud projects delete PROJECT_ID

¿Qué sigue?