Enruta eventos de Firebase Realtime Database a Cloud Run

Vista previa — Firebase Realtime Database direct events

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.

Un activador de Eventarc declara tu interés en un evento o conjunto de eventos determinado. Si deseas configurar el enrutamiento del evento, especifica filtros para el activador, incluidos el origen del evento y el servicio Cloud Run de destino.

Eventarc entrega eventos al receptor de eventos en formato de CloudEvents a través de una solicitud HTTP.

En estas instrucciones, se muestra cómo configurar el enrutamiento de eventos en el servicio de Cloud Run que activa un evento directo Firebase Realtime Database . Para obtener más detalles, consulta la lista de eventos directos compatibles.

Nota: Si un proveedor de Google admite eventos directos y de registro de auditoría, te recomendamos que crees un activador que filtre el evento directo. Los eventos directos ofrecen una serie de ventajas sobre los eventos de registro de auditoría. Para obtener más información, consulta Rutas de eventos.

Prepárate para crear un activador

Antes de crear un activador, completa estos requisitos previos:

Console

1. En la página del selector de proyectos de la consola de Google Cloud, elige o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos creados durante este procedimiento, crea un proyecto en lugar de elegir un proyecto existente. Cuando termines, puedes borrar el proyecto si quitas todos los recursos asociados con él.

   Ir al selector de proyectos

2. Habilita las APIs de Cloud Logging, Eventarc y Eventarc Publishing.

   Habilita las API

3. Si corresponde, habilita la API relacionada con los eventos directos. Por ejemplo, para eventos Firebase Realtime Database , habilita la APIFirebase Realtime Database .

4. Si aún no tienes una, crea una cuenta de servicio administrada por el usuario y, luego, otórgale los roles y los permisos necesarios para que Eventarc pueda administrar los eventos para el servicio de destino.

   1. En la consola de Google Cloud, ve a la página Crear cuenta de servicio.

      Ve a Crear cuenta de servicio

   2. Elige tu proyecto.

   3. Escribe un nombre en el campo Nombre de cuenta de servicio. La consola de Google Cloud completa el campo ID de la cuenta de servicio en función de este nombre.

      Opcional: en el campo Descripción de la cuenta de servicio, escribe una descripción. Por ejemplo, Service account for event trigger.

   4. Haz clic en Crear y continuar.

   5. Para proporcionar el acceso adecuado, en la lista Elegir un rol, elige los roles necesarios de Identity and Access Management (IAM) que otorgarás a tu cuenta de servicio para las invocaciones autenticadas o no autenticadas. Si deseas obtener más información, consulta Roles y permisos para destinos de Cloud Run.

      Para obtener roles adicionales, haz clic en Agregar otro rol y agrega cada rol adicional.

      Importante: Para aceptar invocaciones autenticadas en el servicio de Cloud Run, debes asociar el activador a una cuenta de servicio que tenga el rol roles/run.invoker. Cuando crees o actualices el activador, elige esa cuenta de servicio.

   6. Haz clic en Continuar.

   7. Para terminar de crear la cuenta, haz clic en Listo.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   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.

2. Habilita las APIs de Cloud Logging, Eventarc y Eventarc Publishing.

   gcloud services enable logging.googleapis.com \
     eventarc.googleapis.com \
     eventarcpublishing.googleapis.com

3. Si corresponde, habilita la API relacionada con los eventos directos. Por ejemplo, para los eventos Firebase Realtime Database , habilita firebasedatabase.googleapis.com.

4. Si aún no tienes una, crea una cuenta de servicio administrada por el usuario y, luego, otórgale los roles y los permisos necesarios para que Eventarc pueda administrar los eventos para el servicio de destino.

   1. Cree la cuenta de servicio:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Reemplaza SERVICE_ACCOUNT_NAME por el nombre de la cuenta de servicio. Debe tener entre 6 y 30 caracteres y puede contener guiones y caracteres alfanuméricos en minúscula. Después de crear una cuenta de servicio, no podrás cambiar su nombre.

   2. Otorga los roles o permisos necesarios de Identity and Access Management (IAM) para las invocaciones autenticadas o no autenticadas. Si deseas obtener más información, consulta Roles y permisos para destinos de Cloud Run.

   Importante: Para aceptar invocaciones autenticadas en el servicio de Cloud Run, debes asociar el activador a una cuenta de servicio que tenga el rol roles/run.invoker. Cuando crees o edites el activador, usa la marca --service-account para asociar esa cuenta de servicio con el activador.

