Verificar o aplicativo após a implantação

Neste guia de início rápido, mostramos como usar o Cloud Deploy para verificar o aplicativo implantado como parte do pipeline de entrega.

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

  1. Criar um cluster do GKE ou um serviço do Cloud Run.

    Também é possível usar a verificação de implantação em clusters anexados do GKE, mas este guia de início rápido usa apenas o GKE e o Cloud Run.

  2. Definir o pipeline de entrega e o destino de implantação do Cloud Deploy.

    O pipeline de entrega inclui apenas um estágio e usa apenas um destino. Você define a configuração da verificação de implantação na seção stage.

  3. Criar uma configuração do Skaffold necessária para a versão e um manifesto do Kubernetes ou uma definição de serviço do Cloud Run.

  4. Criar uma versão que seja implantada automaticamente no destino.

    Após a implantação do aplicativo, a verificação é executada como uma fase do lançamento.

  5. Confira os resultados da verificação nos registros do Cloud Build, usando a página Detalhes do lançamento do Cloud Deploy no Google Cloud console.

Antes de começar

  1. Faça login na sua Google Cloud conta do. Se você não conhece o Google Cloud, crie uma conta para avaliar o desempenho dos nossos produtos em cenários reais. Clientes novos também recebem US $300 em créditos para executar, testar e implantar cargas de trabalho.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

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

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  5. Instale a Google Cloud CLI.

  6. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  7. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

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

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  11. Instale a Google Cloud CLI.

  12. Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.

  13. Para inicializar a CLI gcloud, execute o seguinte comando: 

    gcloud init

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

    gcloud components update

  14. 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 estão incluídas para projetos que desativam 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)")-compute@developer.gserviceaccount.com \
    --role="roles/clouddeploy.jobRunner"

    2. Adicione o papel 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)")-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"

    3. Adicione o papel iam.serviceAccountUser, que inclui a permissão actAs para 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

Criar o ambiente de execução

Se você estiver implantando no Cloud Run, pule este comando.

Para o GKE, crie um cluster: deploy-verification-cluster, com as configurações padrão. O endpoint de API Kubernetes do cluster precisa ser acessível pela rede da internet pública. Por padrão, os clusters do GKE podem ser acessados externamente.

gcloud container clusters create-auto deploy-verification-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

Criar pipelines e entregas de entrega

É possível definir o pipeline e os destinos em um arquivo ou em arquivos separados. Neste guia de início rápido, você cria um único arquivo.

  1. Abra uma janela do terminal.

  2. Crie um novo diretório e navegue até ele.

    GKE 

    mkdir deploy-verification-gke-quickstart
cd deploy-verification-gke-quickstart

    Cloud Run 

    mkdir deploy-verification-run-quickstart
cd deploy-verification-run-quickstart

  3. Crie o pipeline de entrega e a definição de destino:

    GKE

    No diretório deploy-verification-gke-quickstart, crie um novo arquivo: clouddeploy.yaml, com o seguinte conteúdo:

    apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-gke-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: verify-staging
description: verification staging cluster
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-verification-cluster

    Cloud Run

    No diretório deploy-verification-run-quickstart, crie um novo arquivo: clouddeploy.yaml, com o seguinte conteúdo:

    apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-run-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: verify-staging
description: staging Run service
run:
  location: projects/PROJECT_ID/locations/us-central1

    Esse arquivo inclui a seção verify na definição strategy do pipeline de entrega. Ele define o contêiner e o comando a serem executados após a implantação do aplicativo. Nesse caso, estamos implantando um contêiner do Ubuntu e executando um comando echo simples. É possível conferir os resultados desse comando nos registros. Em um cenário mais realista, você executaria testes no aplicativo implantado.

  4. 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 de entrega com um destino pronto para implantar o aplicativo e verificar essa implantação.

  5. Confirme o pipeline e os destinos:

    No Google Cloud console, navegue até a página Pipelines de entrega do Cloud Deploy para visualizar 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 um destino listado na coluna Destinos.

    Página do pipeline de entrega no console do Google Cloud , mostrando seu pipeline

