Usar parâmetros de implantação
Nesta página, mostramos como usar o Cloud Deploy para fornecer um aplicativo de amostra a dois destinos ao mesmo tempo (uma implantação paralela), transmitindo um valor de parâmetro diferente para cada manifesto renderizado ou definição de serviço usando três métodos diferentes.
Neste guia de início rápido, você fará o seguinte:
Criar dois clusters do GKE ou dois serviços do Cloud Run.
Também é possível usar clusters do GKE Enterprise, mas este guia de início rápido usa apenas o GKE e o Cloud Run.
Crie uma configuração do Skaffold e um manifesto do Kubernetes ou uma definição de serviço do Cloud Run.
A definição do manifesto ou serviço será a mesma para os dois destinos filhos, mas no momento da implantação, o manifesto renderizado ou a definição de serviço para cada destino filho terá valores diferentes para os parâmetros específicos configurados neste guia de início rápido.
Defina o pipeline de entrega e os destinos de implantação do Cloud Deploy.
Esse pipeline terá um multi-target, referenciando dois destinos filhos, para entregar seu app aos dois clusters ou dois serviços.
Defina os parâmetros de implantação em três locais diferentes:
- Na progressão do pipeline
- Nos destinos filhos
- Na linha de comando, ao criar a versão
Instancie o pipeline de entrega criando uma versão que é implantada automaticamente nos dois destinos em paralelo.
Confira os lançamentos do controlador e filhos no console do Google Cloud.
Antes de começar
- 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.
-
No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Ative as APIs Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- Instale a CLI do Google Cloud.
-
Para inicializar a CLI gcloud, execute o seguinte comando:
gcloud init
-
No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.
-
Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
-
Ative as APIs Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- Instale a CLI do Google Cloud.
-
Para inicializar a CLI gcloud, execute o seguinte comando:
gcloud init
- 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 em projetos que desativam as concessões automáticas de papéis para contas de serviço padrão.
- 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"
- 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"
-
Adicione o papel
iam.serviceAccountUser
, que inclui a permissãoactAs
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
- Primeiro, adicione o papel
Se você já tiver a CLI instalada, verifique se está executando a versão mais recente:
gcloud components update
Criar ambientes de execução
Se você estiver implantando no Cloud Run, pule este comando.
Para o GKE, crie dois clusters: deploy-params-cluster-prod1
e deploy-params-cluster-prod2
, com as 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 deploy-params-cluster-prod1 \
--project=PROJECT_ID \
--region=us-central1 \
&& gcloud container clusters create-auto deploy-params-cluster-prod2 \
--project=PROJECT_ID \
--region=us-west1
Preparar a configuração e os manifestos do Skaffold
O Cloud Deploy usa o Skaffold para fornecer os detalhes sobre o que implantar e como implantá-lo corretamente nos destinos separados.
Neste guia de início rápido, você cria um arquivo skaffold.yaml
, que identifica o manifesto do Kubernetes ou a definição do serviço do Cloud Run a ser usada para implantar o app de amostra.
Abra uma janela de terminal.
Crie um novo diretório e navegue até ele.
GKE;
mkdir deploy-params-gke-quickstart cd deploy-params-gke-quickstart
Cloud Run
mkdir deploy-params-run-quickstart cd deploy-params-run-quickstart
Crie um arquivo chamado
skaffold.yaml
com o seguinte conteúdo:GKE;
apiVersion: skaffold/v4beta7 kind: Config manifests: rawYaml: - kubernetes.yaml deploy: kubectl: {}
Cloud Run
apiVersion: skaffold/v4beta7 kind: Config manifests: rawYaml: - service.yaml deploy: cloudrun: {}
Esse arquivo é uma configuração mínima do Skaffold. Para este guia de início rápido, você cria o arquivo. Mas você também pode fazer com que o Cloud Deploy crie um para você, para aplicativos simples que não sejam de produção.
Consulte a referência do
skaffold.yaml
para mais informações sobre esse arquivo.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
kubernetes.yaml
com o seguinte conteúdo:apiVersion: apps/v1 kind: Deployment metadata: name: my-deployment spec: replicas: 1 # from-param: ${replicaCount} selector: matchLabels: app: my-app template: metadata: labels: app: my-app annotations: commit: defaultShaValue # from-param: ${git-sha} spec: containers: - name: nginx image: my-app-image env: - name: envvar1 value: default1 # from-param: ${application_env1} - name: envvar2 value: default2 # from-param: ${application_env2}
Esse arquivo é um manifesto simples do Kubernetes, 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-parallel-run-service spec: autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances} selector: matchLabels: app: my-app template: metadata: annotations: commit: defaultShaValue # from-param: ${git-sha} spec: containers: - image: my-app-image env: - name: envvar1 value: defaultValue1 # from-param: ${application_env1} - name: envvar2 value: defaultValue2 # from-param: ${application_env2}
Esse arquivo é uma definição simples do serviço do Cloud Run, usada no momento da implantação para criar o 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, criamos um único arquivo.
Crie o pipeline de entrega e a definição de destino:
GKE;
No diretório
deploy-params-gke-quickstart
, crie um novo arquivo:clouddeploy.yaml
, com o seguinte conteúdo:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-params-demo-app-1 description: main application pipeline serialPipeline: stages: - targetId: params-prod-multi deployParameters: - values: replicaCount: "2" matchTargetLabels: label1: label1 - values: replicaCount: "3" matchTargetLabels: label2: label2 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-multi description: production clusters multiTarget: targetIds: [params-prod-a, params-prod-b] --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-a labels: label1: label1 description: production cluster 1 deployParameters: application_env1: "sampleValue1" gke: cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-params-cluster-prod1 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-b labels: label2: label2 description: production cluster 2 deployParameters: application_env2: "sampleValue2" gke: cluster: projects/PROJECT_ID/locations/us-west1/clusters/deploy-params-cluster-prod2
Cloud Run
No diretório
deploy-params-run-quickstart
, crie um novo arquivo:clouddeploy.yaml
, com o seguinte conteúdo:apiVersion: deploy.cloud.google.com/v1 kind: DeliveryPipeline metadata: name: my-params-demo-app-1 description: main application pipeline serialPipeline: stages: - targetId: params-prod-multi deployParameters: - values: minInstances: "2" matchTargetLabels: label1: label1 - values: minInstances: "3" matchTargetLabels: label2: label2 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-multi description: production clusters multiTarget: targetIds: [params-prod-a, params-prod-b] --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-a labels: label1: label1 description: production cluster 1 deployParameters: application_env1: "sampleValue1" run: location: projects/PROJECT_ID/locations/us-central1 --- apiVersion: deploy.cloud.google.com/v1 kind: Target metadata: name: params-prod-b labels: label2: label2 description: production cluster 2 deployParameters: application_env2: "sampleValue2" run: location: projects/PROJECT_ID/locations/us-west1
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 um destino múltiplo composto por dois destinos do GKE ou do Cloud Run, pronto para implantar seu aplicativo.
Confirme o pipeline e os destinos:
No console do Google Cloud, navegue até a página Pipelines de entrega do Cloud Deploy para ver uma lista de pipelines de entrega disponíveis.
Abrir a página "Pipelines de entrega"
O pipeline de entrega que você acabou de criar é exibido. Há um destino listado na coluna Targets, mesmo que você tenha configurado três destinos (um de vários destinos e dois filhos) no arquivo
clouddeploy.yaml
.Observe que o único destino listado é o
params-prod-multi
de destinos múltiplos. Destinos filhos não são mostrados.
Criar uma versão
Uma versão é o recurso central do Cloud Deploy que representa as alterações 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.
GKE;
Execute o seguinte comando no diretório deploy-gke-parallel-quickstart
para criar um recurso release
que represente a imagem do contêiner a ser implantada:
gcloud deploy releases create test-release-001 \
--project=PROJECT_ID \
--region=us-central1 \
--delivery-pipeline=my-params-demo-app-1 \
--images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
--deploy-parameters="git-sha=f787cac"
Cloud Run
Execute o seguinte comando no diretório deploy-run-parallel-quickstart
para criar um recurso release
que represente a imagem do contêiner a ser implantada:
gcloud deploy releases create test-release-001 \
--project=PROJECT_ID \
--region=us-central1 \
--delivery-pipeline=my-params-demo-app-1 \
--images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc \
--deploy-parameters="git-sha=f787cac"
Como sempre, quando você cria uma versão, um lançamento é criado automaticamente para o
primeiro destino no pipeline (ou, como nesse caso, um destino específico especificado
usando --to-target=
). Neste guia de início rápido, esse destino é de vários destinos. Portanto,
rollout
é um "lançamento do controlador" para dois
destinos filhos e não há destinos subsequentes no pipeline de entrega.
Isso significa que seu aplicativo será implantado em qualquer lugar após a criação do lançamento.
Conferir os resultados no console do Google Cloud
Agora que você criou a versão e os lançamentos do controlador e os filhos são criados, esses lançamentos filhos são implantados (ou estão em processo de implantação) nos respectivos clusters do GKE ou serviços do Cloud Run.
No console do Google Cloud, navegue até a página Pipelines de entrega do Cloud Deploy para visualizar seu pipeline de entrega my-parallel-demo-app-1.
Clique no nome do pipeline de entrega "my-parallel-demo-app-1".
A visualização do pipeline mostra o status da implantação do aplicativo. 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.
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.
Em Detalhes da versão, selecione a guia Artefatos.
A tabela Parâmetros de implantação lista todos os parâmetros configurados no manifesto e os valores fornecidos para esses parâmetros:
GKE;
Cloud Run
Além dos parâmetros e valores, a tabela mostra a qual destino cada parâmetro se aplica.
Na coluna Inspetor de versão, clique em Exibir artefatos para qualquer destino.
Clique em Show diff (Mostrar diferenças) e selecione
params-prod-a
para um destino eparams-prod-b
para o outro.Uma diferença será mostrada, comparando os manifestos renderizados dos dois destinos, incluindo os valores especificados:
GKE;
Cloud Run
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados nesta página, siga estas etapas.
Exclua os clusters do GKE ou os serviços do Cloud Run:
GKE;
gcloud container clusters delete deploy-params-cluster-prod1 --region=us-central1 --project=PROJECT_ID \ && gcloud container clusters delete deploy-params-cluster-prod2 --region=us-west1 --project=PROJECT_ID
Cloud Run
gcloud run services delete my-parallel-run-service --region=us-central1 --project=PROJECT_ID \ && gcloud run services delete my-parallel-run-service --region=us-west1 --project=PROJECT_ID
Exclua o pipeline de entrega, destinos múltiplos e filhos, versão e lançamentos:
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
Exclua os buckets do Cloud Storage criados pelo Cloud Deploy.
Uma termina com
_clouddeploy
, e a outra é[region].deploy-artifacts.[project].appspot.com
.
Pronto, você concluiu as etapas deste início rápido.
A seguir
Saiba mais sobre como usar parâmetros de implantação.
Leia mais sobre como implantar em vários destinos ao mesmo tempo.
Aprenda as noções básicas sobre a implantação de aplicativos.
Saiba como gerenciar seus manifestos.