Il workflow potrebbe dover attendere un processo esterno. Puoi utilizzare i callback HTTP per attendere che un altro servizio effettui una richiesta a un endpoint di callback; questa richiesta riprende l'esecuzione del flusso di lavoro. Puoi anche attendere utilizzando il polling.
Anziché utilizzare il polling, questo tutorial mostra come attendere eventi o messaggi Pub/Sub utilizzando i callback HTTP e i trigger Eventarc. Sebbene tu possa attivare un workflow con eventi o messaggi Pub/Sub, potresti voler interrompere l'esecuzione per attendere un altro evento prima di continuare. Ad esempio, un evento attiva un workflow per avviare un processo, ma il workflow deve attendere un altro evento che segnala che il processo è completato. Puoi implementarlo facendo in modo che un flusso di lavoro richiami un altro flusso di lavoro.
Obiettivi
In questo tutorial, si verifica quanto segue:
Un flusso di lavoro principale che deve attendere gli eventi viene implementato ed eseguito. Poiché deve attendere che si verifichino gli eventi, memorizza i dettagli del callback in un database Firestore in modo che il flusso di lavoro secondario possa recuperarli. Il flusso di lavoro principale attende quindi le chiamate HTTP.
Un flusso di lavoro secondario viene attivato dagli eventi e recupera i dettagli del callback dal database Firestore quando vengono generati gli eventi. Il flusso di lavoro secondario richiama quindi il flusso di lavoro principale, che riprende l'esecuzione.
Ecco una panoramica dell'intera procedura:
Workflow principale:
- Un flusso di lavoro
callback-event-sample
crea endpoint di callback per due origini eventi: un argomento Pub/Sub e un bucket Cloud Storage. - Questo flusso di lavoro memorizza entrambi gli endpoint di callback in un documento Firestore.
- Questo flusso di lavoro interrompe l'esecuzione e attende l'arrivo delle richieste HTTP agli endpoint di callback.
Eventi:
- Si verificano eventi: un messaggio viene pubblicato in un argomento Pub/Sub e un file viene caricato in un bucket Cloud Storage.
Workflow secondario:
- Eventarc indirizza gli eventi al flusso di lavoro
callback-event-listener
e ne attiva l'esecuzione. - Questo flusso di lavoro recupera gli URL endpoint di callback appropriati dal documento Firestore.
- Questo flusso di lavoro esegue i callback agli endpoint appropriati nel flusso di lavoro di esempio.
Workflow principale:
- Il flusso di lavoro
callback-event-sample
riceve gli eventi negli endpoint di callback e riprende l'esecuzione. - Questo flusso di lavoro elimina gli URL di callback dal documento Firestore e completa l'esecuzione.
Costi
In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il calcolatore prezzi.
Prima di iniziare
Puoi eseguire i seguenti comandi nella console Google Cloud o utilizzando Google Cloud CLI nel terminale o in Cloud Shell.
I vincoli di sicurezza definiti dalla tua organizzazione potrebbero impedirti di completare i passaggi seguenti. Per informazioni sulla risoluzione dei problemi, vedi Sviluppare applicazioni in un ambiente Google Cloud vincolato.
Console
Nella console Google Cloud , nella pagina di selezione del progetto, seleziona o crea un progetto Google Cloud .
Verifica che la fatturazione sia attivata per il tuo progetto Google Cloud . Scopri come verificare se la fatturazione è abilitata per un progetto.
Abilita le API App Engine, Eventarc, Firestore, Pub/Sub e Workflows.
Crea un account di servizio da utilizzare per l'autenticazione con altri servizi Google Cloud e concedigli i ruoli appropriati:
Nella console Google Cloud , vai alla pagina Service Accounts.
Per andare alla pagina Crea service account, seleziona il tuo progetto.
Nel campo Nome account di servizio, inserisci un nome. La console Google Cloud compila il campo ID service account in base a questo nome.
Nel campo Descrizione service account, inserisci una descrizione. Ad esempio,
Service account for tutorial
.Fai clic su Crea e continua.
Nell'elenco Seleziona un ruolo, filtra i seguenti ruoli da concedere alaccount di serviziot gestito dall'utente che hai creato nel passaggio precedente:
- Utente Cloud Datastore: per accedere ai dati di Firestore in modalità Datastore (Datastore).
- Eventarc Event Receiver: per ricevere eventi dai provider di eventi.
- Writer log: per scrivere i log.
- Workflows Invoker: per eseguire i flussi di lavoro e gestire le esecuzioni.
Per altri ruoli, fai clic su
Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.Fai clic su Continua.
Per completare la creazione dell'account, fai clic su Fine.
Per creare un trigger Eventarc che esegue il routing degli eventi da Cloud Storage, concedi il ruolo Publisher Pub/Sub all'agente di servizio Cloud Storage. In genere, questo valore è
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
. Puoi recuperare l'indirizzo email dell'agente di servizio Cloud Storage.Nella console Google Cloud , vai alla pagina IAM.
Nella riga dell'agente di servizio Cloud Storage, fai clic su
Modifica entità. (Se l'agente di assistenza non è elencato, vai al passaggio successivo.) Viene visualizzato il riquadro Modifica accesso.- Fai clic su addAggiungi un altro ruolo e poi cerca il ruolo Publisher Pub/Sub.
- Seleziona il ruolo.
- Fai clic su Salva.
Se l'agente di servizio non è presente nell'elenco, fai clic su
Concedi accesso. Viene visualizzato il riquadro Concedi l'accesso.- Nel campo Nuove entità, inserisci l'indirizzo email dell'agente di servizio.
- Nell'elenco Seleziona un ruolo, cerca il ruolo Publisher Pub/Sub.
- Seleziona il ruolo.
- Fai clic su Salva.
gcloud
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Verifica che la fatturazione sia attivata per il tuo progetto Google Cloud . Scopri come verificare se la fatturazione è abilitata per un progetto.
Abilita le API App Engine, Eventarc, Firestore, Pub/Sub e Workflows.
gcloud services enable \ appengine.googleapis.com \ eventarc.googleapis.com \ firestore.googleapis.com \ pubsub.googleapis.com \ workflows.googleapis.com
Crea un account di servizio da utilizzare per l'autenticazione con altri servizi Google Cloud e concedigli i ruoli appropriati.
Crea l'account di servizio:
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
Sostituisci
SERVICE_ACCOUNT_NAME
con un nome per ilaccount di serviziot.Concedi ruoli al account di servizio gestito dall'utente che hai creato nel passaggio precedente. Esegui il seguente comando una volta per ciascuno dei seguenti ruoli IAM:
roles/datastore.user
: per accedere ai dati di Firestore in modalità Datastore (Datastore).roles/eventarc.eventReceiver
: per ricevere eventi dai provider di eventi.roles/logging.logWriter
: per scrivere i log.roles/workflows.invoker
: per eseguire i workflow e gestire le esecuzioni.
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \ --role=ROLE
Sostituisci quanto segue:
PROJECT_ID
: l'ID progetto in cui hai creato il account di servizioROLE
: il ruolo da concedere
Per creare un trigger Eventarc che esegue il routing degli eventi da Cloud Storage, concedi il ruolo Publisher Pub/Sub all'agente di servizio Cloud Storage. In genere, questo valore è
service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com
. Utilizzagcloud storage service-agent
per recuperare prima l'agente di servizio Cloud Storage.SERVICE_ACCOUNT_STORAGE="$(gcloud storage service-agent --project=PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$SERVICE_ACCOUNT_STORAGE \ --role=roles/pubsub.publisher
Crea un database Firestore
Firestore archivia i dati in documenti che contengono campi che corrispondono ai valori. Questi documenti vengono archiviati in raccolte, che sono contenitori per i documenti che puoi utilizzare per organizzare i dati e creare query. Scopri di più su Firestore.
Tieni presente che ogni Google Cloud progetto è limitato a un database Firestore. Completa i seguenti passaggi se devi creare un nuovo database.
Console
Nella console Google Cloud , vai alla pagina Guida introduttiva di Firestore.
Fai clic su Seleziona modalità Native.
Per indicazioni sulla selezione di una modalità di database e per un confronto delle funzionalità, vedi Scelta tra la modalità nativa e la modalità Datastore.
Nell'elenco Seleziona una località, seleziona nam5 (Stati Uniti).
La località si applica sia al database Firestore sia all'applicazione App Engine nel tuo progetto Google Cloud . Una volta creato il database, non puoi modificarne la posizione.
Fai clic su Crea database.
gcloud
Per creare un database Firestore, devi prima creare un'applicazione App Engine ed eseguire il comando
gcloud firestore databases create
:
gcloud app create --region=us-central gcloud firestore databases create --region=us-central
Puoi ignorare l'avviso us-central is not a valid Firestore location
.
App Engine e Firestore supportano le stesse località, ma la regione us-central
(Iowa) di App Engine corrisponde alla multi-regione nam5
(Stati Uniti) di Firestore.
crea un argomento Pub/Sub
Questo tutorial utilizza Pub/Sub come origine eventi. Crea un argomento Pub/Sub in modo da poter pubblicare un messaggio. Scopri di più sulla creazione e sulla gestione degli argomenti.
Console
Nella console Google Cloud , vai alla pagina Argomenti di Pub/Sub.
Fai clic su
Crea argomento.Nel campo ID argomento, inserisci
topic-callback
.Accetta gli altri valori predefiniti.
Fai clic su Crea argomento.
gcloud
Per creare un argomento, esegui il comando
gcloud pubsub topics create
:
gcloud pubsub topics create topic-callback
Crea un bucket Cloud Storage
Questo tutorial utilizza Cloud Storage come origine evento. Crea un bucket Cloud Storage in modo da poter caricare un file. Scopri di più sulla creazione di bucket di archiviazione.
Console
Nella console Google Cloud , vai alla pagina Bucket in Cloud Storage.
Fai clic su
Crea.Come Nome del bucket, inserisci
PROJECT_ID-bucket-callback
.L'ID progetto viene utilizzato nel flusso di lavoro
callback-event-sample
per identificare il bucket.Fai clic su Continua.
In Tipo di località, seleziona Regione e poi us-central1 (Iowa).
Accetta gli altri valori predefiniti.
Fai clic su Crea.
gcloud
Per creare un bucket, esegui il comando
gcloud storage buckets create
:
gcloud storage buckets create gs://PROJECT_ID-bucket-callback \ --location=us-central1
L'ID progetto
viene utilizzato nel flusso di lavoro callback-event-sample
per identificare il bucket.
Dopo aver creato le origini eventi, puoi eseguire il deployment del flusso di lavoro del ricevitore di eventi.
Deployment di un flusso di lavoro in ascolto di eventi
Il flusso di lavoro callback-event-listener
viene attivato quando un messaggio viene pubblicato
in un argomento Pub/Sub o quando un file viene caricato in un bucket Cloud Storage. Il flusso di lavoro riceve l'evento, recupera i dettagli di callback appropriati dal database Firestore e poi invia una richiesta HTTP all'endpoint di callback.
Console
Nella console Google Cloud , vai alla pagina Workflows:
Fai clic su
Crea.Inserisci un nome per il nuovo flusso di lavoro:
callback-event-listener
.Nell'elenco Regione, seleziona us-central1.
Seleziona l'account di servizio che hai creato in precedenza.
Fai clic su Avanti.
Nell'editor del workflow, inserisci la seguente definizione per il workflow:
Fai clic su Esegui il deployment.
gcloud
Crea un file di codice sorgente per il workflow:
touch callback-event-listener.yaml
In un editor di testo, copia il seguente flusso di lavoro nel file del codice sorgente:
Esegui il deployment del flusso di lavoro inserendo questo comando:
gcloud workflows deploy callback-event-listener \ --source=callback-event-listener.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Sostituisci
SERVICE_ACCOUNT_NAME
con il nome del account di servizio che hai creato in precedenza.
Esegui il deployment di un workflow che attende eventi
Il flusso di lavoro callback-event-sample
archivia i dettagli del callback in un database Firestore, interrompe l'esecuzione e attende che si verifichino eventi specifici.
Console
Nella console Google Cloud , vai alla pagina Workflows:
Fai clic su
Crea.Inserisci un nome per il nuovo flusso di lavoro:
callback-event-sample
.Nell'elenco Regione, seleziona us-central1.
Seleziona l'account di servizio che hai creato in precedenza.
Fai clic su Avanti.
Nell'editor del workflow, inserisci la seguente definizione per il workflow:
Fai clic su Esegui il deployment.
gcloud
Crea un file di codice sorgente per il workflow:
touch callback-event-sample.yaml
In un editor di testo, copia il seguente flusso di lavoro nel file del codice sorgente:
Esegui il deployment del flusso di lavoro inserendo questo comando:
gcloud workflows deploy callback-event-sample \ --source=callback-event-sample.yaml \ --location=us-central1 \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Sostituisci
SERVICE_ACCOUNT_NAME
con il nome del account di servizio che hai creato in precedenza.
Crea un trigger Eventarc per il routing degli eventi Pub/Sub
Un trigger Eventarc consente di instradare gli eventi specificando
i filtri per il trigger, inclusi l'origine evento e il workflow di destinazione.
Crea un trigger Eventarc per eseguire il flusso di lavoro callback-event-listener
in seguito alla pubblicazione di un messaggio in un argomento Pub/Sub.
Scopri di più sull'attivazione di un workflow.
Console
Nella Google Cloud console, vai alla pagina Eventarc.
Fai clic su
Crea trigger.Digita un Nome trigger.
Ad esempio,
trigger-pubsub-events-listener
.Nell'elenco Provider di eventi, seleziona Cloud Pub/Sub.
Nell'elenco Evento, seleziona google.cloud.pubsub.topic.v1.messagePublished in Personalizzato.
Nell'elenco Seleziona un argomento Cloud Pub/Sub, seleziona l'argomento che hai creato in precedenza.
Nell'elenco Regione, seleziona us-central1 (Iowa).
Se richiesto, concedi il ruolo
iam.serviceAccountTokenCreator
all'account di servizio Pub/Sub.Seleziona l'account di servizio che hai creato in precedenza.
Nell'elenco Destinazione evento, seleziona Workflows.
Nell'elenco Seleziona un workflow, seleziona il workflow callback-event-listener.
Fai clic su Crea.
gcloud
Per creare un trigger, esegui il comando
gcloud eventarc triggers create
:
gcloud eventarc triggers create trigger-pubsub-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --transport-topic=topic-callback \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Gli eventi vengono trasformati e passati all'esecuzione del flusso di lavoro come argomenti runtime. Tieni presente che l'attivazione del nuovo trigger può richiedere fino a 2 minuti.
Crea un trigger Eventarc per il routing degli eventi di Cloud Storage
Un trigger Eventarc consente di instradare gli eventi specificando
i filtri per il trigger, inclusi l'origine evento e il workflow di destinazione.
Crea un trigger Eventarc per eseguire il flusso di lavoro callback-event-listener
in seguito al caricamento di un file in un bucket Cloud Storage.
Scopri di più sull'attivazione di un workflow.
Console
Nella console Google Cloud , vai alla pagina Eventarc.
Fai clic su
Crea trigger.Digita un Nome trigger.
Ad esempio,
trigger-storage-events-listener
.Nell'elenco Provider di eventi, seleziona Cloud Storage.
Nell'elenco Evento, in Diretti, seleziona google.cloud.storage.object.v1.finalized.
Nell'elenco Bucket, cerca il bucket che hai creato in precedenza e selezionalo.
Nell'elenco Regione, in base al bucket Cloud Storage, accetta il valore predefinito us-central1 (Iowa).
Se richiesto, concedi il ruolo
iam.serviceAccountTokenCreator
all'account di servizio Pub/Sub.Seleziona l'account di servizio che hai creato in precedenza.
Nell'elenco Destinazione evento, seleziona Workflows.
Nell'elenco Seleziona un workflow, seleziona il workflow callback-event-listener.
Fai clic su Crea.
gcloud
Per creare un trigger, esegui il comando
gcloud eventarc triggers create
:
gcloud eventarc triggers create trigger-storage-events-listener \ --location=us-central1 \ --destination-workflow=callback-event-listener \ --destination-workflow-location=us-central1 \ --event-filters="type=google.cloud.storage.object.v1.finalized" \ --event-filters="bucket=PROJECT_ID-bucket-callback" \ --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Gli eventi vengono trasformati e passati all'esecuzione del flusso di lavoro come argomenti runtime. Tieni presente che l'attivazione del nuovo trigger può richiedere fino a 2 minuti.
Esegui il workflow principale
L'esecuzione di un workflow esegue la definizione attuale del workflow associata al workflow. Esegui il workflow callback-event-sample
. Questo è il workflow
principale e attende che si verifichino eventi specifici, riprendendo l'esecuzione
solo quando il workflow secondario effettua le richieste di callback appropriate.
Console
Nella Google Cloud console, vai alla pagina Workflows.
Nella pagina Workflows, fai clic sul flusso di lavoro callback-event-sample per accedere alla relativa pagina dei dettagli.
Nella pagina Dettagli workflow, fai clic su play_arrow Esegui.
Fai di nuovo clic su Esegui.
Viene avviata l'esecuzione del workflow. Durante l'esecuzione, dovresti vedere uno Stato di esecuzione
Running
e una voce di log simile alla seguente:Started waiting 1hr for an event from source topic-callback
.
gcloud
Per eseguire un workflow, esegui il comando
gcloud workflows run
:
gcloud workflows run callback-event-sample \ --location=us-central1
Viene avviata l'esecuzione del workflow. Durante l'esecuzione, dovresti vedere uno stato di esecuzione simile al seguente:
Waiting for execution [a848a164-268a-449c-b2fe-396f32f2ed66] to complete...working...
Generare eventi e controllare lo stato di esecuzione
Puoi verificare che i risultati siano quelli previsti generando eventi, visualizzando le voci di log e controllando lo stato di esecuzione del workflow.
Pubblica un messaggio
Pubblica un messaggio nell'argomento Pub/Sub che hai creato in precedenza.
Console
Nella console Google Cloud , vai alla pagina Argomenti di Pub/Sub.
Fai clic su topic-callback.
Fai clic sulla scheda Messaggi.
Fai clic su Pubblica messaggio.
Nel campo Corpo del messaggio, inserisci
Hello World
.Fai clic su Pubblica.
gcloud
Per pubblicare un messaggio, utilizza il comando gcloud pubsub topics publish:
gcloud pubsub topics publish topic-callback \ --message="Hello World"
Caricamento di un oggetto
Carica un file nel bucket Cloud Storage che hai creato in precedenza.
Console
- Nella console Google Cloud , vai alla pagina Bucket in Cloud Storage.
Fai clic sul nome del bucket che hai creato in precedenza.
Nella scheda Oggetti, esegui una delle seguenti operazioni:
Trascina il file desiderato dal desktop o dal file manager nel riquadro principale della console Google Cloud .
Fai clic su Carica file, seleziona il file che vuoi caricare e poi fai clic su Apri.
gcloud
Per caricare un file, esegui il comando gcloud storage cp
:
gcloud storage cp OBJECT_LOCATION gs://PROJECT_ID-bucket-callback/
Sostituisci OBJECT_LOCATION
con il percorso locale del tuo
oggetto. Ad esempio, random.txt
.
Visualizzare le voci di log e lo stato di esecuzione
Verifica che il flusso di lavoro callback-event-sample
sia stato completato correttamente.
Console
Nella Google Cloud console, vai alla pagina Workflows.
Nella pagina Workflows, fai clic sul flusso di lavoro callback-event-sample per accedere alla relativa pagina dei dettagli.
Nella pagina Dettagli del flusso di lavoro, per recuperare i dettagli di una determinata esecuzione, fai clic sull'ID esecuzione appropriato.
Lo stato di esecuzione deve essere Succeeded e, nel riquadro Output, dovresti vedere gli eventi Pub/Sub e Cloud Storage ricevuti.
gcloud
Filtra le voci di log e restituisci l'output in formato JSON:
gcloud logging read "resource.type=workflows.googleapis.com/Workflow AND textPayload:calling OR textPayload:waiting" \ --format=json
Cerca voci di log simili a:
"textPayload": "Stopped waiting for an event from source..." "textPayload": "Calling back url https://workflowexecutions.googleapis.com/v1/projects/..." "textPayload": "Started waiting 1hr for an event from source..."
Controlla lo stato dell'ultimo tentativo di esecuzione:
gcloud workflows executions wait-last
Il risultato dovrebbe essere simile al seguente:
Using cached execution name: projects/1085953646031/locations/us-central1/workflows/callback-event-sample/executions/79929e4e-82c1-4da1-b068-f828034c01b7 Waiting for execution [79929e4e-82c1-4da1-b068-f828034c01b7] to complete...done. [...] state: SUCCEEDED
Esegui la pulizia
Se hai creato un nuovo progetto per questo tutorial, elimina il progetto. Se hai utilizzato un progetto esistente e vuoi conservarlo senza le modifiche aggiunte in questo tutorial, elimina le risorse create per il tutorial.
Elimina il progetto
Il modo più semplice per eliminare la fatturazione è eliminare il progetto creato per il tutorial.
Per eliminare il progetto:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Eliminare le risorse create in questo tutorial
Passaggi successivi
- Prova il tutorial Crea un workflow human-in-the-loop utilizzando i callback.