Pianificare i workflow

Questo tutorial mostra come utilizzare Cloud Scheduler per eseguire automaticamente Workflows in modo che un workflow venga eseguito in base a una pianificazione specifica, in questo caso ogni 5 minuti.

Obiettivi

Crea ed esegui il deployment di un workflow che può ricevere argomenti di runtime.
Crea un job Cloud Scheduler che attiva il workflow e lo esegue ogni 5 minuti, passando gli argomenti JSON nel formato corretto.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.

I nuovi utenti di Google Cloud potrebbero avere diritto a una prova senza costi.

Prima di iniziare

Configura l'ambiente per Cloud Scheduler, inclusa la creazione di un'app App Engine.
Abilita l'API Workflows.
Ruoli richiesti per abilitare le API
Per abilitare le API, devi disporre del ruolo IAM Amministratore utilizzo dei servizi (roles/serviceusage.serviceUsageAdmin), che include l'autorizzazione serviceusage.services.enable. Scopri come concedere i ruoli.
Abilitare l'API

Imposta la località predefinita utilizzata in questo tutorial:
```
  gcloud config set workflows/location REGION
```
Sostituisci REGION con la località Workflows supportata che preferisci.
Crea un account di servizio da utilizzare per Workflows, ad esempio sa-name.
```
  gcloud iam service-accounts create sa-name
```

Concedi al tuo account di servizio il ruolo workflows.invoker in modo che l'account abbia l'autorizzazione per attivare il workflow:

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member "serviceAccount:sa-name@PROJECT_ID.iam.gserviceaccount.com" \
      --role "roles/workflows.invoker"

PROJECT_ID

Concedi il ruolo logging.logWriter al account di servizio.

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member "serviceAccount:sa-name@PROJECT_ID.iam.gserviceaccount.com" \
      --role "roles/logging.logWriter"

Crea un workflow che riceve argomenti di runtime

Una definizione di workflow è costituita da una serie di passaggi descritti utilizzando la sintassi di Workflows, che può essere scritta in formato YAML o JSON. Dopo aver creato un workflow, esegui il deployment per renderlo disponibile per l'esecuzione.

Console

Nella console Google Cloud , vai alla pagina Workflow:

Vai a Flussi di lavoro
Fai clic su Crea.
Inserisci myFirstWorkflow come nome del nuovo flusso di lavoro.
Seleziona us-central1 per la regione.
Seleziona il account di servizio che hai creato in precedenza.
Fai clic su Avanti.

Nell'editor del workflow, inserisci la seguente definizione per il workflow.

YAML

main:
  params: [args]
  steps:
    - step1:
        assign:
          - outputVar: ${"Hello, " + args.firstName + " " + args.lastName + "!"}
    - step2:
        return: ${outputVar}

JSON

{
  "main": {
    "params": [
      "args"
    ],
    "steps": [
      {
        "step1": {
          "assign": [
            {
              "outputVar": "${\"Hello \" + args.firstName + \" \" + args.lastName}"
            }
          ]
        }
      },
      {
        "step2": {
          "return": "${outputVar}"
        }
      }
    ]
  }
}

Questo flusso di lavoro restituisce il saluto "Hello" a una persona di cui passi il nome e il cognome come argomenti runtime.

Fai clic su Esegui il deployment.

gcloud

Apri un terminale.

Salva la seguente definizione del flusso di lavoro come file YAML o JSON, ad esempio myFirstWorkflow.yaml o myFirstWorkflow.json.

YAML

main:
  params: [args]
  steps:
    - step1:
        assign:
          - outputVar: ${"Hello, " + args.firstName + " " + args.lastName + "!"}
    - step2:
        return: ${outputVar}

JSON

{
  "main": {
    "params": [
      "args"
    ],
    "steps": [
      {
        "step1": {
          "assign": [
            {
              "outputVar": "${\"Hello \" + args.firstName + \" \" + args.lastName}"
            }
          ]
        }
      },
      {
        "step2": {
          "return": "${outputVar}"
        }
      }
    ]
  }
}

