Implantar um app no GKE usando o Cloud Deploy

Implantar um app no GKE usando o Cloud Deploy

Nesta página, mostramos como usar o Cloud Deploy para enviar uma imagem de aplicativo de amostra chamada nginx para uma sequência de dois clusters do Google Kubernetes Engine.

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

1. Crie os dois clusters.

2. Criar uma configuração do Skaffold e um manifesto do Kubernetes para especificar a imagem do contêiner (pré-criada) a ser implantada.

3. Defina o pipeline de entrega e os destinos de implantação do Cloud Deploy, que apontam para os dois clusters.

4. Instancie o pipeline de entrega criando uma versão, que implanta automaticamente no primeiro destino.

5. Promova a versão para a segunda segmentação.

6. Veja os dois lançamentos no console do Google Cloud .

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.

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

Se este guia estiver usando um projeto atual, verifique se você tem as permissões necessárias para concluir o guia. Se você criou um projeto, já tem as permissões necessárias.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, 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

Install the 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 gcloud CLI, execute o seguinte comando:

gcloud init

Observação: execute a gcloud CLI no console do Google Cloud sem instalar a CLI do Google Cloud. Para executar a gcloud CLI 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.

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

Se este guia estiver usando um projeto atual, verifique se você tem as permissões necessárias para concluir o guia. Se você criou um projeto, já tem as permissões necessárias.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Deploy, Cloud Build, GKE, 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

Install the 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 gcloud CLI, execute o seguinte comando:

gcloud init

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

Funções exigidas

Para receber as permissões necessárias para criar um pipeline de entrega e um lançamento do Cloud Deploy, peça ao administrador para conceder a você o papel do IAM de Executor de jobs do Cloud Deploy (roles/clouddeploy.jobrunner) no projeto.

Para garantir que a conta de serviço do Cloud Deploy tenha as permissões necessárias para executar operações do Cloud Deploy e fazer implantações no Cloud Run, peça ao administrador para conceder a ela os seguintes papéis do IAM no projeto:

Importante:conceda esses papéis à conta de serviço do Cloud Deploy, não à sua conta de usuário. Se o papel não for concedido ao principal correto, poderão ocorrer erros de permissão.

• Desenvolvedor do Google Kubernetes Engine (roles/container.developer)
• Usuário da conta de serviço do IAM (roles/iam.serviceAccountUser)

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

O administrador também pode conceder à conta de serviço do Cloud Deploy as permissões necessárias por meio de papéis personalizados ou outros papéis predefinidos.

Criar seus clusters do Google Kubernetes Engine

Crie dois clusters: qsdev e qsprod, com configurações padrão. Os endpoints da API Kubernetes dos clusters precisam ser acessíveis pela rede da Internet pública. Por padrão, os clusters do GKE podem ser acessados externamente.

gcloud container clusters create-auto quickstart-cluster-qsdev --project=PROJECT_ID --region=us-central1 && gcloud container clusters create-auto quickstart-cluster-qsprod --project=PROJECT_ID --region=us-central1

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

O Cloud Deploy usa o Skaffold para fornecer detalhes sobre o que implantar e como fazer isso corretamente para seus destinos separados.

Neste guia de início rápido, você cria um arquivo skaffold.yaml, que identifica o manifesto do Kubernetes a ser usado para implantar o aplicativo de amostra.

1. Abra uma janela de terminal.

2. Crie um novo diretório chamado deploy-gke-quickstart e navegue até ele.

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

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

   apiVersion: skaffold/v4beta7
   kind: Config
   manifests:
     rawYaml:
     - k8s-*
   deploy:
     kubectl: {}
   

   Esse arquivo é uma configuração mínima do Skaffold que identifica seu manifesto. Para este guia de início rápido, você vai criar o arquivo. Mas também é possível fazer com que o Cloud Deploy crie um para você, para aplicativos simples que não são de produção.

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

4. Crie um arquivo chamado k8s-pod.yaml com o seguinte conteúdo:

   apiVersion: v1
   kind: Pod
   metadata:
     name: getting-started
   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 de 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 a versão.

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 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. No diretório deploy-gke-quickstart, crie um novo arquivo: clouddeploy.yaml, com o seguinte conteúdo:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-gke-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: qsdev
       profiles: []
     - targetId: qsprod
       profiles: []
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsdev
   description: development cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsdev
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: qsprod
   description: production cluster
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod
   

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 com destinos prontos para implantar seu aplicativo no primeiro destino.

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 é exibido, e os dois destinos são listados 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.

Execute o seguinte comando no diretório deploy-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=my-gke-demo-app-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 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 primeiro destino da progressão.

Promover a versão

Observação: depois de criar a versão, talvez seja necessário aguardar alguns minutos antes de continuar com esta etapa.

1. Na página Pipelines de entrega, clique no pipeline my-gke-demo-app-1.

   Abrir a página "Pipelines de entrega"

   A página de detalhes do pipeline de entrega mostra uma representação gráfica do progresso do pipeline de entrega. Neste caso, ele mostra que a versão foi implantada no destino qsdev.

   

2. No primeiro destino na visualização do pipeline de exibição, clique em Promover.

   A caixa de diálogo Promover versão é exibida. Ela mostra os detalhes do destino que você está promovendo.

3. Clique em Promover.

   A versão agora está na fila para implantação em qsprod. Quando a implantação estiver concluída, a visualização do pipeline de entrega a mostrará como implantada:

   

Conferir os resultados no console do Google Cloud

1. No console Google Cloud , navegue até a página Pipelines de entrega do Cloud Deploy para conferir seu pipeline de entrega my-gke-demo-app-1.

   Abrir a página "Pipelines de entrega"

2. Clique no nome do pipeline de entrega "my-gke-demo-app-1".

   A visualização do pipeline mostra o progresso do aplicativo por meio do pipeline.

   

   E sua versão é listada na guia Versões em Detalhes do pipeline de entrega.

3. Clique no nome da versão, test-release-001.

   Seus lançamentos aparecem em Lançamentos. É possível clicar em um lançamento para ver os detalhes dele, incluindo o registro de implantação.

   

Limpar

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

1. Exclua o cluster qsdev:

   gcloud container clusters delete quickstart-cluster-qsdev --region=us-central1 --project=PROJECT_ID
   

2. Exclua o cluster qsprod:

   gcloud container clusters delete quickstart-cluster-qsprod --region=us-central1 --project=PROJECT_ID
   

3. Exclua o pipeline de entrega, os destinos, a versão e os lançamentos:

   gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
   

4. 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 gerenciar seus manifestos.

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