Ricevere eventi Pub/Sub utilizzando un servizio Cloud Run autenticato

Standard

Questo tutorial mostra come eseguire il deployment di un'applicazione containerizzata utilizzando un servizio Cloud Run autenticato che riceve eventi tramite Pub/Sub. Pub/Sub è un servizio di messaggistica in tempo reale completamente gestito che consente di inviare e ricevere messaggi tra applicazioni indipendenti.

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

Obiettivi

In questo tutorial, imparerai a:

1. Esegui il deployment di un servizio di ricezione di eventi in Cloud Run che richiede chiamate autenticate.

2. Creare un trigger Eventarc che collega un argomento Pub/Sub al servizio Cloud Run.

3. Pubblica un messaggio nell'argomento Pub/Sub per generare un evento.

4. Visualizza l'evento nei log di Cloud Run.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

• Artifact Registry
• Cloud Build
• Cloud Run
• Eventarc
• Pub/Sub

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il calcolatore prezzi.

I nuovi utenti di Google Cloud potrebbero avere diritto a una prova senza costi.

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 ambiente Google Cloud vincolato.

Accedi al tuo account Google Cloud . Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

Crea o seleziona un Google Cloud progetto.

Ruoli richiesti per selezionare o creare un progetto

• Seleziona un progetto: la selezione di un progetto non richiede un ruolo IAM specifico. Puoi selezionare qualsiasi progetto per il quale ti è stato concesso un ruolo.
• Crea un progetto: per creare un progetto, devi disporre del ruolo Autore progetto (roles/resourcemanager.projectCreator), che contiene l'autorizzazione resourcemanager.projects.create. Scopri come concedere i ruoli.

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 relative risorse.

• Creare un progetto Google Cloud :

  gcloud projects create PROJECT_ID

  Sostituisci PROJECT_ID con un nome per il progetto Google Cloud che stai creando.

• Seleziona il progetto Google Cloud che hai creato:

  gcloud config set project PROJECT_ID

  Sostituisci PROJECT_ID con il nome del progetto Google Cloud .

Verifica che la fatturazione sia abilitata per il tuo progetto Google Cloud .

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

Crea o seleziona un Google Cloud progetto.

Ruoli richiesti per selezionare o creare un progetto

• Seleziona un progetto: la selezione di un progetto non richiede un ruolo IAM specifico. Puoi selezionare qualsiasi progetto per il quale ti è stato concesso un ruolo.
• Crea un progetto: per creare un progetto, devi disporre del ruolo Autore progetto (roles/resourcemanager.projectCreator), che contiene l'autorizzazione resourcemanager.projects.create. Scopri come concedere i ruoli.

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 relative risorse.

• Creare un progetto Google Cloud :

  gcloud projects create PROJECT_ID

  Sostituisci PROJECT_ID con un nome per il progetto Google Cloud che stai creando.

• Seleziona il progetto Google Cloud che hai creato:

  gcloud config set project PROJECT_ID

  Sostituisci PROJECT_ID con il nome del progetto Google Cloud .

Verifica che la fatturazione sia abilitata per il tuo progetto Google Cloud .

1. Aggiorna i componenti di Google Cloud CLI:

   gcloud components update

2. Accedi utilizzando il tuo account:

   gcloud auth login

3. Abilita le API:

   gcloud services enable artifactregistry.googleapis.com \
       cloudbuild.googleapis.com \
       eventarc.googleapis.com \
       pubsub.googleapis.com \
       run.googleapis.com

4. Imposta le variabili di configurazione utilizzate in questo tutorial:

   export REGION=us-central1
   gcloud config set run/region ${REGION}
   gcloud config set run/platform managed
   gcloud config set eventarc/location ${REGION}
   export SERVICE_NAME=trigger-pubsub

