Questo tutorial mostra come scrivere e attivare funzioni Cloud Run basate su eventi con un trigger Pub/Sub.
Puoi configurare il routing degli eventi, inclusi l'origine e la destinazione, 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 una richiesta viene inviata 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, utilizzi 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.
- 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.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud 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.
-
-
Make sure that billing is enabled for your Google Cloud project.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud 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.
-
-
Make sure that billing is enabled for your Google Cloud project.
- 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 account di servizio:
SERVICE_ACCOUNT=eventarc-trigger-sa gcloud iam service-accounts create $SERVICE_ACCOUNT
Se il tuo progetto è soggetto a un criterio dell'organizzazione con restrizioni di dominio che limitano le chiamate non autenticate, dovrai accedere al servizio di cui è stato eseguito il deployment come descritto in Test dei servizi privati.
Ruoli obbligatori
Tu o il tuo amministratore dovete concedere all'account di deployment, all'identità del trigger e, facoltativamente, all'agente di servizio Pub/Sub e all'agente di servizio Cloud Storage i seguenti ruoli IAM.
Ruoli richiesti per l'account del deployer
-
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.
Per ottenere le autorizzazioni necessarie per completare questo tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:
-
Sviluppatore di origini Cloud Run (
roles/run.sourceDeveloper
) -
Amministratore IAM progetto (
roles/resourcemanager.projectIamAdmin
) -
Utente service account (
roles/iam.serviceAccountUser
) -
Amministratore utilizzo servizi (
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.
-
Sviluppatore di origini Cloud Run (
Ruoli obbligatori per l'identità del trigger
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:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
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.
- Per impostazione predefinita, i servizi Cloud Run possono essere chiamati 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 di Cloud Run (
run.invoker
) nel progetto Google Cloud all'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: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 unauthenticated invocations or set the proper Authorization header.
- Concedi il
ruolo Destinatario di eventi
Eventarc (
roles/eventarc.eventReceiver
) nel progetto al account di servizio predefinito di Compute Engine 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 l'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.git
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Vai
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
.NET
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
Passa alla directory che contiene il codice campione per l'accesso a Pub/Sub:
Node.js
cd nodejs-docs-samples/functions/v2/helloPubSub/
Python
cd python-docs-samples/functions/v2/pubsub/
Vai
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 sugli eventi
Per 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 che 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
nodejs22
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
python313
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
go123
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
java21
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
dotnet8
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
ruby34
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 che 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
php84
. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Runtime di 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 mostra un URL in cui
il servizio è in esecuzione.
Crea un trigger Eventarc
Per il deployment della funzione con un trigger Pub/Sub, esegui questo comando nella directory contenente ilcodice campioneo:
Crea un trigger Eventarc Pub/Sub:
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 dell'attivatore.
- FUNCTION con il nome della tua funzione.
- PROJECT_NUMBER con il numero del tuo 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 dell'agente di servizio Eventarc. Questo problema può essere risolto di solito riprovando a creare il trigger. Per saperne di più, vedi Errori di autorizzazione negata.
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}
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
Attivare 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 servizio Cloud Run registra il corpo del messaggio in entrata. 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 alcuni istanti. Se non li vedi immediatamente, ricontrolla dopo qualche istante.
Cerca il messaggio "Hello World!".
Esegui la pulizia
Se hai creato un nuovo progetto per questo tutorial, elimina il progetto. 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 è quello di eliminare il progetto creato per il tutorial.
Per eliminare il progetto:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Eliminare 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 che hai scelto.Puoi anche eliminare i servizi Cloud Run dalla Google Cloud console.
Rimuovi tutte le configurazioni predefinite gcloud CLI che hai aggiunto durante la configurazione del tutorial.
Ad esempio:
gcloud config unset run/region
o
gcloud config unset project
Elimina le altre risorse Google Cloud create in questo tutorial:
- Elimina il trigger Eventarc:
Sostituiscigcloud eventarc triggers delete TRIGGER_NAME
TRIGGER_NAME
con il nome del tuo trigger.
- Elimina il trigger Eventarc: