Attiva Workflows utilizzando messaggi Pub/Sub (gcloud CLI)

Guida rapida: attiva Workflows utilizzando messaggi Pub/Sub (Google Cloud CLI)

Attiva Workflows utilizzando messaggi Pub/Sub (gcloud CLI)

Questa guida rapida mostra come eseguire un flusso di lavoro utilizzando un trigger Eventarc che riceve eventi utilizzando Pub/Sub. Il trigger esegue il flusso di lavoro passando gli eventi pubblicati tramite Pub/Sub sotto forma di argomenti di runtime a un flusso di lavoro di destinazione.

In questa guida rapida:

1. Utilizza Workflows per creare ed eseguire il deployment di un flusso di lavoro che decodifica e restituisce messaggi Pub/Sub.
2. Crea un trigger Eventarc che connette un argomento Pub/Sub a un ricevitore di eventi Workflows.
3. Pubblica un messaggio nell'argomento Pub/Sub per generare un evento. Questo evento viene passato come argomento di runtime al flusso di lavoro di destinazione.
4. Visualizza il messaggio Pub/Sub come risultato dell'esecuzione del flusso di lavoro.

Prima di iniziare

Assicurati di poter accedere a questa funzionalità richiedendo l'aggiunta del progetto alle anteprime private per Google Cloud Workflows.

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
2. Installa Google Cloud CLI.

3. Per initialize gcloud CLI, esegui questo comando:

   gcloud init

4. Crea o seleziona un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   • Crea un progetto Google Cloud:

     gcloud projects create PROJECT_ID

     Sostituisci PROJECT_ID con un nome per il progetto Google Cloud che stai creando.

   • Seleziona il progetto Google Cloud che hai creato:

     gcloud config set project PROJECT_ID

     Sostituisci PROJECT_ID con il nome del tuo progetto Google Cloud.

5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

6. Installa Google Cloud CLI.

7. Per initialize gcloud CLI, esegui questo comando:

   gcloud init

8. Crea o seleziona un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   • Crea un progetto Google Cloud:

     gcloud projects create PROJECT_ID

     Sostituisci PROJECT_ID con un nome per il progetto Google Cloud che stai creando.

   • Seleziona il progetto Google Cloud che hai creato:

     gcloud config set project PROJECT_ID

     Sostituisci PROJECT_ID con il nome del tuo progetto Google Cloud.

9. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

10. Aggiorna i componenti gcloud:

    gcloud components update

11. Abilitare le API Compute Engine, Eventarc, Pub/Sub e Workflows.

    gcloud services enable \
    compute.googleapis.com \
    eventarc.googleapis.com \
    pubsub.googleapis.com \
    workflows.googleapis.com \
    workflowexecutions.googleapis.com

12. Imposta le variabili di configurazione utilizzate in questo tutorial:

    export WORKFLOW_LOCATION=us-central1
    export TRIGGER_LOCATION=us-central1
    export PROJECT_ID=PROJECT_ID
    gcloud config set project ${PROJECT_ID}
    gcloud config set workflows/location ${WORKFLOW_LOCATION}
    gcloud config set eventarc/location ${TRIGGER_LOCATION}
    

13. Se sei l'autore del progetto, ti viene concesso il ruolo Proprietario di base (roles/owner). Per impostazione predefinita, questo ruolo di Identity and Access Management (IAM) include le autorizzazioni necessarie per l'accesso completo alla maggior parte delle risorse Google Cloud e puoi saltare questo passaggio.

    Se non sei l'autore del progetto, le autorizzazioni richieste devono essere concesse per il progetto all'entità appropriata. Ad esempio, un'entità può essere un Account Google (per gli utenti finali) o un account di servizio (per applicazioni e carichi di lavoro di computing). Per ulteriori informazioni, consulta la pagina Ruoli e autorizzazioni per la destinazione dell'evento.

    Autorizzazioni obbligatorie

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

    • Amministratore Eventarc (roles/eventarc.admin)
    • Funzione di accesso alla visualizzazione dei log (roles/logging.viewAccessor)
    • Amministratore IAM progetto (roles/resourcemanager.projectIamAdmin)
    • Publisher Pub/Sub (roles/pubsub.publisher)
    • Service Account Admin (roles/iam.serviceAccountAdmin) [Amministratore account di servizio]
    • Utente account di servizio (roles/iam.serviceAccountUser)
    • Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin)
    • Amministratore flussi di lavoro (roles/workflows.admin)

    Per saperne di più sulla concessione dei ruoli, vedi Gestire l'accesso.

    Potresti anche essere in grado di ottenere le autorizzazioni richieste tramite ruoli personalizzati o altri ruoli predefiniti.

