Instructivo de Terraform


En este instructivo, se muestra cómo implementar una función HTTP mediante la carga de un archivo ZIP de código fuente de función a un bucket de Cloud Storage mediante Terraform para aprovisionar los recursos. Terraform es una herramienta de código abierto que te permite aprovisionar recursos de Google Cloud con archivos de configuración declarativos.

En este instructivo, usa una función HTTP de Node.js como ejemplo, pero también se aplica a las funciones de HTTP de Python, Go y Java. Las instrucciones son las mismas sin importar el entorno de ejecución que uses.

Objetivos

  • Aprende a usar Terraform para implementar una función HTTP.

Costos

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

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. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

Antes de comenzar

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  5. Install the Google Cloud CLI.
  6. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

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

    Enable the APIs

  10. Install the Google Cloud CLI.
  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Si ya tienes instalado gcloud CLI, ejecuta el siguiente comando para actualizarla:

    gcloud components update
  13. Prepara tu entorno de desarrollo.

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

Configure su entorno

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

Abra Cloud Shell

Prepara la aplicación

En Cloud Shell, sigue los siguientes pasos:

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

    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
  2. Ve al directorio que contiene los ejemplos de código de muestra de las funciones de Cloud Run:

    cd nodejs-docs-samples/functions

    La muestra de Node.js que se usa en este instructivo es una función HTTP “Hello World” básica.

Crea tu archivo main.tf

  1. En el directorio nodejs-docs-samples/functions/, crea un archivo main.tf para la configuración de Terraform:

    touch main.tf
    
  2. Copia esta configuración de Terraform en tu archivo main.tf:

    terraform {
      required_providers {
        google = {
          source  = "hashicorp/google"
          version = ">= 4.34.0"
        }
      }
    }
    
    resource "random_id" "default" {
      byte_length = 8
    }
    
    resource "google_storage_bucket" "default" {
      name                        = "${random_id.default.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  = "functions/hello-world/"
    }
    resource "google_storage_bucket_object" "object" {
      name   = "function-source.zip"
      bucket = google_storage_bucket.default.name
      source = data.archive_file.default.output_path # Add path to the zipped function source code
    }
    
    resource "google_cloudfunctions2_function" "default" {
      name        = "function-v2"
      location    = "us-central1"
      description = "a new function"
    
      build_config {
        runtime     = "nodejs16"
        entry_point = "helloHttp" # Set the entry point
        source {
          storage_source {
            bucket = google_storage_bucket.default.name
            object = google_storage_bucket_object.object.name
          }
        }
      }
    
      service_config {
        max_instance_count = 1
        available_memory   = "256M"
        timeout_seconds    = 60
      }
    }
    
    resource "google_cloud_run_service_iam_member" "member" {
      location = google_cloudfunctions2_function.default.location
      service  = google_cloudfunctions2_function.default.name
      role     = "roles/run.invoker"
      member   = "allUsers"
    }
    
    output "function_uri" {
      value = google_cloudfunctions2_function.default.service_config[0].uri
    }
  3. Edita el archivo main.tf a fin de asegurarte de que tenga los valores correctos para los siguientes elementos. Debes editar este archivo cada vez que cambie la configuración (por ejemplo, para usar un entorno de ejecución diferente o implementar una función diferente):

    • Entorno de ejecución: En este ejemplo, reemplaza nodejs16 por el entorno de ejecución de Node.js más reciente nodejs20.
    • Punto de entrada de la función: en este ejemplo, el punto de entrada de la función es helloHttp.
    • Ruta de acceso al directorio del código fuente: En este ejemplo, cambia source_dir por helloworld/helloworldHttp.
    • La configuración member="allUsers" de IAM no se realizará de forma correcta si tu proyecto está bajo una política de la organización de restricción de dominio que restringe el otorgamiento de roles de IAM a la principal allUsers. Úsala con precaución en producción y considera incluir una lista de miembros más restringida, si es posible.

Inicializa Terraform

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

terraform init

Aplica la configuración de Terraform

En el directorio nodejs-docs-samples/functions/ que contiene tu archivo main.tf, aplica la función mediante la configuración. Cuando se te solicite, ingresa yes.

terraform apply

Pruebe la función

  1. Cuando la función termine de implementarse, toma nota de la propiedad URI o búscala con el siguiente comando:

    gcloud functions describe function-v2 --gen2 --region=us-central1 --format="value(serviceConfig.uri)"
    
  2. Realiza una solicitud a esta URL para ver el mensaje “Hello World” de tu función. Ten en cuenta que la función se implementa con el requisito de autenticación. Por lo tanto, debes proporcionar credenciales en tu solicitud:

    curl -H "Authorization: Bearer $(gcloud auth print-identity-token)" YOUR_FUNCTION_URL

Realiza una limpieza

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

Terraform te permite quitar todos los recursos definidos en el archivo de configuración mediante la ejecución del comando terraform destroy en el directorio nodejs-docs-samples/functions/ que contiene tu archivo main.tf:

terraform destroy

Ingresa yes para permitir que Terraform borre tus recursos.