Questo flusso di lavoro restituisce il saluto "Hello" a una persona di cui passi il nome e il cognome come argomenti runtime.

Esegui il deployment del flusso di lavoro inserendo questo comando:
```
gcloud workflows deploy myFirstWorkflow \
    --source=myFirstWorkflow.yaml_OR_json \
    --service-account=sa-name@PROJECT_ID.iam.gserviceaccount.com
```
Sostituisci yaml_OR_json con yaml o json a seconda del formato del file di definizione di Workflows che hai creato in precedenza.

Pianifica il workflow

Crea un job Cloud Scheduler che attiva il flusso di lavoro utilizzando il service account creato in precedenza.

Console

Nella console Google Cloud , vai alla pagina Cloud Scheduler:

Vai a Cloud Scheduler
Fai clic su Crea job.
Imposta Nome su my-workflow-job.
In Frequenza, inserisci:
```
*/5 * * * *
```
Il job verrà eseguito ogni 5 minuti. L'intervallo è definito utilizzando il formato unix-cron.
Per Fuso orario, seleziona un paese e un fuso orario.

Ad esempio, seleziona Stati Uniti e Los Angeles o Ora legale del Pacifico (PDT).
Fai clic su Continua.
In Tipo di destinazione, seleziona HTTP.

In URL, inserisci:

https://workflowexecutions.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/workflows/myFirstWorkflow/executions

Lascia il metodo HTTP impostato sul valore predefinito POST.
Aggiungi le due intestazioni HTTP seguenti:
- Nome: Content-Type e valore: application/octet-stream
- Nome: User-Agent e valore: Google-Cloud-Scheduler
In Corpo, inserisci:
```
{"argument": "{\"firstName\":\"Sherlock\", \"lastName\":\"Holmes\"}"}
```
Viene trasmessa una codifica JSON degli argomenti del flusso di lavoro; in questo caso, il nome "Sherlock" e il cognome "Holmes". Le virgolette doppie all'interno della stringa vengono sottoposte a escape utilizzando barre rovesciate (\).
Per Intestazione di autenticazione, seleziona Aggiungi token OAuth.
Inserisci il account di servizio che hai creato in precedenza.
```
sa-name@PROJECT_ID.iam.gserviceaccount.com
```
Non è necessario specificare l'ambito, poiché viene utilizzato il valore predefinito https://www.googleapis.com/auth/cloud-platform.
Accetta tutte le altre impostazioni predefinite e fai clic su Crea.

gcloud

Pianifica un job denominato my-workflow-job inserendo questo comando:

gcloud scheduler jobs create http my-workflow-job \
    --schedule="*/5 * * * *" \
    --uri="https://workflowexecutions.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/workflows/myFirstWorkflow/executions" \
    --message-body="{\"argument\": \"{\\\"firstName\\\":\\\"Sherlock\\\", \\\"lastName\\\":\\\"Holmes\\\"}\"}" \
    --time-zone="America/Los_Angeles" \
    --oauth-service-account-email="sa-name@PROJECT_ID.iam.gserviceaccount.com"

L'intervallo è definito utilizzando il formato unix-cron.

Il flag message-body viene utilizzato per passare una codifica JSON degli argomenti del workflow; in questo caso, il nome, "Sherlock", e il cognome, "Holmes". Le virgolette doppie all'interno della stringa vengono sottoposte a escape utilizzando le barre rovesciate (\).

Ora il workflow viene eseguito ogni 5 minuti.

Per saperne di più sui flag gcloud scheduler, nonché su come applicare la registrazione delle chiamate in modo che ogni passaggio della chiamata durante l'esecuzione del workflow venga registrato, consulta Pianificare un workflow e il gcloud riferimento.

Esegui il job e verifica i risultati

Console

Nella console Google Cloud , vai alla pagina Cloud Scheduler:

Vai a Cloud Scheduler

Se il job non viene visualizzato, potresti dover aggiornare la pagina.
Per il job denominato my-workflow-job, fai clic su Esegui ora.

