Referência do esquema de configuração

Os arquivo de configuração do Cloud Deploy definem o pipeline de entrega, os destinos a serem implantados e o progresso desses destinos.

O arquivo de configuração do pipeline de entrega pode incluir definições de destino ou podem estar em um ou mais arquivos separados. Por convenção, um arquivo que contém a configuração do pipeline de entrega e as configurações de destino é chamado de clouddeploy.yaml, e uma configuração de pipeline sem destinos é chamada de delivery-pipeline.yaml. Mas você pode dar a esses arquivos o nome que quiser.

O que vai para onde

O Cloud Deploy usa dois arquivos de configuração principais:

Eles podem ser arquivos separados ou o pipeline de entrega e os destinos podem ser configurados no mesmo arquivo.

Estrutura de um arquivo de configuração de pipeline de entrega

A configuração a seguir inclui uma definição de destino:

# Delivery pipeline config
apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
 name:
 annotations:
 labels:
description:
suspended:
serialPipeline:
 stages:
 - targetId:
   profiles: []
# Deployment strategies
# One of:
#   standard:
#   canary:
# See the strategy section in this document for details.
   strategy:
     standard:
       verify:
       predeploy:
         actions: []
       postdeploy:
         actions: []
   deployParameters:
   - values:
     matchTargetLabels:
 - targetId:
   profiles: []
   strategy:
   deployParameters:
---

# Target config
apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
 name:
 annotations:
 labels:
description:
multiTarget:
 targetIds: []
deployParameters:
requireApproval:
#
# Runtimes
# one of the following runtimes:
gke:
 cluster:
 internalIp:
 proxyUrl:
#
# or:
anthosCluster:
 membership:
#
# or:
run:
 location:
#
# or:
customTarget:
  customTargetType:
#
# (End runtimes. See documentation in this article for more details.)
#
executionConfigs:
- usages:
  - [RENDER | PREDEPLOY | DEPLOY | VERIFY | POSTDEPLOY]
  workerPool:
  serviceAccount:
  artifactStorage:
  executionTimeout:
---

# Custom target type config
apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name:
  annotations:
  labels:
description:
customActions:
  renderAction:
  deployAction:
  includeSkaffoldModules:
    - configs:
    # either:
    googleCloudStorage:
      source:
      path:
    # or:
    git:
      repo:
      path:
      ref:
---

# Automation config
apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name:
  labels:
  annotations:
description:
suspended:
serviceAccount:
selector:
- target:
    id:
    # or
    labels:
rules:
- [RULE_TYPE]:
  name:
  [RULE-SPECIFIC_CONFIG]

Esse YAML tem três componentes principais:

  • O principal pipeline de entrega e a progressão

    O arquivo de configuração pode incluir qualquer número de definições de canal.

  • As definições de destino

    Para simplificar, apenas um destino é mostrado neste exemplo, mas pode haver qualquer um deles. Além disso, os destinos podem ser definidos em um ou mais arquivos.

  • Definições de tipo de segmentação personalizada

    Os destinos personalizados, exigem uma definição de tipo de destino personalizado. Assim como nos destinos e automações, os tipos de segmentação personalizados podem ser definidos no mesmo arquivo que o pipeline de entrega ou em um arquivo separado.

  • Definições de Automation

    É possível criar qualquer automação de implantação no mesmo arquivo que o pipeline de entrega e os destinos ou em um ou mais arquivos separados. Para simplificar, apenas um Automation é mostrado aqui, mas você pode criar quantos quiser.

Esses componentes são definidos no restante deste documento.

Definição e progressão do pipeline

Além dos metadados do pipeline, como name, a definição do pipeline principal inclui uma lista de referências a destinos na ordem de sequência de implantação. Ou seja, o primeiro destino listado é o primeiro destino de implantação. Depois da implantação nesse destino, a promoção da versão é implantada no próximo destino na lista.

Veja a seguir as propriedades de configuração de um pipeline de entrega, sem incluir as definições de destino.

