Creazione di una pipeline di elaborazione di BigQuery con Eventarc

Standard

---

Questo tutorial mostra come utilizzare Eventarc per creare una pipeline di elaborazione che pianifica le query su un set di dati BigQuery pubblico, genera grafici in base ai dati e condivide i link ai grafici via email.

Obiettivi

In questo tutorial, creerai ed eseguirai il deployment di tre servizi Cloud Run che consentono l'accesso non autenticato e ricevono eventi utilizzando Eventarc:

1. Query Runner: attivato quando i job Cloud Scheduler pubblicano un messaggio in un argomento Pub/Sub, questo servizio utilizza l'API BigQuery per recuperare i dati da un set di dati pubblico COVID-19 e salva i risultati in una nuova tabella BigQuery.
2. Chart Creator: viene attivato quando il servizio Query Runner pubblica un messaggio in un argomento Pub/Sub. Questo servizio genera grafici utilizzando la libreria di rappresentazione di dati in Python Matplotlib e li salva in un bucket Cloud Storage.
3. Notifier: attivato dagli audit log quando il servizio Chart Creator archivia un grafico in un bucket Cloud Storage, questo servizio utilizza il servizio email SendGrid per inviare i link ai grafici a un indirizzo email.

Il seguente diagramma mostra l'architettura di alto livello:

Nota: per impostazione predefinita, tutti i servizi Cloud Run vengono di'applicati in modo privato, il che significa che non è possibile accedervi senza fornire le credenziali di autenticazione nella richiesta. Per i progetti con criteri dell'organizzazione per la condivisione limitata per i domini, utilizza un servizio di destinazione Cloud Run autenticato anziché uno che consenta l'accesso pubblico (non autenticato).

Costi

In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:

• Artifact Registry
• BigQuery
• Cloud Build
• Cloud Run
• Cloud Scheduler
• Cloud Storage
• Eventarc
• Pub/Sub

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi Google Cloud utenti potrebbero avere diritto a una prova gratuita.

Prima di iniziare

I vincoli di sicurezza definiti dalla tua organizzazione potrebbero impedirti di completare i passaggi seguenti. Per informazioni sulla risoluzione dei problemi, vedi Sviluppare applicazioni in un Google Cloud ambiente vincolato.

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
2. Install the Google Cloud CLI.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.

4. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

5. Make sure that billing is enabled for your Google Cloud project.

6. Enable the Artifact Registry, Cloud Build, Cloud Logging, Cloud Run, Cloud Scheduler, Eventarc, and Pub/Sub APIs:

   gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com cloudscheduler.googleapis.com eventarc.googleapis.com logging.googleapis.com pubsub.googleapis.com run.googleapis.com

7. Install the Google Cloud CLI.

8. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.

9. Create or select a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   • Create a Google Cloud project:

     gcloud projects create PROJECT_ID

     Replace PROJECT_ID with a name for the Google Cloud project you are creating.

   • Select the Google Cloud project that you created:

     gcloud config set project PROJECT_ID

     Replace PROJECT_ID with your Google Cloud project name.

10. Make sure that billing is enabled for your Google Cloud project.

11. Enable the Artifact Registry, Cloud Build, Cloud Logging, Cloud Run, Cloud Scheduler, Eventarc, and Pub/Sub APIs:

    gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com cloudscheduler.googleapis.com eventarc.googleapis.com logging.googleapis.com pubsub.googleapis.com run.googleapis.com

12. Per Cloud Storage, abilita la registrazione degli audit log per i tipi di accesso ai dati ADMIN_READ, DATA_WRITE e DATA_READ.
    1. Leggi il criterio Identity and Access Management (IAM) associato al tuo progetto, alla tua cartella o alla tua organizzazione Google Cloud e memorizzalo in un file temporaneo:

       gcloud projects get-iam-policy PROJECT_ID > /tmp/policy.yaml

    2. In un editor di testo, apri /tmp/policy.yaml e aggiungi o modifica solo la configurazione del log di controllo nella sezione auditConfigs:
       Attenzione: devi mantenere invariate le sezioni bindings: e etag:. La modifica di parti dei criteri non correlate al logging di controllo potrebbe rendere il tuo progetto Google Cloud inaccessibile.

       
         auditConfigs:
         - auditLogConfigs:
           - logType: ADMIN_READ
           - logType: DATA_WRITE
           - logType: DATA_READ
           service: storage.googleapis.com
         bindings:
         - members:
         [...]
         etag: BwW_bHKTV5U=
         version: 1

    3. Scrivi il nuovo criterio IAM:

       gcloud projects set-iam-policy PROJECT_ID /tmp/policy.yaml

       Se il comando precedente segnala un conflitto con un'altra modifica, ripeti questi passaggi, iniziando con la lettura del criterio IAM. Per maggiori informazioni, consulta Configurare gli audit log di accesso ai dati con l'API.

