Instructivo de Pub/Sub de Terraform

En este instructivo, te explicamos cómo se implementa una función de Pub/Sub subiendo un archivo ZIP del código fuente de una función a un bucket de Cloud Storage a través de Terraform para aprovisionar los recursos. Terraform es una herramienta de código abierto que permite aprovisionar recursos de Google Cloud con archivos de configuración declarativos.

En este instructivo se usa una función de Node.js como ejemplo, pero el contenido también se aplica a las funciones de Python, Go y Java. Las instrucciones son las mismas sin importar el entorno de ejecución que uses. Consulta las páginas de referencia de Hashicorp para obtener detalles sobre el uso de Terraform con la API de Cloud Functions v2.

Objetivos

• Aprender a usar Terraform para implementar una función de Pub/Sub

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

• Cloud Run functions
• Cloud Build
• Cloud Storage
• Artifact Registry

For details, see Cloud Run functions pricing.

Para obtener una estimación de costos en función del uso previsto, usa la calculadora de precios.

Es posible que los usuarios nuevos de Google Cloud cumplan con los requisitos para acceder a una prueba gratuita.

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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions, Cloud Build, Artifact Registry, and Cloud Storage APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions, Cloud Build, Artifact Registry, and Cloud Storage APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Install the Google Cloud CLI.

Si usas un proveedor de identidad externo (IdP), primero debes Acceder a la gcloud CLI con tu identidad federada.

Para inicializar gcloud CLI, ejecuta el siguiente comando:

gcloud init

Si ya tienes instalada la gcloud CLI, ejecuta el siguiente comando para actualizarla:

gcloud components update

1. Otorga roles/run.invoker y roles/cloudbuild.builds.builder a la cuenta de servicio de procesamiento predeterminada.
2. Prepara el entorno de desarrollo.
   

   Ir a la guía de configuración de Node.js

Configura el entorno

En este instructivo, ejecutarás comandos en Cloud Shell. Cloud Shell es un entorno de shell que tiene la Google Cloud CLI ya instalada y valores ya establecidos para el proyecto actual. La inicialización de Cloud Shell puede demorar varios minutos:

Abrir Cloud Shell

Prepara la aplicación

En Cloud Shell, sigue los pasos siguientes:

1. Clona el repositorio de la app de ejemplo en tu instancia de Cloud Shell:

   git clone https://github.com/terraform-google-modules/terraform-docs-samples.git

2. Accede al directorio que contiene el código de muestra de Cloud Run Functions:

   cd terraform-docs-samples/functions/pubsub

   La muestra de Node.js que se usa en este instructivo es una función “Hello World” básica de Pub/Sub. Este es el archivo main.tf:

   terraform {
     required_providers {
       google = {
         source  = "hashicorp/google"
         version = ">= 4.34.0"
       }
     }
   }
   
   resource "random_id" "bucket_prefix" {
     byte_length = 8
   }
   
   
   resource "google_service_account" "default" {
     account_id   = "test-gcf-sa"
     display_name = "Test Service Account"
   }
   
   resource "google_pubsub_topic" "default" {
     name = "functions2-topic"
   }
   
   resource "google_storage_bucket" "default" {
     name                        = "${random_id.bucket_prefix.hex}-gcf-source" # Every bucket name must be globally unique
     location                    = "US"
     uniform_bucket_level_access = true
   }
   
   data "archive_file" "default" {
     type        = "zip"
     output_path = "/tmp/function-source.zip"
     source_dir  = "function-source/"
   }
   
   resource "google_storage_bucket_object" "default" {
     name   = "function-source.zip"
     bucket = google_storage_bucket.default.name
     source = data.archive_file.default.output_path # Path to the zipped function source code
   }
   
   resource "google_cloudfunctions2_function" "default" {
     name        = "function"
     location    = "us-central1"
     description = "a new function"
   
     build_config {
       runtime     = "nodejs22"
       entry_point = "helloPubSub" # Set the entry point
       environment_variables = {
         BUILD_CONFIG_TEST = "build_test"
       }
       source {
         storage_source {
           bucket = google_storage_bucket.default.name
           object = google_storage_bucket_object.default.name
         }
       }
     }
   
     service_config {
       max_instance_count = 3
       min_instance_count = 1
       available_memory   = "256M"
       timeout_seconds    = 60
       environment_variables = {
         SERVICE_CONFIG_TEST = "config_test"
       }
       ingress_settings               = "ALLOW_INTERNAL_ONLY"
       all_traffic_on_latest_revision = true
       service_account_email          = google_service_account.default.email
     }
   
     event_trigger {
       trigger_region = "us-central1"
       event_type     = "google.cloud.pubsub.topic.v1.messagePublished"
       pubsub_topic   = google_pubsub_topic.default.id
       retry_policy   = "RETRY_POLICY_RETRY"
     }
   }

Inicializa Terraform

En el directorio terraform-docs-samples/functions/pubsub que contiene el archivo main.tf, ejecuta este comando para agregar los complementos necesarios y compilar el directorio .terraform:

terraform init

Valida la configuración de Terraform

Obtén una vista previa de la configuración de Terraform. Este paso es opcional, pero te permite verificar que la sintaxis de main.tf sea correcta. Este comando muestra una vista previa de los recursos que se crearán:

terraform plan

Aplica la configuración de Terraform

Aplica la configuración para implementar la función. Cuando se te solicite, ingresa yes.

terraform apply

Activa la función

Para probar la función de Pub/Sub, sigue estos pasos:

1. Publica un mensaje en el tema (en este ejemplo, el nombre del tema es functions2-topic):

   gcloud pubsub topics publish TOPIC_NAME --message="Friend"

2. Lee los registros de la función para ver el resultado, en el que FUNCTION_NAME es el nombre de la función (en este ejemplo, el nombre de la función es function):

   gcloud functions logs read FUNCTION_NAME

   Deberías ver un resultado de registro que incluya tu nuevo mensaje “Amigable“.

   Nota: Los registros pueden tardar un poco en aparecer. Si no los ves de inmediato, vuelve a revisar en un minuto o dos.

Realiza una limpieza

Después de completar el instructivo, puedes borrar todo lo que creaste para no incurrir en más costos.

Terraform permite quitar todos los recursos definidos en el archivo de configuración ejecutando el comando terraform destroy:

terraform destroy

Ingresa yes para permitir que Terraform borre tus recursos.