Programar y ejecutar una tarea cron con Terraform

Programar y ejecutar una tarea cron con Terraform

En esta guía de inicio rápido se muestra cómo usar Terraform para crear un trabajo cron de Cloud Scheduler. Terraform es una herramienta de infraestructura como código (IaC) que te permite crear, cambiar y mejorar tu infraestructura de nube de forma predecible mediante código. Puedes consultar más información sobre cómo usar Terraform para aprovisionar infraestructura en Google Cloud.

Cloud Scheduler tiene un nivel gratuito y, por lo tanto, no deberías incurrir en ningún coste al completar esta guía de inicio rápido. Para obtener más información, consulta los precios.

En esta guía de inicio rápido, harás lo siguiente:

1. Usa Terraform para crear un trabajo cron para Cloud Scheduler.
2. Define una programación periódica para la tarea.
3. Especifica un tema de Pub/Sub como destino del trabajo.
4. Ejecuta la tarea.
5. Comprueba que el trabajo se haya ejecutado correctamente.

Antes de empezar

Sign in to your Google Account.

If you don't already have one, sign up for a new account.

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.

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 (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.

• 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.

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.

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 (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.

• 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.

1. Cloud Shell ya tiene Terraform integrado. Si necesitas instalar Terraform, consulta la documentación de HashiCorp Terraform.

Crear un archivo de configuración de Terraform

Para usar Terraform con Cloud Scheduler, debes crear un archivo de configuración que describa tu infraestructura y crear un plan de ejecución. A continuación, aplica el archivo de configuración a tu plataforma o servicio para realizar operaciones que aprovisionen tu infraestructura.

Sigue estos pasos para crear un archivo de configuración de Terraform llamado main.tf:

1. Abre una terminal y crea un directorio:

   mkdir terraform

2. Ve al directorio terraform:

   cd terraform

3. Añade un archivo nuevo, main.tf, al directorio:

   nano main.tf

4. Añade los siguientes recursos del proveedor de Terraform para Google Cloud al archivo main.tf:

   1. Habilita las APIs Cloud Scheduler y Pub/Sub:

      # Enable Cloud Scheduler API
      resource "google_project_service" "scheduler" {
        service            = "cloudscheduler.googleapis.com"
        disable_on_destroy = false
      }
      # Enable Pub/Sub API
      resource "google_project_service" "pubsub" {
        service            = "pubsub.googleapis.com"
        disable_on_destroy = false
      }

   2. Crea un tema de Pub/Sub como recurso al que los editores pueden enviar mensajes:

      # Create Pub/Sub topic
      resource "google_pubsub_topic" "default" {
        name = "pubsub_topic"
      }

      De esta forma, se crea un tema llamado pubsub_topic.

   3. Crea una suscripción para recibir mensajes publicados en el tema de Pub/Sub:

      # Create Pub/Sub subscription
      resource "google_pubsub_subscription" "default" {
        name  = "pubsub_subscription"
        topic = google_pubsub_topic.default.name
      }

   4. Crea un trabajo cron con el recurso google_cloud_scheduler_job:

      # Create a cron job using Cloud Scheduler
      resource "google_cloud_scheduler_job" "default" {
        name        = "test-job"
        description = "test job"
        schedule    = "30 16 * * 7"
        region      = "us-central1"
      
        pubsub_target {
          topic_name = google_pubsub_topic.default.id
          data       = base64encode("Hello world!")
        }
      }

      En el ejemplo se usan los siguientes argumentos:

      • name: el nombre del puesto.
      • description: una descripción del puesto.

      • schedule: la frecuencia del trabajo, con un formato basado en cron de Unix.

        En este ejemplo, 30 16 * * 7 significa que el trabajo se ejecutará a las 16:30 los domingos. Para obtener más información, consulta Formato de las tareas cron y zona horaria.

      • region: la región en la que se encuentra el trabajo.

      • pubsub_target: el tema de Pub/Sub de destino, incluido el nombre completo del recurso del tema (topic_name) en el que se publica la carga útil del mensaje (data) cuando se ejecuta el trabajo.

      Se admiten otros argumentos. Para obtener más información, consulta la referencia de argumentos de Terraform Registry.

Crear la tarea cron

Despliega tus recursos de Terraform para crear la tarea cron.

1. Abre una terminal y, en el directorio terraform, inicializa Terraform:

   terraform init

2. Comprueba que los cambios que propones con Terraform coinciden con el plan esperado:

   terraform plan

   Puedes ignorar la nota sobre no usar la opción -out.

3. Crea la tarea cron:

   terraform apply

4. En la petición Introduce un valor, escribe yes para continuar con la creación de recursos.

5. Confirma que se ha creado un trabajo:

   gcloud scheduler jobs describe test-job --location=us-central1

   La salida debería ser similar a la siguiente:

   description: test job
   lastAttemptTime: '2024-04-04T13:56:00.669530Z'
   name: projects/PROJECT_ID/locations/us-central1/jobs/test-job
   pubsubTarget:
   data: dGVzdA==
   topicName: projects/PROJECT_ID/topics/pubsub_topic
   schedule: '30 16 * * 7'
   scheduleTime: '2024-04-04T13:58:00.737907Z'
   state: ENABLED

Has creado un trabajo que envía un mensaje a un tema de Pub/Sub a las 16:30 los domingos. Ahora puedes ejecutar el trabajo.

Ejecutar una tarea

Además de ejecutarse según la programación especificada, puedes forzar que tu trabajo se ejecute inmediatamente con el siguiente comando.

gcloud scheduler jobs run test-job --location=us-central1

Ten en cuenta que, debido a la configuración inicial, la primera tarea creada en un proyecto puede tardar unos minutos en ejecutarse.

Verificar los resultados

Comprueba que tu tema de Pub/Sub recibe mensajes de tu trabajo.

1. Para extraer mensajes de Pub/Sub de una suscripción, sigue estos pasos:

   gcloud pubsub subscriptions pull pubsub_subscription --limit 5
   

   Si no se extraen mensajes al principio, vuelve a ejecutar el comando.

2. Consulta los resultados de la ejecución del trabajo. La salida debería ser similar a la siguiente:

   DATA: Hello world!
   MESSAGE_ID: 5028933846601543
   ORDERING_KEY:
   ATTRIBUTES:
   DELIVERY_ATTEMPT:
   ACK_ID: RFAGFixdRkhRNxkIaFEOT14jPzUgKEUQAgVPAihdeTFXLkFacGhRDRlyfWB9[...]
   

Limpieza

Para evitar que se apliquen cargos en tu Google Cloud cuenta por los recursos utilizados en esta página, elimina el Google Cloud proyecto con los recursos.

1. Al eliminar tu proyecto Google Cloud , se detendrá la facturación de todos los recursos utilizados en ese proyecto. Ten en cuenta que, de forma predeterminada, los archivos de tu directorio principal de Cloud Shell (por ejemplo, los archivos de Terraform) se conservan de una sesión a otra.
   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.

   Delete a Google Cloud project:

   gcloud projects delete PROJECT_ID

2. También puedes eliminar todos los recursos que hayas creado con Terraform.

   El comando terraform destroy finaliza todos los recursos especificados en tu estado de Terraform. No destruye los recursos que no gestiona el proyecto de Terraform actual. Tu archivo de configuración de Terraform no se elimina. Para obtener más información, consulta Destruir infraestructura.

   terraform destroy

Siguientes pasos

• ¿Qué es Terraform?
• Información sobre Cloud Scheduler
• Ver los registros de Cloud Scheduler