Verificar seu aplicativo depois de implantá-lo

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 um cluster do GKE Enterprise, mas este guia de início rápido usa apenas o GKE e o Cloud Run.

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

    É no arquivo de configuração do Skaffold que você define o contêiner de verificação de implantação para ser executado após a implantação.

  3. Defina o pipeline de entrega e o destino da implantação do Cloud Deploy.

    Na configuração do pipeline de entrega, você fará referência à verificação de implantação definida em skaffold.yaml para executá-la.

    Este pipeline inclui apenas um estágio e usa apenas um destino.

  4. Crie uma versão, que é implantada automaticamente no destino.

    Depois que o aplicativo é implantado, a verificação é executada como uma fase do lançamento.

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

Antes de começar

  1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

  2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  4. Ative as APIs Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

    Ative as APIs

  5. Instale a CLI do Google Cloud.

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

    gcloud init
    7.

  7. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  8. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

  9. Ative as APIs Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

    Ative as APIs

  10. Instale a CLI do Google Cloud.

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

    gcloud init
    12.

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

    2. 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)")-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 seu ambiente de execução

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

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

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

Preparar a configuração e o manifesto do aplicativo do Skaffold

O Cloud Deploy usa o Skaffold para fornecer detalhes sobre o que implantar e como implantá-lo no destino.

Neste guia de início rápido, você cria um arquivo skaffold.yaml, que identifica o manifesto a ser usado para implantar o app de amostra e também identifica o contêiner a ser executado após a implantação (a verificação da implantação).

  1. Abra uma janela de 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 um arquivo chamado skaffold.yaml com o seguinte conteúdo:

    GKE; 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

    Cloud Run 

    apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
verify:
- name: verification-test
  container:
    name: verification-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "Your test or tests would go here."' ]

    Esse arquivo inclui a estrofe verify:, definindo 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. Os resultados desse comando estão disponíveis nos registros. Em um cenário mais realista, você executaria testes no aplicativo implantado.

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

  4. 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 simples do Kubernetes, aplicado ao cluster para implantar o aplicativo.

    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 simples do serviço do Cloud Run, usada no momento da implantação para criar o serviço do Cloud Run.

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. 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: true
---

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: true
---

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

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

  3. Confirme o pipeline e os destinos:

    No console do Google Cloud, navegue até a página Pipelines de entrega do Cloud Deploy para ver uma lista de 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 o pipeline

Criar uma versão

Uma versão é o recurso central do Cloud Deploy que representa as alterações 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 ver detalhes sobre esse ciclo de vida.

GKE;

Execute o seguinte comando no diretório deploy-verification-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=deploy-verification-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Execute o seguinte comando no diretório deploy-verification-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=deploy-verification-demo-app-run-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc

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

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

Conferir os resultados no console do Google Cloud

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

O job de verificação que configuramos (para fins de exemplo) imprime uma string no registro do Cloud Build. Podemos visualizar esse registro para confirmar que a verificação funcionou como esperado.

  1. No console do Google Cloud, navegue até a página Pipelines de entrega do Cloud Deploy para visualizar o 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 da implantação do aplicativo. Como há apenas um estágio no pipeline, a visualização mostra apenas um nó.

    Visualização do pipeline de entrega mostrando o 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 consultar os detalhes.

    no console do Google Cloud

    Verificar está listado como um job.

  5. Clique em Verificar.

    O registro de execução do job será exibido.

  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 é a que foi configurada na estrofe Verify da sua configuração do Skaffold.

Limpar

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

  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