Crear activadores a partir de eventos de Firestore

En esta guía se explica cómo crear activadores para servicios y funciones de Cloud Run a partir de eventos de Firestore.

Puedes configurar tus servicios de Cloud Run para que se activen mediante eventos de una base de datos de Firestore. Cuando se activan, tu servicio lee y actualiza una base de datos de Firestore en respuesta a estos eventos a través de las APIs y bibliotecas de cliente de Firestore.

En un ciclo de vida típico, cuando un servicio de Cloud Run se activa mediante eventos de Firestore, ocurre lo siguiente:

  1. El servicio espera a que se produzcan cambios en un documento concreto.

  2. Cuando se produce un cambio, se activa el servicio y realiza sus tareas.

  3. El servicio recibe un objeto de datos con una vista general del documento afectado. En el caso de los eventos write o update, el objeto de datos contiene capturas que representan el estado del documento antes y después del evento activador.

Tipos de eventos

Firestore admite eventos create, update, delete y write. El evento write abarca todas las modificaciones que se hagan en un documento.

Tipo de evento Activador
google.cloud.firestore.document.v1.created (predeterminado) Se activa cuando se escribe en un documento por primera vez.
google.cloud.firestore.document.v1.updated Se activa cuando ya existe un documento y se cambia algún valor.
google.cloud.firestore.document.v1.deleted Se activa cuando se elimina un documento con datos.
google.cloud.firestore.document.v1.written Se activa cuando se crea, actualiza o elimina un documento.

Los comodines se escriben en los activadores con llaves. Por ejemplo: projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}

Especificar la ruta del documento

Para activar tu servicio, especifica una ruta de documento que quieras monitorizar. La ruta del documento debe estar en el mismo proyecto que el servicio. Google Cloud

Estos son algunos ejemplos de rutas de documentos válidas:

  • users/marie: activador válido. Monitoriza un solo documento, /users/marie.

  • users/{username}: activador válido. Monitoriza todos los documentos de los usuarios. Los comodines se usan para monitorizar todos los documentos de la colección.

  • users/{username}/addresses: activador no válido. Hace referencia a la subcolección addresses, no a un documento.

  • users/{username}/addresses/home: activador válido. Monitoriza el documento de domicilio de todos los usuarios.

  • users/{username}/addresses/{addressId}: activador válido. Monitoriza todos los documentos de dirección.

  • users/{user=**}: activador válido. Monitoriza todos los documentos de los usuarios y los documentos de las subcolecciones de cada documento de usuario, como /users/userID/address/home o /users/userID/phone/work.

Comodines y parámetros

Si no sabes qué documento quieres monitorizar, usa {wildcard} en lugar del ID de documento:

  • users/{username} escucha los cambios en todos los documentos de los usuarios.

En este ejemplo, cuando se cambia cualquier campo de cualquier documento de users, coincide con un comodín llamado {username}.

Si un documento de users tiene subcolecciones y se cambia un campo de uno de los documentos de esas subcolecciones, el comodín {username} no se activará. Si tu objetivo es responder a eventos en subcolecciones, usa el comodín multisegmento {username=**}.

Las coincidencias con comodines se extraen de las rutas de los documentos. Puedes definir tantos comodines como quieras para sustituir los IDs de colecciones o documentos explícitos. Puedes usar hasta un comodín multisegmento, como {username=**}.

Estructuras de eventos

Este activador invoca tu servicio con un evento similar al siguiente: 

{
    "oldValue": { // Update and Delete operations only
        A Document object containing a pre-operation document snapshot
    },
    "updateMask": { // Update operations only
        A DocumentMask object that lists changed fields.
    },
    "value": {
        // A Document object containing a post-operation document snapshot
    }
}

Cada objeto Document contiene uno o varios objetos Value. Consulta la documentación de Value para ver las referencias de tipos.

Antes de empezar

  1. Asegúrate de haber configurado un proyecto para Cloud Run tal como se describe en la página de configuración.

  2. Habilita las APIs Artifact Registry, Cloud Build, Cloud Run Admin, Eventarc, Firestore Cloud Logging y Pub/Sub:

    Habilitar las APIs

Roles obligatorios

Tú o tu administrador debéis conceder a la cuenta de implementación, a la identidad del activador y, opcionalmente, al agente de servicio de Pub/Sub los siguientes roles de gestión de identidades y accesos.

Roles necesarios para la cuenta de implementación

