Instradare gli eventi di Cloud Firestore a Workflows

Un trigger Eventarc dichiara il tuo interesse per un determinato evento o per una serie di eventi. Puoi configurare il routing degli eventi specificando i filtri per l'attivatore, inclusa l'origine evento e il flusso di lavoro di destinazione.

Gli eventi vengono pubblicati nel formato CloudEvents tramite una richiesta HTTP. Il servizio Workflows converte l'evento in un oggetto JSON (secondo la specifica CloudEvents) e lo passa all'esecuzione del flusso di lavoro come argomento di runtime del flusso di lavoro. Assicurati che le dimensioni dell'evento non superino i 512 KB. Gli eventi più grandi della dimensione massima degli argomenti di Workflows non attiveranno le esecuzioni dei flussi di lavoro.

Cloud Firestore supporta Auth Context come attributo di estensione del formato CloudEvents. Quando crei un attivatore, puoi applicare questo attributo del tipo di evento per filtrare gli eventi con informazioni sull'autenticazione.

Queste istruzioni mostrano come configurare il routing degli eventi in modo che un'esecuzione del tuo workflow venga attivata in risposta a un eventoCloud Firestore diretto. Per maggiori dettagli, consulta l'elenco degli eventi diretti supportati.

Prepararsi a creare un trigger

Prima di creare un attivatore Eventarc per un flusso di lavoro di destinazione, completa le seguenti attività.

Console

  1. Nella console Google Cloud, nella pagina di selezione del progetto, seleziona o crea un Google Cloud progetto.

    Vai al selettore dei progetti

  2. Abilita le API Eventarc, Eventarc Publishing, Workflows e Workflow Executions.

    Abilita le API

  3. Se applicabile, abilita l'API relativa agli eventi diretti. Ad esempio, per Cloud Firestore gli eventi, abilita l'Cloud Firestore API.

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedi i ruoli e le autorizzazioni necessari affinché Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

    1. Nella console Google Cloud, vai alla pagina Account di servizio.

      Vai a Service account

    2. Seleziona il progetto.

    3. Inserisci un nome nel campo Nome account di servizio. La console Google Cloud compila il campo ID account di servizio in base a questo nome.

      Nel campo Descrizione account di servizio, inserisci una descrizione. Ad esempio, Service account for event trigger.

    4. Fai clic su Crea e continua.

    5. Per fornire l'accesso appropriato, nell'elenco Seleziona un ruolo, seleziona i ruoli IAM (Identity and Access Management) richiesti da concedere all'account di servizio. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per i target di flusso di lavoro.

      Per altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.

    6. Fai clic su Continua.

    7. Per completare la creazione dell'account, fai clic su Fine.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    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.

  2. Abilita le API Eventarc, Eventarc Publishing, Workflows e Workflow Executions:

    gcloud services enable eventarc.googleapis.com \
    eventarcpublishing.googleapis.com \
    workflows.googleapis.com \
    workflowexecutions.googleapis.com

  3. Se applicabile, abilita l'API relativa agli eventi diretti. Ad esempio, per Cloud Firestore eventi, attivafirestore.googleapis.com.

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedi i ruoli e le autorizzazioni necessari affinché Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

    1. Crea l'account di servizio:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Sostituisci SERVICE_ACCOUNT_NAME con il nome dell'account di servizio. Deve essere compreso tra 6 e 30 caratteri e può contenere caratteri alfanumerici minuscoli e trattini. Una volta creato un account di servizio, non puoi modificarne il nome.

    2. Concedi i ruoli o le autorizzazioni IAM (Identity and Access Management) richiesti. Per saperne di più, consulta Ruoli e autorizzazioni per i target di flusso di lavoro.

Crea un trigger

Puoi creare un attivatore Eventarc con un flusso di lavoro di cui è stato eseguito il deployment come destinatario di eventi utilizzando Google Cloud CLI (gcloud o Terraform) o tramite la console Google Cloud.

