En este sencillo instructivo, se muestra cómo escribir, implementar y activar una función de Cloud Run basada en eventos con un activador de Cloud Storage para responder a eventos de Cloud Storage.
Visita el navegador de muestra de Google Cloud si buscas muestras de código para usar Cloud Storage.
Objetivos
- Escribir e implementar una función de Cloud Run basada en eventos.
- Activar la función subiendo un archivo a Cloud Storage
Costos
En este documento, usarás los siguientes componentes facturables de Google Cloud:
- Cloud Run functions
- Cloud Build
- Pub/Sub
- Cloud Storage
- Artifact Registry
- Eventarc
- Cloud Logging
For details, see Cloud Run functions pricing.
Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.
Antes de comenzar
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, Artifact Registry, Eventarc, Logging, and Pub/Sub APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, Artifact Registry, Eventarc, Logging, and Pub/Sub APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Prepara tu entorno de desarrollo:
Si ya tienes instalado gcloud CLI, ejecuta el siguiente comando para actualizarla:
gcloud components update
Requisitos previos
Crea un bucket regional, en el que
YOUR_BUCKET_NAME
es un nombre de bucket único a nivel global yREGION
es la región en la que planeas implementar tu función:gcloud storage buckets create gs://YOUR_BUCKET_NAME --location=REGION
Para usar las funciones de Cloud Storage, otorga el rol
pubsub.publisher
a la cuenta de servicio de Cloud Storage:PROJECT_ID=$(gcloud config get-value project) PROJECT_NUMBER=$(gcloud projects list --filter="project_id:$PROJECT_ID" --format='value(project_number)') 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
Prepara la aplicación
Clona el repositorio de la app de muestra en tu máquina local:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo ZIP y extraerla.
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Ve al directorio que contiene el código de muestra de Cloud Run Functions:
Node.js
cd nodejs-docs-samples/functions/v2/helloGCS/
Python
cd python-docs-samples/functions/v2/storage/
Go
cd golang-samples/functions/functionsv2/hellostorage/
Java
cd java-docs-samples/functions/v2/hello-gcs/
C#
cd dotnet-docs-samples/functions/helloworld/HelloGcs/
Ruby
cd ruby-docs-samples/functions/helloworld/storage/
PHP
cd php-docs-samples/functions/helloworld_storage/
Implementa y activa la función
Las funciones de Cloud Storage se basan en notificaciones de Pub/Sub desde Cloud Storage y admiten tipos de eventos similares:
En las siguientes secciones, se describe cómo implementar y activar una función para cada uno de estos tipos de eventos.
Finalización del objeto
Los eventos de finalización del objeto se activan cuando una operación de “escritura” de un objeto de Cloud Storage se finaliza correctamente. En particular, esto significa que crear un objeto nuevo o reemplazar uno existente activa este evento. Este activador ignora las operaciones de actualización de archivo y metadatos.
Finalización del objeto: implementa la función
Consulta la función de muestra que maneja los eventos de Cloud Storage:
Node.js
Python
Go
Java
C#
Ruby
PHP
Para implementar la función, ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy nodejs-finalize-function \ --gen2 \ --runtime=nodejs20 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy python-finalize-function \ --gen2 \ --runtime=python312 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy go-finalize-function \ --gen2 \ --runtime=go121 \ --region=REGION
\ --source=. \ --entry-point=HelloStorage \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
Java
gcloud functions deploy java-finalize-function \ --gen2 \ --runtime=java17 \ --region=REGION
\ --source=. \ --entry-point=functions.HelloGcs \ --memory=512MB \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
C#
gcloud functions deploy csharp-finalize-function \ --gen2 \ --runtime=dotnet6 \ --region=REGION
\ --source=. \ --entry-point=HelloGcs.Function \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Ruby
gcloud functions deploy ruby-finalize-function \ --gen2 \ --runtime=ruby32 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy php-finalize-function \ --gen2 \ --runtime=php82 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.finalized" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de PHP compatible para ejecutar la función.
Reemplaza lo siguiente:
- REGION: el nombre de la
región de Google Cloud en la que deseas implementar tu función
(por ejemplo,
us-west1
). - YOUR_BUCKET_NAME: el nombre del bucket de Cloud Storage que
activa la función. Cuando implementes Cloud Run Functions, especifica el nombre del bucket solo sin el
gs://
inicial; por ejemplo:--trigger-event-filters="bucket=my-bucket"
.
Finalización del objeto: activa la función
Sube un archivo a tu bucket para probar la función:
echo "Hello World" > test-finalize.txt gcloud storage cp test-finalize.txt gs://YOUR_BUCKET_NAME/test-finalize.txt
Debería ver el CloudEvent recibido en los registros:
gcloud functions logs read YOUR_FUNCTION_NAME --region REGION --gen2 --limit=10
Eliminación del objeto
Los eventos de eliminación del objeto son más útiles para los depósitos sin control de versiones. Se activan cuando se borra una versión antigua de un objeto. Además, también lo hacen cuando se reemplaza un objeto. Los activadores de eliminación del objeto también se pueden usar con los depósitos con control de versiones, que se activan cuando una versión de un objeto se borra permanentemente.
Eliminación del objeto: implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de eliminación del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy nodejs-delete-function \ --gen2 \ --runtime=nodejs20 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy python-delete-function \ --gen2 \ --runtime=python312 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy go-delete-function \ --gen2 \ --runtime=go121 \ --region=REGION
\ --source=. \ --entry-point=HelloStorage \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
Java
gcloud functions deploy java-delete-function \ --gen2 \ --runtime=java17 \ --region=REGION
\ --source=. \ --entry-point=functions.HelloGcs \ --memory=512MB \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
C#
gcloud functions deploy csharp-delete-function \ --gen2 \ --runtime=dotnet6 \ --region=REGION
\ --source=. \ --entry-point=HelloGcs.Function \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Ruby
gcloud functions deploy ruby-delete-function \ --gen2 \ --runtime=ruby32 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy php-delete-function \ --gen2 \ --runtime=php82 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.deleted" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de PHP compatible para ejecutar la función.
Reemplaza lo siguiente:
- REGION: el nombre de la
región de Google Cloud en la que deseas implementar tu función
(por ejemplo,
us-west1
). - YOUR_BUCKET_NAME: el nombre del bucket de Cloud Storage que
activa la función. Cuando implementes Cloud Run Functions, especifica el nombre del bucket solo sin el
gs://
inicial; por ejemplo:--trigger-event-filters="bucket=my-bucket"
.
Eliminación del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
test-delete.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket no tenga control de versiones:
gcloud storage buckets update gs://YOUR_BUCKET_NAME --no-versioning
Sube el archivo a Cloud Storage:
gcloud storage cp test-delete.txt gs://YOUR_BUCKET_NAME
en el que
YOUR_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Borra el archivo para activar la función:
gcloud storage rm gs://YOUR_BUCKET_NAME/test-delete.txt
Debería ver el CloudEvent recibido en los registros:
gcloud functions logs read YOUR_FUNCTION_NAME --region REGION --gen2 --limit=10
Ten en cuenta que la función puede tardar algún tiempo en terminar de ejecutarse.
Archivado del objeto
Los eventos de archivado del objeto se pueden usar solo con depósitos con control de versiones. Se activan cuando se archiva una versión anterior de un objeto. En particular, esto significa que se activa un evento de archivado cuando un objeto se reemplaza o borra.
Archivado del objeto: implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de archivado del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy nodejs-archive-function \ --gen2 \ --runtime=nodejs20 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy python-archive-function \ --gen2 \ --runtime=python312 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy go-archive-function \ --gen2 \ --runtime=go121 \ --region=REGION
\ --source=. \ --entry-point=HelloStorage \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
Java
gcloud functions deploy java-archive-function \ --gen2 \ --runtime=java17 \ --region=REGION
\ --source=. \ --entry-point=functions.HelloGcs \ --memory=512MB \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
C#
gcloud functions deploy csharp-archive-function \ --gen2 \ --runtime=dotnet6 \ --region=REGION
\ --source=. \ --entry-point=HelloGcs.Function \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Ruby
gcloud functions deploy ruby-archive-function \ --gen2 \ --runtime=ruby32 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy php-archive-function \ --gen2 \ --runtime=php82 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.archived" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de PHP compatible para ejecutar la función.
Reemplaza lo siguiente:
- REGION: el nombre de la
región de Google Cloud en la que deseas implementar tu función
(por ejemplo,
us-west1
). - YOUR_BUCKET_NAME: el nombre del bucket de Cloud Storage que
activa la función. Cuando implementes Cloud Run Functions, especifica el nombre del bucket solo sin el
gs://
inicial; por ejemplo:--trigger-event-filters="bucket=my-bucket"
.
Archivado del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
test-archive.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket tenga el control de versiones habilitado:
gcloud storage buckets update gs://YOUR_BUCKET_NAME --versioning
Sube el archivo a Cloud Storage:
gcloud storage cp test-archive.txt gs://YOUR_BUCKET_NAME
en el que
YOUR_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Archiva el archivo para activar la función:
gcloud storage rm gs://YOUR_BUCKET_NAME/test-archive.txt
Debería ver el CloudEvent recibido en los registros:
gcloud functions logs read YOUR_FUNCTION_NAME --region REGION --gen2 --limit=10
Actualización de metadatos del objeto
Los eventos de actualización de metadatos del objeto se activan cuando se actualizan los metadatos del objeto existente.
Actualización de metadatos del objeto: implementa la función
Con el mismo código de muestra que en el ejemplo de finalización, implementa la función con el evento de actualización de metadatos del objeto como su activador. Ejecuta el siguiente comando en el directorio donde se encuentra el código de muestra:
Node.js
gcloud functions deploy nodejs-metadata-function \ --gen2 \ --runtime=nodejs20 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión compatible de Node.js para ejecutar la función.
Python
gcloud functions deploy python-metadata-function \ --gen2 \ --runtime=python312 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Python compatible para ejecutar la función.
Go
gcloud functions deploy go-metadata-function \ --gen2 \ --runtime=go121 \ --region=REGION
\ --source=. \ --entry-point=HelloStorage \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Go compatible para ejecutar tu función.
Java
gcloud functions deploy java-metadata-function \ --gen2 \ --runtime=java17 \ --region=REGION
\ --source=. \ --entry-point=functions.HelloGcs \ --memory=512MB \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de Java compatible para ejecutar tu función.
C#
gcloud functions deploy csharp-metadata-function \ --gen2 \ --runtime=dotnet6 \ --region=REGION
\ --source=. \ --entry-point=HelloGcs.Function \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión .NET compatible para ejecutar tu función.
Ruby
gcloud functions deploy ruby-metadata-function \ --gen2 \ --runtime=ruby32 \ --region=REGION
\ --source=. \ --entry-point=hello_gcs \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID de entorno de ejecución de una versión de Ruby compatible para ejecutar tu función.
PHP
gcloud functions deploy php-metadata-function \ --gen2 \ --runtime=php82 \ --region=REGION
\ --source=. \ --entry-point=helloGCS \
--trigger-event-filters="type=google.cloud.storage.object.v1.metadataUpdated" \
--trigger-event-filters="bucket=YOUR_BUCKET_NAME"
Usa la marca --runtime
para especificar el ID del entorno de ejecución de una versión de PHP compatible para ejecutar la función.
Reemplaza lo siguiente:
- REGION: el nombre de la
región de Google Cloud en la que deseas implementar tu función
(por ejemplo,
us-west1
). - YOUR_BUCKET_NAME: el nombre del bucket de Cloud Storage que
activa la función. Cuando implementes Cloud Run Functions, especifica el nombre del bucket solo sin el
gs://
inicial; por ejemplo:--trigger-event-filters="bucket=my-bucket"
.
Actualización de metadatos del objeto: activa la función
Sigue estos pasos para activar la función:
Crea un archivo
test-metadata.txt
vacío en el directorio donde se encuentra el código de muestra.Asegúrate de que tu bucket no tenga control de versiones:
gcloud storage buckets update gs://YOUR_BUCKET_NAME --no-versioning
Sube el archivo a Cloud Storage:
gcloud storage cp test-metadata.txt gs://YOUR_BUCKET_NAME
en el que
YOUR_BUCKET_NAME
es el nombre del depósito de Cloud Storage al que subirás un archivo de prueba. En este punto, la función aún no debería ejecutarse.Actualiza los metadatos del archivo:
gcloud storage objects update gs://YOUR_BUCKET_NAME/test-metadata.txt --content-type=text/plain
Debería ver el CloudEvent recibido en los registros:
gcloud functions logs read YOUR_FUNCTION_NAME --region REGION --gen2 --limit=10
Realiza una limpieza
Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.
Borra el proyecto
La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.
Para borrar el proyecto, sigue estos pasos:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Borra la función
Borrar las funciones de Cloud Run no quita ningún recurso almacenado en Cloud Storage.
Para borrar las funciones de Cloud Run Functions que creaste en este instructivo, ejecuta los siguientes comandos:
gcloud functions delete YOUR_FUNCTION_NAME --gen2 --region REGION
También puedes borrar funciones de Cloud Run en la consola de Google Cloud.