Crea un bus y una inscripción para publicar y recibir eventos

Crea un bus y una inscripción para publicar y recibir eventos

Avanzado

Vista previa — Eventarc Advanced

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

En esta guía de inicio rápido, se muestra cómo publicar y recibir mensajes de eventos mediante la creación de un bus avanzado de Eventarc y la inscripción 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 eventos de una fuente de mensajes o publicados por un proveedor, y los evalúa según una inscripción.

Una inscripción identifica una suscripción a un bus en particular y define los criterios de coincidencia para los mensajes, lo que hace que se enruten según uno o más destinos.

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

1. Crea una subred y habilita el Acceso privado a Google.

2. Crear un adjunto de red

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

4. Crea un bus de Eventarc Advanced.

5. Crea una inscripción de Eventarc Advanced.

6. Publica un mensaje de evento en el bus.

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

Puedes completar esta guía de inicio rápido con Google Cloud CLI.

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. 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.
2. Install the Google Cloud CLI.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. Create or select a Google Cloud project.

   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.

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

6. Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs:

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

7. Install the Google Cloud CLI.

8. To initialize the gcloud CLI, run the following command:

   gcloud init

9. Create or select a Google Cloud project.

   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.

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

11. Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs:

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

12. Actualiza los componentes de gcloud:

    gcloud components update

13. Accede con tu cuenta:

    gcloud auth login

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

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

    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:

    • Editor de Cloud Build (roles/cloudbuild.builds.editor)
    • Administrador de Cloud Run (roles/run.admin)
    • Desarrollador de Eventarc (roles/eventarc.developer)
    • Administrador de buses de mensajes de Eventarc (roles/eventarc.messageBusAdmin)
    • 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)

    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.

16. Otorga los siguientes roles del proyecto a la cuenta de servicio predeterminada de Compute Engine. Estos roles son necesarios cuando compilas y, luego, implementas la imagen de tu contenedor:
    • Artifact Registry Writer: Para subir artefactos de Artifact Registry
    • Logs Writer: Para escribir registros en Cloud Logging
    • Usuario de objetos de almacenamiento: Para acceder a los 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

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

17. De forma predeterminada, solo los propietarios y los editores del proyecto, y los administradores y los invocadores de Cloud Run pueden llamar a los servicios de Cloud Run. Para configurar la autenticación, otorga el rol de invocador de Cloud Run (run.invoker) en tu proyecto de Google Cloud a una cuenta de servicio:
    1. Crea una cuenta de servicio. Para realizar pruebas, conectarás esta cuenta de servicio a una canalización de Eventarc Advanced para representar la identidad de la canalización.

       gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

       Reemplaza SERVICE_ACCOUNT_NAME por un nombre para la cuenta de servicio.
    2. Otorga el rol de IAM roles/run.invoker 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 una 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 no autenticado.

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

Crea una subred y habilita el Acceso privado a Google

A menos que crees una política de la organización que lo prohíba, los proyectos nuevos de Google Cloud comienzan con una red de nube privada virtual (VPC) predeterminada (una red de VPC en modo automático) que tiene una subred en cada región. Las subredes tienen rangos de direcciones IP asociados.

Como enrutas mensajes a un destino de Cloud Run con una dirección DNS, debes habilitar el Acceso privado a Google en la subred que se usa en el adjunto de red. De lo contrario, no se podrá resolver la dirección DNS. Para obtener más información sobre las redes privadas y Cloud Run, consulta Recibe solicitudes de redes de VPC.

Crea una subred en la red predeterminada de tu proyecto y usa la marca --enable-private-ip-google-access para habilitar el Acceso privado a Google:

gcloud compute networks subnets create SUBNET_NAME \
    --network=default \
    --range=10.8.0.0/24 \
    --region=$REGION \
    --enable-private-ip-google-access

Reemplaza SUBNET_NAME por el nombre de tu subred, por ejemplo, my-subnet.

Los rangos de IP de las subredes deben ser únicos y no superponerse dentro de una red de VPC ni de una red de VPC con intercambio de tráfico. Para obtener más información sobre los tipos de subredes y los rangos de subredes válidos, consulta Subredes.

Crea un adjunto de red

Un adjunto de red es un recurso que permite que una red de VPC del productor inicie conexiones a una red de VPC del consumidor. Para publicar eventos, Eventarc Advanced usa el adjunto de red para establecer una conexión con el extremo alojado en una red de VPC.

Crea un adjunto de red en la misma red y región que contiene el extremo de destino del evento y que acepte automáticamente las conexiones de cualquier interfaz de Private Service Connect que haga referencia al adjunto de red:

gcloud compute network-attachments create ATTACHMENT_NAME \
   --region=$REGION \
   --connection-preference=ACCEPT_AUTOMATIC \
   --subnets=SUBNET_NAME

Reemplaza ATTACHMENT_NAME por el nombre de tu conexión de red, por ejemplo, my-network-attachment.

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. Solo se puede acceder a este servicio desde redes de VPC dentro del mismo proyecto, y no se puede acceder directamente a la URL del servicio porque solo permite invocaciones autenticadas.

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

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 internal \
       --no-allow-unauthenticated \
       --region=$REGION

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

Cuando veas la URL del servicio de Cloud Run, la implementación estará completa. Anota esta URL para poder usarla en un paso posterior.

Crea un bus de Eventarc Advanced

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

gcloud beta 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.

Nota: Solo puedes crear un bus por proyecto de Google Cloud.

Para obtener más información, consulta Cómo crear un bus para enrutar mensajes.

Crea una inscripción de Eventarc Advanced

Una inscripción determina qué mensajes se enrutan a un destino. También especifica la canalización a través de la cual se deben enrutar los mensajes. La canalización se usa para configurar un destino para los mensajes de eventos.

Para obtener más información, consulta Cómo crear una inscripción para recibir eventos.

Cuando usas gcloud CLI, primero debes crear una canalización y, luego, crear una inscripción.

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

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

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

   Reemplaza lo siguiente:

   • PIPELINE_NAME: El ID de la canalización o un nombre completamente calificado.
   • CLOUD_RUN_SERVICE_URL: 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 tu evento.

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

2. Crea una inscripción con el comando gcloud beta eventarc enrollments create:

   gcloud beta 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: 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 beta 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 un formato de 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. Cualquier JSON con el formato correcto puede ir en este campo. Para obtener más información sobre los atributos de contexto de CloudEvents, consulta Formato de evento.

Los siguientes son 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 y otras marcas de atributos de eventos:

gcloud beta 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 beta 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 “Evento publicado 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 confirmar que el evento se recibió como se esperaba.

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'
   

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

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.

Limpia

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 una subred de VPC.

2. Borra un adjunto de red de VPC.

3. Borra un repositorio de Artifact Registry.

4. Borra un servicio de Cloud Run.

5. Borra los recursos de Eventarc Advanced:

   1. Borrar una inscripción.

   2. Borra una canalización.

   3. Borra un autobús.

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.

Si planeas explorar varias infraestructuras, instructivos y guías de inicio rápido la reutilización de proyectos puede ayudarte a evitar exceder los límites de las cuotas del proyecto.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

¿Qué sigue?

• Publica eventos de fuentes de Google
• Publica eventos directamente
• Cómo transformar los eventos recibidos
• Formato de los eventos recibidos