14. L'account di servizio predefinito di Compute Engine viene creato automaticamente dopo aver abilitato o utilizzato un servizio Google Cloud che utilizza Compute Engine.

    A scopo di test, puoi collegare questo account di servizio a un trigger Eventarc per rappresentare l'identità del trigger. Prendi nota del formato email da utilizzare quando crei un trigger:

    [e-mail]
    

    Sostituisci PROJECT_NUMBER con il numero del tuo progetto Google Cloud. Puoi trovare il numero del progetto nella pagina Dashboard della console Google Cloud o eseguendo il seguente comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

    All'account di servizio Compute Engine viene concesso automaticamente il ruolo Editor di base (roles/editor) sul tuo progetto. Tuttavia, se le concessioni automatiche dei ruoli sono state disabilitate, consulta le istruzioni applicabili su Ruoli e autorizzazioni per creare un nuovo account di servizio e concedere i ruoli richiesti.

    Attenzione: ti consigliamo di utilizzare l'account di servizio predefinito di Compute Engine solo a scopo di test. Per gli ambienti di produzione, consigliamo vivamente di creare un nuovo account di servizio e di concedere a tale account uno o più ruoli IAM contenenti le autorizzazioni minime richieste e che seguono il principio del privilegio minimo.
15. Concedi il ruolo Invoker flussi di lavoro (roles/workflows.invoker) sul progetto all'account di servizio predefinito di Compute Engine in modo che l'account abbia l'autorizzazione per attivare l'esecuzione del flusso di lavoro.

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/workflows.invoker

16. Se hai abilitato l'agente di servizio Cloud Pub/Sub entro l'8 aprile 2021 per supportare le richieste push Pub/Sub autenticate, concedi il ruolo Creatore token account di servizio (roles/iam.serviceAccountTokenCreator) all'account di servizio gestito da Google. In caso contrario, questo ruolo è concesso per impostazione predefinita:

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --member=serviceAccount:[e-mail] \
        --role=roles/iam.serviceAccountTokenCreator

Crea ed esegui il deployment di un flusso di lavoro

Crea ed esegui il deployment di un flusso di lavoro che viene eseguito quando un messaggio pubblicato in un argomento Pub/Sub attiva un flusso di lavoro con una richiesta HTTP.

1. Apri un terminale o Cloud Shell.
2. Nella home directory, crea un nuovo file denominato myFirstWorkflow.yaml o myFirstWorkflow.json.
3. Copia e incolla quanto segue nel nuovo file e salvalo:

   YAML

   main:
     params: [event]
     steps:
       - decode_pubsub_message:
           assign:
              - base64: ${base64.decode(event.data.message.data)}
              - message: ${text.decode(base64)}
       - return_pubsub_message:
           return: ${message}

   JSON

   {
     "main": {
       "params": [
         "event"
       ],
       "steps": [
         {
           "decode_pubsub_message": {
             "assign": [
               {
                 "base64": "${base64.decode(event.data.message.data)}"
               },
               {
                 "message": "${text.decode(base64)}"
               }
             ]
           }
         },
         {
           "return_pubsub_message": {
             "return": "${message}"
           }
         }
       ]
     }
   }

4. Esegui il deployment del flusso di lavoro:

   export MY_WORKFLOW=myFirstWorkflow
   gcloud workflows deploy ${MY_WORKFLOW} --source=myFirstWorkflow.yaml
   

   Sostituisci .yaml con .json se hai copiato la versione JSON del flusso di lavoro di esempio.

Crea un trigger Eventarc

Quando un messaggio viene pubblicato nell'argomento Pub/Sub, l'evento attiva il flusso di lavoro.

1. Crea un trigger per ascoltare i messaggi Pub/Sub:

   Nuovo argomento Pub/Sub

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-workflow=${MY_WORKFLOW} \
       --destination-workflow-location=${WORKFLOW_LOCATION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]"

   Viene creato un nuovo argomento Pub/Sub e un trigger denominato events-pubsub-trigger.

   Argomento Pub/Sub esistente

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-workflow=${MY_WORKFLOW} \
       --destination-workflow-location=${WORKFLOW_LOCATION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]" \
       --transport-topic=TOPIC_ID

   Sostituisci TOPIC_ID con l'ID dell'argomento Pub/Sub esistente.

   Questo crea un trigger denominato events-pubsub-trigger per un argomento Pub/Sub esistente.

   Nota: per impostazione predefinita, le sottoscrizioni Pub/Sub create per Eventarc rimangono valide indipendentemente dall'attività e non scadono. Per modificare la durata di inattività, consulta la sezione Proprietà degli abbonamenti.

   Tieni presente che quando crei un trigger Eventarc per la prima volta in un progetto Google Cloud, potrebbe verificarsi un ritardo nel provisioning dell'agente di servizio Eventarc. Per risolvere questo problema, prova a creare di nuovo il trigger. Per ulteriori informazioni, consulta la sezione Errori di autorizzazione negata.

