Executar ganchos antes e depois da implantação

Executar ganchos 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 antes ou depois da implantação usando o Cloud Deploy.

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

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

   Também é possível usar um cluster do GKE Enterprise para isso, este guia de início rápido usa apenas o GKE e o Cloud Run.

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

   O arquivo de configuração do Skaffold é onde você configura os hooks de implantação para correr. Você identifica um contêiner para executar antes da implantação sejam executados 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, faça referência aos hooks de implantação que foram definidos em skaffold.yaml para executar esses hooks.

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

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

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

5. Ver os resultados dos hooks de pré e pós-implantação no Cloud Build registros, usando a página Detalhes do lançamento do Cloud Deploy em 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. 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. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

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. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

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á 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. Estas etapas são incluídas para projetos que desativam concessões automáticas de papéis para contas de serviç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 de desenvolvedor ao 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íveis por rede a partir da Internet pública. Clusters do GKE são acessíveis externamente por padrão.

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 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 os contêineres sejam executados antes e depois da implantação (os ganchos 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 executar antes e depois da implantação (os ganchos).

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

4. Crie a definição para seu aplicativo, uma definição de serviço para o Cloud Run ou um manifesto do Kubernetes para 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 arquivo manifesto, 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-hooks-run-service
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Esse arquivo é uma definição simples de serviço do Cloud Run, que é usado no momento da implantação para criar serviço.

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

Crie o pipeline de entrega e o destino

É 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 do 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 está incluído no pipeline de entrega, mas é possível definir destinos em um ou vários arquivos separados.

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

3. Confirme o pipeline e os destinos:

   No console do Google Cloud, acesse a página do Cloud Deploy Página Pipelines de entrega para exibir a lista de entregas disponíveis pipelines de dados.

   Abrir a página "Pipelines de entrega"

   O pipeline de entrega que você acabou de criar é mostrado, com um destino listado em na coluna Destinos.

   

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

GKE;

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

Cloud Run

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

Assim como acontece com todas as versões (a menos que incluam --disable-initial-rollout), O Cloud Deploy cria automaticamente um rollout também. O aplicativo é implantados automaticamente no destino configurado para essa entrega pipeline.

Além disso, o job de pré-implantação é executado antes da implantação do aplicativo, e o o job 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 pré e pós-implantação que configuramos (por exemplo, para fins de impressão) strings aos registros do Cloud Build. Podemos conferir esses registros para confirmar que se os ganchos funcionaram como 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-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 aplicativo. Como não 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 Lançamentos, 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 para baixo na lista de entradas de registro para encontrar predeploy-echo e clique em reimplantá-lo.

   

   Observe o textPayload. Essa string é aquela configurada no predeploy-action na sua Configuração do Skaffold.

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

   

Limpar

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

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

   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 que o Cloud Deploy criou.

   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.

• Confira o tutorial do Cloud Deploy.

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