5. Se hai creato il progetto, ti viene assegnato il ruolo di base Proprietario (roles/owner). Per impostazione predefinita, questo ruolo Identity and Access Management (IAM) include le autorizzazioni necessarie per l'accesso completo alla maggior parte delle risorse Google Cloud e puoi saltare questo passaggio.

   Se non sei il creatore del progetto, le autorizzazioni richieste devono essere concesse al principal appropriato. Ad esempio, un'entità può essere un Account Google (per gli utenti finali) o un account di servizio (per applicazioni e carichi di lavoro di calcolo). Per saperne di più, consulta la pagina Ruoli e autorizzazioni per la destinazione eventi.

   Tieni presente che, per impostazione predefinita, le autorizzazioni di Cloud Build includono le autorizzazioni per caricare e scaricare gli artefatti di Artifact Registry.

   Autorizzazioni obbligatorie

   Per ottenere le autorizzazioni necessarie per completare questo tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM per il progetto:

   • Editor Cloud Build (roles/cloudbuild.builds.editor)
   • Cloud Run Admin (roles/run.admin)
   • Eventarc Admin (roles/eventarc.admin)
   • Logs View Accessor (roles/logging.viewAccessor)
   • Project IAM Admin (roles/resourcemanager.projectIamAdmin)
   • Pub/Sub Publisher (roles/pubsub.publisher)
   • Amministratore service account (roles/iam.serviceAccountAdmin)
   • Utente Service Account (roles/iam.serviceAccountUser)
   • Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin)
   • Storage Admin (roles/storage.admin)

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

   Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

6. Prendi nota dell'account di servizio predefinito di Compute Engine, in quanto lo collegherai a un trigger Eventarc per rappresentare l'identità del trigger a scopo di test. Questo account di servizio viene creato automaticamente dopo l'attivazione o l'utilizzo di un servizio Google Cloud che utilizza Compute Engine e con il seguente formato email:

   [e-mail]

   Sostituisci PROJECT_NUMBER con il numero del tuo progetto Google Cloud. Puoi trovare il numero di progetto nella pagina Benvenuto della console Google Cloud o eseguendo questo comando:

   gcloud projects describe PROJECT_ID --format='value(projectNumber)'

   Per gli ambienti di produzione, ti consigliamo vivamente di creare un nuovo service account e di concedergli uno o più ruoli IAM che contengano le autorizzazioni minime richieste e di seguire il principio del privilegio minimo.

   Nota:

   Il vincolo della policy dell'organizzazione iam.automaticIamGrantsForDefaultServiceAccounts impedisce che il ruolo Editor venga concesso automaticamente ai service account predefiniti. Se hai creato la tua organizzazione dopo il 3 maggio 2024, questo vincolo viene applicato per impostazione predefinita.

   Ti consigliamo vivamente di applicare questo vincolo per disattivare la concessione automatica dei ruoli. Se disattivi la concessione automatica dei ruoli, devi decidere quali ruoli concedere ai service account predefiniti, quindi concederli personalmente.

   Se il service account predefinito dispone già del ruolo Editor, ti consigliamo di sostituire il ruolo Editor con ruoli meno permissivi.Per modificare in sicurezza i ruoli del service account, utilizza Policy Simulator per vedere l'impatto della modifica, quindi concedi e revoca i ruoli appropriati.

7. Per impostazione predefinita, i servizi Cloud Run sono chiamabili solo da proprietari del progetto, editor del progetto e amministratori e chiamanti di Cloud Run. Puoi controllare l'accesso in base al servizio; tuttavia, a scopo di test, concedi il ruolo Invoker Cloud Run (run.invoker) nel progetto Google Cloud al account di servizio Compute Engine. Questo ruolo viene concesso per tutti i servizi e i job Cloud Run in un progetto.

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/run.invoker

   Tieni presente che se crei un trigger per un servizio Cloud Run autenticato senza concedere il ruolo Invoker di Cloud Run, il trigger viene creato correttamente ed è attivo. Tuttavia, il trigger non funzionerà come previsto e nei log viene visualizzato un messaggio simile al seguente:

   The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
8. Se hai attivato l'agente di servizio Cloud Pub/Sub l'8 aprile 2021 o in una data precedente, per supportare le richieste push Pub/Sub autenticate, concedi il ruolo Creatore token service account (roles/iam.serviceAccountTokenCreator) all'agente di servizio. In caso contrario, questo ruolo viene concesso per impostazione predefinita:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/iam.serviceAccountTokenCreator

Crea un repository Artifact Registry standard

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

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

Sostituisci REPOSITORY con un nome univoco per il repository.

Esegui il deployment di un ricevitore di eventi in Cloud Run

Esegui il deployment di un servizio Cloud Run che registra i contenuti di un evento.

1. Clona il repository GitHub:

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

   Java

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

   Ruby

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

   C#

   git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

2. Passa alla directory che contiene il codice campione di Cloud Run:

   Node.js

   cd nodejs-docs-samples/eventarc/pubsub/

   Python

   cd python-docs-samples/eventarc/pubsub/

   Go

   cd golang-samples/eventarc/pubsub/

   Java

   cd java-docs-samples/eventarc/pubsub/

   Ruby

   cd ruby-docs-samples/eventarc/pubsub/

   C#

   cd dotnet-docs-samples/eventarc/pubsub/

