Instradare gli eventi di Cloud Firestore a Cloud Run

Un trigger Eventarc dichiara il tuo interesse per un determinato evento o per un insieme di eventi. Puoi configurare il routing degli eventi specificando i filtri per l'attivatore, incluso l'origine evento e il servizio Cloud Run di destinazione.

Eventarc pubblica gli eventi nel formato CloudEvents tramite una richiesta HTTP al destinatario degli eventi.

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 al servizio Cloud Run attivato da un eventoCloud Firestore diretto. Per maggiori dettagli, consulta l'elenco degli eventi diretti supportati.

Prepararsi a creare un trigger

Prima di creare un attivatore, completa i seguenti prerequisiti:

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 Cloud Logging, Eventarc e Eventarc Publishing.

    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 il servizio di destinazione.

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

      Vai a Crea 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 IAM (Identity and Access Management) richiesti da concedere al tuo account di servizio per le chiamate autenticate o non autenticate. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per i target Cloud Run.

      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 Cloud Logging, Eventarc e Eventarc Publishing.

    gcloud services enable logging.googleapis.com \
  eventarc.googleapis.com \
  eventarcpublishing.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 il servizio 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 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 le chiamate autenticate o non autenticate. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per i target Cloud Run.

Crea un trigger

Puoi creare un trigger Eventarc utilizzando Google Cloud CLI 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.

  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 Cloud Run.
  12. Seleziona un servizio.

    Questo è il nome del servizio che riceve gli eventi per l'attivatore. Il servizio deve trovarsi nello stesso progetto dell'attivatore e riceverà gli eventi come richieste POST HTTP inviate al percorso dell'URL principale (/) ogni volta che viene generato.

  13. Se vuoi, puoi specificare il percorso dell'URL del servizio a cui inviare la richiesta in entrata.

    Si tratta del percorso relativo nel servizio di destinazione a cui devono essere inviati gli eventi per l'attivatore. Ad esempio: /, /route, route, route/subroute.

  14. Fai clic su Crea.

    15. 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-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --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=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Modalità Datastore

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --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=SERVICE_ACCOUNT_NAME@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_RUN_SERVICE: il nome del servizio Cloud Run che riceve gli eventi per l'attivatore. Il servizio può trovarsi in una delle località supportate da Cloud Run e non deve trovarsi nella stessa località dell'attivatore. Tuttavia, il servizio deve trovarsi nello stesso progetto dell'attivatore e riceverà gli eventi sotto forma di richieste HTTP POST inviate al percorso dell'URL di primo livello (/) ogni volta che viene generato l'evento.
  • DESTINATION_RUN_REGION: (facoltativo) la regione in cui si trova il servizio Cloud Run di destinazione. Se non viene specificato, si presume che il servizio si trovi nella stessa regione 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.
  • SERVICE_ACCOUNT_NAME: il nome del tuo account di servizio gestito dall'utente.
  • 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.
  • Facoltativamente, specifica un percorso relativo nel servizio Cloud Run di destinazione a cui devono essere inviati gli eventi per l'attivatore utilizzando il flag --destination-run-path.

Esempio:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-east1 \
    --destination-run-service=helloworld-events \
    --destination-run-region=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=${SERVICE_ACCOUNT_NAME}@${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-.

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