Crear un activador

Puedes crear un activador de Eventarc con Google Cloud CLI o a través de la consola de Google Cloud.

Nota: El filtrado se hace a través de una concordancia exacta y no admite comodines ni expresiones regulares. Sin embargo, puedes usar la marca --event-filters-path-pattern en el siguiente comando de gcloud CLI o definir un patrón de ruta de acceso a través de la consola. Para obtener más información, consulta Información sobre los patrones de ruta de acceso.

Console

1. En la consola de Google Cloud, ve a la página Activadores de Eventarc.

   Ir a Activadores

2. Haz clic en Crear activador.
3. Escribe un nombre de activador.

   Este es el ID del activador y debe empezar con una letra. Puede contener hasta 63 letras en minúscula, números o guiones.

4. Para el Tipo de activador, elige Fuentes de Google.
5. En la lista Proveedor del evento, elige Firebase Realtime Database.

   Ten en cuenta que el nombre del proveedor de eventos que se usa en la documentación de Google Cloud asociada podría no tener el prefijo Cloud o Google Cloud. Por ejemplo, en la consola, Memorystore for Redis se denomina Google Cloud Memorystore para Redis.

6. En la lista Tipo de evento, en los eventos Directos, selecciona un tipo de evento.
7. En la lista Tipo de contenido de datos de eventos, elige la codificación de la carga útil del evento.

   Para los eventos directos de Firebase Realtime Database, debe ser application/json.

8. En la lista Región, elige la misma región que el servicio de Google Cloud que genera los eventos.

   Para obtener más información, consulta Ubicaciones de Eventarc.

9. En el campo Atributo 1, el ID de recurso de la instancia actúa como un filtro de evento. Elige un operador para este filtro:
   • Igual
   • Patrón de ruta de acceso

     Para obtener más información, consulta Información sobre los patrones de ruta de acceso.

10. En el campo Valor del atributo 1, escribe el nombre de la instancia de la base de datos desde la que deseas recibir los eventos. Según el operador que elegiste en el paso anterior, el valor del atributo debe ser el nombre exacto o un formato de patrón de ruta de acceso.
11. Para el atributo ref, elige el operador Patrón de ruta de acceso.
12. En el campo Valor del atributo 2, escribe la ruta de acceso de la instancia de la base de datos para recibir los eventos si se crean, actualizan o borran datos en esa ruta o en cualquier ruta secundaria.
13. Elige la cuenta de servicio que invocará el servicio o el flujo de trabajo.

    O bien, puedes crear una cuenta de servicio nueva.

    Esto especifica el correo electrónico de la cuenta de servicio de Identity and Access Management (IAM) asociado con el activador y al que otorgaste antes roles específicos que requiere Eventarc.

14. En la lista Destino del evento, elige Cloud Run.
15. Elige un servicio.
    

    Este es el nombre del servicio que recibe los eventos del activador. El servicio debe estar en el mismo proyecto que el activador y recibirá eventos como solicitudes POST HTTP enviadas a su ruta de URL raíz (/) cada vez que se genere el evento.

16. De manera opcional, puedes especificar la ruta de URL de servicio a la que enviar la solicitud entrante.

    Esta es la ruta de acceso relativa en el servicio de destino al que se deben enviar los eventos del activador. Por ejemplo: /, /route, route, route/subroute.

17. Haz clic en Crear.

Después de que se crea un activador, los filtros de fuente del evento no se pueden cambiar. En su lugar, crea un activador nuevo y borra el anterior. Para obtener más información, consulta Administra activadores.

gcloud

Para crear un activador, ejecuta un comando gcloud eventarc triggers create junto con las marcas obligatorias y opcionales.

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Reemplaza lo siguiente:

• TRIGGER: el ID del activador o un identificador completamente calificado.

• LOCATION: la ubicación del activador de Eventarc. De forma alternativa, puedes establecer la propiedadeventarc/location; por ejemplo, gcloud config set eventarc/location us-central1.

  Los activadores de Firebase Realtime Database para Eventarc solo están disponibles en ciertas ubicaciones y el activador debe estar en la misma ubicación que la instancia de Firebase Realtime Database. Para obtener más información, consulta Ubicaciones de Eventarc y Ubicaciones de Realtime Database.

