Pianifica ed esegui un cron job utilizzando Terraform

Pianifica ed esegui un cron job utilizzando Terraform

Questa guida rapida mostra come utilizzare Terraform per creare un cron job di Cloud Scheduler. Terraform è uno strumento Infrastructure as Code (IaC) che consente di creare, modificare e migliorare in modo prevedibile l'infrastruttura cloud utilizzando il codice. Puoi scoprire di più sull'utilizzo di Terraform per il provisioning dell'infrastruttura su Google Cloud.

Cloud Scheduler prevede un Livello senza costi e l'esecuzione di questa guida rapida non dovrebbe comportare alcun costo. Per saperne di più, consulta i prezzi.

In questa guida rapida:

1. Utilizza Terraform per creare un cron job per Cloud Scheduler.
2. Imposta una programmazione ricorrente per il job.
3. Specificare un argomento Pub/Sub come target del job.
4. Esegui il job.
5. Verificare che il job sia stato eseguito correttamente.

Prima di iniziare

I vincoli di sicurezza definiti dalla tua organizzazione potrebbero impedirti di completare i passaggi seguenti. Per informazioni sulla risoluzione dei problemi, vedi Sviluppa applicazioni in un ambiente Google Cloud vincolato.

Sign in to your Google Account.

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

Install the Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo 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 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.

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

Se utilizzi un progetto esistente per questa guida, verifica di disporre delle autorizzazioni necessarie per completare la guida. Se hai creato un nuovo progetto, disponi già delle autorizzazioni necessarie.

Enable the Resource Manager and Service Usage 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.

gcloud services enable cloudresourcemanager.googleapis.com serviceusage.googleapis.com

Install the Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo 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 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.

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

Se utilizzi un progetto esistente per questa guida, verifica di disporre delle autorizzazioni necessarie per completare la guida. Se hai creato un nuovo progetto, disponi già delle autorizzazioni necessarie.

Enable the Resource Manager and Service Usage 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.

gcloud services enable cloudresourcemanager.googleapis.com serviceusage.googleapis.com

1. Cloud Shell ha già integrato Terraform. Se devi installare Terraform, consulta la documentazione di HashiCorp Terraform.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per completare questa guida rapida, chiedi all'amministratore di concederti i seguenti ruoli IAM nel tuo progetto:

• Cloud Scheduler Admin (roles/cloudscheduler.admin)
• Editor Pub/Sub (roles/pubsub.editor)

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Crea un file di configurazione Terraform

Per utilizzare Terraform con Cloud Scheduler, devi creare un file di configurazione per descrivere la tua infrastruttura e creare un piano di esecuzione. Applica quindi il file di configurazione alla tua piattaforma o al tuo servizio per eseguire operazioni che eseguono il provisioning dell'infrastruttura.

Completa i seguenti passaggi per creare un file di configurazione Terraform denominato main.tf:

1. Apri un terminale e crea una directory:

   mkdir terraform

2. Vai alla directory terraform:

   cd terraform

3. Aggiungi un nuovo file, main.tf, alla directory:

   nano main.tf

4. Aggiungi le seguenti risorse del provider Terraform per Google Cloud al file main.tf:

   1. Abilita le API Cloud Scheduler e 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 argomento Pub/Sub come risorsa a cui gli editori possono inviare messaggi:

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

      Viene creato un argomento denominato pubsub_topic.

   3. Crea una sottoscrizione per ricevere i messaggi pubblicati nell'argomento Pub/Sub:

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

   4. Crea un cron job utilizzando la risorsa 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!")
        }
      }

      Nell'esempio vengono utilizzati i seguenti argomenti:

      • name: il nome del job.
      • description: una descrizione del lavoro.

      • schedule: la frequenza del job, utilizzando un formato basato su unix-cron.

        In questo esempio, 30 16 * * 7 significa che il job verrà eseguito alle 16:30 di domenica. Per saperne di più, consulta Formato cron job e fuso orario.

      • region: la regione in cui si trova il job.

      • pubsub_target: la destinazione dell'argomento Pub/Sub, incluso il nome completo della risorsa dell'argomento (topic_name) a cui viene pubblicato il payload del messaggio (data) quando viene eseguito il job.

      Sono supportati altri argomenti. Per maggiori dettagli, consulta il riferimento agli argomenti del registro Terraform.

Per un altro esempio di utilizzo di Terraform con Cloud Scheduler, consulta Esecuzione di servizi Cloud Run in base a una pianificazione.

Crea il cron job

Esegui il deployment delle risorse Terraform per creare il job cron.

1. Apri un terminale e, nella directory terraform, inizializza Terraform:

   terraform init

2. Verifica che le modifiche che proponi con Terraform corrispondano al piano previsto:

   terraform plan

   Puoi ignorare la nota relativa al mancato utilizzo dell'opzione -out.

3. Crea il cron job:

   terraform apply

4. Al prompt Inserisci un valore, digita yes per procedere con la creazione delle risorse.

5. Verifica che sia stato creato un job:

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

   L'output dovrebbe essere simile al seguente:

   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

Hai creato un job che invia un messaggio a un argomento Pub/Sub alle 16:30 di domenica. Ora puoi eseguire il job.

Esegui il job

Oltre a essere eseguito in base alla pianificazione specificata, puoi forzare l'esecuzione immediata del job eseguendo il comando seguente.

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

Tieni presente che, a causa della configurazione iniziale, l'esecuzione del primo job creato in un progetto può richiedere alcuni minuti.

Verifica i risultati

Verifica che l'argomento Pub/Sub riceva messaggi dal job.

1. Esegui il pull dei messaggi Pub/Sub da una sottoscrizione:

   gcloud pubsub subscriptions pull pubsub_subscription --limit 5
   

   Se inizialmente non vengono estratti messaggi, esegui di nuovo il comando.

2. Visualizza i risultati dell'esecuzione del job. L'output dovrebbe essere simile al seguente:

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

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, elimina il progetto Google Cloud con le risorse.

1. L'eliminazione del tuo progetto Google Cloud interrompe la fatturazione per tutte le risorse utilizzate al suo interno. Tieni presente che, per impostazione predefinita, tutti i file nella home directory di Cloud Shell (ad esempio, tutti i file Terraform) persistono tra le sessioni.
   Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

   • L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per, le attività descritte in questo documento, eliminerai anche tutto il lavoro che hai svolto nel progetto.
   • Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

   Delete a Google Cloud project:

   gcloud projects delete PROJECT_ID

2. In alternativa, puoi eliminare tutte le risorse che hai creato con Terraform.

   Il comando terraform destroy termina tutte le risorse specificate nel tuo stato Terraform. Non elimina le risorse non gestite dal progetto Terraform corrente. Il file di configurazione Terraform non viene eliminato. Per saperne di più, consulta la sezione Distruggere l'infrastruttura.

   terraform destroy

Passaggi successivi

• Che cos'è Terraform?
• Visualizzazione dei log di Cloud Scheduler