metadata.name

O campo name usa uma string que precisa ser exclusiva por projeto e local.

metadata.annotations e metadata.labels

A configuração do pipeline de entrega pode incluir anotações e rótulos. As anotações e os rótulos são armazenados com o recurso de pipeline de entrega depois que o pipeline é registrado.

Para mais informações, consulte Como usar rótulos e anotações com o Cloud Deploy.

description

Uma string arbitrária descrevendo esse pipeline de entrega. Essa descrição é mostrada nos detalhes do pipeline de entrega no console do Google Cloud.

suspended

Um booleano, que, se true, suspensa o pipeline de entrega de modo que não possa ser usado para criar, promover, reverter ou reimplantar versões. Além disso, se o pipeline de entrega estiver suspenso, não será possível aprovar ou rejeitar um lançamento criado a partir dele.

O padrão é false.

serialPipeline

O início da definição de um pipeline de entrega de progressão em série. Esta estrofe é obrigatória.

stages

Uma lista de todos os destinos em que esse pipeline de entrega está configurado para implantação.

A lista precisa estar na ordem em que a sequência de exibição você quer. Por exemplo, se você tiver destinos chamados dev, staging e production, liste-os na mesma ordem, de modo que a primeira implantação seja dev; sua implantação final será em production.

Preencha cada campo stages.targetId com o valor do campo metadata.name na definição de destino correspondente. E em targetId, inclua profiles:

serialPipeline:
 stages:
 - targetId:
   profiles: []
   strategy:
     standard:
       verify:

targetId

Identifica o destino específico a ser usado neste estágio do pipeline de entrega. O valor é a propriedade metadata.name da definição de destino.

strategy.standard.verify definido como true ativa a verificação de implantação no destino. Se nenhuma estratégia de implantação for especificada, a estratégia standard será usada, com a verificação definida como false.

profiles

Usa uma lista de zero ou mais nomes de perfil do Skaffold do skaffold.yaml. O Cloud Deploy usa o perfil com skaffold render ao criar a versão. Os perfis do Skaffold permitem que você varie a configuração entre os destinos ao usar um único arquivo de configuração.

strategy

Inclui propriedades para especificar uma estratégia de implantação. As seguintes estratégias são compatíveis:

  • standard:

    O aplicativo é totalmente implantado no destino especificado.

    Essa é a estratégia de implantação padrão. Se você omitir strategy, o Cloud Deploy usará a estratégia de implantação standard.

  • canary:

    Em uma implantação canário, você implanta uma nova versão do aplicativo progressivamente, substituindo a versão já em execução por incrementos baseados em porcentagem (por exemplo, 25%, depois 50%, depois 75% e depois totalmente).

A estratégia de implantação é definida por destino. Por exemplo, você pode ter uma estratégia canário para seu destino prod, mas uma estratégia padrão (nenhum strategy especificado) para seus outros destinos.

Para mais informações, consulte Usar uma estratégia de implantação.

Configuração strategy

Esta seção mostra os elementos de configuração de strategy para cada ambiente de execução compatível.

Estratégia de implantação padrão

A estratégia padrão inclui apenas os seguintes elementos:

strategy:
  standard:
    verify: true|false

A propriedade verify é opcional. O padrão é false, o que significa que não haverá uma fase de verificação para os lançamentos resultantes.

É possível omitir o elemento strategy em uma estratégia de implantação padrão.

Estratégia de implantação canário

As seções a seguir descrevem a configuração de uma estratégia de implantação canário para cada ambiente de execução compatível com o Cloud Deploy.

Para destinos do Cloud Run
strategy:
  canary:
    runtimeConfig:
      cloudRun:
        automaticTrafficControl: true | false
    canaryDeployment:
      percentages: [PERCENTAGES]
      verify: true | false
Para destinos do GKE e GKE Enterprise

