Activar funciones de Cloud Storage con Eventarc

---

En este tutorial se muestra cómo desplegar una función basada en eventos en Cloud Run y cómo usar Eventarc para activar la función en respuesta a eventos de Cloud Storage mediante la CLI de Google Cloud.

Si especificas filtros para un activador de Eventarc, puedes configurar el enrutamiento de eventos, incluida la fuente y el destino de los eventos. En el ejemplo de este tutorial, una actualización de un segmento de Cloud Storage activa el evento y se envía una solicitud a tu función en forma de solicitud HTTP.

Objetivos

En este tutorial, aprenderás a hacer lo siguiente:

1. Crea un segmento de Cloud Storage que sea la fuente de eventos.
2. Despliega una función basada en eventos.
3. Crea un activador de Eventarc.
4. Activa la función subiendo un archivo a Cloud Storage.

Costes

En este documento, se utilizan los siguientes componentes facturables de Google Cloud:

• Artifact Registry
• Cloud Build
• Cloud Run
• Cloud Storage
• Eventarc

Para generar una estimación de costes basada en el uso previsto, utiliza la calculadora de precios.

Los usuarios nuevos Google Cloud pueden disfrutar de una prueba gratuita.

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.

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.

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.

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.

1. Si no usas Cloud Shell, actualiza los componentes de la CLI de Google Cloud e inicia sesión con tu cuenta:

   gcloud components update
   gcloud auth login

2. Habilita las APIs:

   gcloud services enable artifactregistry.googleapis.com \
       cloudbuild.googleapis.com \
       eventarc.googleapis.com \
       run.googleapis.com \
       storage.googleapis.com

3. Define las variables de configuración que se van a usar en este tutorial:

   export REGION=us-central1
   gcloud config set run/region ${REGION}
   gcloud config set run/platform managed
   gcloud config set eventarc/location ${REGION}

4. Si tu proyecto está sujeto a una política de organización de restricción de dominio que restringe las invocaciones no autenticadas, tendrás que acceder al servicio desplegado tal como se describe en la sección Probar servicios privados.

Definir roles obligatorios

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

Roles necesarios para la cuenta de implementación

1. 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, un principal puede ser una cuenta de Google (para usuarios finales) o una cuenta de servicio (para aplicaciones y cargas de trabajo de computación). Para obtener más información, consulta la página Roles y permisos de tu destino de evento.

   Para obtener los permisos que necesitas para completar este tutorial, 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 fuentes de Cloud Run (roles/run.sourceDeveloper)
   • Administrador de Eventarc (roles/eventarc.admin)
   • 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)
   • Administrador de almacenamiento (roles/storage.admin)

   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

   [e-mail]

   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.

   Nota:

   La restricción de la política de organización iam.automaticIamGrantsForDefaultServiceAccounts impide que se conceda automáticamente el rol Editor a las cuentas de servicio predeterminadas. Si has creado tu organización después del 3 de mayo del 2024, esta restricción se aplica de forma predeterminada.

   Te recomendamos que apliques esta restricción para inhabilitar la concesión automática de roles. Si inhabilitas la concesión automática de roles, debes decidir qué roles quieres conceder a las cuentas de servicio predeterminadas y, a continuación, concederlos tú mismo.

   Si la cuenta de servicio predeterminada ya tiene el rol Editor, te recomendamos que lo sustituyas por roles con menos permisos.Para modificar los roles de la cuenta de servicio de forma segura, usa Simulador de políticas para ver el impacto del cambio y, a continuación, asigna y revoca los roles adecuados.

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:[e-mail] \
       --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:[e-mail] \
       --role=roles/eventarc.eventReceiver

Rol opcional del agente de servicio de Cloud Storage

• Antes de crear un activador para eventos directos de Cloud Storage, concede el rol Publicador de Pub/Sub (roles/pubsub.publisher) al agente de servicio de Cloud Storage:

  SERVICE_ACCOUNT="$(gcloud storage service-agent --project=PROJECT_ID)"
  
  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member="serviceAccount:${SERVICE_ACCOUNT}" \
      --role='roles/pubsub.publisher'

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:[e-mail] \
      --role=roles/iam.serviceAccountTokenCreator

Crea un segmento de Cloud Storage

Crea un segmento de Cloud Storage que se usará como fuente de eventos:

gcloud storage buckets create -l us-central1 gs://PROJECT_ID-bucket/

Nota: El segmento de Cloud Storage debe estar en el mismoGoogle Cloud proyecto y en la misma región o multirregión que el activador de Eventarc.