Criar o arquivo de configuração do Skaffold e o manifesto do aplicativo

O Cloud Deploy usa Skaffold para identificar o manifesto a ser usado para implantar o app de exemplo no destino.

  1. Crie um arquivo chamado skaffold.yaml com o seguinte conteúdo:

    GKE 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}

    Cloud Run 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}

    Consulte a skaffold.yaml referência para mais informações sobre esse arquivo de configuração.

  2. Crie a definição do aplicativo: uma definição de serviço para o Cloud Run ou um manifesto do Kubernetes para o GKE.

    GKE

    Crie um arquivo chamado k8s-pod.yaml, com o seguinte conteúdo:

    apiVersion: v1
kind: Pod
metadata:
  name: my-verification-pod
spec:
  containers:
  - name: nginx
    image: my-app-image

    Esse arquivo é um manifesto básico do Kubernetes manifesto, que é aplicado ao cluster para implantar o aplicativo. A imagem do contêiner a ser implantada é definida aqui como um marcador, my-app-image, que é substituído pela imagem específica quando você cria a versão.

    Cloud Run

    Crie um arquivo chamado service.yaml, com o seguinte conteúdo:

    apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-verification-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image

    Esse arquivo é uma definição de serviço básica do Cloud Run, que é usada para implantar o aplicativo. A imagem do contêiner a ser implantada é definida aqui como um marcador, my-app-image, que é substituído pela imagem específica quando você cria a versão.

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 mais detalhes sobre esse ciclo de vida.

GKE

Execute o seguinte comando no diretório deploy-verification-gke-quickstart para criar um recurso release que representa a imagem do contêiner a ser implantada:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-verification-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

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

Cloud Run

Execute o seguinte comando no diretório deploy-verification-run-quickstart para criar um recurso release que representa a imagem do contêiner a ser implantada:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-verification-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

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

Como acontece com todas as versões (a menos que incluam --disable-initial-rollout), o Cloud Deploy também cria automaticamente um lançamento recurso. O aplicativo é implantado automaticamente no destino configurado para esse pipeline de entrega.

O job de verificação especificado no pipeline de entrega é executado como parte desse lançamento, após a implantação do aplicativo.

Conferir os resultados no Google Cloud console

Após alguns minutos, a versão será implantada no ambiente de execução de destino.

O job de verificação configurado (para fins de exemplo) imprime uma string no registro do Cloud Build. Podemos conferir esse registro para confirmar se a verificação funcionou conforme o esperado.

  1. No Google Cloud console, navegue até a página Pipelines de entrega do Cloud Deploy para visualizar seu pipeline de entrega ("deploy-verification-demo-app-gke-1" ou "deploy-verification-demo-app-run-1").

    Abrir a página "Pipelines de entrega"

  2. Clique no nome do pipeline de entrega ("deploy-verification-demo-app-gke-1" ou "deploy-verification-demo-app-run-1").

    A visualização do pipeline mostra o status de implantação do app. Como há apenas um estágio no pipeline, a visualização mostra apenas um nó.

    Visualização do pipeline de entrega mostrando sucesso

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

  3. Clique na guia Lançamentos em Detalhes do pipeline de entrega.

  4. Clique no nome do lançamento para conferir os detalhes.

    lançamentos no console Google Cloud

    Verificar é listado como um job.

  5. Clique em Verificar.

    O registro de execução do job é mostrado.

  6. Role para baixo na lista de entradas de registro para encontrar verification-test e clique nele.

    Entrada de registro mostrando a saída do job de verificação

    Observe o textPayload. Essa string é o que foi configurado na Verify seção no pipeline de entrega.

Liberar espaço

Para evitar cobranças na conta do Google Cloud pelos recursos usados nesta página, siga as etapas abaixo.

  1. Exclua o cluster do GKE ou o serviço do Cloud Run:

    GKE 

    gcloud container clusters delete deploy-verification-cluster --region=us-central1 --project=PROJECT_ID

    Cloud Run 

    gcloud run services delete my-verification-run-service --region=us-central1 --project=PROJECT_ID

  2. Exclua o pipeline de entrega, o destino, a versão e o lançamento:

    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