Inoltra gli eventi di Firebase Realtime Database a Workflows

Standard

Anteprima — Firebase Realtime Database direct events

Questa funzionalità è soggette ai "Termini delle Offerte pre-GA" nella sezione Termini di servizio generali 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, inclusa l'origine evento, e il flusso di lavoro target.

Gli eventi vengono distribuiti in 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 più grandi della dimensione massima degli argomenti di Workflows non attiveranno le esecuzioni del workflow.

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

Nota :se sono supportati sia gli eventi diretti sia quelli del log di controllo per un provider Google, ti consigliamo di creare un trigger che filtri l'evento diretto. Gli eventi diretti offrono una serie di vantaggi rispetto agli eventi dei log di controllo. Per saperne di più, vedi Percorsi degli eventi.

Prepararsi a creare un trigger

Prima di creare un trigger 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 progetto Google Cloud .

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno già esistente. Una volta completata questa procedura, puoi eliminare il progetto e tutte le risorse associate.

   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 Firebase Realtime Database , abilita l'APIFirebase Realtime Database .

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 service account, 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 service account. Per saperne di più, vedi Ruoli e autorizzazioni per le Workflows 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 gli Firebase Realtime Database eventi, attiva firebasedatabase.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 service account. 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.

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 eseguito 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 o definire un pattern di percorso tramite la console. Per saperne di più, vedi Informazioni sui pattern di percorso.

Console

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

   Vai ai trigger

2. Fai clic su 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 Firebase Realtime Database.

   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 quelli Diretti.
7. Nell'elenco Tipo di contenuti dei dati evento, seleziona la codifica del payload dell'evento.

   Per gli eventi diretti da Firebase Realtime Database, deve essere application/json.

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

   Per saperne di più, consulta Località Eventarc.

9. Nel campo Attributo 1, l'ID risorsa dell'istanza funge da filtro eventi. Seleziona un operatore per questo filtro:
   • Uguale
   • Pattern del percorso

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

10. Nel campo Valore attributo 1, inserisci il nome dell'istanza del database da cui ricevere gli eventi. A seconda dell'operatore che hai scelto nel passaggio precedente, il valore dell'attributo deve essere il nome esatto o un formato di pattern del percorso.
11. Per l'attributo ref, seleziona l'operatore Pattern percorso.
12. Nel campo Valore attributo 2, inserisci il percorso dell'istanza del database da cui ricevere gli eventi se i dati vengono creati, aggiornati o eliminati in quel percorso o in qualsiasi percorso secondario.
13. 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 precedentemente concesso ruoli specifici richiesti da Eventarc.

14. Nell'elenco Destinazione evento, seleziona Workflows.
15. 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.

16. (Facoltativo) Per aggiungere un'etichetta, puoi fare clic su 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?
17. 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

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="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --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, imposta la proprietà eventarc/location; ad esempio, gcloud config set eventarc/location us-central1. I trigger di Firebase Realtime Database per Eventarc sono disponibili solo nelle seguenti località:

  • us-central1
  • europe-west1
  • asia-southeast1

  Tieni presente che il trigger deve trovarsi nella stessa località dell'istanza di Firebase Realtime Database. Per saperne di più, consulta Località di Realtime Database.

• DESTINATION_WORKFLOW: l'ID del workflow di cui è stato eseguito il deployment che riceve gli eventi dall'attivatore. Il flusso di lavoro 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 Firebase Realtime Database e può essere uno dei seguenti:

  • google.firebase.database.ref.v1.created: l'evento viene inviato quando i dati vengono creati nel database
  • google.firebase.database.ref.v1.updated: l'evento viene inviato quando i dati vengono aggiornati nel database
  • google.firebase.database.ref.v1.deleted: l'evento viene inviato quando i dati vengono eliminati nel database
  • google.firebase.database.ref.v1.written: l'evento viene inviato quando i dati vengono creati, aggiornati o eliminati nel database

• INSTANCE: una singola istanza di database e l'operatore può essere uno dei seguenti:

  • Uguale; ad esempio, --event-filters="instance=INSTANCE"
  • Pattern del percorso, ad esempio --event-filters-path-pattern="instance=INSTANCE". Per saperne di più, vedi Informazioni sui pattern di percorso.

• REF: il percorso all'interno dell'istanza del database per cui vuoi ricevere eventi quando i dati vengono creati, aggiornati o eliminati in quel percorso o in uno dei relativi elementi secondari.

• 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 Firebase Realtime Database, la codifica del payload dell'evento è application/json.
• Questi flag sono obbligatori:
  • --event-filters="type=EVENT_FILTER_TYPE"
  • --event-filters="instance=INSTANCE" o --event-filters-path-pattern="instance=INSTANCE"
  • --event-filters-path-pattern="ref=REF"
• Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
• --service-account: L'email del account di servizio IAM che il trigger Eventarc utilizzerà per richiamare le esecuzioni del flusso di lavoro. Ti consigliamo vivamente di utilizzare un account di servizio con i privilegi minimi necessari per accedere alle risorse richieste. Per scoprire di più sui service account, vedi Creare e gestire i service account.
• Per impostazione predefinita, le sottoscrizioni Pub/Sub create per Eventarc vengono mantenute indipendentemente dall'attività e non scadono. Per modificare la durata dell'inattività, consulta Proprietà dell'abbonamento.

Esempio:

gcloud eventarc triggers create rd-workflows-trigger \
    --location=us-central1 \
    --destination-workflow=my-workflow \
    --destination-workflow-location=europe-west4 \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

Questo comando crea un trigger denominato rd-workflows-trigger per l'evento identificato come google.firebase.database.ref.v1.created.

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.

Nota :anche se il trigger viene creato immediatamente, la propagazione e il filtraggio 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 tramite la console Google Cloud .

Console

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

   Vai ai trigger

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

2. Per filtrare i trigger:

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

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

3. Per ordinare i trigger, fai clic su 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.

Passaggi successivi

• Attivare un flusso di lavoro utilizzando Eventarc e Terraform

• Scopri di più su Eventarc