13. Concedi il ruolo eventarc.eventReceiver all'account di servizio Compute Engine:

    export PROJECT_NUMBER="$(gcloud projects describe $(gcloud config get-value project) --format='value(projectNumber)')"
    
    gcloud projects add-iam-policy-binding $(gcloud config get-value project) \
        --member=serviceAccount:${PROJECT_NUMBER}[e-mail] \
        --role='roles/eventarc.eventReceiver'

14. Se hai attivato l'account di servizio Pub/Sub il giorno 8 aprile 2021 o in una data precedente, concedi il ruolo iam.serviceAccountTokenCreator all'account di servizio Pub/Sub:

    gcloud projects add-iam-policy-binding $(gcloud config get-value project) \
        --member="serviceAccount:service-${PROJECT_NUMBER}@gcp-sa-pubsub.iam.gserviceaccount.com"\
        --role='roles/iam.serviceAccountTokenCreator'

15. Imposta i valori predefiniti utilizzati in questo tutorial:

    export REGION=REGION
    gcloud config set run/region ${REGION}
    gcloud config set run/platform managed
    gcloud config set eventarc/location ${REGION}

    Sostituisci REGION con la località Eventarc supportata che preferisci.

Crea una chiave API SendGrid

SendGrid è un provider email basato su cloud che ti consente di inviare email senza dover gestire i server email.

1. Accedi a SendGrid e vai a Impostazioni > API Keys (Chiavi API).
2. Fai clic su Crea chiave API.
3. Seleziona le autorizzazioni per la chiave. La chiave deve disporre almeno delle autorizzazioni Invio email per inviare email.
4. Assegna un nome alla chiave e fai clic su Salva per crearla.
5. SendGrid genera una nuova chiave. Questa è l'unica copia della chiave, quindi assicurati di copiarla e salvarla per utilizzarla in un secondo momento.

Creare un repository standard Artifact Registry

Crea un repository standard di Artifact Registry per archiviare l'immagine del container Docker:

gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=$REGION

Sostituisci REPOSITORY con un nome univoco per il repository.

Crea un bucket Cloud Storage

Crea un bucket Cloud Storage univoco per salvare i grafici. Assicurati che il bucket e i grafici siano disponibili pubblicamente e nella stessa regione del servizio Cloud Run:

export BUCKET="$(gcloud config get-value core/project)-charts"
gsutil mb -l $(gcloud config get-value run/region) gs://${BUCKET}
gsutil uniformbucketlevelaccess set on gs://${BUCKET}
gsutil iam ch allUsers:objectViewer gs://${BUCKET}

Esegui il deployment del servizio Notifier

Esegui il deployment di un servizio Cloud Run che riceve gli eventi di Chart Creator e utilizza SendGrid per inviare tramite email i link ai grafici generati.

1. Clona il repository GitHub e passa alla directory notifier/python:

   git clone https://github.com/GoogleCloudPlatform/eventarc-samples
   cd eventarc-samples/processing-pipelines/bigquery/notifier/python/

2. Crea ed esegui il push dell'immagine container:

   export SERVICE_NAME=notifier
   docker build -t $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 .
   docker push $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1

3. Esegui il deployment dell'immagine container in Cloud Run, passando un indirizzo куда отправлять email e la chiave API SendGrid:

   export TO_EMAILS=EMAIL_ADDRESS
   export SENDGRID_API_KEY=YOUR_SENDGRID_API_KEY
   gcloud run deploy ${SERVICE_NAME} \
       --image $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 \
       --update-env-vars TO_EMAILS=${TO_EMAILS},SENDGRID_API_KEY=${SENDGRID_API_KEY},BUCKET=${BUCKET} \
       --allow-unauthenticated

   Sostituisci quanto segue:

   • EMAIL_ADDRESS con un indirizzo email a cui inviare i link ai grafici generati
   • YOUR_SENDGRID_API_KEY con la chiave API SendGrid che hai annotato in precedenza

Quando viene visualizzato l'URL del servizio, il deployment è completato.

Nota: potrebbero essere necessari alcuni minuti prima che le autorizzazioni vengano propagate al servizio e prima che tu possa creare un attivatore.

Crea un trigger per il servizio Notifier