Para obtener los permisos que necesitas para activar funciones a partir de eventos de Firestore, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

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.

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

Roles necesarios para la identidad del activador

  1. Anota la cuenta de servicio predeterminada de Compute Engine, ya que la asociarás a un activador de Eventarc para representar la identidad del activador con fines de prueba. Esta cuenta de servicio se crea automáticamente después de habilitar o usar un servicio que utilice Compute Engine y tiene el siguiente formato de correo electrónico: Google Cloud 

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

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

    En los entornos de producción, te recomendamos que crees una cuenta de servicio y le asignes uno o varios roles de IAM que contengan los permisos mínimos necesarios y que sigas el principio de privilegio mínimo.

  2. De forma predeterminada, solo los propietarios y editores de proyectos, así como los administradores y los invocadores de Cloud Run, pueden llamar a los servicios de Cloud Run. Puedes controlar el acceso por servicio. Sin embargo, para hacer pruebas, otorga el rol Invocador de Cloud Run (run.invoker) en el proyecto Google Cloud a la cuenta de servicio de Compute Engine. Concede el rol en todos los servicios y trabajos de Cloud Run de un proyecto. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/run.invoker

    Ten en cuenta que, si creas un activador para un servicio de Cloud Run autenticado sin conceder el rol Invocador de Cloud Run, el activador se creará correctamente y estará activo. Sin embargo, el activador no funcionará como se espera y aparecerá un mensaje similar al siguiente en los registros:

    The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
  3. Concede el rol Receptor de eventos de Eventarc (roles/eventarc.eventReceiver) en el proyecto a la cuenta de servicio predeterminada de Compute Engine para que el activador de Eventarc pueda recibir eventos de proveedores de eventos. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/eventarc.eventReceiver

Rol opcional del agente de servicio de Pub/Sub

  • 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:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator

Configurar una base de datos de Firestore

Antes de implementar tu servicio, debes crear una base de datos de Firestore:

  1. Ve a la página Datos de Firestore.

  2. Selecciona Crear base de datos.

  3. Haz clic en Modo nativo y, a continuación, en Continuar.

  4. En el campo Name your database (Asigna un nombre a tu base de datos), introduce un ID de base de datos, como firestore-db.

  5. En Tipo de ubicación, selecciona Región y elige la región en la que se va a alojar tu base de datos. Esta selección es permanente.

  6. Deje la sección Reglas seguras tal como está.

  7. Haz clic en Crear base de datos.

El modelo de datos de Firestore consta de colecciones que contienen documentos. Un documento contiene un conjunto de pares clave-valor.

Cree activadores.

En función del tipo de servicio que estés implementando, puedes hacer lo siguiente:

Crear un activador para servicios

Puedes especificar un activador después de implementar un servicio.

Haga clic en la pestaña para ver las instrucciones sobre cómo usar la herramienta que prefiera.

Consola

  1. Despliega tu servicio de Cloud Run mediante contenedores o desde fuentes.

  2. En la Google Cloud consola, ve a Cloud Run:

    Ir a Cloud Run

  3. En la lista de servicios, haz clic en uno que ya tengas.

  4. En la página Detalles del servicio, ve a la pestaña Activadores.

  5. Haz clic en Añadir activador y selecciona Activador de Firestore.

  6. En el panel Activador de Eventarc, modifica los detalles del activador de la siguiente manera:

    1. En el campo Nombre del activador, escribe un nombre para el activador o usa el nombre predeterminado.

    2. Seleccione un Tipo de activador de la lista para especificar uno de los siguientes tipos de activador:

      • Fuentes de Google para especificar activadores de Pub/Sub, Cloud Storage, Firestore y otros proveedores de eventos de Google.

      • Terceros: para integrarse con proveedores que no sean de Google y que ofrezcan una fuente de Eventarc. Para obtener más información, consulta Eventos de terceros en Eventarc.

    3. Selecciona Firestore en la lista Proveedor de eventos para elegir un producto que proporcione el tipo de evento que activará tu servicio. Para ver la lista de proveedores de eventos, consulte Proveedores y destinos de eventos.

    4. Selecciona type=google.cloud.firestore.document.v1.created en la lista Tipo de evento. La configuración del activador varía en función del tipo de evento admitido. Para obtener más información, consulta Tipos de eventos.

    5. En la sección Filtros, seleccione una base de datos, una operación y valores de atributos, o utilice las selecciones predeterminadas.

    6. Si el campo Región está habilitado, selecciona una ubicación para el activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debe desplegar su servicio en la misma región. Consulta ¿Qué son las ubicaciones de Eventarc? para obtener más información sobre las ubicaciones de los activadores de Eventarc.

    7. En el campo Cuenta de servicio, selecciona una cuenta de servicio. Los activadores de Eventarc están vinculados a cuentas de servicio que se usan como identidad al invocar tu servicio. La cuenta de servicio del activador de Eventarc debe tener permiso para invocar tu servicio. De forma predeterminada, Cloud Run usa la cuenta de servicio predeterminada de Compute Engine.

    8. Si quiere, especifique la ruta de la URL del servicio a la que se enviará la solicitud entrante. Es la ruta relativa del servicio de destino al que se deben enviar los eventos del activador. Por ejemplo: /, /route, route y route/subroute.

    9. Una vez que haya completado los campos obligatorios, haga clic en Guardar activador.

  7. Después de crear el activador, compruebe su estado asegurándose de que haya una marca de verificación en la pestaña Activadores.

