Questo tutorial mostra come scrivere, eseguire il deployment e chiamare un servizio Cloud Run da una sottoscrizione push Pub/Sub.
Obiettivi
- Scrivere, creare ed eseguire il deployment di un servizio su Cloud Run
- Chiama il servizio pubblicando un messaggio in un argomento Pub/Sub.
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
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Pub/Sub and Cloud Run APIs.
- Installa e inizializza gcloud CLI.
- Aggiorna i componenti:
gcloud components update
-
Editor Cloud Build (
roles/cloudbuild.builds.editor
) -
Cloud Run Admin (
roles/run.admin
) -
Crea service account (
roles/iam.serviceAccountCreator
) -
Amministratore IAM progetto (
roles/resourcemanager.projectIamAdmin
) -
Editor Pub/Sub (
roles/pubsub.editor
) -
Utente service account (
roles/iam.serviceAccountUser
) -
Consumer utilizzo servizi (
roles/serviceusage.serviceUsageConsumer
) -
Amministratore spazio di archiviazione (
roles/storage.admin
)
Ruoli obbligatori
Per ottenere le autorizzazioni necessarie per completare il tutorial, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:
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.
Configura i valori predefiniti di gcloud
Per configurare gcloud con i valori predefiniti per il tuo servizio Cloud Run:
Imposta il progetto predefinito:
gcloud config set project PROJECT_ID
Sostituisci PROJECT_ID con il nome del progetto che hai creato per questo tutorial.
Configura gcloud per la regione scelta:
gcloud config set run/region REGION
Sostituisci REGION con la regione Cloud Run supportata che preferisci.
Località Cloud Run
Cloud Run è regionale, il che significa che l'infrastruttura che
esegue i tuoi servizi Cloud Run si trova in una regione specifica ed è
gestita da Google per essere disponibile in modo ridondante in
tutte le zone all'interno di quella regione.
Il rispetto dei requisiti di latenza, disponibilità o durabilità sono fattori
primari per la selezione della regione in cui vengono eseguiti i servizi Cloud Run.
In genere puoi selezionare la regione più vicina ai tuoi utenti, ma devi considerare
la posizione degli altri Google Cloud
prodotti utilizzati dal tuo servizio Cloud Run.
L'utilizzo Google Cloud combinato di prodotti in più località può influire sulla latenza e sui costi del servizio.
Cloud Run è disponibile nelle seguenti regioni:
Soggetto ai prezzi di Livello 1
asia-east1
(Taiwan)asia-northeast1
(Tokyo)asia-northeast2
(Osaka)asia-south1
(Mumbai, India)europe-north1
(Finlandia)Bassi livelli di CO2
europe-north2
(Stoccolma)Bassi livelli di CO2
europe-southwest1
(Madrid)Bassi livelli di CO2
europe-west1
(Belgio)Bassi livelli di CO2
europe-west4
(Paesi Bassi)Bassi livelli di CO2
europe-west8
(Milano)europe-west9
(Parigi)Bassi livelli di CO2
me-west1
(Tel Aviv)northamerica-south1
(Messico)us-central1
(Iowa)Bassi livelli di CO2
us-east1
(Carolina del Sud)us-east4
(Virginia del Nord)us-east5
(Columbus)us-south1
(Dallas)Bassi livelli di CO2
us-west1
(Oregon)Bassi livelli di CO2
Soggetto ai prezzi di Livello 2
africa-south1
(Johannesburg)asia-east2
(Hong Kong)asia-northeast3
(Seul, Corea del Sud)asia-southeast1
(Singapore)asia-southeast2
(Giacarta)asia-south2
(Delhi, India)australia-southeast1
(Sydney)australia-southeast2
(Melbourne)europe-central2
(Varsavia, Polonia)europe-west10
(Berlino)Bassi livelli di CO2
europe-west12
(Torino)europe-west2
(Londra, Regno Unito)Bassi livelli di CO2
europe-west3
(Francoforte, Germania)Bassi livelli di CO2
europe-west6
(Zurigo, Svizzera)Bassi livelli di CO2
me-central1
(Doha)me-central2
(Dammam)northamerica-northeast1
(Montreal)Bassi livelli di CO2
northamerica-northeast2
(Toronto)Bassi livelli di CO2
southamerica-east1
(San Paolo, Brasile)Bassi livelli di CO2
southamerica-west1
(Santiago, Cile)Bassi livelli di CO2
us-west2
(Los Angeles)us-west3
(Salt Lake City)us-west4
(Las Vegas)
Se hai già creato un servizio Cloud Run, puoi visualizzare la regione nella dashboard di Cloud Run nella consoleGoogle Cloud .
Crea un repository standard Artifact Registry
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.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
crea un argomento Pub/Sub
Il servizio di esempio viene attivato dai messaggi pubblicati in un argomento Pub/Sub, quindi devi creare un argomento in Pub/Sub.
gcloud
Per creare un nuovo argomento Pub/Sub, utilizza il comando:
gcloud pubsub topics create myRunTopic
Puoi utilizzare myRunTopic o sostituirlo con un nome di argomento univoco all'interno del tuo progetto Google Cloud .
Terraform
Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.
Per creare un argomento Pub/Sub, aggiungi quanto segue al file main.tf
esistente:
Puoi utilizzare un nome di argomento univoco all'interno del tuo progetto cloud.
Recupera il esempio di codice
Per recuperare l'esempio di codice da utilizzare:
Clona il repository dell'app di esempio sulla tua macchina locale:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Vai
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Passa alla directory che contiene il codice campione di Cloud Run:
Node.js
cd nodejs-docs-samples/run/pubsub/
Python
cd python-docs-samples/run/pubsub/
Vai
cd golang-samples/run/pubsub/
Java
cd java-docs-samples/run/pubsub/
C#
cd dotnet-docs-samples/run/Run.Samples.Pubsub.MinimalApi/
Esamina il codice
Il codice di questo tutorial è costituito da quanto segue:
Un server che gestisce le richieste in entrata.
Node.js
Per semplificare il test del servizio Node.js, la configurazione del server è separata dall'avvio del server.
Il server web Node.js è configurato in
app.js
.Il server web viene avviato in
index.js
:Python
Go
Java
C#
Un gestore che elabora il messaggio Pub/Sub e registra un saluto.
Node.js
Python
Go
Java
C#
Devi codificare il servizio in modo che restituisca un codice di risposta HTTP accurato. I codici di operazione riuscita, ad esempio HTTP
200
o204
, confermano l'elaborazione completa del messaggio Pub/Sub. I codici di errore, ad esempio HTTP400
o500
, indicano che il messaggio verrà ritentato, come descritto nella Guida alla ricezione dei messaggi tramite Push.Un
Dockerfile
che definisce l'ambiente operativo per il servizio. I contenuti diDockerfile
variano in base alla lingua.Node.js
Python
Go
Java
Questo esempio utilizza Jib per creare immagini Docker utilizzando strumenti Java comuni. Jib ottimizza le build dei container senza la necessità di un Dockerfile o di Docker installato. Scopri di più sulla creazione di container Java con Jib.
C#
Per informazioni dettagliate su come autenticare l'origine delle richieste Pub/Sub, consulta Integrare con Pub/Sub.
Spedisci il codice
La spedizione del codice è composta da tre passaggi: la creazione di un'immagine container con Cloud Build, il caricamento dell'immagine container in Artifact Registry e il deployment dell'immagine container in Cloud Run.
Per spedire il codice:
-
Crea il container e pubblicalo su Artifact Registry:
Node.js
Sostituisci:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine.In caso di esito positivo, dovresti visualizzare un messaggio di operazione riuscita contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Artifact Registry e può essere riutilizzata, se necessario.
Python
Sostituisci:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine.In caso di esito positivo, dovresti visualizzare un messaggio di operazione riuscita contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Artifact Registry e può essere riutilizzata, se necessario.
Vai
Sostituisci:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine.In caso di esito positivo, dovresti visualizzare un messaggio di operazione riuscita contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Artifact Registry e può essere riutilizzata, se necessario.
Java
-
Utilizza l'assistente per le credenziali gcloud CLI
per autorizzare Docker a eseguire il push su Artifact Registry.
gcloud auth configure-docker
-
Utilizza il plug-in Jib Maven per creare ed eseguire il push del container in Artifact Registry.
Sostituisci:mvn compile jib:build -D image=REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine.In caso di esito positivo, dovresti visualizzare un messaggio che indica che la build è stata creata correttamente. L'immagine è archiviata in Artifact Registry e, se necessario, può essere riutilizzata.
C#
Sostituisci:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine.In caso di esito positivo, dovresti visualizzare un messaggio di operazione riuscita contenente l'ID, l'ora di creazione e il nome dell'immagine. L'immagine è archiviata in Artifact Registry e può essere riutilizzata se necessario.
-
Esegui il deployment dell'applicazione:
Riga di comando
-
Esegui questo comando per eseguire il deployment dell'app:
Sostituisci:gcloud run deploy pubsub-tutorial --image REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub --no-allow-unauthenticated
- PROJECT_ID con l'ID progetto Google Cloud .
- REPOSITORY con il nome del repository Artifact Registry.
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
pubsub
è il nome dell'immagine epubsub-tutorial
è il nome del servizio. Tieni presente che l'immagine container viene implementata nel servizio e nella regione che hai configurato in precedenza in Configurazione di gcloud.Il flag
--no-allow-unauthenticated
limita l'accesso non autenticato al servizio. Mantenendo privato il servizio, puoi fare affidamento sull'integrazione automatica di Pub/Sub di Cloud Run per autenticare le richieste. Per maggiori dettagli sulla configurazione, consulta Integrare con Pub/Sub. Per maggiori dettagli sull'autenticazione basata su Identity and Access Management (IAM), consulta Gestire l'accesso utilizzando IAM.Attendi il completamento del deployment, che può richiedere circa 30 secondi. Se l'operazione riesce, la riga di comando visualizza l'URL del servizio. Questo URL viene utilizzato per configurare una sottoscrizione Pub/Sub.
-
Se vuoi eseguire il deployment di un aggiornamento del codice nel servizio, ripeti i passaggi precedenti. Ogni deployment in un servizio crea una nuova revisione e inizia automaticamente a pubblicare il traffico quando è pronto.
Terraform
Per creare un servizio Cloud Run, aggiungi quanto segue al file
.tf
esistente. Sostituisci:resource "google_project_service" "cloudrun_api" { service = "run.googleapis.com" disable_on_destroy = false } resource "google_cloud_run_v2_service" "default" { name = "pubsub-tutorial" location = "REGION" template { containers { image = "IMAGE_URL" } } depends_on = [google_project_service.cloudrun_api] }
- IMAGE_URL con l'URL dell'immagine:
REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- REGION con la regione Google Cloud da utilizzare per il repository Artifact Registry.
-
Integrare con Pub/Sub
Per integrare il servizio con Pub/Sub:
gcloud
Crea o seleziona un account di servizio per rappresentare l'identità dell'abbonamento Pub/Sub.
gcloud iam service-accounts create cloud-run-pubsub-invoker \ --display-name "Cloud Run Pub/Sub Invoker"
Puoi utilizzare
cloud-run-pubsub-invoker
o sostituirlo con un nome univoco all'interno del tuo progetto Google Cloud .Crea una sottoscrizione Pub/Sub con il account di servizio:
Concedi al account di servizio chiamante l'autorizzazione per richiamare il servizio
pubsub-tutorial
:gcloud run services add-iam-policy-binding pubsub-tutorial \ --member=serviceAccount:cloud-run-pubsub-invoker@PROJECT_ID.iam.gserviceaccount.com \ --role=roles/run.invoker
La propagazione delle modifiche IAM può richiedere diversi minuti. Nel frattempo, potresti visualizzare errori
HTTP 403
nei log del servizio.Consenti a Pub/Sub di creare token di autenticazione nel tuo progetto:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Sostituisci:
- PROJECT_ID con l'ID progetto Google Cloud .
- PROJECT_NUMBER con il numero del tuo progetto Google Cloud .
L'ID progetto e il numero di progetto sono elencati nel riquadro Informazioni sul progetto della consoleGoogle Cloud del tuo progetto.
Crea una sottoscrizione Pub/Sub con il account di servizio:
gcloud pubsub subscriptions create myRunSubscription --topic myRunTopic \ --ack-deadline=600 \ --push-endpoint=SERVICE-URL/ \ --push-auth-service-account=cloud-run-pubsub-invoker@PROJECT_ID.iam.gserviceaccount.com
Sostituisci:
- myRunTopic con l'argomento che hai creato in precedenza.
- SERVICE-URL con l'URL HTTPS fornito durante il deployment del servizio. Questo URL funziona anche se hai aggiunto una mappatura di dominio.
- PROJECT_ID con l'ID progetto Google Cloud .
Il flag
--push-auth-service-account
attiva la funzionalità push di Pub/Sub per l'autenticazione e l'autorizzazione.Il dominio del servizio Cloud Run viene registrato automaticamente per l'utilizzo con gli abbonamenti Pub/Sub.
Solo per Cloud Run, è presente un controllo di autenticazione integrato che verifica che il token sia valido e un controllo di autorizzazione che verifica che il service account disponga dell'autorizzazione per richiamare il servizio Cloud Run.
Il servizio è ora completamente integrato con Pub/Sub.
Terraform
Crea o seleziona un account di servizio per rappresentare l'identità dell'abbonamento Pub/Sub.
Crea una sottoscrizione Pub/Sub con il account di servizio:
Concedi al account di servizio chiamante l'autorizzazione per richiamare il servizio
pubsub-tutorial
:Consenti a Pub/Sub di creare token di autenticazione nel tuo progetto:
Crea una sottoscrizione Pub/Sub con il account di servizio:
Il servizio è ora completamente integrato con Pub/Sub.
Fai una prova
Per testare la soluzione end-to-end:
Invia un messaggio Pub/Sub all'argomento:
gcloud pubsub topics publish myRunTopic --message "Runner"
Puoi anche pubblicare messaggi in modo programmatico anziché utilizzare la riga di comando, come mostrato in questo tutorial. Per ulteriori informazioni, consulta la sezione Pubblicare messaggi.
Vai ai log del servizio:
- Vai alla consoleGoogle Cloud
- Fai clic sul servizio
pubsub-tutorial
. 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 Runner!".
Esegui la pulizia
Per esaminare un caso d'uso più approfondito dell'utilizzo di Cloud Run con Pub/Sub, salta per ora la pulizia e continua con il tutorial sull'elaborazione delle immagini con Cloud Run.
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.
Eliminazione del 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.
Eliminazione delle 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 la configurazione della regione predefinita di gcloud che hai aggiunto durante la configurazione del tutorial:
gcloud config unset run/region
Rimuovi la configurazione del progetto:
gcloud config unset project
Elimina le altre risorse Google Cloud create in questo tutorial:
- Elimina l'argomento Pub/Sub
myRunTopic
- Elimina la sottoscrizione Pub/Sub
myRunSubscription
- Elimina l'immagine container denominata
REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
da Artifact Registry. - Elimina il account di servizio chiamante
cloud-run-pubsub-invoker@PROJECT_ID.iam.gserviceaccount.com
- Elimina l'argomento Pub/Sub
Passaggi successivi
- Consulta Limitazione dell'ingresso per informazioni su come aumentare la sicurezza della produzione utilizzando i controlli di ingresso interni per limitare l'ingresso.
- Espandi il servizio di esempio di cui è stato eseguito il deployment in questo tutorial per aggiungere funzionalità di elaborazione delle immagini che modificano le immagini caricate in Cloud Storage.
- Scopri di più su come gli argomenti si inseriscono nell'architettura Pub/Sub e su come gestirli.
- Scopri di più sulle sottoscrizioni Pub/Sub in Gestione delle sottoscrizioni.
- Esplora architetture di riferimento, diagrammi e best practice su Google Cloud. Consulta il nostro Cloud Architecture Center.