Definir e usar um tipo de destino personalizado

Definir e usar um tipo de destino personalizado

Neste guia de início rápido, mostramos como usar o Cloud Deploy para criar um tipo de destino personalizado e, em seguida, implantar em um destino personalizado desse tipo.

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

1. Defina um tipo de destino personalizado, em que você vai configurar o comportamento do destino. Essa configuração faz referência a imagens de contêiner e comandos de shell para serem executados nessas imagens, que são as ações para operações de renderização e implantação.

2. Defina um destino que faça referência ao tipo de destino personalizado.

3. Defina o pipeline de entrega do Cloud Deploy.

   Esse pipeline inclui apenas um estágio e usa apenas um destino. Nesse estágio, você vai fazer referência ao destino configurado.

4. Crie uma configuração do Skaffold, que é necessária para a versão.

5. Crie uma versão, que cria automaticamente um lançamento, resultando na execução das operações personalizadas de renderização e implantação.

   Como parte dessa versão e lançamento, as operações de renderização e implantação definidas na configuração do tipo de destino personalizado são executadas.

6. Confira os resultados das operações personalizadas. Isso inclui um arquivo de configuração renderizado enviado ao Cloud Storage, uma string gravada nesse arquivo e um arquivo de resultados que inclui o status da operação.

Antes de começar

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.
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.
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.
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
Instale a Google Cloud CLI.
Ao usar um provedor de identidade (IdP) externo, primeiro faça login na gcloud CLI com sua identidade federada.
Para inicializar a CLI gcloud, execute o seguinte comando:
gcloud init
Observação: execute a CLI gcloud no Google Cloud console sem instalar a Google Cloud CLI. Para executar a CLI gcloud no Google Cloud console, use o Cloud Shell.

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.

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.

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

Instale a Google Cloud CLI.

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

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

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

Se você já tiver a Google Cloud 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 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 o papel de desenvolvedor para o ambiente de execução específico.
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 pipeline de entrega, o tipo de destino personalizado e o destino

É possível definir o pipeline de entrega, o tipo de destino personalizado e o destino em um arquivo ou em arquivos separados. Neste guia de início rápido, você cria um único arquivo com os três.

1. Abra uma janela do terminal.

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

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

3. No diretório custom-target-quickstart, crie um novo arquivo, clouddeploy.yaml, com o seguinte conteúdo:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: custom-targets-pipeline
   serialPipeline:
     stages:
     - targetId: sample-env
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: sample-env
   customTarget:
     customTargetType: basic-custom-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: CustomTargetType
   metadata:
     name: basic-custom-target
   tasks:
     render:
       type: 'container'
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo "Sample manifest rendered content" > manifest.txt
           gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
           echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
     deploy:
       type: 'container'
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:484e8266c1cfc84b283bc6d4eec1f6b61223115178cce76fb59f77b223f26e8e
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   

   A definição de tipo de destino personalizado inclui a tasks seção, que define uma tarefa de renderização e uma tarefa de implantação. Cada uma dessas tarefas faz referência a uma imagem do contêiner a ser executada e a comandos a serem executados nesse contêiner.

   Observação: o tipo de destino personalizado e o destino são incluídos no pipeline de entrega nesse arquivo, mas é possível defini-los em um arquivo separado ou em vários arquivos separados.

4. 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. Esse é o destino que usa o tipo de destino personalizado, e esse pipeline não implanta um aplicativo em um ambiente de execuçã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.

   

Criar o arquivo de configuração do Skaffold

A versão neste guia de início rápido requer um Skaffold arquivo de configuração, mas este arquivo não exige uma configuração significativa.

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

   apiVersion: skaffold/v4beta7
   kind: Config
   

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

Execute o seguinte comando no diretório custom-target-quickstart para criar um recurso release que representa a ação personalizada a ser implantada:

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

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. E todas as fases desse lançamento são executadas, incluindo renderização e implantação.

Conferir os resultados no Google Cloud console

Após alguns minutos, a implantação será concluída. Nesse caso, como as duas ações personalizadas são comandos para ecoar strings em um arquivo e fazer upload do arquivo para o Cloud Storage, nada é implantado em nenhum ambiente de execução de destino.

No entanto, é possível conferir o arquivo e as strings nele:

1. No Google Cloud console, navegue até a página Pipelines de entrega do Cloud Deploy para visualizar seu pipeline de entrega (custom-targets-pipeline).

   Abrir a página "Pipelines de entrega"

2. Clique no nome do pipeline de entrega (custom-targets-pipeline).

   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 no nome da versão.

   A página Detalhes da versão é mostrada.

4. Clique na guia Artefatos.

5. Em Artefatos de destino, clique no link CONFERIR ARTEFATOS.

   O arquivo de manifesto renderizado é mostrado. Nesse caso, o arquivo é a saída da ação de renderização personalizada definida na configuração do tipo de destino personalizado, contendo a string "Conteúdo renderizado do manifesto de amostra".

   

6. Encontre os buckets do Cloud Storage criados por essa versão.

   Abrir a página "Procurar" do Cloud Storage

   A página Buckets é mostrada, mostrando dois buckets criados para essa versão. Um bucket contém o arquivo de configuração do pipeline de entrega e o skaffold.yaml renderizado. O outro inclui o arquivo de saída que nossa ação personalizada está configurada para criar.

7. Clique no bucket cujo nome começa com us-central1.deploy-artifacts...

   

8. Clique na pasta cujo nome começa com custom-targets-pipeline- e clique na pasta test-release-001.

9. Clique na pasta cujo nome é o nome do lançamento, que precisa ser test-release-001-to-sample-env-0001.

10. Clique na pasta mostrada, que é um UUID, e clique na pasta custom-output.

11. Clique em results.json e clique no URL com hiperlink no campo URL autenticado.

    Esse arquivo contém a string configurada como saída da ação custom-deploy, na definição do tipo de destino personalizado:

    

Observação: também é possível conferir os resultados da renderização no bucket do Cloud Storage, mas é mais rápido usar o inspetor de versões, conforme mostrado nas primeiras etapas deste procedimento.

Limpar

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

1. 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
   

2. Exclua os dois buckets do Cloud Storage criados pelo Cloud Deploy.

   Abrir a página "Procurar" do Cloud Storage

Pronto, você concluiu as etapas deste início rápido.

A seguir

• Saiba mais sobre destinos personalizados.

• Consulte os tipos de destino personalizados de amostra disponíveis.

• Saiba mais sobre o Cloud Deploy.

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