Attiva Workflows con eventi diretti da Cloud Storage (gcloud CLI)

Imposta le variabili di ambiente

Imposta le variabili di ambiente utilizzate in questa guida rapida.

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

Puoi trovare l'ID progetto nella pagina Benvenuto della console Google Cloud .

Configura gli account di servizio

Concedi le autorizzazioni richieste ai service account utilizzati in questa guida rapida.

1. Se hai creato il progetto, ti viene assegnato il ruolo di base Proprietario (roles/owner). Per impostazione predefinita, questo ruolo 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 il creatore del progetto, le autorizzazioni richieste devono essere concesse al principal appropriato. 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 calcolo). Per saperne di più, consulta la pagina Ruoli e autorizzazioni per la destinazione eventi.

   Autorizzazioni obbligatorie

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

   • Amministratore Eventarc (roles/eventarc.admin)
   • Logs View Accessor (roles/logging.viewAccessor)
   • Amministratore IAM progetto (roles/resourcemanager.projectIamAdmin)
   • Amministratore account di servizio (roles/iam.serviceAccountAdmin)
   • Utente service account (roles/iam.serviceAccountUser)
   • Amministratore utilizzo servizi (roles/serviceusage.serviceUsageAdmin)
   • Amministratore spazio di archiviazione (roles/storage.admin)
   • Workflows Admin (roles/workflows.admin)

   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.

2. Prendi nota dell'Account di servizio predefinito di Compute Engine, in quanto lo collegherai a un trigger Eventarc per rappresentare l'identità del trigger a scopo di test. Questo account di servizio viene creato automaticamente dopo l'attivazione o l'utilizzo di un servizio Google Cloud che utilizza Compute Engine e con il seguente formato email:

   PROJECT_NUMBER-compute@developer.gserviceaccount.com

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

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

   Per gli ambienti di produzione, ti consigliamo vivamente di creare un nuovo service account e di concedergli uno o più ruoli IAM che contengano le autorizzazioni minime richieste e di seguire il principio del privilegio minimo.

3. Concedi il ruolo Destinatario di eventi Eventarc (roles/eventarc.eventReceiver) nel progetto al account di servizio predefinito di Compute Engine in modo che il trigger Eventarc possa ricevere eventi dai provider di eventi.

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
       --role=roles/eventarc.eventReceiver

4. Concedi il ruolo Invoker di Workflows (roles/workflows.invoker) sul progetto all'account di servizio Compute Engine predefinito 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:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
       --role=roles/workflows.invoker

5. Concedi il ruolo Writer log Logging (roles/logging.logWriter) sul progetto al account di servizio Compute Engine predefinito in modo che il flusso di lavoro possa inviare i log a Cloud Logging.

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
       --role=roles/logging.logWriter

6. Prima di creare un trigger per gli eventi diretti da Cloud Storage, concedi il ruolo Publisher Pub/Sub (roles/pubsub.publisher) all'agente di servizio Cloud Storage:

   SERVICE_ACCOUNT="$(gcloud storage service-agent --project=PROJECT_ID)"
   
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member="serviceAccount:${SERVICE_ACCOUNT}" \
       --role='roles/pubsub.publisher'

7. Se hai attivato l'agente di servizio Cloud Pub/Sub l'8 aprile 2021 o in una data precedente, per supportare le richieste push Pub/Sub autenticate, concedi il ruolo Creatore token account di servizio (roles/iam.serviceAccountTokenCreator) all'agente di servizio. In caso contrario, questo ruolo viene concesso per impostazione predefinita:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
       --role=roles/iam.serviceAccountTokenCreator

Crea un bucket Cloud Storage

Crea un bucket Cloud Storage da utilizzare come origine evento:

  gcloud storage buckets create gs://${PROJECT_ID}-bucket --location=us-central1

Crea ed esegui il deployment di un flusso di lavoro

Crea e sottoponi a deployment un flusso di lavoro eseguito quando un oggetto creato nel bucket Cloud Storage attiva un flusso di lavoro con una richiesta HTTP.