Escribir una función basada en eventos

Para escribir una función basada en eventos, sigue estos pasos:

Node.js

1. Crea un directorio llamado helloGCS y cambia a ese directorio:

      mkdir helloGCS
      cd helloGCS
   

2. Crea un archivo package.json en el directorio helloGCS para especificar las dependencias de Node.js:

   {
     "name": "nodejs-docs-samples-functions-v2-storage",
     "version": "0.0.1",
     "private": true,
     "license": "Apache-2.0",
     "author": "Google LLC",
     "repository": {
       "type": "git",
       "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
     },
     "engines": {
       "node": ">=16.0.0"
     },
     "scripts": {
       "test": "c8 mocha -p -j 2 test/*.test.js --timeout=60000"
     },
     "dependencies": {
       "@google-cloud/functions-framework": "^3.0.0"
     },
     "devDependencies": {
       "c8": "^10.0.0",
       "mocha": "^10.0.0",
       "sinon": "^18.0.0",
       "supertest": "^7.0.0"
     }
   }
   

3. Crea un archivo index.js en el directorio helloGCS con el siguiente ejemplo de Node.js:

   const functions = require('@google-cloud/functions-framework');
   
   // Register a CloudEvent callback with the Functions Framework that will
   // be triggered by Cloud Storage.
   functions.cloudEvent('helloGCS', cloudEvent => {
     console.log(`Event ID: ${cloudEvent.id}`);
     console.log(`Event Type: ${cloudEvent.type}`);
   
     const file = cloudEvent.data;
     console.log(`Bucket: ${file.bucket}`);
     console.log(`File: ${file.name}`);
     console.log(`Metageneration: ${file.metageneration}`);
     console.log(`Created: ${file.timeCreated}`);
     console.log(`Updated: ${file.updated}`);
   });

Python

1. Crea un directorio llamado helloGCS y cambia a ese directorio:

      mkdir helloGCS
      cd helloGCS
   

2. Crea un archivo requirements.txt en el directorio helloGCS para especificar las dependencias de Python:

   functions-framework==3.8.2
   cloudevents==1.11.0

   De esta forma, se añaden los paquetes que necesita el ejemplo.

3. Crea un archivo main.py en el directorio helloGCS con el siguiente ejemplo de Python:

   from cloudevents.http import CloudEvent
   
   import functions_framework
   
   
   # Triggered by a change in a storage bucket
   @functions_framework.cloud_event
   def hello_gcs(cloud_event: CloudEvent) -> tuple:
       """This function is triggered by a change in a storage bucket.
   
       Args:
           cloud_event: The CloudEvent that triggered this function.
       Returns:
           The event ID, event type, bucket, name, metageneration, and timeCreated.
       """
       data = cloud_event.data
   
       event_id = cloud_event["id"]
       event_type = cloud_event["type"]
   
       bucket = data["bucket"]
       name = data["name"]
       metageneration = data["metageneration"]
       timeCreated = data["timeCreated"]
       updated = data["updated"]
   
       print(f"Event ID: {event_id}")
       print(f"Event type: {event_type}")
       print(f"Bucket: {bucket}")
       print(f"File: {name}")
       print(f"Metageneration: {metageneration}")
       print(f"Created: {timeCreated}")
       print(f"Updated: {updated}")
   
       return event_id, event_type, bucket, name, metageneration, timeCreated, updated
   
   

Desplegar una función basada en eventos

Despliega la función llamada helloworld-events ejecutando el siguiente comando en el directorio que contiene el código de ejemplo:

Node.js

gcloud run deploy helloworld-events \
      --source . \
      --function helloGCS \
      --base-image BASE_IMAGE \
      --region us-central1

Sustituye BASE_IMAGE por el entorno de imagen base de tu función (por ejemplo, nodejs22). Para obtener más información sobre las imágenes base y los paquetes incluidos en cada imagen, consulta Runtimes e imágenes base de los idiomas admitidos.

Python

gcloud run deploy helloworld-events \
      --source . \
      --function hello_gcs \
      --base-image BASE_IMAGE \
      --region us-central1

Sustituye BASE_IMAGE por el entorno de imagen base de tu función (por ejemplo, python313). Para obtener más información sobre las imágenes base y los paquetes incluidos en cada imagen, consulta Runtimes e imágenes base de los idiomas admitidos.

Cuando se complete la implementación, la CLI de Google Cloud mostrará una URL en la que se esté ejecutando tu servicio.

Crear un activador de Eventarc