O YAML a seguir mostra como configurar uma estratégia de implantação para um destino do GKE ou do GKE Enterprise usando uma rede baseada em serviço:

      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "SERVICE_NAME"
              deployment: "DEPLOYMENT_NAME"
              disablePodOverprovisioning: true | false
        canaryDeployment:
          percentages: [PERCENTAGES]
          verify: true | false

O YAML a seguir mostra como configurar uma estratégia de implantação para um destino do GKE ou GKE Enterprise usando a API Gateway:

      canary:
        runtimeConfig:
          kubernetes:
            gatewayServiceMesh:
              httpRoute: "HTTP_ROUTE_NAME"
              service: "SERVICE_NAME"
              deployment: "DEPLOYMENT_NAME"
              routeUpdateWaitTime: "WAIT_TIME"
        canaryDeployment:
          percentages: ["PERCENTAGES"]
          verify: true | false

Observe neste exemplo routeUpdateWaitTime. Isso está incluído porque a API Gateway divide o tráfego usando um recurso HTTPRoute e, às vezes, há um atraso na propagação das alterações feitas no HTTPRoute. Nesses casos, as solicitações podem ser descartadas porque o tráfego está sendo enviado para recursos indisponíveis. Use routeUpdateWaitTime para fazer com que o Cloud Deploy espere depois de aplicar as alterações de HTTPRoute, se você observar esse atraso.

O YAML a seguir mostra como configurar uma estratégia de implantação canário personalizada ou automatizada. A configuração específica do ambiente de execução, na seção runtimeConfig, foi omitida para o canário personalizado, mas foi incluída na configuração canário automatizada e personalizada.

strategy:
       canary:
         # Runtime configs are configured as shown in the
         # Canary Deployment Strategy section of this document.
         runtimeConfig:

         # Manual configuration for each canary phase
         customCanaryDeployment:
           - name: "PHASE1_NAME"
             percent: PERCENTAGE1
             profiles: [ "PROFILE1_NAME" ]
             verify: true | false
           - …
           - name: "stable"
             percent: 100
             profiles: [ "LAST_PROFILE_NAME" ]
             verify: true|false

verify

Booleano opcional que indica se é ou não compatível com a verificação de implantação para o destino. O padrão é false.

A ativação da verificação de implantação também exige uma estrofe verify no skaffold.yaml. Se você não fornecer essa propriedade, o job de verificação falhará.

deployParameters

Permite especificar pares de chave-valor para transmitir valores a manifestos de destinos correspondentes ao rótulo, ao usar parâmetros de implantação.

Também é possível incluir isso em destinos.

Implante parâmetros definidos em um pipeline de entrega usando rótulos para corresponder aos destinos:

deployParameters:
- values:
    someKey: "value1"
  matchTargetLabels:
    label1: firstLabel
- values:
    someKey: "value2"
  matchTargetLabels:
    label2: secondLabel

Neste exemplo, dois valores são fornecidos para a chave e, para cada valor, há um rótulo. O valor é aplicado ao manifesto para qualquer destino que tenha um rótulo correspondente.

Jobs predeploy e postdeploy

Isso permite que você faça referência a ações personalizadas (definidas separadamente, em skaffold.yaml) para serem executadas antes do job de implantação (predeploy) e depois do job de verificação, se presente (postdeploy). Se não houver um job de verificação, o job pós-implantação será executado depois do job de implantação.

Os hooks de implantação são configurados em strategy.standard ou strategy.canary da seguinte maneira:

serialPipeline:
  stages:
  - targetId: 
    strategy:
      standard:
        predeploy:
          actions: [ACTION_NAME]
        postdeploy:
          actions: [ACTION_NAME]

Em que ACTION_NAME é o nome configurado em skaffold.yaml para customActions.name.

É possível configurar jobs predeploy e postdeploy em qualquer estratégia (standard, canary, por exemplo).

Para mais informações sobre como configurar e usar hooks de pré e pós-implantação, consulte Executar hooks antes e depois da implantação.

Definições de destino

O arquivo de definição do pipeline de entrega pode conter definições de destino ou é possível especificar destinos em um arquivo separado. É possível repetir nomes de destino em um projeto, mas eles precisam ser exclusivos em um pipeline de entrega.

