Instrada gli eventi di Cloud Firestore a Workflows

Anteprima - Cloud Firestore direct events

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Un trigger Eventarc dichiara il tuo interesse per un determinato evento o insieme di eventi. Puoi configurare il routing degli eventi specificando i filtri per il trigger, tra cui 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 (in base alla 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 superiori alla dimensione massima degli argomenti Workflows non attiveranno le esecuzioni del flusso di lavoro.

Queste istruzioni mostrano come configurare il routing degli eventi in modo che venga attivata un'esecuzione del tuo flusso di lavoro in risposta a un evento Cloud Firestore diretto. Per ulteriori dettagli, consulta l'elenco degli eventi diretti supportati.

Nota: se un provider Google supporta sia eventi diretti che eventi del log di controllo, ti consigliamo di creare un trigger che filtri l'evento diretto. Gli eventi diretti offrono una serie di vantaggi rispetto agli eventi degli audit log. Per ulteriori informazioni, consulta la sezione Route di eventi.

Prepararsi a creare un trigger

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

Console

1. Nella console Google Cloud, nella pagina del selettore dei progetti, seleziona o crea un progetto Google Cloud.

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

   Vai al selettore di progetti

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

   Abilita le API

3. Se applicabile, abilita l'API relativa agli eventi. Ad esempio, per gli eventi di Cloud Functions, abilita cloudfunctions.googleapis.com.

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

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

      Vai ad Account di servizio

   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 Identity and Access Management (IAM) richiesti da concedere al tuo account di servizio. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per le destinazioni di Workflows.

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

   6. Fai clic su Continua.

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

gcloud

1. Nella console Google Cloud, attiva Cloud Shell.

   Attiva Cloud Shell

   Nella parte inferiore della console Google Cloud viene avviata una sessione di Cloud Shell che mostra un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installato e con valori già impostati per il progetto attuale. L'inizializzazione della sessione può richiedere alcuni secondi.

2. Abilita le API Eventarc, Eventarc Publishing, Workflows ed 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 gli eventi di Cloud Functions, abilita cloudfunctions.googleapis.com.

4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedigli i ruoli e le autorizzazioni necessari in modo che 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. Dopo aver creato un account di servizio, non puoi modificarne il nome.

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

Crea un trigger

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

Nota: il filtro viene applicato tramite una corrispondenza esatta e non supporta caratteri jolly o espressioni regolari. Tuttavia, puoi utilizzare il flag --event-filters-path-pattern nel seguente comando gcloud CLI oppure definire un pattern del percorso tramite la console. Per ulteriori informazioni, consulta Comprendere i pattern dei percorsi.

Console

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

   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 il 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 documentazione di Google Cloud associata potrebbe non avere un prefisso di Cloud o Google Cloud. Ad esempio, nella console, Memorystore per Redis viene chiamato Google Cloud Memorystore for Redis.

6. Nell'elenco Evento, seleziona un evento per il tipo di evento Diretto.
7. Nell'elenco Tipo di contenuto dei dati sugli eventi, 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 ulteriori informazioni sui messaggi protobuf per gli eventi di Cloud Firestore, consulta Eventi comuni. Tieni presente che puoi utilizzare una funzione libreria standard di Workflows per codificare i byte in testo Base64. Per ulteriori informazioni, consulta la sezione Restituzione di byte.

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

   Per ulteriori informazioni, consulta le 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 che hai scelto, seleziona un ID risorsa che possa fungere da filtro di eventi.
   2. Seleziona un operatore:
      • Uguale
      • Pattern del percorso

        Per maggiori informazioni, consulta la pagina Comprendere i pattern dei percorsi.

   3. Nel campo Valore attributo 1, a seconda dell'operatore che hai scelto, digita il valore esatto o applica un pattern del percorso.
   4. Se è applicabile un campo Attributo 2, specifica i valori appropriati.
10. Seleziona l'account di servizio che richiama 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 al trigger e a cui hai precedentemente concesso i 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 trasmettere gli eventi. Gli eventi per l'esecuzione di un flusso di lavoro vengono trasformati e passati al flusso di lavoro come argomenti di runtime.

    Per ulteriori informazioni, consulta Creare un trigger per Workflows.

13. Fai clic su Crea.

Una volta creato un attivatore, i filtri dell'origine evento non possono essere modificati. Crea invece un nuovo attivatore ed elimina quello precedente. Per ulteriori informazioni, consulta Gestire i trigger.

gcloud

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

I flag variano a seconda che tu stia eseguendo Firestore in modalità nativa 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 completo.

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

  I trigger di Cloud Firestore per Eventarc sono disponibili solo in determinate località e il trigger deve trovarsi nella stessa località del database Cloud Firestore. Per ulteriori informazioni, consulta le località Eventarc e le località di Cloud Firestore.

• DESTINATION_WORKFLOW: l'ID del flusso di lavoro di cui è stato eseguito il deployment che riceve gli eventi dal trigger. Il flusso di lavoro può trovarsi in una qualsiasi delle località supportate di Workflows e non deve necessariamente trovarsi nella stessa località del trigger. Tuttavia, il flusso di lavoro deve trovarsi nello stesso progetto del trigger.
• DESTINATION_WORKFLOW_LOCATION (facoltativo): la località 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 del trigger.
• EVENT_FILTER_TYPE: l'identificatore dell'evento. Quando una chiamata API per il metodo ha esito positivo, viene generato un evento. 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, vedi Tipi di eventi supportati da Eventarc.
Cloud Firestore supporta i seguenti tipi di eventi solo in modalità nativa. Il tipo di evento google.cloud.firestore.document.v1.written comprende tutte le modifiche a un documento.
• google.cloud.firestore.document.v1.created: l'evento viene inviato quando un documento viene scritto per la prima volta
• google.cloud.firestore.document.v1.updated: l'evento viene inviato quando un documento esiste già e ha un valore modificato
• google.cloud.firestore.document.v1.deleted: l'evento viene inviato quando viene eliminato un documento
• google.cloud.firestore.document.v1.written: l'evento viene inviato quando un documento viene creato, aggiornato o eliminato

Cloud Firestore supporta i seguenti tipi di eventi in solo modalità Datastore. Gli oggetti di dati in Firestore in modalità Datastore sono noti come entità. Il tipo di evento google.cloud.datastore.entity.v1.written include tutte le modifiche a un'entità.

• google.cloud.datastore.entity.v1.created: l'evento viene inviato quando un'entità viene scritta per la prima volta
• google.cloud.datastore.entity.v1.updated: l'evento viene inviato quando esiste già un'entità con un valore modificato
• google.cloud.datastore.entity.v1.deleted: l'evento viene inviato quando viene eliminata un'entità
• google.cloud.datastore.entity.v1.written: l'evento viene inviato quando un'entità viene creata, aggiornata o eliminata

• DATABASE: il database Firestore. Come nome del database predefinito, utilizza (default).

• NAMESPACE (facoltativo): lo spazio dei nomi del database Firestore. Per lo spazio dei nomi predefinito in modalità Datastore, utilizza (default). Se non specificato, viene creata una corrispondenza con carattere jolly (*) a qualsiasi occorrenza.

• DOCUMENT (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità nativa. Il percorso del database da cui vuoi ricevere gli eventi dal momento in cui 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". Per ulteriori informazioni, consulta Comprendere i pattern dei percorsi.

• ENTITY (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità Datastore. Il percorso del database da cui vuoi ricevere gli eventi dal momento in cui 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 Comprendere i pattern dei percorsi.

    Tieni presente che potrebbe essere necessario eseguire l'escape dei caratteri negli ID tipo e negli ID entità. L'uso di caratteri di escape per un carattere consente al filtro di eventi di interpretare correttamente l'ID. Per ulteriori informazioni, consulta la sezione Carattere di escape.

• EVENT_DATA_CONTENT_TYPE: la codifica del payload dell'evento. Per gli eventi diretti da Firestore, deve essere application/protobuf e i dati degli eventi sono un array di byte. Per ulteriori informazioni sui messaggi protobuf per gli eventi di Cloud Firestore, consulta Eventi comuni. Tieni presente che puoi utilizzare una funzione libreria standard di Workflows per codificare i byte in testo Base64. Per ulteriori informazioni, consulta la sezione Restituzione di 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 ID progetto Google Cloud

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 di eventi, vengono abbinati gli eventi per tutte le risorse.
• Impossibile modificare EVENT_FILTER_TYPE dopo la creazione. Per modificare EVENT_FILTER_TYPE, crea un nuovo trigger ed elimina quello precedente.
• Ogni attivatore può avere più filtri evento, delimitati da virgole in un flag --event-filters=[ATTRIBUTE=VALUE,...] oppure 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, quando utilizzi il flag --event-filters-path-pattern, puoi definire un pattern del 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 document percorsi 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.

Nota: anche se il trigger viene creato immediatamente, la propagazione e il filtro degli eventi possono richiedere fino a due minuti.

Elenca un trigger

Puoi confermare la creazione di un trigger elencando i trigger Eventarc utilizzando Google Cloud CLI o la console Google Cloud.

Console

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

   Vai ai trigger

   Questa pagina elenca i tuoi trigger 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 per filtrare gli attivatori.

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

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

gcloud

Esegui questo comando per elencare i trigger:

gcloud eventarc triggers list --location=-

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

Passaggi successivi

• Attiva un flusso di lavoro utilizzando Eventarc e Terraform

• Scopri di più su Eventarc