Este tutorial mostra como escrever, implementar e chamar um serviço do Cloud Run a partir de uma subscrição push do Pub/Sub.
Objetivos
- Escreva, crie e implemente um serviço no Cloud Run
- Chame o serviço publicando uma mensagem num tópico do Pub/Sub.
Custos
Neste documento, usa os seguintes componentes faturáveis do Google Cloud:
Para gerar uma estimativa de custos com base na sua utilização projetada,
use a calculadora de preços.
Antes de começar
- 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.
-
Verify 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.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Pub/Sub and Cloud Run APIs.
- Instale e inicialize a CLI gcloud.
- Atualize os componentes:
gcloud components update
-
Editor do Cloud Build (
roles/cloudbuild.builds.editor
) -
Administrador do Cloud Run (
roles/run.admin
) -
Criar contas de serviço (
roles/iam.serviceAccountCreator
) -
Project IAM Admin (
roles/resourcemanager.projectIamAdmin
) -
Editor do Pub/Sub (
roles/pubsub.editor
) -
Utilizador da conta de serviço (
roles/iam.serviceAccountUser
) -
Consumidor de utilização do serviço (
roles/serviceusage.serviceUsageConsumer
) -
Administrador de armazenamento (
roles/storage.admin
)
Funções necessárias
Para receber as autorizações de que precisa para concluir o tutorial, peça ao seu administrador para lhe conceder as seguintes funções da IAM no seu projeto:
Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.
Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.
Configure as predefinições do gcloud
Para configurar o gcloud com as predefinições do seu serviço do Cloud Run:
Defina o projeto predefinido:
gcloud config set project PROJECT_ID
Substitua PROJECT_ID pelo nome do projeto que criou para este tutorial.
Configure o gcloud para a região escolhida:
gcloud config set run/region REGION
Substitua REGION pela região do Cloud Run suportada à sua escolha.
Localizações do Cloud Run
O Cloud Run é regional, o que significa que a infraestrutura que executa os seus serviços do Cloud Run está localizada numa região específica e é gerida pela Google para estar disponível de forma redundante em todas as zonas dessa região.
O cumprimento dos requisitos de latência, disponibilidade ou durabilidade são fatores
principais para selecionar a região onde os seus serviços do Cloud Run são executados.
Geralmente, pode selecionar a região mais próxima dos seus utilizadores, mas deve considerar a localização dos outros Google Cloudprodutos usados pelo seu serviço do Cloud Run.
A utilização Google Cloud de produtos em conjunto em várias localizações pode afetar
a latência do seu serviço, bem como o custo.
O Cloud Run está disponível nas seguintes regiões:
Sujeito aos preços de Nível 1
asia-east1
(Taiwan)asia-northeast1
(Tóquio)asia-northeast2
(Osaca)asia-south1
(Mumbai, Índia)europe-north1
(Finlândia)Baixo CO2
europe-north2
(Estocolmo)Baixo CO2
europe-southwest1
(Madrid)Baixo CO2
europe-west1
(Bélgica)Baixo CO2
europe-west4
(Países Baixos)Baixo CO2
europe-west8
(Milão)europe-west9
(Paris)Baixo CO2
me-west1
(Telavive)northamerica-south1
(México)us-central1
(Iowa)Baixo CO2
us-east1
(Carolina do Sul)us-east4
(Virgínia do Norte)us-east5
(Columbus)us-south1
(Dallas)Baixo CO2
us-west1
(Oregão)Baixo CO2
Sujeito aos preços de Nível 2
africa-south1
(Joanesburgo)asia-east2
(Hong Kong)asia-northeast3
(Seul, Coreia do Sul)asia-southeast1
(Singapura)asia-southeast2
(Jacarta)asia-south2
(Deli, Índia)australia-southeast1
(Sydney)australia-southeast2
(Melbourne)europe-central2
(Varsóvia, Polónia)europe-west10
(Berlim)Baixo CO2
europe-west12
(Turim)europe-west2
(Londres, Reino Unido)Baixo CO2
europe-west3
(Frankfurt, Alemanha)europe-west6
(Zurique, Suíça)Baixo CO2
me-central1
(Doha)me-central2
(Dammam)northamerica-northeast1
(Montreal)Baixo CO2
northamerica-northeast2
(Toronto)Baixo CO2
southamerica-east1
(São Paulo, Brasil)Baixo CO2
southamerica-west1
(Santiago, Chile)Baixo CO2
us-west2
(Los Angeles)us-west3
(Salt Lake City)us-west4
(Las Vegas)
Se já criou um serviço do Cloud Run, pode ver a região no painel de controlo do Cloud Run na Google Cloud consola.
Crie um repositório padrão do Artifact Registry
Crie um repositório padrão do Artifact Registry para armazenar a imagem de contentor:
gcloud artifacts repositories create REPOSITORY \ --repository-format=docker \ --location=REGION
Substituir:
- REPOSITORY com um nome exclusivo para o repositório.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
Crie um tópico do Pub/Sub
O serviço de exemplo é acionado por mensagens publicadas num tópico do Pub/Sub, pelo que tem de criar um tópico no Pub/Sub.
gcloud
Para criar um novo tópico do Pub/Sub, use o comando:
gcloud pubsub topics create myRunTopic
Pode usar myRunTopic ou substituir por um nome de tópico exclusivo no seu projeto. Google Cloud
Terraform
Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.
Para criar um tópico do Pub/Sub, adicione o seguinte ao seu ficheiro main.tf
existente:
Pode usar um nome de tópico único no seu projeto do Google Cloud.
Obtenha o exemplo de código
Para obter o exemplo de código para utilização:
Clone o repositório da app de exemplo para a sua máquina local:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.
Ir
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
Em alternativa, pode transferir o exemplo como um ficheiro ZIP e extraí-lo.
Altere para o diretório que contém o código de exemplo do Cloud Run:
Node.js
cd nodejs-docs-samples/run/pubsub/
Python
cd python-docs-samples/run/pubsub/
Ir
cd golang-samples/run/pubsub/
Java
cd java-docs-samples/run/pubsub/
C#
cd dotnet-docs-samples/run/Run.Samples.Pubsub.MinimalApi/
Reveja o código
O código deste tutorial consiste no seguinte:
Um servidor que processa pedidos recebidos.
Node.js
Para manter o serviço Node.js fácil de testar, a configuração do servidor está separada do arranque do servidor.
O servidor Web Node.js está configurado em
app.js
.O servidor Web é iniciado em
index.js
:Python
Ir
Java
C#
Um controlador que processa a mensagem do Pub/Sub e regista uma saudação.
Node.js
Python
Ir
Java
C#
Tem de programar o serviço para devolver um código de resposta HTTP preciso. Os códigos de êxito, como HTTP
200
ou204
, confirmam o processamento completo da mensagem do Pub/Sub. Os códigos de erro, como HTTP400
ou500
, indicam que a mensagem vai ser repetida, conforme descrito no guia de receção de mensagens através de push.Um
Dockerfile
que define o ambiente operacional do serviço. O conteúdo doDockerfile
varia consoante o idioma.Node.js
Python
Ir
Java
Este exemplo usa o Jib para criar imagens do Docker com ferramentas Java comuns. O Jib otimiza as compilações de contentores sem precisar de um Dockerfile nem ter o Docker instalado. Saiba mais sobre como criar contentores Java com o Jib.
C#
Para ver detalhes sobre como autenticar a origem dos pedidos do Pub/Sub, consulte o artigo Integre com o Pub/Sub.
Envie o código
O código de envio consiste em três passos: criar uma imagem de contentor com o Cloud Build, carregar a imagem de contentor para o Artifact Registry e implementar a imagem de contentor no Cloud Run.
Para enviar o código:
-
Crie o contentor e publique-o no Artifact Registry:
Node.js
Substituir:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem.Após o êxito, deve ver uma mensagem SUCCESS com o ID, a hora de criação e o nome da imagem. A imagem é armazenada no Artifact Registry e pode ser reutilizada, se necessário.
Python
Substituir:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem.Após o êxito, deve ver uma mensagem SUCCESS com o ID, a hora de criação e o nome da imagem. A imagem é armazenada no Artifact Registry e pode ser reutilizada, se necessário.
Ir
Substituir:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem.Após o êxito, deve ver uma mensagem SUCCESS com o ID, a hora de criação e o nome da imagem. A imagem é armazenada no Artifact Registry e pode ser reutilizada, se necessário.
Java
-
Use o auxiliar de credenciais da CLI gcloud
para autorizar o Docker a enviar para o seu Artifact Registry.
gcloud auth configure-docker
-
Use o plugin Jib Maven para criar e enviar o contentor para o Artifact Registry.
Substituir:mvn compile jib:build -D image=REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem.Se tiver êxito, deve ver a mensagem BUILD SUCCESS. A imagem é armazenada no Artifact Registry e pode ser reutilizada, se necessário.
C#
Substituir:gcloud builds submit --tag REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem.Após o êxito, deve ver uma mensagem SUCCESS com o ID, a hora de criação e o nome da imagem. A imagem é armazenada no Artifact Registry e pode ser reutilizada, se necessário.
-
Implemente a sua aplicação:
Linha de comandos
-
Execute o seguinte comando para implementar a sua app:
Substituir:gcloud run deploy pubsub-tutorial --image REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub --no-allow-unauthenticated
- PROJECT_ID com o seu Google Cloud ID do projeto.
- REPOSITORY com o nome do repositório do Artifact Registry.
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
pubsub
é o nome da imagem epubsub-tutorial
é o nome do serviço. Repare que a imagem do contentor é implementada no serviço e na região que configurou anteriormente em Configurar o gcloudA flag
--no-allow-unauthenticated
restringe o acesso não autenticado ao serviço. Ao manter o serviço privado, pode confiar na integração automática do Pub/Sub do Cloud Run para autenticar pedidos. Consulte o artigo Integre com o Pub/Sub para ver mais detalhes sobre como esta opção é configurada. Para mais detalhes sobre a autenticação baseada na gestão de identidade e de acesso (IAM), consulte o artigo Gerir o acesso através da IAM.Aguarde até que a implementação esteja concluída. Este processo pode demorar cerca de meio minuto. Se for bem-sucedido, a linha de comandos apresenta o URL do serviço. Este URL é usado para configurar uma subscrição do Pub/Sub.
-
Se quiser implementar uma atualização de código no serviço, repita os passos anteriores. Cada implementação num serviço cria uma nova revisão e começa automaticamente a publicar tráfego quando estiver pronta.
Terraform
Para criar um serviço do Cloud Run, adicione o seguinte ao seu ficheiro
.tf
existente. Substituir: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 com o URL da imagem:
REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
- REGION com a Google Cloud região a usar para o repositório do Artifact Registry.
-
Faça a integração com o Pub/Sub
Para integrar o serviço com o Pub/Sub:
gcloud
Crie ou selecione uma conta de serviço para representar a identidade da subscrição do Pub/Sub.
gcloud iam service-accounts create cloud-run-pubsub-invoker \ --display-name "Cloud Run Pub/Sub Invoker"
Pode usar
cloud-run-pubsub-invoker
ou substituir por um nome exclusivo no seu projeto. Google CloudCrie uma subscrição do Pub/Sub com a conta de serviço:
Conceda à conta de serviço do invocador autorização para invocar o seu serviço
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
As alterações à IAM podem demorar vários minutos a propagar-se. Entretanto, pode ver
HTTP 403
erros nos registos de serviços.Permita que o Pub/Sub crie tokens de autenticação no seu projeto:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Substituir:
- PROJECT_ID com o seu Google Cloud ID do projeto.
- PROJECT_NUMBER com o seu Google Cloud número do projeto.
O ID do projeto e o número do projeto estão listados no painel Informações do projeto na Google Cloud consola do seu projeto.
Crie uma subscrição do Pub/Sub com a conta de serviço:
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
Substituir:
- myRunTopic com o tópico que criou anteriormente.
- SERVICE-URL com o URL HTTPS fornecido na implementação do serviço. Este URL funciona mesmo que também tenha adicionado um mapeamento de domínio.
- PROJECT_ID com o seu Google Cloud ID do projeto.
O sinalizador
--push-auth-service-account
ativa a funcionalidade de envio do Pub/Sub para autenticação e autorização.O domínio do serviço do Cloud Run é registado automaticamente para utilização com subscrições do Pub/Sub.
Apenas para o Cloud Run, existe uma verificação de autenticação incorporada que o token é válido e uma verificação de autorização que a conta de serviço tem autorização para invocar o serviço do Cloud Run.
O seu serviço está agora totalmente integrado com o Pub/Sub.
Terraform
Crie ou selecione uma conta de serviço para representar a identidade da subscrição do Pub/Sub.
Crie uma subscrição do Pub/Sub com a conta de serviço:
Conceda à conta de serviço do invocador autorização para invocar o seu serviço
pubsub-tutorial
:Permita que o Pub/Sub crie tokens de autenticação no seu projeto:
Crie uma subscrição do Pub/Sub com a conta de serviço:
O seu serviço está agora totalmente integrado com o Pub/Sub.
Experimentar
Para testar a solução completa:
Envie uma mensagem Pub/Sub para o tópico:
gcloud pubsub topics publish myRunTopic --message "Runner"
Também pode publicar mensagens de forma programática em vez de usar a linha de comandos, como mostrado neste tutorial. Para mais informações, consulte o artigo Publicar mensagens.
Navegue para os registos de serviço:
- Navegue para a Google Cloud consola
- Clique no serviço
pubsub-tutorial
. Selecione o separador Registos.
Os registos podem demorar alguns momentos a aparecer. Se não os vir imediatamente, verifique novamente após alguns momentos.
Procure a mensagem "Olá, corredor!".
Limpar
Para ver um exemplo de utilização mais detalhado do Cloud Run com o Pub/Sub, ignore a limpeza por agora e continue com o tutorial de processamento de imagens com o Cloud Run.
Se criou um novo projeto para este tutorial, elimine o projeto. Se usou um projeto existente e quer mantê-lo sem as alterações adicionadas neste tutorial, elimine os recursos criados para o tutorial.
Eliminar o projeto
A forma mais fácil de eliminar a faturação é eliminar o projeto que criou para o tutorial.
Para eliminar o projeto:
- 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.
Eliminar recursos do tutorial
Elimine o serviço do Cloud Run que implementou neste tutorial:
gcloud run services delete SERVICE-NAME
Onde SERVICE-NAME é o nome do serviço escolhido.
Também pode eliminar serviços do Cloud Run a partir da Google Cloud consola.
Remova a configuração da região predefinida do gcloud que adicionou durante a configuração do tutorial:
gcloud config unset run/region
Remova a configuração do projeto:
gcloud config unset project
Elimine outros Google Cloud recursos criados neste tutorial:
- Elimine o tópico do Pub/Sub
myRunTopic
- Elimine a subscrição do Pub/Sub
myRunSubscription
- Elimine a imagem de contentor denominada
REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/pubsub
do Artifact Registry. - Elimine a conta de serviço do invocador
cloud-run-pubsub-invoker@PROJECT_ID.iam.gserviceaccount.com
- Elimine o tópico do Pub/Sub
O que se segue?
- Consulte o artigo Restringir a entrada para ver informações sobre como aumentar a segurança da produção através da utilização de controlos de entrada internos para limitar a entrada.
- Expanda o serviço de exemplo implementado neste tutorial para adicionar funcionalidade de processamento de imagens que modifica as imagens carregadas para o Cloud Storage.
- Saiba como os tópicos se enquadram na arquitetura Pub/Sub e como gerir tópicos
- Saiba mais sobre as subscrições do Pub/Sub na secção Gerir subscrições.
- Explore arquiteturas de referência, diagramas e práticas recomendadas sobre o Google Cloud. Consulte o nosso Centro de arquitetura na nuvem.