Automatizar a promoção de versões e o avanço do lançamento no Cloud Deploy

Automatizar a promoção de versões e o avanço do lançamento no Cloud Deploy

Nesta página, mostramos como usar o Cloud Deploy para promover automaticamente uma versão a um destino e avançar um lançamento para a próxima fase.

Neste guia de início rápido, você fará o seguinte:

1. Crie dois clusters do GKE ou dois serviços do Cloud Run.

2. Crie uma configuração do Skaffold e um manifesto do Kubernetes ou uma definição de serviço do Cloud Run.

3. Defina o pipeline de entrega e os destinos de implantação do Cloud Deploy.

   O pipeline será implantado em dois destinos: dev e staging. E o destino staging usa uma estratégia de implantação canário.

4. Defina duas regras de automação:

   • Uma automação para promover a versão no destino staging em lançamento bem-sucedido para dev.

   • Uma automação para avançar o lançamento para a fase stable após a conclusão da fase canary-25.

5. Instancie o pipeline de entrega criando uma versão, que implanta automaticamente no destino dev.

6. Confira o pipeline de entrega e a versão no console do Google Cloud.

   Devido à promoção automática, essa versão é promovida para o staging automaticamente.

   Como o destino staging usa uma estratégia de implantação de canário e essa é a primeira implantação nesse ambiente de execução, a fase canary-25 é ignorada. Consulte Por que as fases são puladas às vezes para entender melhor por que a fase canário é pulada na primeira vez.

   Devido ao avanço automático da fase, o lançamento é avançado para a fase stable.

Antes de começar

1. 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.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Se você já tiver a CLI instalada, verifique se está executando a versão mais recente:

gcloud components update

12. 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.

    1. Primeiro, adicione o papel clouddeploy.jobRunner:

       gcloud projects add-iam-policy-binding PROJECT_ID \
           --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --role="roles/clouddeploy.jobRunner"
       

    2. Adicione o papel clouddeploy.releaser:

       gcloud projects add-iam-policy-binding PROJECT_ID \
           --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --role="roles/clouddeploy.releaser"
       

    3. Adicione a função de desenvolvedor para o 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)")[e-mail] \
          --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)")[e-mail] \
          --role="roles/run.developer"
      

    4. Adicione o papel iam.serviceAccountUser, que inclui a permissão actAs para a conta de serviço padrão ser implantada no ambiente de execução:

       gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --role="roles/iam.serviceAccountUser" \
           --project=PROJECT_ID
       

    5. Adicione o papel iam.serviceAccountUser, incluindo a permissão actAs, 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)")[e-mail] \
           --member=user:YOUR_EMAIL_ADDRESS \
           --role="roles/iam.serviceAccountUser" \
           --project=PROJECT_ID
       

       Nesse caso, YOUR_EMAIL_ADDRESS é o endereço de e-mail usado para acessar o Google Cloud.

Criar 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 configurações padrão. Os endpoints da API Kubernetes dos clusters precisam ser acessíveis pela rede da Internet pública. Por padrão, os clusters do GKE podem ser acessados externamente.

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 é necessário para configurar o recurso de automação.

1. Execute o seguinte comando para conferir o número do projeto:

   gcloud projects describe PROJECT_ID
   

2. Copie o número do projeto da saída da linha de comando e cole aqui.

   Não é necessário executar isso como um comando. Colar aqui preenche a 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 detalhes sobre o que implantar e como implantar corretamente para seus destinos separados.

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.

1. Abra uma janela de terminal.

2. 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
   

3. 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. No entanto, você também pode criar uma com o Cloud Deploy para aplicativos simples que não são de produção.

   Consulte a referência do skaffold.yaml para mais informações sobre esse arquivo.

4. Crie a definição do aplicativo: um par de definições de serviço para o Cloud Run ou um manifesto do Kubernetes para o 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 manifesto simples do Kubernetes, que é usado para implantar o aplicativo. A imagem do contêiner a ser implantada é definida aqui como um marcador de posição, my-app-image, que é substituído pela imagem específica quando você cria a versão.

   Cloud Run

   1. 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
      

   2. 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
      

   Esses arquivos são definições de serviço simples do Cloud Run, que são usadas para implantar o aplicativo. A imagem do contêiner a ser implantada é definida aqui como um marcador de posição, my-app-image, que é substituído pela imagem específica quando você cria a versã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. Este guia de início rápido usa um arquivo para o pipeline, os destinos e a automação.

1. Crie o pipeline de entrega, as definições de destino e a ação 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: [e-mail]
   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: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Observação: neste arquivo, os destinos e a configuração de automação são incluídos com o pipeline de entrega, mas é possível definir destinos em um arquivo separado ou em vários arquivos separados e automações em um ou mais arquivos separados.

   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: [e-mail]
   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: [e-mail]
   selector:
     targets:
     - id: automation-quickstart-staging
   rules:
   - advanceRolloutRule:
       name: "advance-rollout"
       sourcePhases: ["canary-25"]
       wait: 1m
   

   Observação: neste arquivo, os destinos e a configuração de automação são incluídos com o pipeline de entrega, mas é possível definir destinos em um arquivo separado ou em vários arquivos separados e automações em um ou mais arquivos separados.

2. Registre o pipeline e os destinos com o 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.

3. 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 na coluna Destinos.

   

4. Clique no nome do pipeline para abrir a visualização e os detalhes do pipeline de entrega.

5. Selecione a guia Automações em Detalhes do pipeline de envio.

   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 as 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 saber mais 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

Observe a flag --images=, que você usa para substituir o marcador de posição (my-app-image) no manifesto pela imagem específica qualificada pelo SHA. O Google recomenda que você crie um modelo para seus manifestos dessa maneira e use nomes de imagem qualificados por SHA na criação da versão.

Cloud Run

Execute o seguinte comando no diretório deploy-automation-run-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=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

Observe a flag --images=, que você usa para substituir o marcador de posição (my-app-image) na definição do serviço pela imagem específica qualificada pelo SHA. O Google recomenda que você crie modelos para suas definições de serviço e job dessa maneira e use nomes de imagem qualificados com SHA na criação da versão.

Por padrão, quando você cria uma versão, um lançamento é criado automaticamente para o primeiro destino no pipeline.

Como este guia de início rápido inclui duas automações, duas coisas acontecem automaticamente:

• Após uma implantação bem-sucedida no primeiro destino, a versão é promovida automaticamente para o segundo destino.

  Há um tempo de espera de um minuto na automação de promoção.

• No segundo destino, em que há um canário de 25% configurado, a segunda automatização avança o lançamento de canary-25 para stable.

  Nesta primeira versão, a fase canary-25 é pulada, porque não há uma versão preexistente do app para canário. E o lançamento é avançado automaticamente para stable.

  Há um atraso de um minuto na automação avançada.

Quando tudo terminar, o aplicativo será implantado com sucesso nos dois destinos sem que você precise fazer mais nada.

Para saber mais sobre como executar uma estratégia de implantação canário, tente o guia de início rápido do canário.

Conferir os resultados no console do Google Cloud

É possível conferir os resultados, incluindo as execuções de automação, no Console do Google Cloud.

1. Navegue até a página Pipelines de entrega do Cloud Deploy para conferir seu pipeline de entrega.

   Abrir a página "Pipelines de entrega"

2. Clique no nome do pipeline de entrega "my-automation-demo-app-1".

   A visualização do pipeline mostra o status de implantação do app. Se o tempo suficiente tiver decorrido, os dois destinos vão aparecer em verde.

   

   E sua versão é listada na guia Versões em Detalhes do pipeline de entrega.

3. Clique na guia Execuções de automação.

   Há duas entradas, uma para cada uma das duas automações criadas. Clique em qualquer uma delas para conferir 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.

1. Exclua os clusters do GKE ou os serviços do Cloud Run:

   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
   

2. Exclua o pipeline de entrega, destinos, automações, versões e lançamentos:

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

3. Exclua os buckets do Cloud Storage criados pelo Cloud Deploy.

   Uma termina com _clouddeploy, e a outra é [region].deploy-artifacts.[project].appspot.com.

   Abrir a página "Procurar" do Cloud Storage

Pronto, você concluiu as etapas deste início rápido.

A seguir

• Saiba mais sobre o Cloud Deploy.

• Teste outras automações.

• Aprenda as noções básicas sobre a implantação de aplicativos.

• Teste o tutorial do Cloud Deploy.

• Saiba como combinar ferramentas de CI/CD do Google Cloud para desenvolver e entregar software de maneira eficaz no GKE.