L'attivatore Eventarc per il servizio Notifier di cui è stato eseguito il deployment su Cloud Run filtra gli audit log di Cloud Storage in cui methodName è storage.objects.create.

1. Crea l'attivatore:

   gcloud eventarc triggers create trigger-${SERVICE_NAME} \
       --destination-run-service=${SERVICE_NAME} \
       --destination-run-region=${REGION} \
       --event-filters="type=google.cloud.audit.log.v1.written" \
       --event-filters="serviceName=storage.googleapis.com" \
       --event-filters="methodName=storage.objects.create" \
       --service-account=${PROJECT_NUMBER}[e-mail]

   Viene creato un trigger denominato trigger-notifier.

Esegui il deployment del servizio Chart Creator

Esegui il deployment di un servizio Cloud Run che riceve eventi Query Runner, recupera i dati da una tabella BigQuery per un paese specifico e poi genera un grafico utilizzando Matplotlib. Il grafico viene caricato in un bucket Cloud Storage.

1. Passa alla directory chart-creator/python:

   cd ../../chart-creator/python

2. Crea ed esegui il push dell'immagine container:

   export SERVICE_NAME=chart-creator
   docker build -t $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 .
   docker push $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1

3. Esegui il deployment dell'immagine container in Cloud Run passando BUCKET:

   gcloud run deploy ${SERVICE_NAME} \
       --image $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 \
       --update-env-vars BUCKET=${BUCKET} \
       --allow-unauthenticated

Quando viene visualizzato l'URL del servizio, il deployment è completato.

Creare un attivatore per il servizio Chart Creator

L'attivatore Eventarc per il servizio Chart Creator di cui è stato eseguito il deployment su Cloud Run filtra i messaggi pubblicati in un argomento Pub/Sub.

