Questo tutorial mostra come scrivere e attivare Cloud Run Functions basate su eventi con un trigger Pub/Sub.
Puoi configurare il routing degli eventi, inclusi l'origine e la destinazione degli eventi, specificando i filtri per un trigger Eventarc. Per l'esempio in questo tutorial, la pubblicazione di un messaggio in un argomento Pub/Sub attiva l'evento e viene inviata una richiesta alla tua funzione sotto forma di richiesta HTTP.
Se non hai mai utilizzato Pub/Sub e vuoi saperne di più, consulta la documentazione di Pub/Sub per guide rapide e riferimenti chiave.
Obiettivi
In questo tutorial, imparerai a:
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi.
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 progetto Google Cloud .
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 cui ti è stato concesso un ruolo.
-
Crea un progetto: per creare un progetto, devi disporre del ruolo Autore progetto (
roles/resourcemanager.projectCreator), che contiene l'autorizzazioneresourcemanager.projects.create. Scopri come concedere i ruoli.
-
Crea un progetto Google Cloud :
gcloud projects create PROJECT_ID
Sostituisci
PROJECT_IDcon 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_IDcon il nome del progetto Google Cloud .
-
Verifica che la fatturazione sia attivata 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 progetto Google Cloud .
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 cui ti è stato concesso un ruolo.
-
Crea un progetto: per creare un progetto, devi disporre del ruolo Autore progetto (
roles/resourcemanager.projectCreator), che contiene l'autorizzazioneresourcemanager.projects.create. Scopri come concedere i ruoli.
-
Crea un progetto Google Cloud :
gcloud projects create PROJECT_ID
Sostituisci
PROJECT_IDcon 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_IDcon il nome del progetto Google Cloud .
-
Verifica che la fatturazione sia attivata per il tuo progetto Google Cloud .
- Se non utilizzi Cloud Shell, aggiorna i componenti di Google Cloud CLI e accedi utilizzando il tuo account:
gcloud components update gcloud auth login
- Abilita le API:
gcloud services enable artifactregistry.googleapis.com \ cloudbuild.googleapis.com \ eventarc.googleapis.com \ run.googleapis.com \ logging.googleapis.com \ pubsub.googleapis.com
- 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}
- Crea un service account:
SERVICE_ACCOUNT=eventarc-trigger-sa gcloud iam service-accounts create $SERVICE_ACCOUNT
Se il tuo progetto è soggetto a una policy dell'organizzazione con limitazione del dominio che limita le chiamate non autenticate, dovrai accedere al servizio di cui hai eseguito il deployment come descritto in Test dei servizi privati.
Ruoli obbligatori
Tu o l'amministratore dovete concedere all'account deployer, all'identità del trigger e, facoltativamente, all'agente di servizio Pub/Sub e all'agente di servizio Cloud Storage i seguenti ruoli IAM.
Ruoli obbligatori per l'account deployer
-
Se sei l'autore del progetto, ti viene concesso il ruolo di base Proprietario (
roles/owner). Per impostazione predefinita, questo ruolo IAM (Identity and Access Management) include le autorizzazioni necessarie per l'accesso completo alla maggior parte delle risorse Google Cloude puoi saltare questo passaggio.Se non sei il Project Creator, devi concedere le autorizzazioni richieste sul progetto all'entità appropriata. Ad esempio, un'entità può essere un Account Google (per gli utenti finali) o un account di servizio (per le applicazioni e i workload di computing). Per saperne di più, consulta la pagina Ruoli e autorizzazioni per la destinazione degli eventi.
Per ottenere le autorizzazioni necessarie per completare questo tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:
- Cloud Run Source Developer (
roles/run.sourceDeveloper) - Project IAM Admin (
roles/resourcemanager.projectIamAdmin) - Utente Service Account (
roles/iam.serviceAccountUser) - Amministratore Service Usage (
roles/serviceusage.serviceUsageAdmin) - Logs View Accessor (
roles/logging.viewAccessor)
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.
Tieni presente che, per impostazione predefinita, le autorizzazioni di Cloud Build includono le autorizzazioni per caricare e scaricare gli artefatti di Artifact Registry.
- Cloud Run Source Developer (
Ruoli richiesti per l'identità del trigger
Prendi nota del service account predefinito di Compute Engine, perché 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:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
Sostituisci
PROJECT_NUMBERcon il tuo numero di 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 contengono le autorizzazioni minime richieste e di seguire il principio del privilegio minimo.
- Per impostazione predefinita, i servizi Cloud Run possono essere chiamati solo da Project Owner, Project Editor e Cloud Run Admin e Invoker.
Puoi controllare l'accesso in base al servizio; tuttavia, per scopi di test, concedi il ruolo Cloud Run Invoker (
run.invoker) nel progetto Google Cloud al account di servizio Compute Engine. In questo modo, il ruolo viene concesso a tutti i servizi e i job Cloud Run di un progetto.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --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 verrà visualizzato un messaggio simile al seguente:
The request was not authenticated. Either allow public access or set the proper Authorization header. - Concedi il ruolo Eventarc Event Receiver (
roles/eventarc.eventReceiver) nel progetto al account di servizio Compute Engine predefinito in modo che il trigger Eventarc possa ricevere eventi dai provider di eventi.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/eventarc.eventReceiver
Ruolo facoltativo per l'agente di servizio Cloud Storage
- Prima di creare un trigger per gli eventi diretti da Cloud Storage, concedi il ruolo Publisher Pub/Sub (
roles/pubsub.publisher) all'agente di servizio Cloud Storage:SERVICE_ACCOUNT="$(gcloud storage service-agent --project=PROJECT_ID)" gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:${SERVICE_ACCOUNT}" \ --role='roles/pubsub.publisher'
Ruolo facoltativo per l'agente di servizio Pub/Sub
- Se hai attivato l'agente di servizio Cloud Pub/Sub il giorno 8 aprile 2021 o in una data precedente, per supportare le richieste push Pub/Sub autenticate, concedi il ruolo Creatore token account di servizio (
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:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Crea un argomento Pub/Sub
In Cloud Run, gli argomenti Pub/Sub non vengono creati automaticamente quando esegui il deployment di una funzione. Prima di eseguire il deployment della funzione, pubblica un messaggio in questo argomento Pub/Sub per attivare la funzione:
gcloud pubsub topics create YOUR_TOPIC_NAME
Prepara l'applicazione
Clona il repository dell'app di esempio sulla tua macchina locale:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.gitPython
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.gitGo
git clone https://github.com/GoogleCloudPlatform/golang-samples.gitJava
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git.NET
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.gitRuby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.gitPHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.gitPassa alla directory che contiene il codice campione per accedere a Pub/Sub:
Node.js
cd nodejs-docs-samples/functions/v2/helloPubSub/Python
cd python-docs-samples/functions/v2/pubsub/Go
cd golang-samples/functions/functionsv2/hellopubsub/Java
cd java-docs-samples/functions/v2/pubsub/.NET
cd dotnet-docs-samples/functions/helloworld/HelloPubSub/Ruby
cd ruby-docs-samples/functions/helloworld/pubsub/PHP
cd php-docs-samples/functions/helloworld_pubsub/Dai un'occhiata al codice campione:
Node.js
Python
Go
Java
.NET
Ruby
PHP
Esegui il deployment di una funzione basata su eventi
Per eseguire il deployment della funzione, esegui questo comando nella directory che contiene il codice campione:
Node.js
gcloud run deploy FUNCTION \
--source . \
--function helloPubSub \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
nodejs24. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
Python
gcloud run deploy FUNCTION \
--source . \
--function subscribe \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
python314. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
Vai
gcloud run deploy FUNCTION \
--source . \
--function HelloPubSub \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
go127. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
Java
gcloud run deploy FUNCTION \
--source . \
--function functions.SubscribeToTopic \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
java25. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
.NET
gcloud run deploy FUNCTION \
--source . \
--function HelloPubSub.Function \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
dotnet10. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
Ruby
gcloud run deploy FUNCTION \
--source . \
--function hello_pubsub \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
ruby40. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
PHP
gcloud run deploy FUNCTION \
--source . \
--function helloworldPubsub \
--base-image BASE_IMAGE \
Sostituisci:
- FUNCTION con il nome della funzione di cui stai eseguendo il deployment. Se ometti questo parametro, ti verrà chiesto di inserire un nome quando esegui il comando.
- BASE_IMAGE con l'ambiente dell'immagine di base per la tua funzione, ad esempio
php85. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Runtime dei linguaggi e immagini di base supportati.
Se ti viene chiesto di creare un repository nella regione specificata, rispondi premendo y.
Al termine del deployment, Google Cloud CLI visualizza un URL in cui è in esecuzione il servizio.
Crea un trigger Eventarc
Per eseguire il deployment della funzione con un trigger Pub/Sub, esegui questo comando nella directory che contiene il codice campione:
Crea un trigger Pub/Sub Eventarc:
gcloud eventarc triggers create TRIGGER_NAME \ --location=${REGION} \ --destination-run-service=FUNCTION \ --destination-run-region=${REGION} \ --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \ --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
Sostituisci:
- TRIGGER_NAME con il nome del trigger.
- FUNCTION con il nome della tua funzione.
- PROJECT_NUMBER con il numero di progetto Google Cloud .
Tieni presente che quando crei un trigger Eventarc per la prima volta in un progetto Google Cloud , potrebbe verificarsi un ritardo nel provisioning del service agent Eventarc. Questo problema di solito può essere risolto provando a creare nuovamente il trigger. Per saperne di più, consulta Errori di autorizzazione negata.
Verifica che il trigger sia stato creato correttamente. Tieni presente che, sebbene il trigger venga creato immediatamente, possono essere necessari fino a due minuti prima che sia completamente funzionale.
gcloud eventarc triggers list --location=${REGION}
L'output dovrebbe essere simile al seguente:
NAME: helloworld-events TYPE: google.cloud.pubsub.topic.v1.messagePublished DESTINATION: Cloud Run service: helloworld-events ACTIVE: Yes LOCATION: us-central1
Attiva la funzione
Per testare la funzione Pub/Sub:
Assegna l'argomento a una variabile:
TOPIC_ID=$(gcloud eventarc triggers describe TRIGGER_NAME --location $REGION --format='value(transport.pubsub.topic)')Pubblica un messaggio nell'argomento:
gcloud pubsub topics publish $TOPIC_ID --message="Hello World"
Il log del servizio Cloud Run registra il corpo del messaggio in arrivo. Puoi visualizzarlo nella sezione Log dell'istanza Cloud Run:
- Vai alla consoleGoogle Cloud .
- Fai clic sulla funzione.
Seleziona la scheda Log.
La visualizzazione dei log potrebbe richiedere qualche istante. Se non li vedi subito, ricontrolla dopo qualche istante.
Cerca il messaggio "Hello World!".
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.
Elimina il progetto
Il modo più semplice per eliminare la fatturazione è eliminare il progetto creato per il tutorial.
Per eliminare il progetto:
- Nella console Google Cloud , vai alla pagina Gestisci risorse.
- Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
- Nella finestra di dialogo, digita l'ID progetto, quindi fai clic su Chiudi per eliminare il progetto.
Elimina le risorse del tutorial
Elimina il servizio 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 eliminare i servizi Cloud Run anche dalla consoleGoogle Cloud .
Rimuovi le configurazioni predefinite di gcloud CLI che hai aggiunto durante la configurazione del tutorial.
Ad esempio:
gcloud config unset run/regiono
gcloud config unset projectElimina le altre risorse Google Cloud create in questo tutorial:
- Elimina il trigger Eventarc:
Sostituiscigcloud eventarc triggers delete TRIGGER_NAME
TRIGGER_NAMEcon il nome del trigger.
- Elimina il trigger Eventarc: