Automatize a promoção de versões e o avanço de lançamentos no Cloud Deploy
Nesta página, mostramos como usar o Cloud Deploy para promover automaticamente um em um destino e avançar o lançamento para a próxima fase.
Neste guia de início rápido, você fará o seguinte:
Criar dois clusters do GKE ou dois clusters do Cloud Run serviços.
Crie uma configuração do Skaffold e um arquivo do Kubernetes ou uma definição de serviço do Cloud Run.
Definir o pipeline de entrega e a implantação do Cloud Deploy de destino.
O pipeline será implantado em dois destinos:
dev
estaging
. E ostaging
destino usa um estratégia de implantação canário.Defina duas regras de automação:
Uma automação para promover a versão no destino
staging
em lançamento bem-sucedido paradev
.Uma automação para avançar o lançamento para a fase
stable
se for bem-sucedido. conclusão da fasecanary-25
.
Crie uma versão para instanciar o pipeline de entrega, que automaticamente é implantado no destino
dev
.Conferir o pipeline de entrega e lançar no console do Google Cloud.
Por causa da promoção automática, esta versão é promovida para a
staging
automaticamente.Como o destino
staging
usa uma estratégia de implantação canário, e essa for a primeira implantação nesse ambiente de execução, a fasecanary-25
será ignorada. Consulte Por que as fases às vezes são ignoradas para entender por que a fase canário é ignorada na primeira vez.Por conta do avanço automatizado, o lançamento é avançado para a
stable
.
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.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Verifique se a conta de serviço padrão do Compute Engine tem permissões suficientes.
A conta de serviço já pode ter as permissões necessárias. Essas etapas são incluídas para projetos que desativam as concessões automáticas de papéis para contas de serviço padrão.
- Primeiro, adicione o papel
clouddeploy.jobRunner
:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --role="roles/clouddeploy.jobRunner"
- Adicione o papel
clouddeploy.releaser
:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --role="roles/clouddeploy.releaser"
- Adicione o papel de desenvolvedor ao ambiente de execução específico.
- Para o GKE:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --role="roles/container.developer"
- Para o Cloud Run:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:$(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --role="roles/run.developer"
-
Adicione o papel
iam.serviceAccountUser
, que inclui a permissãoactAs
para que a conta de serviço padrão implantar no ambiente de execução:gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --member=serviceAccount:$(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --role="roles/iam.serviceAccountUser" \ --project=PROJECT_ID
-
Adicione o papel
iam.serviceAccountUser
, incluindoactAs
. permissão para usar a conta de serviço padrão:gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \ --format="value(projectNumber)")-compute@developer.gserviceaccount.com \ --member=user:YOUR_EMAIL_ADDRESS \ --role="roles/iam.serviceAccountUser" \ --project=PROJECT_ID
Nesse caso, YOUR_EMAIL_ADDRESS é o endereço de e-mail que você usa para acessar. Google Cloud.
- Primeiro, adicione o papel
Se você já tem a CLI instalada, verifique se está executando a versão mais recente versão:
gcloud components update
Crie seus ambientes de execução
Se você estiver implantando no Cloud Run, pule este comando.
Para o GKE, crie dois clusters: automation-quickstart-cluster-dev
e automation-quickstart-cluster-staging
, com as configurações padrão. O
aglomerados Os endpoints da API Kubernetes precisam ser acessíveis pela rede pelo público
Internet. Os clusters do GKE podem ser acessados
padrão.
gcloud container clusters create-auto automation-quickstart-cluster-dev \
--project=PROJECT_ID \
--region=us-central1 \
&& gcloud container clusters create-auto automation-quickstart-cluster-staging \
--project=PROJECT_ID \
--region=us-central1
Confira o número do seu projeto.
Você precisa do número do projeto para identificar a conta de serviço padrão. Isso é para configurar o recurso de automação.
Execute o seguinte comando para ver o número do seu projeto:
gcloud projects describe PROJECT_ID
Copie o número do projeto que aparece na saída da linha de comando e cole-o aqui.
Não é necessário executá-lo como um comando. Quando ele é colado aqui, o referência da conta de serviço na configuração de automação mais adiante neste guia de início rápido.
PROJECT_NUMBER
Preparar a configuração do Skaffold e o manifesto do aplicativo
O Cloud Deploy usa o Skaffold para fornecer os detalhes de o que implantar e como fazer isso corretamente em destinos.
Neste guia de início rápido, você cria um arquivo skaffold.yaml
, que identifica o
manifesto do aplicativo a ser usado para implantar o app de exemplo.
Abra uma janela de terminal.
Crie um novo diretório e navegue até ele.
GKE;
mkdir deploy-automation-gke-quickstart cd deploy-automation-gke-quickstart
Cloud Run
mkdir deploy-automation-run-quickstart cd deploy-automation-run-quickstart
Crie um arquivo chamado
skaffold.yaml
com o seguinte conteúdo:GKE;
apiVersion: skaffold/v4beta7 kind: Config metadata: name: gke-automation manifests: rawYaml: - k8s-deployment.yaml deploy: kubectl: {}
Cloud Run
apiVersion: skaffold/v4beta7 kind: Config metadata: name: run-automation profiles: - name: dev manifests: rawYaml: - run-dev.yaml - name: staging manifests: rawYaml: - run-staging.yaml deploy: cloudrun: {}
Esse arquivo é uma configuração mínima do Skaffold. Para este guia de início rápido, você vai criar o arquivo. Mas você também pode deixe o Cloud Deploy criar uma para você, para aplicativos simples que não sejam de produção.
Consulte a referência do
skaffold.yaml
. para saber mais sobre o arquivo.Crie a definição para seu aplicativo: um par de serviços definições para o Cloud Run ou um manifesto do Kubernetes para no GKE.
GKE;
Crie um arquivo chamado
k8s-deployment.yaml
com o seguinte conteúdo:apiVersion: apps/v1 kind: Deployment metadata: name: my-deployment labels: app: my-app namespace: default spec: replicas: 1 selector: matchLabels: app: my-app template: metadata: labels: app: my-app spec: containers: - name: nginx image: my-app-image --- apiVersion: v1 kind: Service metadata: name: my-service namespace: default spec: selector: app: my-app ports: - protocol: TCP port: 80
Esse arquivo é um arquivo manifesto, que é aplicado ao cluster para implantar o aplicativo.
Cloud Run
Crie um arquivo chamado
run-dev.yaml
com o seguinte conteúdo:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: my-automation-run-service-dev spec: template: spec: containers: - image: my-app-image
Crie um arquivo chamado
run-staging.yaml
com o seguinte conteúdo:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: my-automation-run-service-staging spec: template: spec: containers: - image: my-app-image
Esse arquivo é uma definição simples de serviço do Cloud Run, que é usado no momento da implantação para criar serviço.
Criar o pipeline de entrega, os destinos e a automação
É possível definir o pipeline de entrega e os destinos em um arquivo ou em arquivos separados . Também é possível definir uma ação de automação em um arquivo separado. Isso o guia de início rápido usa um arquivo para o pipeline, os destinos e a automação.
Crie seu pipeline de entrega, definições de metas e ações de automação:
GKE;
No diretório
deploy-automation-gke-quickstart
, crie um novo arquivo:clouddeploy.yaml
, com o seguinte conteúdo:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-automation-demo-app-1 description: Automation demonstration pipeline serialPipeline: stages: - targetId: automation-quickstart-dev - targetId: automation-quickstart-staging profiles: [] strategy: canary: runtimeConfig: kubernetes: serviceNetworking: service: "my-service" deployment: "my-deployment" canaryDeployment: percentages: [25] verify: false --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: automation-quickstart-dev description: Dev cluster to demonstrate deploy automation gke: cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: automation-quickstart-staging description: Staging cluster to demonstrate deploy automation gke: cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging --- apiVersion: deploy.cloud.google.com/v1 kind: Automation metadata: name: my-automation-demo-app-1/promote description: promotes a release suspended: false serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com selector: targets: - id: automation-quickstart-dev rules: - promoteReleaseRule: name: "promote-release" wait: 1m toTargetId: "@next" --- apiVersion: deploy.cloud.google.com/v1 kind: Automation metadata: name: my-automation-demo-app-1/advance description: advances a rollout suspended: false serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com selector: targets: - id: automation-quickstart-staging rules: - advanceRolloutRule: name: "advance-rollout" sourcePhases: ["canary-25"] wait: 1m
Cloud Run
No diretório
deploy-automation-run-quickstart
, crie um novo arquivo:clouddeploy.yaml
, com o seguinte conteúdo:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-automation-demo-app-1 description: Automation demonstration pipeline serialPipeline: stages: - targetId: automation-quickstart-dev profiles: [dev] - targetId: automation-quickstart-staging profiles: [staging] strategy: canary: runtimeConfig: cloudRun: automaticTrafficControl: true canaryDeployment: percentages: [25] verify: false --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: automation-quickstart-dev description: Dev cluster to demonstrate deploy automation run: location: projects/PROJECT_ID/locations/us-central1 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: automation-quickstart-staging description: Staging cluster to demonstrate deploy automation run: location: projects/PROJECT_ID/locations/us-central1 --- apiVersion: deploy.cloud.google.com/v1 kind: Automation metadata: name: my-automation-demo-app-1/promote description: Promotes a release to the next target suspended: false serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com selector: targets: - id: automation-quickstart-dev rules: - promoteReleaseRule: name: "promote-release" wait: 1m toTargetId: "@next" --- apiVersion: deploy.cloud.google.com/v1 kind: Automation metadata: name: my-automation-demo-app-1/advance description: advances a rollout suspended: false serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com selector: targets: - id: automation-quickstart-staging rules: - advanceRolloutRule: name: "advance-rollout" sourcePhases: ["canary-25"] wait: 1m
Registre o pipeline e os destinos no serviço do Cloud Deploy:
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
Agora você tem um pipeline com um destino múltiplo que compreende dois destinos do GKE ou do Cloud Run, pronto para implantar seu aplicativo.
Confirme o pipeline e os destinos:
No console do Google Cloud, navegue até a página Pipelines de entrega do Cloud Deploy para conferir a lista dos seus pipelines de entrega disponíveis.
Abrir a página "Pipelines de entrega"
O pipeline de entrega que você acabou de criar é mostrado, com dois destinos listados em na coluna Destinos.
Clique no nome do pipeline para abrir a visualização dele e detalhes.
Selecione a guia Automações em Detalhes do pipeline de entrega.
As duas automações que você criou vão aparecer.
Criar uma versão
Uma versão é o recurso central do Cloud Deploy que representa mudanças que estão sendo implantadas. O pipeline de entrega define o ciclo de vida dessa versão. Consulte Arquitetura de serviço do Cloud Deploy para detalhes sobre esse ciclo de vida.
GKE;
Execute o seguinte comando no diretório deploy-automation-gke-quickstart
para criar um recurso release
que represente a imagem do contêiner
a ser implantada:
gcloud deploy releases create test-release-001 \
--project=PROJECT_ID \
--region=us-central1 \
--delivery-pipeline=my-automation-demo-app-1 \
--images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa
Cloud Run
Execute o seguinte comando no deploy-automation-run-quickstart
para criar um recurso release
que representa o contêiner
imagem a ser implantada:
gcloud deploy releases create test-release-001 \
--project=PROJECT_ID \
--region=us-central1 \
--delivery-pipeline=my-automation-demo-app-1 \
--images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc
Por padrão, quando você cria uma versão, um lançamento é criado automaticamente para o primeiro destino do pipeline.
Como este guia de início rápido inclui duas automações, ocorrem duas ações automaticamente:
Após a implantação no primeiro destino, a versão promovido automaticamente para o segundo destino.
Há um tempo de espera de um minuto na automação da promoção.
No segundo destino, em que há um canário de 25% configurado, a automação avança o lançamento de
canary-25
parastable
.Nessa primeira versão, a fase
canary-25
é ignorada, porque não há pré-existente do app para a versão canário novamente. E o lançamento é avançado automaticamente parastable
.Há um atraso de um minuto na automação avançada.
Quando tudo termina, o aplicativo é implantado nos dois sem que você precise fazer mais nada.
Se você quiser saber mais sobre como executar uma estratégia de implantação canário, acesse Teste o guia de início rápido do canário.
Conferir os resultados no console do Google Cloud
É possível visualizar os resultados, incluindo as execuções de automação, no console do Google Cloud.
Navegue até a página Pipelines de entrega do Cloud Deploy para conferir seu pipeline de entrega.
Clique no nome do pipeline de entrega "my-automation-demo-app-1".
A visualização do pipeline mostra o status de implantação do aplicativo. Se houver tempo suficiente decorrido, os dois destinos aparecerão em verde.
E sua versão é listada na guia Versões em Detalhes do pipeline de entrega.
Clique na guia Execuções de automação.
Há duas entradas, uma para cada uma das automações criadas. Você pode clicar em qualquer um deles para ver os detalhes da execução da automação.
Limpar
Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga estas etapas.
Excluir os clusters do GKE ou o Cloud Run serviços:
GKE;
gcloud container clusters delete automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \ && gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID
Cloud Run
gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \ && gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID
Exclua o pipeline de entrega, os destinos, as automações, a versão e os lançamentos:
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
Exclua os buckets do Cloud Storage que o Cloud Deploy criou.
Uma termina com
_clouddeploy
, e a outra é[region].deploy-artifacts.[project].appspot.com
.
Pronto, você concluiu as etapas deste início rápido.