gcloud

  1. Despliega tu servicio de Cloud Run mediante contenedores o desde fuentes.

  2. Ejecuta el siguiente comando para crear un activador que filtre eventos:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=EVENTARC_TRIGGER_LOCATION \
    --destination-run-service=SERVICE  \
    --destination-run-region=REGION \
    --event-filters="type=google.cloud.firestore.document.v1.created" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Sustituye:

    • TRIGGER_NAME con el nombre del activador.

    • EVENTARC_TRIGGER_LOCATION con la ubicación del activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debes desplegar tu servicio en la misma región. Para obtener más información, consulta Ubicaciones de Eventarc.

    • SERVICE con el nombre del servicio que vas a implementar.

    • REGION con la región de Cloud Run del servicio. Por ejemplo, europe-west1.

    • PROJECT_NUMBER con el número de tu proyecto Google Cloud . Los activadores de Eventarc están vinculados a cuentas de servicio para usarse como identidad al invocar tu servicio. La cuenta de servicio del activador de Eventarc debe tener permiso para invocar el servicio. De forma predeterminada, Cloud Run usa la cuenta de servicio de Compute predeterminada.

    Cada marca event-filters especifica un tipo de evento. La función solo se activa cuando un evento cumple todos los criterios especificados en sus marcas event-filters. Cada activador debe tener una marca event-filters que especifique un tipo de evento admitido, como un documento nuevo escrito en Firestore o un archivo subido a Cloud Storage. No puedes cambiar el tipo de filtro de eventos después de crearlo. Para cambiar el tipo de filtro de eventos, debe crear un activador y eliminar el antiguo. Opcionalmente, puedes repetir la marca --event-filters con un filtro admitido en el formato ATTRIBUTE=VALUE para añadir más filtros.

Terraform

Para crear un activador de Eventarc para un servicio de Cloud Run, consulta Crear un activador con Terraform.

Crear un activador para funciones

Haga clic en la pestaña para ver las instrucciones sobre cómo usar la herramienta que prefiera.

Consola

Cuando usas la consola Google Cloud para crear una función, también puedes añadir un activador a la función. Sigue estos pasos para crear un activador para tu función:

  1. En la Google Cloud consola, ve a Cloud Run:

    Ir a Cloud Run

  2. Haz clic en Escribir una función e introduce los detalles de la función. Para obtener más información sobre cómo configurar funciones durante la implementación, consulta Implementar funciones.

  3. En la sección Activador, haz clic en Añadir activador.

  4. Seleccione Activador de Firestore.

  5. En el panel Activador de Eventarc, modifica los detalles del activador de la siguiente manera:

    1. En el campo Nombre del activador, escriba un nombre para el activador o use el predeterminado.

    2. Selecciona un Tipo de activador de la lista:

      • Fuentes de Google para especificar activadores de Pub/Sub, Cloud Storage, Firestore y otros proveedores de eventos de Google.

      • Terceros: para integrarse con proveedores que no sean de Google y que ofrezcan una fuente de Eventarc. Para obtener más información, consulta Eventos de terceros en Eventarc.

    3. Selecciona Firestore en la lista Proveedor de eventos para elegir un producto que proporcione el tipo de evento que activará la función. Para ver la lista de proveedores de eventos, consulte Proveedores y destinos de eventos.

    4. Selecciona type=google.cloud.firestore.document.v1.created en la lista Tipo de evento. La configuración del activador varía en función del tipo de evento admitido. Para obtener más información, consulta Tipos de eventos.

    5. En la sección Filtros, seleccione una base de datos, una operación y valores de atributos, o utilice las selecciones predeterminadas.

    6. Si el campo Región está habilitado, selecciona una ubicación para el activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debes desplegar tu función en la misma región. Consulta ¿Qué son las ubicaciones de Eventarc? para obtener más información sobre las ubicaciones de los activadores de Eventarc.

    7. En el campo Cuenta de servicio, selecciona una cuenta de servicio. Los activadores de Eventarc están vinculados a cuentas de servicio para usarlas como identidad al invocar tu función. La cuenta de servicio del activador de Eventarc debe tener permiso para invocar tu función. De forma predeterminada, Cloud Run usa la cuenta de servicio predeterminada de Compute Engine.

    8. Si quiere, especifique la ruta de la URL del servicio a la que se enviará la solicitud entrante. Es la ruta relativa del servicio de destino al que se deben enviar los eventos del activador. Por ejemplo: /, /route, route y route/subroute.

  6. Una vez que haya completado los campos obligatorios, haga clic en Guardar activador.