É possível reutilizar destinos entre vários pipelines de entrega. No entanto, só é possível referenciar um destino uma vez a partir da progressão de um único pipeline de entrega.

Consulte também: Definições de tipo de segmentação personalizada

Para destinos do GKE

O YAML a seguir mostra como configurar um destino que é implantado em um cluster do GKE:

     apiVersion: deploy.cloud.google.com/v1
     kind: Target
     metadata:
      name:
      annotations:
      labels:
     description:
     deployParameters:
     multiTarget:
      targetIds: []

     requireApproval:
     gke:
      cluster: projects/[project_name]/locations/[location]/clusters/[cluster_name]
      internalIp:
      proxyUrl:

     executionConfigs:
     - usages:
       - [RENDER | PREDEPLOY | DEPLOY | VERIFY | POSTDEPLOY]
       workerPool:
       serviceAccount:
       artifactStorage:
       executionTimeout:
       verbose:

metadata.name

O nome dessa segmentação. Esse nome precisa ser globalmente exclusivo.

metadata.annotations e metadata.labels

A configuração de destino oferece suporte a anotações e rótulos do Kubernetes, mas o Cloud Deploy não os exige.

Anotações e rótulos são armazenados com o recurso de destino. Para mais informações, consulte Como usar rótulos e anotações com o Cloud Deploy.

description

Esse campo usa uma string arbitrária que descreve o uso desse destino.

deployParameters

É possível incluir parâmetros de implantação em qualquer destino, junto com valores. Esses valores são atribuídos às chaves correspondentes no manifesto, após a renderização.

A estrofe deployParameters usa pares de chave-valor, conforme mostrado:

deployParameters:
  someKey: "someValue"
  someOtherKey: "someOtherValue"

Se você definir parâmetros de implantação em um multi-target, o valor será atribuído ao manifesto de todos os destinos filhos desse vários destinos.

multiTarget.targetIds: []

Essa propriedade é opcional e é usada para configurar um multi-target a ser usado para implantação paralela.

O valor é uma lista separada por vírgulas de destinos filhos. Os destinos filhos são configurados como destinos normais e não incluem essa propriedade multiTarget.

requireApproval

Indica se a promoção para esta meta requer aprovação manual. Pode ser true ou false.

Esta propriedade é opcional. O padrão é false.

Ao configurar a implantação paralela, é possível exigir aprovação apenas para vários destinos, não em destinos filhos.

gke

Apenas para clusters do GKE, o caminho do recurso que identifica o cluster em que o aplicativo será implantado:

gke:
  cluster: projects/[project_name]/locations/[location]/clusters/[cluster_name]

  • project_name

    O projeto do Google Cloud em que o cluster reside.

  • location

    O local em que o cluster reside. Por exemplo, us-central1 O cluster também pode ser zonal (us-central1-c).

  • cluster_name

    O nome do cluster, como aparece na lista de clusters no console do Google Cloud.

Veja um exemplo:

gke:
  cluster: projects/cd-demo-01/locations/us-central1/clusters/prod

Omita a propriedade gke ao configurar uma multi-target. Em vez disso, o cluster do GKE é configurado dentro do destino filho correspondente.

Consulte executionConfigs, neste artigo, para descrições das propriedades do ambiente de execução.

internalIp

Se o cluster do GKE especificado usa ou não um endereço IP particular. Esta propriedade é opcional. Por padrão, o Cloud Deploy usa o endereço IP disponível publicamente para o cluster. Se houver um endereço IP particular e você quiser usá-lo, defina como true.

proxyUrl

Se você acessar clusters por um proxy, forneça a propriedade proxyUrl aqui. O valor é o URL do cluster do GKE de proxy, que é transmitido ao kubectl quando se conecta ao cluster.

Para destinos do Cloud Run

