Verificar o 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. Crie 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 apresentação rápida 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.

    O arquivo de configuração do Skaffold é onde você configura a implantação contêiner de verificação a ser executado após a implantação.

  3. Definir o pipeline de entrega e a implantação do Cloud Deploy alvo.

    Na configuração do pipeline de entrega, você vai fazer referência ao definida em skaffold.yaml para executar essa verificação.

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

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

    Depois da implantação do aplicativo, A verificação é executada como um fase do lançamento.

  5. Conferir os resultados da verificação nos registros do Cloud Build na página Detalhes do lançamento do Cloud Deploy console do Google Cloud.

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.

    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

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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

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

    gcloud components update

  12. Verifique se o padrão A conta de serviç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)")-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 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 da API Kubernetes do cluster precisa ser acessível pela rede da Internet pública. Clusters do GKE são acessíveis externamente por padrão.

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

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

O Cloud Deploy usa o Skaffold para oferecer os detalhes sobre o que implantar e como implantar no seu destino.

Neste guia de início rápido, você cria um arquivo skaffold.yaml, que identifica o manifesto a ser usado para implantar o aplicativo de exemplo e também identifica o contêiner sejam executados após a implantação (a verificação de 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:, que define o contêiner e o comando a serem executados após a implantação do aplicativo. Neste 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ê executa 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 seu 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 do Kubernetes simples, que é 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 de serviço simples do Cloud Run, que é usada no momento do deploy para criar seu 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 do 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 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 seu 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 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 um destino listado na coluna Destinos.

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

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

GKE;

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

Cloud Run

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

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

O job de verificação especificado na configuração do Skaffold é executado como parte desse lançamento, depois que o aplicativo é implantado.

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 conferir esse registro para confirmar que a verificação funcionou conforme o esperado.

  1. No console do Google Cloud, acesse a página do Cloud Deploy Página Pipelines de entrega para exibir 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 de implantação do aplicativo. Como há apenas uma fase 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 Implantações em Detalhes do pipeline de entrega.

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

    lançamentos no console do Google Cloud

    Verificar é listado como um job.

  5. Clique em Verificar.

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

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

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

    Observe o textPayload. Essa string é aquela configurada no Verify estrofe em sua Configuração do Skaffold.

Limpar

Para evitar cobranças na 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