Instradare gli eventi di Cloud Firestore a Workflows

Console

1. Nella console Google Cloud , nella pagina del selettore di progetti, 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 gli eventi Cloud Firestore , abilita l'APICloud Firestore .

4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, poi concedigli 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 Service Accounts.

      Vai a Service account

   2. Seleziona il progetto.

   3. 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 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 service account. Per saperne di più, vedi Ruoli e autorizzazioni per le Workflows lavoro.

      Per altri ruoli, fai clic su add 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 gli Cloud Firestore eventi, attiva firestore.googleapis.com.

4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, poi concedigli 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 del account di servizio. Deve contenere da 6 a 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ù, vedi Ruoli e autorizzazioni per Workflows lavoro.

Console

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

   Vai ai trigger

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

   Questo è l'ID del trigger e deve iniziare con una lettera. Può contenere fino a 63 lettere minuscole, numeri o trattini.

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

   Tieni presente che il nome del fornitore di eventi utilizzato nella Google Cloud documentazione associata potrebbe non avere un prefisso di 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 tra gli 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, questo deve essere application/protobuf e i dati dell'evento sono un array di byte. Per saperne di più sui messaggi protobuf per gli eventi di 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 maggiori informazioni, consulta la sezione Restituzione di byte.

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

   Per saperne di più, consulta Località Eventarc.

9. Se applicabile al fornitore 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 può fungere da filtro per gli eventi.
   2. Seleziona un operatore:
      • Uguale
      • Pattern di 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 multisegmento ** corrisponde a zero o più segmenti nel pattern. Non specificare una barra iniziale, ad esempio:

        users/* o users/{userId}	Corrisponde a tutti i documenti della raccolta /users. Non corrisponde ai documenti nelle sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68
        users/**	Corrisponde a tutti i documenti nella raccolta /users e ai documenti nelle sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68

        Per saperne di più, consulta Informazioni sui pattern di percorso.

   3. Nel campo Valore attributo 1, a seconda dell'operatore che hai 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 richiamerà il tuo servizio o flusso di lavoro.

    In alternativa, puoi creare un nuovo account di servizio.

    Specifica l'indirizzo email del account di servizio Identity and Access Management (IAM) associato al trigger e a cui hai concesso in precedenza ruoli specifici richiesti da Eventarc.

11. Nell'elenco Destinazione evento, seleziona Workflows.
12. Seleziona un workflow.
    

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

    Per saperne di più, consulta Creare un trigger per Workflows.

13. (Facoltativo) Per aggiungere un'etichetta, puoi fare clic su add Aggiungi etichetta. Le etichette sono coppie chiave/valore che ti aiutano a organizzare le tue risorseGoogle Cloud . Per saperne di più, vedi Che cosa sono le etichette?
14. Fai clic su Crea.

Una volta creato un trigger, i filtri dell'origine eventi non possono essere modificati. Crea invece un nuovo trigger ed elimina quello precedente. Per saperne di più, consulta Gestire i trigger.

gcloud

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

I flag variano a seconda che tu stia eseguendo Firestore in modalità Native o in modalità Datastore. Per ulteriori informazioni, consulta la sezione Scelta 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 del trigger o un identificatore completamente qualificato.

• 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 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 Località Eventarc e Località 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 qualsiasi delle località supportate da Workflows e non deve trovarsi nella stessa località del trigger. Tuttavia, il workflow 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 workflow si trovi nella stessa posizione del trigger.
• 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à Native.

• google.cloud.firestore.document.v1.created: l'evento viene inviato quando un documento viene scritto per la prima volta
• google.cloud.firestore.document.v1.created.withAuthContext: event with authentication information attributes is sent when a document is written to for the first time
• 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 un documento esiste già e ha un valore modificato
• google.cloud.firestore.document.v1.deleted: l'evento viene inviato quando un documento viene eliminato
• google.cloud.firestore.document.v1.deleted.withAuthContext: event with authentication information attributes is sent when a document is deleted
• 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à.

• google.cloud.datastore.entity.v1.created: l'evento viene inviato quando un'entità viene scritta per la prima volta
• google.cloud.datastore.entity.v1.created.withAuthContext: evento con attributi delle informazioni di autenticazione inviato quando un'entità viene scritta per la prima volta
• google.cloud.datastore.entity.v1.updated: l'evento viene inviato quando un'entità esiste già e un valore è stato modificato
• google.cloud.datastore.entity.v1.updated.withAuthContext: evento con attributi delle informazioni di autenticazione viene inviato quando un'entità esiste già e ha un valore 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 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 delle informazioni di autenticazione inviato quando un'entità viene creata, aggiornata o eliminata

• DATABASE: il database Firestore. Per il 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 eseguita una corrispondenza con caratteri jolly (*) per qualsiasi occorrenza.
• DOCUMENT (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità nativa. Il percorso del database da cui vuoi ricevere eventi quando i dati vengono creati, aggiornati o eliminati in quel percorso. Non specificare una barra iniziale. 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 e un carattere jolly multiregione ** 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 sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68
    users/**	Corrisponde a tutti i documenti nella raccolta /users e ai documenti nelle sottoraccolte come /users/marie/messages/33e2IxYBD9enzS50SJ68

    Per saperne di più, 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 eventi quando i dati vengono creati, aggiornati o eliminati in quel percorso. Non specificare una barra iniziale. 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 saperne di più, consulta Informazioni sui pattern di percorso.

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

• EVENT_DATA_CONTENT_TYPE: la codifica del payload dell'evento. Per gli eventi diretti di Firestore, questo deve essere application/protobuf e i dati dell'evento sono un array di byte. Per maggiori informazioni sui messaggi protobuf per gli eventi di Cloud Firestore, vedi Eventi comuni. Tieni presente che puoi utilizzare una funzione della libreria standard di Workflows per codificare i byte in testo Base64. Per maggiori informazioni, consulta la sezione Restituzione di byte.
• SERVICE_ACCOUNT_NAME: il nome del service account IAM che hai 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 alcun altro filtro eventi, vengono abbinati gli eventi per tutte le risorse.
• EVENT_FILTER_TYPE non può essere modificato dopo la creazione. Per modificare EVENT_FILTER_TYPE, crea un nuovo trigger ed elimina quello precedente.
• Ogni attivatore può avere più filtri evento, separati da virgole in un unico --event-filters=[ATTRIBUTE=VALUE,...] flag oppure 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, quando utilizzi il flag --event-filters-path-pattern, puoi definire un pattern di percorso della risorsa.
• Il flag --service-account viene utilizzato per specificare l'email del account di servizio Identity and Access Management (IAM) associato al trigger.

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 del 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 i dettagli, vedi Attivare un flusso di lavoro utilizzando Eventarc e Terraform.

Console

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

   Vai ai trigger

   Questa pagina elenca i trigger in tutte le posizioni e include dettagli quali nomi, regioni, fornitori di eventi, destinazioni e altro ancora.

2. Per filtrare i trigger:

   1. Fai clic su filter_list Filtro o sul campo Trigger del filtro.
   2. Nell'elenco Proprietà, seleziona un'opzione per filtrare gli attivatori.

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

3. Per ordinare i trigger, fai clic su arrow_upward Ordina accanto a un'intestazione di colonna supportata.

gcloud

Esegui questo comando per elencare i trigger:

gcloud eventarc triggers list --location=-

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