Console

  1. Nella console Google Cloud, vai alla pagina Eventarc Trigger.

    Vai ai trigger

  2. Fai clic su Crea trigger.
  3. Digita un Nome trigger.

    Si tratta dell'ID dell'attivatore e deve iniziare con una lettera. Può contenere fino a 63 lettere minuscole, numeri o trattini.

  4. Per Tipo di attivatore, seleziona Origini Google.
  5. Nell'elenco Provider di eventi, seleziona Cloud Firestore.

    Tieni presente che il nome del provider di eventi utilizzato nella documentazioneGoogle Cloud associata potrebbe non avere un prefisso Cloud o Google Cloud. Ad esempio, nella console, Memorystore for Redis è indicato come Google Cloud Memorystore for Redis.

  6. Nell'elenco Tipo di evento, seleziona un tipo di evento dagli eventi Diretti.
  7. Nell'elenco Tipo di contenuti dei dati evento, seleziona la codifica del payload dell'evento.

    Per gli eventi diretti da Cloud Firestore, deve essere application/protobuf e i dati dell'evento sono un array di byte. Per saperne di più sui messaggi protobuf per gli eventi Cloud Firestore, consulta Eventi comuni. Tieni presente che puoi utilizzare una funzione della libreria standard di Workflows per codificare i byte in testo Base64. Per ulteriori informazioni, consulta la sezione Restituire byte.

  8. Nell'elenco Regione, seleziona la stessa regione del Google Cloud servizio che genera gli eventi.

    Per ulteriori informazioni, consulta Località Eventarc.

  9. Se applicabile al provider di eventi, fai clic su Aggiungi filtro e specifica quanto segue:
    1. Nel campo Attributo 1, a seconda dell'evento diretto scelto, seleziona un ID risorsa che possa fungere da filtro per gli eventi.
    2. Seleziona un operatore:
      • Uguale
      • Pattern percorso: applicabile alle risorse document (modalità Native) e entity (modalità Datastore). Utilizza i caratteri jolly per rispondere alle modifiche che corrispondono a un pattern. Un carattere jolly * corrisponde a un singolo segmento, mentre un carattere jolly per più segmenti ** corrisponde a zero o più segmenti nel pattern. Ad esempio:
        /users/* o /users/{userId} Corrisponde a tutti i documenti della raccolta /users. Non corrisponde ai documenti nelle sottocollezioni come /users/marie/messages/33e2IxYBD9enzS50SJ68
        /users/** Corrisponde a tutti i documenti della raccolta /users e ai documenti delle sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68

        Per ulteriori informazioni, consulta Informazioni sui pattern di percorso.

    3. Nel campo Valore attributo 1, a seconda dell'operatore scelto, digita il valore esatto o applica un pattern di percorso.
    4. Se sono applicabili altri filtri degli attributi, fai clic su Aggiungi filtro e specifica i valori appropriati.
  10. Seleziona l'account di servizio che chiamerà il servizio o il flusso di lavoro.

    In alternativa, puoi creare un nuovo account di servizio.

    Specifica l'indirizzo email dell'account di servizio Identity and Access Management (IAM) associato all'attivatore e a cui hai precedentemente assegnato ruoli specifici richiesti da Eventarc.

  11. Nell'elenco Destinazione evento, seleziona Workflows.
  12. Seleziona un flusso di lavoro.

    Questo è il nome del flusso di lavoro a cui devono essere trasmessi gli eventi. Gli eventi per un'esecuzione del flusso di lavoro vengono trasformati e passati al flusso di lavoro come argomenti di runtime.

    Per ulteriori informazioni, consulta Creare un attivatore per Workflows.

  13. Fai clic su Crea.

    14. Una volta creato un attivatore, i filtri delle origini evento non possono essere modificati. Crea invece un nuovo attivatore ed elimina quello precedente. Per saperne di più, consulta Gestire gli attivatori.

gcloud

Puoi creare un trigger eseguendo un gcloud eventarc triggers create comando insieme a flag obbligatori e facoltativi.

I flag variano a seconda che tu stia utilizzando Firestore in modalità Native o in modalità Datastore. Per ulteriori informazioni, consulta la sezione Scegliere tra la modalità nativa e la modalità Datastore.

Modalità nativa

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-workflow=DESTINATION_WORKFLOW  \
    --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="database=DATABASE" \
    --event-filters="namespace=NAMESPACE" \
    --event-filters-path-pattern="document=DOCUMENT" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

Modalità Datastore

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-workflow=DESTINATION_WORKFLOW  \
    --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="database=DATABASE" \
    --event-filters="namespace=NAMESPACE" \
    --event-filters-path-pattern="entity=ENTITY" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

Sostituisci quanto segue:

  • TRIGGER: l'ID dell'attivatore o un identificatore completamente qualificato.

  • LOCATION: la posizione dell'attivatore Eventarc. In alternativa, puoi impostare la proprietà eventarc/location, ad esempio gcloud config set eventarc/location us-central1.

    Gli attivatori Cloud Firestore per Eventarc sono disponibili solo in determinate località e devono trovarsi nella stessa località del database Cloud Firestore. Per ulteriori informazioni, consulta Località di Eventarc e Località di Cloud Firestore.

  • DESTINATION_WORKFLOW: l'ID del workflow di cui è stato eseguito il deployment che riceve gli eventi dall'attivatore. Il workflow può trovarsi in una delle località supportate per i workflow e non deve trovarsi nella stessa località dell'attivatore. Tuttavia, il flusso di lavoro deve trovarsi nello stesso progetto dell'attivatore.
  • DESTINATION_WORKFLOW_LOCATION (facoltativo): la posizione in cui viene eseguito il deployment del flusso di lavoro di destinazione. Se non specificato, si presume che il flusso di lavoro si trovi nella stessa posizione dell'attivatore.
  • EVENT_FILTER_TYPE: l'identificatore dell'evento. Viene generato un evento quando una chiamata API per il metodo ha esito positivo. Per le operazioni a lunga esecuzione, l'evento viene generato solo al termine dell'operazione e solo se l'azione viene eseguita correttamente. Per un elenco dei tipi di eventi supportati, consulta Tipi di eventi Google supportati da Eventarc.

    • Cloud Firestore supporta i seguenti tipi di eventi solo in modalità nativa.

    • google.cloud.firestore.document.v1.created: viene inviato quando viene scritto un documento per la prima volta
    • google.cloud.firestore.document.v1.created.withAuthContext: l'evento con gli attributi delle informazioni di autenticazione viene inviato quando viene scritto un documento per la prima volta
    • google.cloud.firestore.document.v1.updated: l'evento viene inviato quando un documento esiste già e un valore è stato modificato
    • google.cloud.firestore.document.v1.updated.withAuthContext: l'evento con gli attributi delle informazioni di autenticazione viene inviato quando esiste già un documento e un valore è stato modificato
    • google.cloud.firestore.document.v1.deleted: viene inviato quando viene eliminato un documento
    • google.cloud.firestore.document.v1.deleted.withAuthContext: l'evento con gli attributi delle informazioni di autenticazione viene inviato quando un documento viene eliminato
    • google.cloud.firestore.document.v1.written: l'evento viene inviato quando un documento viene creato, aggiornato o eliminato
    • google.cloud.firestore.document.v1.written.withAuthContext: l'evento con gli attributi delle informazioni di autenticazione viene inviato quando un documento viene creato, aggiornato o eliminato.

    Cloud Firestore supporta i seguenti tipi di eventi solo in modalità Datastore. Gli oggetti dati in Firestore in modalità Datastore sono noti come entità.

    • L'evento google.cloud.datastore.entity.v1.created viene inviato quando viene scritta un'entità per la prima volta
    • google.cloud.datastore.entity.v1.created.withAuthContext: evento con attributi delle informazioni di autenticazione viene inviato quando viene scritta per la prima volta un'entità
    • google.cloud.datastore.entity.v1.updated: l'evento viene inviato quando un'entità esistente viene modificata
    • google.cloud.datastore.entity.v1.updated.withAuthContext: l'evento con gli attributi delle informazioni di autenticazione viene inviato quando esiste già un'entità e un valore è stato modificato
    • google.cloud.datastore.entity.v1.deleted: l'evento viene inviato quando viene eliminata un'entità
    • google.cloud.datastore.entity.v1.deleted.withAuthContext: evento con attributi delle informazioni di autenticazione viene inviato quando un'entità viene eliminata
    • google.cloud.datastore.entity.v1.written: l'evento viene inviato quando un'entità viene creata, aggiornata o eliminata
    • google.cloud.datastore.entity.v1.written.withAuthContext: evento con attributi di informazioni sull'autenticazione inviato quando un'entità viene creata, aggiornata o eliminata
  • DATABASE: il database Firestore. Per il nome del database predefinito, utilizza (default).
  • NAMESPACE (facoltativo): il nome del Namespace del database Firestore. Per lo spazio dei nomi predefinito in modalità Datastore, utilizza (default). Se non specificato, viene eseguita una corrispondenza con caratteri jolly (*) per qualsiasi occorrenza.
  • DOCUMENT (facoltativo): applicabile alle istanze di database in esecuzione in modalità nativa. Il percorso del database da cui vuoi ricevere gli eventi quando i dati vengono creati, aggiornati o eliminati in quel percorso. L'operatore può essere uno dei seguenti:
    • Uguale; ad esempio, --event-filters="document=DOCUMENT"
    • Pattern del percorso, ad esempio --event-filters-path-pattern="document=DOCUMENT".

      Utilizza i caratteri jolly per rispondere alle modifiche nei documenti che corrispondono a un pattern. Un carattere jolly * corrisponde a un singolo segmento, mentre un carattere jolly per più segmenti ** corrisponde a zero o più segmenti nel pattern. Ad esempio:

      /users/* o /users/{userId} Corrisponde a tutti i documenti della raccolta /users. Non corrisponde ai documenti nelle sottocollezioni come /users/marie/messages/33e2IxYBD9enzS50SJ68
      /users/** Corrisponde a tutti i documenti della raccolta /users e ai documenti delle sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68
      Per ulteriori informazioni, consulta Informazioni sui pattern di percorso.
  • ENTITY (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità Datastore. Il percorso del database da cui vuoi ricevere gli eventi quando i dati vengono creati, aggiornati o eliminati in quel percorso. L'operatore può essere uno dei seguenti:
    • Uguale; ad esempio, --event-filters="document=ENTITY"
    • Pattern del percorso; ad esempio, --event-filters-path-pattern="ENTITY=ENTITY"

      Per ulteriori informazioni, consulta Informazioni sui pattern di percorso.

      Tieni presente che potresti dover eseguire l'escape dei caratteri negli ID tipo e negli ID entità. L'inserimento di un carattere di escape consente al filtro evento di interpretare correttamente l'ID. Per ulteriori informazioni, consulta la sezione relativa alla scappatoia dei caratteri.

  • EVENT_DATA_CONTENT_TYPE: la codifica del payload dell'evento. Per gli eventi diretti di Firestore, deve essere application/protobuf e i dati dell'evento sono un array di byte. Per maggiori informazioni sui messaggi protobuf per gli eventi Cloud Firestore, consulta Eventi comuni. Tieni presente che puoi utilizzare una funzione della libreria standard di Workflows per codificare i byte in testo Base64. Per ulteriori informazioni, consulta la sezione Restituire byte.
  • SERVICE_ACCOUNT_NAME: il nome dell'account di servizio IAM creato a cui hai concesso ruoli specifici richiesti da Workflows.
  • PROJECT_ID: il tuo Google Cloud ID progetto

Note:

  • Per gli eventi diretti da Cloud Firestore, la codifica del payload dell'evento è application/protobuf.
  • Il flag --event-filters="type=EVENT_FILTER_TYPE" è obbligatorio. Se non è impostato nessun altro filtro evento, vengono trovati corrispondenze per gli eventi di tutte le risorse.
  • EVENT_FILTER_TYPE non può essere modificato dopo la creazione. Per modificare EVENT_FILTER_TYPE, crea un nuovo attivatore ed elimina quello precedente.
  • Ogni attivatore può avere più filtri evento, separati da virgola in un singolo --event-filters=[ATTRIBUTE=VALUE,…] --event-filtersoppure puoi ripetere il flag per aggiungere altri filtri. Solo gli eventi che corrispondono a tutti i filtri vengono inviati alla destinazione. I caratteri jolly e le espressioni regolari non sono supportati. Tuttavia, se utilizzi il flag --event-filters-path-pattern, puoi definire un pattern di percorso della risorsa.
  • Il flag --service-account viene utilizzato per specificare l'indirizzo email dell'account di servizio Identity and Access Management (IAM) associato all'attivatore.

Esempio:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-east1 \
    --destination-workflow=my-workflow \
    --destination-workflow-location=us-east1 \
    --event-filters="type=google.cloud.firestore.document.v1.updated" \
    --event-filters="database=my-database" \
    --event-filters-path-pattern="document=users/my-document-*" \
    --event-data-content-type="application/protobuf" \
    --service-account="${TRIGGER_SA}@${PROJECT_ID}.iam.gserviceaccount.com"

Questo comando crea un trigger denominato helloworld-trigger per l'evento identificato come google.cloud.firestore.document.v1.updated nell' istanza di database my-database in esecuzione in modalità nativa e filtra gli eventi per i percorsi document che corrispondono a users/my-document-.

Terraform

Puoi creare un trigger per un flusso di lavoro utilizzando Terraform. Per maggiori dettagli, consulta Attivare un flusso di lavoro utilizzando Eventarc e Terraform.

Elenca un trigger

Puoi confermare la creazione di un attivatore elencando gli attivatori Eventarc utilizzando Google Cloud CLI o la console Google Cloud.

Console

  1. Nella console Google Cloud, vai alla pagina Eventarc Trigger.

    Vai ai trigger

    Questa pagina elenca gli attivatori in tutte le località e include dettagli come nomi, regioni, fornitori di eventi, destinazioni e altro ancora.

  2. Per filtrare gli attivatori:

    1. Fai clic su Filtro o sul campo Attivatori filtro.
    2. Nell'elenco Proprietà, seleziona un'opzione in base alla quale filtrare gli attivatori.

    Puoi selezionare una singola proprietà o utilizzare l'operatore logico OR per aggiungere altre proprietà.

  3. Per ordinare gli attivatori, fai clic su Ordina accanto a un'intestazione di colonna supportata.

gcloud

Esegui il comando seguente per elencare gli attivatori:

gcloud eventarc triggers list --location=-

Questo comando elenca gli attivatori in tutte le località e include dettagli come nomi, tipi, destinazioni e stati.

Passaggi successivi