1. Nella tua home directory, crea un nuovo file denominato myEventWorkflow.yaml o myEventWorkflow.json.

2. Copia e incolla quanto segue nel nuovo file e salvalo:

   YAML

     main:
       params: [event]
       steps:
           - log_event:
               call: sys.log
               args:
                   text: ${event}
                   severity: INFO
           - extract_bucket_object:
               assign:
               - bucket: ${event.data.bucket}
               - object: ${event.data.name}
           - return_bucket_object:
                   return:
                       bucket: ${bucket}
                       object: ${object}
     

   JSON

   {
   "main": {
   "params": [
     "event"
   ],
   "steps": [
     {
       "log_event": {
         "call": "sys.log",
         "args": {
           "text": "${event}",
           "severity": "INFO"
         }
       }
     },
     {
       "extract_bucket_object": {
         "assign": [
           {
             "bucket": "${event.data.bucket}"
           },
           {
             "object": "${event.data.name}"
           }
         ]
       }
     },
     {
       "return_bucket_object": {
         "return": {
           "bucket": "${bucket}",
           "object": "${object}"
         }
       }
     }
   ]
   }
   }

3. Esegui il deployment del flusso di lavoro:

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

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

Crea un trigger Eventarc

Il trigger Eventarc invia eventi dal bucket Cloud Storage alla destinazione Workflows.

1. Crea un trigger che filtra gli eventi Cloud Storage:

   gcloud eventarc triggers create storage-events-trigger \
       --destination-workflow=${MY_WORKFLOW} \
       --event-filters="type=google.cloud.storage.object.v1.finalized" \
       --event-filters="bucket=${PROJECT_ID}-bucket" \
       --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"
   

   Viene creato un trigger denominato storage-events-trigger.

   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. Questo problema può essere risolto di solito riprovando a creare il trigger. Per saperne di più, vedi Errori di autorizzazione negata.

2. Per confermare che storage-events-trigger è stato creato correttamente, esegui:

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

   L'output dovrebbe essere simile al seguente, con l'elenco dell'ora di creazione e della posizione del trigger:

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

Generare e visualizzare un evento

1. Per generare un evento, carica un file di testo in Cloud Storage:

   echo "Hello World" > random.txt
   gcloud storage cp random.txt gs://${PROJECT_ID}-bucket/random.txt
   

   Il caricamento genera un evento che viene passato come argomento runtime al flusso di lavoro, che restituisce i nomi del bucket di archiviazione e del file caricato.

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

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

   L'output dovrebbe essere simile al seguente ed elencare valori NAME e STATE pari 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-10-13T03:38:03.019148617Z
   END_TIME: 2021-10-13T03:38:03.249705805Z
   NAME: projects/606789101455/locations/us-central1/workflows/myFirstWorkflow/executions/a6319d9d-36a6-4117-904e-3d1118bdc90a
   STATE: SUCCEEDED
   START_TIME: 2021-10-13T17:28:51.492864252Z
   END_TIME: 2021-10-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 così come viene utilizzato nel passaggio successivo.

3. 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 che corrisponde all'ora in cui il file è stato caricato nel bucket.

   L'output è simile al seguente:

   argument: [...]
   name: projects/218898424763/locations/us-central1/workflows/myEventWorkflow/executions/86d2567b-0f1e-49b3-8b10-cdac5d0f6239
   result: '{"bucket":"PROJECT_ID-bucket","object":"random.txt"}'
   startTime: '2021-10-13T03:38:03.019148617Z'
   state: SUCCEEDED
   

4. Verifica che l'ora "timeCreated": "2021-10-13T03:38" in cui è stato aggiornato il bucket Cloud Storage e il startTime dell'esecuzione del flusso di lavoro corrispondano.

Congratulazioni, hai generato correttamente un evento Cloud Storage che ha attivato un destinatario di eventi Workflows utilizzando Eventarc.