O YAML a seguir mostra como configurar um destino que implanta em um serviço do Cloud Run:

     apiVersion: deploy.cloud.google.com/v1
     kind: Target
     metadata:
      name:
      annotations:
      labels:
     description:
     multiTarget:
      targetIds: []

     requireApproval:
     run:
      location: projects/[project_name]/locations/[location]

     executionConfigs:
     - usages:
       - [RENDER | PREDEPLOY|  DEPLOY | VERIFY | POSTDEPLOY]
       workerPool:
       serviceAccount:
       artifactStorage:
       executionTimeout:
       verbose:

metadata.name

O nome dessa segmentação. Ele precisa ser exclusivo por região.

metadata.annotations e metadata.labels

A configuração de destino oferece suporte a anotações e rótulos, mas o Cloud Deploy não os exige.

Anotações e rótulos são armazenados com o recurso de destino. Para mais informações, consulte Como usar rótulos e anotações com o Cloud Deploy.

description

Esse campo usa uma string arbitrária que descreve o uso desse destino.

multiTarget.targetIds: []

Essa propriedade é opcional e é usada para configurar um multi-target a ser usado para implantação paralela.

O valor é uma lista separada por vírgulas de destinos filhos. Os destinos filhos são configurados como destinos normais e não incluem essa propriedade multiTarget.

requireApproval

Indica se a promoção para esta meta requer aprovação manual. Pode ser true ou false.

Esta propriedade é opcional. O padrão é false.

Ao configurar a implantação paralela, é possível exigir aprovação apenas para vários destinos, não em destinos filhos.

run

Apenas para os serviços do Cloud Run, o local em que o serviço será criado:

run:
  location: projects/[project_name]/locations/[location]

  • project_name

    O projeto do Google Cloud em que o serviço vai ficar.

  • location

    O local onde o serviço vai ficar. Por exemplo, us-central1

Omita a propriedade run ao configurar um [destinos múltiplos]. O local do serviço do Cloud Run é configurado dentro do destino filho correspondente.

Consulte executionConfigs, neste artigo, para descrições das propriedades do ambiente de execução.

Para destinos do GKE Enterprise

A configuração de destino para implantação em um cluster do GKE é semelhante à configuração de um destino para um destino do GKE, exceto que a propriedade é anthosCluster.membership, em vez de gke.cluster, o caminho do recurso é diferente e internalIp não é aplicável.

anthosCluster:
  membership: projects/[project_name]/locations/global/memberships/[membership_name]

  • project_name

    O projeto do Google Cloud em que o cluster do GKE Enterprise fica.

  • /location/global/

    O local em que o cluster está registrado. global, em todos os casos.

  • membership_name

    O nome da assinatura do cluster do GKE Enterprise.

Veja um exemplo:

anthosCluster:
  membership: projects/cd-demo-01/locations/global/memberships/prod

Omita a propriedade anthosCluster ao configurar um [destinos múltiplos]. O cluster do GKE Enterprise é configurado dentro do destino filho correspondente.

Para mais informações sobre como implantar em clusters do GKE, consulte Como implantar em clusters de usuários do Anthos.

Para segmentações personalizadas

A configuração para destinos personalizados é semelhante a todos os outros tipos de destino, exceto por não incluir uma estrofe gke, uma estrofe run nem uma estrofe anthosCluster.

Em vez disso, os destinos personalizados incluem uma estrofe de customTarget:

customTarget:
  customTargetType: [CUSTOM_TARGET_TYPE_NAME]

Em que CUSTOM_TARGET_TYPE_NAME é o nome usado na definição do tipo de destino personalizado.

Veja um exemplo:

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: sample-env
customTarget:
  customTargetType: basic-custom-target

executionConfigs

Um conjunto de campos para especificar um ambiente de execução não padrão para esse destino.

  • usages

    RENDER ou DEPLOY ou ambos, além de PREDEPLOY, VERIFY ou POSTDEPLOY, se verificação ou hooks de implantação estiverem ativados no destino. Eles indicam quais dessas operações realizarão para essa meta usando esse ambiente de execução. Para indicar que um ambiente de execução personalizado deve ser usado para hooks de pré-implantação, renderização, implantação, gancho pós-implantação e verificação, configure-o da seguinte maneira:

    usages:
- RENDER
- PREDEPLOY
- DEPLOY
- VERIFY
- POSTDEPLOY

    Se a verificação estiver ativada no estágio do pipeline e você não especificar VERIFY em uma estrofe usages, o Cloud Deploy usará o ambiente de execução padrão para verificação. Os hooks de pré e pós-implantação funcionam da mesma maneira.

    No entanto, se houver um ambiente de execução personalizado para RENDER e DEPLOY, será necessário especificar um para VERIFY, PREDEPLOY ou POSTDEPLOY se eles estiverem configurados no pipeline de entrega.VERIFY, PREDEPLOY e POSTDEPLOY podem estar no mesmo usages que RENDER ou DEPLOY ou em usages separados.

    Não é possível especificar usages.VERIFY, usages.PREDEPLOY ou usages.POSTDEPLOY, a menos que RENDER e DEPLOY estejam especificados no mesmo ambiente de execução personalizado ou em ambientes separados.

  • workerPool

    Configuração a ser usada pelo pool de workers. Isso requer um caminho de recurso que identifique o pool de workers do Cloud Build a ser usado para esse destino. Exemplo:

    projects/p123/locations/us-central1/workerPools/wp123.

    Para usar o pool padrão do Cloud Build, omita essa propriedade.

    Um determinado destino pode ter dois workerPools (um para RENDER e outro para DEPLOY). Ao configurar o pool padrão, é possível especificar uma conta de serviço alternativa, um local de armazenamento ou ambos.

  • serviceAccount

    O nome da conta de serviço a ser usada para esta operação (RENDER ou DEPLOY) para esse destino.

  • artifactStorage

    O bucket do Cloud Storage a ser usado para esta operação (RENDER ou DEPLOY) para este destino, em vez do bucket padrão.

  • executionTimeout

    Opcional. Define o tempo limite, em segundos, das operações executadas pelo Cloud Build no Cloud Deploy. Por padrão, o valor é de 3600 segundos (1 hora).
    Exemplo: executionTimeout: "5000s"

  • verbose

    Opcional. Se for true, os níveis de detalhamento serão definidos como debug para as seguintes ferramentas:

Sintaxe alternativa compatível

A configuração do executionConfigs descrita neste documento é nova. A sintaxe anterior ainda é compatível:

executionConfigs:
- privatePool:
    workerPool:
    serviceAccount:
    artifactStorage:
  usages:
  - [RENDER | DEPLOY]
- defaultPool:
    serviceAccount:
    artifactStorage:
  usages:
  - [RENDER | DEPLOY]

Ao configurar uma estrofe de executionConfigs para um multi-target, cada destino filho pode herdar esse ambiente de execução desse vários destinos.

Definições de tipo de segmentação personalizada

Esta seção descreve os campos usados para definir tipos de segmentação personalizados

Assim como nos destinos e automações padrão, as definições de CustomTargetType podem ser incluídas na definição do pipeline de entrega ou em um ou mais arquivos separados.

O YAML a seguir mostra como configurar um tipo de destino personalizado:

apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name: [CUSTOM_TARGET_TYPE_NAME]
  annotations:
  labels:
description:
customActions:
  renderAction: [RENDER_ACTION_NAME]
  deployAction: [DEPLOY_ACTION_NAME]
  includeSkaffoldModules:
    - configs:
    # either:
    googleCloudStorage:
      source:
      path:
    # or:
    git:
      repo:
      path:
      ref:

Em que:

  • [CUSTOM_TARGET_TYPE_NAME]

    É um nome arbitrário que você dá para essa definição de tipo de destino personalizado. Esse nome é referenciado na definição de destino para qualquer destino que use o tipo de destino personalizado que você estiver definindo.

  • [RENDER_ACTION_NAME]

    É o nome da ação de renderização personalizada. Esse valor é o customAction.name definido em skaffold.yaml.

  • [DEPLOY_ACTION_NAME]

    É o nome da ação de implantação personalizada. Esse valor é o customAction.name definido em skaffold.yaml.

  • Para includeSkaffoldModules, consulte Usar configurações remotas do Skaffold.