3. Crea il container e caricalo in Cloud Build:

   gcloud builds submit --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/trigger-pubsub:v1

4. Esegui il deployment dell'immagine container in Cloud Run:

   gcloud run deploy ${SERVICE_NAME} \
       --image $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/trigger-pubsub:v1

5. Al prompt Consenti chiamate non autenticate a trigger-pubsub (y/N)?, rispondi n per "No".

Nota: in base al livello di accesso di rete richiesto al servizio Cloud Run, puoi anche impostare il flag ingress.

Quando vedi l'URL del servizio Cloud Run, significa che il deployment è stato completato.

Crea un trigger Eventarc

Quando un messaggio viene pubblicato nell'argomento Pub/Sub, l'evento attiva il servizio Cloud Run.

Nota :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.

1. Crea un trigger per ascoltare i messaggi Pub/Sub:

   Nuovo argomento Pub/Sub

     gcloud eventarc triggers create ${SERVICE_NAME} \
         --destination-run-service=${SERVICE_NAME} \
         --destination-run-region=${REGION} \
         --location=${REGION} \
         --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
         --service-account=[e-mail]
   

   Vengono creati un nuovo argomento Pub/Sub e un trigger per questo argomento denominato trigger-pubsub.

   Argomento Pub/Sub esistente

     gcloud eventarc triggers create ${SERVICE_NAME} \
         --destination-run-service=${SERVICE_NAME} \
         --destination-run-region=${REGION} \
         --location=${REGION} \
         --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
         --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID \
         --service-account=[e-mail]
   

   Sostituisci quanto segue:

   • PROJECT_ID: il tuo Google Cloud ID progetto
   • TOPIC_ID: l'ID dell'argomento Pub/Sub esistente

   Viene creato un trigger denominato trigger-pubsub per l'argomento Pub/Sub esistente.

   Tieni presente che quando crei un trigger Eventarc per la prima volta in un progetto Google Cloud , potrebbe verificarsi un ritardo nel provisioning dell'agente di servizio Eventarc. Questo problema può essere risolto di solito provando a creare di nuovo il trigger. Per saperne di più, consulta la sezione Errori di autorizzazione negata.

2. Verifica che il trigger sia stato creato correttamente. Tieni presente che, anche se il trigger viene creato immediatamente, potrebbero essere necessari fino a due minuti prima che sia completamente funzionale.

   gcloud eventarc triggers list --location=${REGION}

   Lo stato dell'attivatore restituito deve essere ACTIVE: Yes.

Generare e visualizzare un evento

Pubblica un messaggio in un argomento Pub/Sub per generare un evento e attivare il servizio Cloud Run. Il servizio Cloud Run registra i messaggi nei log del servizio.

1. Trova e imposta l'argomento Pub/Sub come variabile di ambiente:

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

2. Invia un messaggio all'argomento Pub/Sub per generare un evento:

   gcloud pubsub topics publish $TOPIC_ID --message "Hello there"

   L'evento viene inviato al servizio Cloud Run, che registra il messaggio dell'evento.

3. Visualizza le voci di log relative agli eventi create dal tuo servizio:

   gcloud logging read 'textPayload: "Hello there!"'

   La voce di log dovrebbe essere simile alla seguente:

   textPayload: 'Hello, Hello there!'

La visualizzazione dei log potrebbe richiedere qualche istante. Se non li vedi subito, ricontrolla dopo un minuto.

Esegui la pulizia

Per evitare di incorrere in addebiti come l'archiviazione dell'immagine container in Artifact Registry, l'archiviazione dei file nel bucket Cloud Storage e l'attivazione di Eventarc, puoi eliminare le risorse che hai creato per questo tutorial:

1. Elimina il servizio Cloud Run.

2. Elimina l'immagine container.

3. Elimina il trigger Eventarc.

In alternativa, puoi eliminare il tuo progetto Google Cloud . L'eliminazione del tuo progettoGoogle Cloud interrompe la fatturazione per tutte le risorse utilizzate al suo interno.

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, eliminerai anche tutto il lavoro che hai 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.

Elimina un progetto Google Cloud :

gcloud projects delete PROJECT_ID

Passaggi successivi

• Ricevere un evento Pub/Sub utilizzando un servizio Cloud Run non autenticato
• Creare container
• Crea un trigger per il routing degli eventi Pub/Sub a Cloud Run
• Sviluppa servizi Cloud Run