El activador de Eventarc envía eventos del segmento de Cloud Storage a tu servicio de Cloud Run helloworld-events.

1. Crea un activador que filtre eventos de Cloud Storage:

   gcloud eventarc triggers create TRIGGER_NAME  \
       --location=${REGION} \
       --destination-run-service=helloworld-events  \
       --destination-run-region=${REGION} \
       --event-filters="type=google.cloud.storage.object.v1.finalized" \
       --event-filters="bucket=PROJECT_ID-bucket" \
       --service-account=[e-mail]

   Sustituye:

   • TRIGGER_NAME con el nombre del activador.
   • PROJECT_ID por el ID de tu proyecto. Google Cloud
   • PROJECT_NUMBER con el número de tu proyecto Google Cloud .

   Ten en cuenta que, cuando crees un activador de Eventarc por primera vez en un proyecto de Google Cloud , puede haber un retraso en el aprovisionamiento del agente de servicio de Eventarc. Este problema suele resolverse intentando crear el activador de nuevo. Para obtener más información, consulta Errores de permiso denegado.

2. Confirma que el activador se ha creado correctamente. Ten en cuenta que, aunque el activador se crea inmediatamente, puede tardar hasta dos minutos en estar totalmente operativo.

   gcloud eventarc triggers list --location=${REGION}

   La salida debería ser similar a la siguiente:

   NAME: helloworld-events
   TYPE: google.cloud.storage.object.v1.finalized
   DESTINATION: Cloud Run service: helloworld-events
   ACTIVE: Yes
   LOCATION: us-central1
   

Generar y ver un evento

Sube un archivo de texto al segmento de Cloud Storage para generar un evento que se enrute a la función. La función de Cloud Run registra el evento en los registros del servicio.

1. Sube un archivo de texto a Cloud Storage para generar un evento:

    echo "Hello World" > random.txt
    gcloud storage cp random.txt gs://PROJECT_ID-bucket/random.txt
   

   La subida genera un evento y la función de Cloud Run registra el mensaje del evento.

2. Para ver la entrada de registro, sigue estos pasos:

   1. Filtra las entradas de registro y devuelve el resultado en formato JSON:

      gcloud logging read "resource.labels.service_name=helloworld-events AND textPayload:random.txt" --format=json
      

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

      [
        {
         ....
          "resource": {
            "labels": {
              ....
              "location": "us-central1",
              .....
              "service_name": "helloworld-events"
            },
          },
          "textPayload": "File: random.txt",
           .....
        }
      ]
      

      Nota: Si no ves ninguna entrada de registro, espera unos minutos y vuelve a intentar ejecutar el comando gcloud logging read. El activador puede tardar hasta dos minutos en empezar a filtrar eventos después de crearse.

      Los registros pueden tardar unos instantes en aparecer. Si no los ves inmediatamente, vuelve a comprobarlo al cabo de un minuto.

Cuando veas la entrada del registro, se confirmará que has desplegado correctamente una función basada en eventos que se ha activado cuando se ha subido un archivo de texto a Cloud Storage.

Correcto: has desplegado una función basada en eventos en Cloud Run y has usado Eventarc para activar la función en respuesta a eventos de Cloud Storage.

Limpieza

Si has creado un proyecto para este tutorial, elimínalo. Si has usado un proyecto y quieres conservarlo sin los cambios añadidos en este tutorial, elimina los recursos creados para el tutorial.

Eliminar el proyecto

La forma más fácil de evitar que te cobren es eliminar el proyecto que has creado para el tutorial.

Para ello, sigue las instrucciones que aparecen a continuación:

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.

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Eliminar recursos del tutorial

1. Elimina el servicio de Cloud Run que has desplegado en este tutorial:

   gcloud run services delete SERVICE_NAME

   Donde SERVICE_NAME es el nombre del servicio que has elegido.

   También puedes eliminar servicios de Cloud Run desde la Google Cloud consola.

2. Elimina las configuraciones predeterminadas de la CLI de gcloud que hayas añadido durante la configuración del tutorial.

   Por ejemplo:

   gcloud config unset run/region

   o

   gcloud config unset project

3. Elimina otros recursos de Google Cloud que hayas creado en este tutorial:

   • Elimina el activador de Eventarc:

     gcloud eventarc triggers delete TRIGGER_NAME
     

     Sustituye TRIGGER_NAME por el nombre de tu activador.

Siguientes pasos

• Crear activadores de Eventarc para otros tipos de eventos
• Gestionar funciones