Definições de Automation

Nesta seção, descrevemos os campos usados para definir os recursos de automação do Cloud Deploy.

Assim como nos destinos, as definições de Automation podem ser incluídas na definição do pipeline de entrega ou em um ou mais arquivos separados.

Para mais informações sobre automação no Cloud Deploy, consulte a documentação de automação.

O YAML a seguir mostra como configurar uma automação. Os detalhes de uma regra de automação são diferentes para cada regra. A configuração dos tipos de regra de automação disponíveis está no documento Como usar regras de automação.

apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name: [PIPELINE_NAME]/[PURPOSE]
  labels:
  annotations:
description: [DESCRIPTION]
suspended: true | false
serviceAccount: [SERVICE_ACCOUNT_ID]
selector:
  targets:
    -  id: [TARGET_ID]
       labels:
         [LABEL_KEY]:[LABEL_VALUE]

rules:
- [RULE_TYPE]:
    name:[RULE_NAME]
  [RULE-SPECIFIC_CONFIG]

Em que:

  • [PIPELINE_NAME]

    É igual ao valor de metadata.name no pipeline de entrega que usa essa automação. Todas as automações são exclusivas dos pipelines de entrega para os quais são criados. Ou seja, não é possível compartilhar uma automação em mais de um pipeline de entrega.

  • [PURPOSE]

    É um nome descritivo para essa automação. Normalmente, essa seria a ação automatizada. Por exemplo, my-app-pipeline/promote

  • labels e annotations são rótulos ou anotações que você quer associar a essa automação.

  • [DESCRIPTION]

    É uma descrição opcional para esta automação.

  • suspended

    true ou false, indicando se essa automação está ativa ou suspensa. Se definido como true, a automação não vai ser usada. Isso pode ser útil para testar uma automação sem afetar o pipeline de entrega.

  • [SERVICE_ACCOUNT_ID]

    É o ID da conta de serviço usada para executar a automação. Por exemplo, se a automação usar promoteReleaseRule, essa conta de serviço realizará a promoção de lançamento e, portanto, exigirá as permissões necessárias para promover uma versão.

    É necessário um valor para essa propriedade. O Cloud Deploy não usa a conta de serviço padrão para automações.

    Essa conta de serviço precisa ter as seguintes permissões:

    • actAs para representar a conta de serviço de execução.

    • permissão para executar a operação que está sendo automatizada. Por exemplo, clouddeploy.releases.promote para promover uma versão ou clouddeploy.rollouts.advance para avançar uma fase de lançamento.

  • [TARGET_ID]

    É o ID do destino em que esta automação é usada. Embora uma automação esteja vinculada a um pipeline de entrega, ela é executada apenas nos destinos especificados.

    Defina como * para selecionar todos os destinos no pipeline de entrega.

  • [LABEL_KEY]:[LABEL_VALUE]

    É um par de chave-valor que corresponde a um par de chave-valor definido no destino. Isso seleciona todos os destinos associados ao pipeline de entrega que têm o mesmo rótulo e valor.

  • [RULE_TYPE]

    É o nome da regra de automação usada para essa automação. É promoteReleaseRule ou advanceRolloutRule. É possível incluir mais de uma regra em uma automação, incluindo mais de uma das mesmas RULE_TYPE. Por exemplo, é possível ter mais de uma regra promoteReleaseRule na mesma automação. Saiba mais.

  • [RULE_NAME]

    Um nome para a regra. Esse nome precisa ser exclusivo no pipeline de entrega. É necessário um valor para essa propriedade.

  • [RULE-SPECIFIC_CONFIG]

    A configuração é diferente para cada tipo de automação compatível. Essas configurações são mostradas em Como usar regras de automação.

A seguir