gcloud

Cuando creas una función con la CLI de gcloud, primero debes desplegar la función y, a continuación, crear un activador. Sigue estos pasos para crear un activador para tu función:

  1. Ejecuta el siguiente comando en el directorio que contiene el código de muestra para desplegar tu función:

    gcloud run deploy FUNCTION \
        --source . \
        --function FUNCTION_ENTRYPOINT \
        --base-image BASE_IMAGE_ID \
        --region REGION

    Sustituye:

    • FUNCTION con el nombre de la función que vas a implementar. Puedes omitir este parámetro por completo, pero se te pedirá el nombre si lo haces.

    • FUNCTION_ENTRYPOINT con el punto de entrada de tu función en el código fuente. Este es el código que ejecuta Cloud Run cuando se ejecuta tu función. El valor de esta marca debe ser un nombre de función o un nombre de clase completo que exista en el código fuente.

    • BASE_IMAGE_ID con el entorno de la imagen base de tu función. Para obtener más información sobre las imágenes base y los paquetes incluidos en cada imagen, consulta Imágenes base de los entornos de ejecución.

    • REGION por la Google Cloud región en la que quieras desplegar tu función. Por ejemplo, europe-west1.

  2. Ejecuta el siguiente comando para crear un activador que filtre eventos:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=EVENTARC_TRIGGER_LOCATION \
    --destination-run-service=FUNCTION  \
    --destination-run-region=REGION \
    --event-filters="type=google.cloud.firestore.document.v1.created" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Sustituye:

    • TRIGGER_NAME con el nombre del activador.

    • EVENTARC_TRIGGER_LOCATION con la ubicación del activador de Eventarc. Por lo general, la ubicación de un activador de Eventarc debe coincidir con la ubicación del Google Cloud recurso que quieras monitorizar para detectar eventos. En la mayoría de los casos, también debes implementar tu función en la misma región. Para obtener más información, consulta Ubicaciones de Eventarc.

    • FUNCTION con el nombre de la función que vas a implementar.

    • REGION con la región de Cloud Run de la función.

    • PROJECT_NUMBER con el número de tu proyecto Google Cloud . Los activadores de Eventarc están vinculados a cuentas de servicio para usarse como identidad al invocar tu función. La cuenta de servicio de tu activador de Eventarc debe tener permiso para invocar tu función. De forma predeterminada, Cloud Run usa la cuenta de servicio de Compute predeterminada.

    Cada marca event-filters especifica un tipo de evento. La función solo se activa cuando un evento cumple todos los criterios especificados en sus marcas event-filters. Cada activador debe tener una marca event-filters que especifique un tipo de evento admitido, como un documento nuevo escrito en Firestore o un archivo subido a Cloud Storage. No puedes cambiar el tipo de filtro de eventos después de crearlo. Para cambiar el tipo de filtro de eventos, debe crear un activador y eliminar el antiguo. Opcionalmente, puedes repetir la marca --event-filters con un filtro admitido en el formato ATTRIBUTE=VALUE para añadir más filtros.

Terraform

Para crear un activador de Eventarc para una función de Cloud Run, consulta Crear un activador con Terraform.

Consulta Extender Firestore con activadores de eventos mediante funciones de Cloud Run para obtener más información.

Siguientes pasos

  • Consulta ejemplos de funciones que se activan cuando haces cambios en un documento de una colección especificada.