Crea e pianifica 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 la tua infrastruttura cloud utilizzando codice. Puoi scoprire di più sull'utilizzo di Terraform per il provisioning dell'infrastruttura su Google Cloud.

Cloud Scheduler ha un livello gratuito e l'esecuzione di questa guida rapida non dovrebbe comportare alcun costo. Per ulteriori informazioni, consulta la sezione Prezzi.

In questa guida rapida:

  1. Utilizza Terraform per creare un cron job per Cloud Scheduler.
  2. Imposta una pianificazione 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

  1. Accedi al tuo Account Google.

    Se non ne hai già uno, crea un nuovo account.

  2. Installa Google Cloud CLI.
  3. Per initialize gcloud CLI, esegui questo comando:

    gcloud init
  4. Create or select a Google Cloud 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.

  5. Installa Google Cloud CLI.
  6. Per initialize gcloud CLI, esegui questo comando:

    gcloud init
  7. Create or select a Google Cloud 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.

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

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. Applicherai 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 il seguente 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 i publisher possono inviare i 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 e fuso orario del job Chrome.

      • 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) su cui viene pubblicato il payload del messaggio (data) quando viene eseguito il job.

      Sono supportati altri argomenti. Per i dettagli, consulta il riferimento all'argomento del registro Terraform.

Crea il cron job

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

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

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

    terraform plan
    

    Puoi ignorare la nota relativa al non 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. Conferma la creazione di 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 eseguire il job in base alla pianificazione specificata, puoi forzare l'esecuzione immediata del job eseguendo questo comando.

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 stia ricevendo messaggi dal tuo 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 all'interno di quel progetto. Tieni presente che, per impostazione predefinita, tutti i file nella home directory di Cloud Shell (ad esempio i file Terraform) rimangono invariati tra una sessione e l'altra.

    Elimina un progetto Google Cloud:

    gcloud projects delete PROJECT_ID
  2. In alternativa, puoi eliminare tutte le risorse create con Terraform.

    Il comando terraform destroy termina tutte le risorse specificate nello stato Terraform. Non elimina le risorse non gestite dall'attuale progetto Terraform. Il file di configurazione Terraform non viene eliminato. Per maggiori informazioni, consulta Eliminare l'infrastruttura.

    terraform destroy

Passaggi successivi