Usar parâmetros de implantação
Nesta página, mostramos como usar o Cloud Deploy para enviar um aplicativo de exemplo para dois destinatários ao mesmo tempo (uma implantação paralela), transmitindo um valor de parâmetro diferente para cada definição de serviço ou manifesto renderizado, usando três métodos diferentes.
Neste guia de início rápido, você fará o seguinte:
Crie dois clusters do GKE ou dois serviços do Cloud Run.
Você também pode 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 de manifesto ou serviço será a mesma para as duas destinações filhas, mas no momento do implante, a definição renderizada de manifesto ou 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 destino múltiplo, que faz referência a dois destinos filhos, para entregar o app aos dois clusters ou serviços.
Defina os parâmetros de implantação em três lugares diferentes:
- Na progressão do pipeline
- Nas segmentações filhas
- Na linha de comando, ao criar a versão
Instancie o pipeline de entrega criando uma versão, que implanta automaticamente nos dois destinos em paralelo.
Confira o "lançamento do controlador" e os lançamentos filhos 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.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
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 são incluídas para 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 seus 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 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 implantar corretamente para seus 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 de 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ê vai criar o arquivo. No entanto, você também pode criar uma com o Cloud Deploy, 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 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 a versão.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 básica de serviço do Cloud Run, 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 a versão.
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 do 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" # Apply the deploy parameter replicaCount: "2" to the target with this label matchTargetLabels: label1: label1 - values: replicaCount: "3" # Apply the deploy parameter replicaCount: "3" to the target with this label 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" # Apply the deploy parameter minInstances: "2" to the target with this label matchTargetLabels: label1: label1 - values: minInstances: "3" # Apply the deploy parameter minInstances: "3" to the target with this label 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 do Cloud Deploy:
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
Agora você tem um pipeline com um destino múltiplo que compreende 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 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. Há um destino listado na coluna Targets, mesmo que você tenha configurado três destinos (um destino múltiplo e dois destinos filhos) no arquivo
clouddeploy.yaml
.O único destino listado é o
params-prod-multi
multidestino. Os destinos filhos não são mostrados.
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 saber mais 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"
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 um modelo para seus manifestos dessa maneira e use nomes de imagem qualificados por SHA
na criação da versão.
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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4 \
--deploy-parameters="git-sha=f787cac"
Observe a
flag --images=
,
que você usa para substituir o marcador de posição (my-app-image
) na
definição do serviço
pela imagem específica qualificada pelo SHA. O Google recomenda que você
crie modelos para suas definições de serviço e job dessa maneira e use
nomes de imagem qualificados com SHA na criação da versão.
Como sempre, quando você cria uma versão, um lançamento é criado automaticamente para o
primeiro destino no pipeline, a menos que um destino específico seja especificado usando
--to-target=
. Neste guia de início rápido, esse destino é multidestino, então o
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 é implantado em todos os lugares após a criação do lançamento.
Conferir os resultados no console do Google Cloud
Agora que você criou a versão e o lançamento do controlador e dos lançamentos filhos, eles 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 conferir o 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 de implantação do app. Como há apenas uma fase 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 Deploy parameters lista todos os parâmetros que você configurou 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 segmentação cada parâmetro se aplica.
Na coluna Release inspector, clique em View artifacts para cada destino.
Clique em Mostrar diferença e selecione
params-prod-a
para um destino eparams-prod-b
para o outro.Uma diferença é mostrada, comparando os manifestos renderizados das duas metas, incluindo os valores especificados:
GKE;
Cloud Run
Limpar
Para evitar cobranças na 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, destinos filhos, lançamentos e implantações:
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.
Saiba 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.