2. Verifica che il trigger sia stato creato:

   gcloud eventarc triggers describe events-pubsub-trigger --location=${TRIGGER_LOCATION}

   L'output dovrebbe essere simile al seguente che elenca l'ora di creazione e la località dell'attivatore:

   createTime: '2021-10-14T15:15:43.872360951Z'
   [...]
   name: projects/PROJECT_ID/locations/us-central1/triggers/events-pubsub-trigger

Generare e visualizzare un evento

Pubblica un messaggio nell'argomento Pub/Sub per generare un evento e attivare il flusso di lavoro. L'evento generato viene passato come argomento di runtime al flusso di lavoro che restituisce il messaggio Pub/Sub come risultato dell'esecuzione del flusso di lavoro. Assicurati che le dimensioni degli eventi trasmessi al flusso di lavoro non superino i 512 kB.

1. Se hai creato un trigger per un nuovo argomento Pub/Sub, trova e imposta l'argomento Pub/Sub creato come variabile di ambiente:

   export TOPIC_ID=$(basename $(gcloud eventarc triggers describe events-pubsub-trigger --format='value(transport.pubsub.topic)'))
   

2. Per attivare il flusso di lavoro, invia un messaggio all'argomento Pub/Sub:

   gcloud pubsub topics publish $TOPIC_ID --message "Hello there"
   

   L'evento generato viene passato come argomento di runtime al flusso di lavoro che restituisce un messaggio "Hello there".

3. Per verificare che sia stata attivata un'esecuzione di flussi di lavoro, elenca le ultime cinque esecuzioni:

   gcloud workflows executions list ${MY_WORKFLOW} --limit=5
   

   L'output dovrebbe essere simile al seguente, elencando NAME e STATE uguali a SUCCEEDED per ogni esecuzione del flusso di lavoro:

   NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/8c02b8f1-8836-4a6d-99d9-fc321eb9668f
   STATE: SUCCEEDED
   START_TIME: 2021-09-13T19:15:10.275677049Z
   END_TIME: 2021-09-13T19:15:10.963136883Z
   NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
   STATE: SUCCEEDED
   START_TIME: 2021-09-13T17:28:51.492864252Z
   END_TIME: 2021-09-13T17:28:52.227212414Z
   

   Tieni presente che nel campo NAME dell'esempio precedente, a6319d9d-36a6-4117-904e-3d1118bdc90a è l'ID dell'esecuzione del flusso di lavoro. Copia l'ID esecuzione per utilizzarlo nel passaggio successivo.

4. Per visualizzare lo stato di esecuzione, esegui questo comando:

   gcloud workflows executions describe WORKFLOW_EXECUTION_ID --workflow=${MY_WORKFLOW}
   

   Sostituisci WORKFLOW_EXECUTION_ID con l'ID dell'esecuzione del flusso di lavoro corrispondente all'ora di pubblicazione dell'argomento Pub/Sub. L'output è simile al seguente:

   argument: [...]
   endTime: '2021-09-13T17:28:47.301012152Z'
   name: projects/1234567/locations/us-central1/workflows/myFirstWorkflow/executions/f72bc6d4-5ea0-4dfb-bb14-2dae82303120
   result: 'Hello there'
   startTime: '2021-09-13T17:28:51.492864252Z'
   state: SUCCEEDED

5. Verifica che il valore publish_time in cui è stato pubblicato il messaggio Pub/Sub e il valore startTime dell'esecuzione del flusso di lavoro corrispondano tra loro.

Complimenti, hai generato correttamente un evento utilizzando un argomento Pub/Sub che ha attivato un ricevitore di eventi Workflows utilizzando Eventarc.

Esegui la pulizia

1. Elimina il flusso di lavoro creato:

   gcloud workflows delete ${MY_WORKFLOW}

   Quando ti viene chiesto se vuoi continuare, digita y.
2. Elimina l'attivatore che hai creato:

   gcloud eventarc triggers delete events-pubsub-trigger

3. In alternativa, puoi eliminare il progetto Google Cloud per evitare addebiti. L'eliminazione di un progetto Google Cloud interrompe la fatturazione per tutte le risorse utilizzate all'interno del 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à in questo documento, quando lo elimini elimini anche qualsiasi altro lavoro 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.

   Elimina un progetto Google Cloud:

   gcloud projects delete PROJECT_ID

Passaggi successivi

• Controlla l'ordine di esecuzione in un flusso di lavoro

• Crea un trigger per instradare gli eventi Pub/Sub a Workflows