• DESTINATION_RUN_SERVICE: el nombre del servicio de Cloud Run que recibe los eventos para el activador. El servicio puede estar en cualquiera de las ubicaciones admitidas de Cloud Run y no es necesario que esté en la misma ubicación que el activador. Sin embargo, el servicio debe estar en el mismo proyecto que el activador y recibirá eventos como solicitudes POST HTTP enviadas a su ruta de URL raíz (/) cada vez que se genere el evento.
• DESTINATION_RUN_REGION: (opcional) la región en la que se puede encontrar el servicio de Cloud Run de destino. Si no se especifica, se supone que el servicio se encuentra en la misma región que el activador.

• EVENT_FILTER_TYPE: es el identificador del evento de Firebase Realtime Database y puede ser uno de los siguientes:

  • google.firebase.database.ref.v1.created: Se envía un evento cuando se crean datos en la base de datos.
  • google.firebase.database.ref.v1.updated: Se envía un evento cuando se actualizan los datos en la base de datos.
  • google.firebase.database.ref.v1.deleted: Se envía un evento cuando se borran datos en la base de datos.
  • google.firebase.database.ref.v1.written: Se envía un evento cuando se crean, actualizan o borran datos en la base de datos.

• INSTANCE: Una instancia de base de datos única y el operador pueden ser uno de los siguientes:

  • Iguales; por ejemplo, --event-filters="instance=INSTANCE"
  • Patrón de ruta de acceso; por ejemplo, --event-filters-path-pattern="instance=INSTANCE" Para obtener más información, consulta Información sobre los patrones de ruta de acceso.

• REF: Es la ruta de acceso dentro de la instancia de base de datos para la que deseas recibir eventos desde la creación, actualización o eliminación de datos en esa ruta o en cualquiera de sus elementos secundarios.

• SERVICE_ACCOUNT_NAME: el nombre de la cuenta de servicio administrada por el usuario.
• PROJECT_ID: Es el ID de tu proyecto de Google Cloud.

Notas:

• Para los eventos directos de Firebase Realtime Database, la codificación de la carga útil del evento es application/json.
• Estas marcas son obligatorias:
  • --event-filters="type=EVENT_FILTER_TYPE"
  • --event-filters="instance=INSTANCE" o --event-filters-path-pattern="instance=INSTANCE"
  • --event-filters-path-pattern="ref=REF"
• Después de crear un activador, no se puede cambiar el tipo de filtro de eventos. Para un tipo de evento diferente, debes crear un activador nuevo.
• La marca --service-account se usa para especificar el correo electrónico de la cuenta de servicio de Identity and Access Management (IAM) asociado con el activador.
• De manera opcional, especifica una ruta de acceso relativa en el servicio de Cloud Run de destino al que se deben enviar los eventos del activador con la marca --destination-run-path.

Ejemplo:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-run-service=helloworld-events \
    --destination-run-region=us-central1 \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com

Con este comando, se crea un activador llamado helloworld-trigger para el evento identificado como google.firebase.database.ref.v1.created y la ruta users/* dentro de la instancia de la base de datos identificada como test-instance.

Terraform

Puedes crear un activador para un destino de Cloud Run con Terraform. Para obtener más información, consulta Crea un activador con Terraform.

Nota: Aunque tu activador se crea de inmediato, puede tardar hasta dos minutos en propagarse y filtrar los eventos.

Enumera un activador

Para confirmar la creación de un activador, enumera los activadores de Eventarc con Google Cloud CLI o a través de la consola de Google Cloud.

Console

1. En la consola de Google Cloud, ve a la página Activadores de Eventarc.

   Ir a Activadores

   En esta página, se enumeran tus activadores en todas las ubicaciones y se incluyen detalles, como nombres, regiones, proveedores de eventos, destinos y mucho más.

2. Para filtrar tus activadores, haz lo siguiente:

   1. Haz clic en Filtrar o en el campo Filtrar activadores.
   2. En la lista Propiedades, elige una opción para filtrar los activadores.

   Puedes elegir una sola propiedad o usar el operador lógico OR para agregar más propiedades.

3. Para ordenar los activadores, junto con el encabezado de la columna compatible, haz clic en Ordenar.

gcloud

Ejecuta el siguiente comando para enumerar los activadores:

gcloud eventarc triggers list --location=-

Este comando enumera tus activadores en todas las ubicaciones y, además, incluye detalles como nombres, tipos, destinos y estados.

¿Qué sigue?

• Obtén más información sobre Eventarc.
• Aprende a administrar activadores.