Executar hooks antes e depois da implantação

Executar hooks antes e depois da implantação

Neste guia de início rápido, mostramos como executar um hook de implantação, um programa arbitrário para executar antes ou depois da implantação usando o Cloud Deploy.

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 um cluster do GKE Enterprise para isso, mas este 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, você configura os hooks de implantação para execução. Você identifica um contêiner para executar antes e outro para executar depois da implantação.

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

   Na configuração do pipeline de entrega, você vai referenciar os hooks de implantação definidos em skaffold.yaml para executar esses hooks.

   Esse pipeline inclui apenas uma etapa e usa apenas um destino.

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

   Um dos hooks é executado antes da implantação do aplicativo, e o outro é executado depois.

5. Confira os resultados dos hooks pré e pós-implantação nos registros do Cloud Build usando a página Detalhes do lançamento do Cloud Deploy emGoogle Cloud console.

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.
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
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Enable the APIs
Install the Google Cloud CLI.
Se você estiver usando um provedor de identidade externo (IdP), primeiro faça login na CLI gcloud com sua identidade federada.
Para inicializar a CLI gcloud, execute o seguinte comando:
gcloud init
Observação:execute a CLI gcloud no console do Google Cloud sem instalar a Google Cloud CLI. Para executar a CLI gcloud no console do Google Cloud , use o Cloud Shell.

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

Verify that billing is enabled for your Google Cloud project.

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

Enable the APIs

Install the Google Cloud CLI.

Se você estiver usando um provedor de identidade externo (IdP), primeiro faça login na CLI gcloud com sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

Observação:execute a CLI gcloud no console do Google Cloud sem instalar a Google Cloud CLI. Para executar a CLI gcloud no console do Google Cloud , use o Cloud Shell.

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

gcloud components update

1. 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 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 a função de desenvolvedor para seu 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"
  

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)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --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-hooks-cluster, com 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-hooks-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 fornecer 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 app de amostra, e também identifica os contêineres a serem executados antes e depois da implantação (os hooks de implantação).

1. Abra uma janela de terminal.

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

   GKE

   mkdir deploy-hooks-gke-quickstart
   cd deploy-hooks-gke-quickstart
   

   Cloud Run

   mkdir deploy-hooks-run-quickstart
   cd deploy-hooks-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: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Cloud Run

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - service.yaml
   deploy:
     cloudrun: {}
   customActions:
   - name: predeploy-action
     containers:
     - name: predeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a predeploy action"' ]
   - name: postdeploy-action
     containers:
     - name: postdeploy-echo
       image: ubuntu
       command: ["/bin/sh"]
       args: ["-c", 'echo "this is a postdeploy action"' ]
   

   Esse arquivo inclui a estrofe customActions:. Isso define os contêineres a serem executados antes e depois da implantação: os hooks.

   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-hooks-pod
   spec:
     containers:
     - name: nginx
       image: my-app-image
   

   Esse arquivo é um manifesto básico do Kubernetes, que é aplicado ao cluster 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 o lançamento.

   Cloud Run

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

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

   Esse arquivo é uma definição simples de serviço do Cloud Run, que é usada 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 o lançamento.

Observação: se você quiser usar manifestos diferentes por destino, leia este artigo sobre o gerenciamento de manifestos para saber mais sobre como usar perfis do Skaffold.

Criar o pipeline e o destino de entrega

É possível definir o pipeline e o destino 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-hooks-gke-quickstart, crie um novo arquivo: clouddeploy.yaml, com o seguinte conteúdo:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-gke-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: hooks staging cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster
   

   Cloud Run

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

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: deploy-hooks-demo-app-run-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: hooks-staging
       profiles: []
       strategy:
         standard:
           predeploy:
             actions: ["predeploy-action"]
           postdeploy:
             actions: ["postdeploy-action"]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: hooks-staging
   description: staging Run service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   Observação: nesse arquivo, o destino é incluído no pipeline de entrega, mas é possível definir destinos em um arquivo separado ou em vários arquivos separados.

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 seu aplicativo e executar os jobs de pré-implantação e pós-implantação.

3. Confirme o pipeline e os destinos:

   No console 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.

   

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-hooks-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-hooks-demo-app-gke-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 modelos de manifestos dessa forma e use nomes de imagens qualificados por SHA na criação do lançamento.

Cloud Run

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

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

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

Além disso, o job de pré-implantação é executado antes da implantação do aplicativo, e o job de pós-implantação é executado depois.

Conferir os resultados no console do Google Cloud

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

Os hooks de pré e pós-implantação que configuramos (para fins de exemplo) imprimem strings nos registros do Cloud Build. Podemos conferir esses registros para confirmar que os hooks funcionaram conforme esperado.

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

   Abrir a página "Pipelines de entrega"

2. Clique no nome do pipeline de entrega ("deploy-hooks-demo-app-gke-1" ou "deploy-hooks-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ó.

   

   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.

   

   Predeploy e Postdeploy são listados como jobs.

5. Clique em Pré-implantação.

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

6. Role a lista de entradas de registro para encontrar predeploy-echo e clique nele.

   

   Observe o textPayload. Essa string é o que foi configurado no predeploy-action da sua configuração do Skaffold.

7. Clique no job Postdeploy e encontre a entrada de registro postdeploy-echo.

   

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-hooks-cluster --region=us-central1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-hooks-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

• Saiba mais sobre o Cloud Deploy.

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

• Teste o tutorial do Cloud Deploy.

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