1. Crea l'attivatore:

   gcloud eventarc triggers create trigger-${SERVICE_NAME} \
       --destination-run-service=${SERVICE_NAME} \
       --destination-run-region=${REGION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished"

   Viene creato un trigger denominato trigger-chart-creator.

2. Imposta la variabile di ambiente dell'argomento Pub/Sub.

   export TOPIC_QUERY_COMPLETED=$(basename $(gcloud eventarc triggers describe trigger-${SERVICE_NAME} --format='value(transport.pubsub.topic)'))

Esegui il deployment del servizio Query Runner

Esegui il deployment di un servizio Cloud Run che riceve eventi Cloud Scheduler, recupera i dati da un set di dati pubblico COVID-19 e salva i risultati in una nuova tabella BigQuery.

1. Passa alla directory processing-pipelines:

   cd ../../..

2. Crea ed esegui il push dell'immagine container:

   export SERVICE_NAME=query-runner
   docker build -t $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 -f Dockerfile .
   docker push $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1

3. Esegui il deployment dell'immagine container in Cloud Run passando PROJECT_ID e TOPIC_QUERY_COMPLETED:

   gcloud run deploy ${SERVICE_NAME} \
       --image $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/${SERVICE_NAME}:v1 \
       --update-env-vars PROJECT_ID=$(gcloud config get-value project),TOPIC_ID=${TOPIC_QUERY_COMPLETED} \
       --allow-unauthenticated

Quando viene visualizzato l'URL del servizio, il deployment è completato.

Crea un trigger per il servizio Query Runner

L'attivatore Eventarc per il servizio Query Runner di cui è stato eseguito il deployment su Cloud Run filtra i messaggi pubblicati in un argomento Pub/Sub.

1. Crea l'attivatore:

   gcloud eventarc triggers create trigger-${SERVICE_NAME} \
       --destination-run-service=${SERVICE_NAME} \
       --destination-run-region=${REGION} \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished"

   Viene creato un trigger denominato trigger-query-runner.

2. Imposta una variabile di ambiente per l'argomento Pub/Sub.

   export TOPIC_QUERY_SCHEDULED=$(gcloud eventarc triggers describe trigger-${SERVICE_NAME} --format='value(transport.pubsub.topic)')

Pianifica i job

La pipeline di elaborazione viene attivata da due job Cloud Scheduler.

1. Crea un'app App Engine richiesta da Cloud Scheduler e specifica una località appropriata:

   export APP_ENGINE_LOCATION=LOCATION
   gcloud app create --region=${APP_ENGINE_LOCATION}

2. Crea due job Cloud Scheduler che pubblicano in un argomento Pub/Sub una volta al giorno:

   gcloud scheduler jobs create pubsub cre-scheduler-uk \
       --schedule="0 16 * * *" \
       --topic=${TOPIC_QUERY_SCHEDULED} \
       --message-body="United Kingdom"

   gcloud scheduler jobs create pubsub cre-scheduler-cy \
       --schedule="0 17 * * *" \
       --topic=${TOPIC_QUERY_SCHEDULED} \
       --message-body="Cyprus"

   La pianificazione è specificata nel formato cron di Unix. Ad esempio, 0 16 * * * indica che i job vengono eseguiti alle 16:00 (16:00) UTC ogni giorno.

esegui la pipeline.

1. Innanzitutto, verifica che tutti gli attivatori siano stati creati correttamente:

   gcloud eventarc triggers list

   Nota: potrebbero essere necessari fino a due minuti prima che gli attivatori siano completamente funzionali.

   L'output dovrebbe essere simile al seguente:

   NAME: trigger-chart-creator
   TYPE: google.cloud.pubsub.topic.v1.messagePublished
   DESTINATION: Cloud Run service: chart-creator
   ACTIVE: Yes
   LOCATION: us-central1
   
   NAME: trigger-notifier
   TYPE: google.cloud.audit.log.v1.written
   DESTINATION: Cloud Run service: notifier
   ACTIVE: Yes
   LOCATION: us-central1
   
   NAME: trigger-query-runner
   TYPE: google.cloud.pubsub.topic.v1.messagePublished
   DESTINATION: Cloud Run service: query-runner
   ACTIVE: Yes
   LOCATION: us-central1
   

2. Recupera gli ID job Cloud Scheduler:

   gcloud scheduler jobs list

   L'output dovrebbe essere simile al seguente:

   ID                LOCATION      SCHEDULE (TZ)         TARGET_TYPE  STATE
   cre-scheduler-cy  us-central1   0 17 * * * (Etc/UTC)  Pub/Sub      ENABLED
   cre-scheduler-uk  us-central1   0 16 * * * (Etc/UTC)  Pub/Sub      ENABLED
   

3. Sebbene i job siano pianificati per essere eseguiti ogni giorno alle 16:00 e alle 17:00, puoi anche eseguire manualmente i job Cloud Scheduler:

   gcloud scheduler jobs run cre-scheduler-cy
   gcloud scheduler jobs run cre-scheduler-uk

4. Dopo alcuni minuti, verifica che nel bucket Cloud Storage siano presenti due grafici:

   gsutil ls gs://${BUCKET}

   L'output dovrebbe essere simile al seguente:

   gs://BUCKET/chart-cyprus.png
   gs://BUCKET/chart-unitedkingdom.png
   

Complimenti! Dovresti anche ricevere due email con i link ai grafici.

Esegui la pulizia

Se hai creato un nuovo progetto per questo tutorial, eliminalo. Se hai utilizzato un progetto esistente e vuoi conservarlo senza le modifiche aggiunte in questo tutorial, elimina le risorse create per il tutorial.

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per le attività descritte in questo documento, quando lo elimini elimini anche tutto il lavoro svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, il riuso dei progetti può aiutarti a non superare i limiti di quota.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Eliminare le risorse dei tutorial

1. Elimina tutti i servizi Cloud Run di cui hai eseguito il deployment in questo tutorial:

   gcloud run services delete SERVICE_NAME

   dove SERVICE_NAME è il nome del servizio scelto.

   Puoi anche eliminare i servizi Cloud Run dalla console Google Cloud.

2. Rimuovi le configurazioni predefinite di Google Cloud CLI aggiunte durante la configurazione del tutorial.

   gcloud config unset project
   gcloud config unset run/region
   gcloud config unset run/platform
   gcloud config unset eventarc/location

3. Elimina gli eventuali trigger Eventarc che hai creato in questo tutorial:

    gcloud eventarc triggers delete TRIGGER_NAME
    

   Sostituisci TRIGGER_NAME con il nome dell'attivatore.

4. Elimina le immagini da Artifact Registry.

   gcloud artifacts docker images delete $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/notifier:v1
   gcloud artifacts docker images delete $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/chart-creator:v1
   gcloud artifacts docker images delete $REGION-docker.pkg.dev/$(gcloud config get-value project)/REPOSITORY/query-runner:v1

5. Elimina il bucket e tutti gli oggetti al suo interno:

   gcloud storage rm --recursive gs://${BUCKET}/

6. Elimina i job Cloud Scheduler:

   gcloud scheduler jobs delete cre-scheduler-cy
   gcloud scheduler jobs delete cre-scheduler-uk

Passaggi successivi

• Scopri di più su Eventarc
• Scopri di più su Cloud Run