Il valore Risultato dovrebbe essere aggiornato a Riuscita.
Nella console Google Cloud , vai alla pagina Workflow:

Vai a Flussi di lavoro
Nell'elenco dei workflow, fai clic su myFirstWorkflow per aprire la pagina dei dettagli.

Lo stato di esecuzione del workflow deve essere Riuscito.
Fai clic sull'ID esecuzione del workflow per aprire la pagina dei dettagli e visualizzare i risultati del workflow nel riquadro Output.

L'output dovrebbe essere "Hello, Sherlock Holmes!".

gcloud

Esegui il job Cloud Scheduler per eseguire il workflow:
```
gcloud scheduler jobs run my-workflow-job
```

Recupera l'ID esecuzione del workflow:

gcloud workflows executions list myFirstWorkflow

L'output dovrebbe essere simile al seguente, con l'ID esecuzione in grassetto:

projects/316710615161/locations/us-central1/workflows/myFirstWorkflow/executions/138b31e1-f3bb-4ba7-a6da-008d0cb4a320

Recupera i risultati dell'esecuzione del workflow:

gcloud workflows executions describe EXECUTION_ID --workflow myFirstWorkflow

Sostituisci EXECUTION_ID con l'ID esecuzione restituito nel passaggio precedente.

L'output dovrebbe essere simile al seguente:

argument: '{"firstName":"Sherlock","lastName":"Holmes"}'
endTime: '2021-09-09T15:15:00.869350639Z'
name: projects/316710615161/locations/us-central1/workflows/myFirstWorkflow/executions/138b31e1-f3bb-4ba7-a6da-008d0cb4a320
result: '"Hello, Sherlock Holmes!"'
startTime: '2021-09-09T15:15:00.839175480Z'
state: SUCCEEDED
workflowRevisionId: 000001-4f9

Complimenti! Hai creato un job Cloud Scheduler che esegue automaticamente un flusso di lavoro in base a una pianificazione specifica.

Esegui la pulizia

Al termine del tutorial, puoi eliminare le risorse che hai creato in modo che non utilizzino più la quota generando addebiti. Le seguenti sezioni descrivono come eliminare o disattivare queste risorse.

Elimina il progetto

Il modo più semplice per eliminare la fatturazione è eliminare il progetto creato per il tutorial.

Per eliminare il progetto:

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.

Se intendi esplorare più architetture, tutorial o guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

Nella console Google Cloud , vai alla pagina Gestisci risorse.
Vai a Gestisci risorse
Nell'elenco dei progetti, seleziona quello che vuoi eliminare, quindi fai clic su Elimina.
Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.

Elimina il job Cloud Scheduler

Vai alla pagina Cloud Scheduler nella console Google Cloud .

Vai a Cloud Scheduler
Seleziona la casella di controllo accanto al job.
Fai clic su Elimina nella parte superiore della pagina e conferma l'eliminazione.

Elimina il workflow Workflows

Vai alla pagina Workflow nella console Google Cloud .

Vai a Flussi di lavoro
Seleziona il workflow.
Fai clic su Elimina nella parte superiore della pagina, digita il nome del workflow e conferma l'eliminazione.

Disabilita l'app App Engine

La disattivazione di un'app App Engine impedisce all'applicazione di eseguire istanze e gestire richieste, mantenendo al contempo dati e impostazioni dell'applicazione.

Vai alla pagina Impostazioni applicazione nella console Google Cloud .

Vai alle impostazioni dell'applicazione
Fai clic su Disabilita applicazione.
Segui le istruzioni.

Passaggi successivi

Scopri di più sui workflow.

Pianificare i workflow Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Obiettivi

Costi

Prima di iniziare

Crea un workflow che riceve argomenti di runtime

Console

YAML

JSON

gcloud

YAML

JSON

Pianifica il workflow

Console

gcloud

Esegui il job e verifica i risultati

Console

gcloud

Esegui la pulizia

Elimina il progetto

Elimina il job Cloud Scheduler

Elimina il workflow Workflows

Disabilita l'app App Engine

Passaggi successivi

Pianificare i workflow