Transmitir parâmetros para a implantação

Usando o Cloud Deploy, é possível transmitir parâmetros para a versão, e esses valores são fornecidos ao manifesto ou aos manifestos antes que eles sejam aplicados aos respectivos destinos. Essa substituição é feita depois que os manifestos são renderizados, como a etapa final na operação de renderização do Cloud Deploy. Os valores são fornecidos a todos os manifestos identificados no arquivo skaffold.yaml que contêm os marcadores correspondentes.

Basta incluir marcadores no manifesto e definir os valores desses marcadores no pipeline de entrega ou na configuração de destino do Cloud Deploy ou ao criar uma versão.

Este artigo descreve como fazer isso.

Por que usar parâmetros de implantação?

Um uso típico seria aplicar valores diferentes a manifestos para diferentes destinos em uma implantação paralela. No entanto, é possível usar parâmetros de implantação para qualquer coisa que exija a substituição de pares de chave-valor pós-renderização no manifesto.

Como funciona

As etapas a seguir descrevem o processo geral para configurar parâmetros de implantação e fornecer valores:

1. Configure a parametrização de implantação, conforme descrito aqui.

   Isso inclui o seguinte:

   • Adicione os marcadores ao manifesto, incluindo um valor padrão para cada um.

   • Adicione valores para esses marcadores.

     Há três maneiras de fazer isso, descritas aqui.

2. Quando você cria uma versão, o manifesto é renderizado.

   Se você começar com um manifesto com modelo, os valores serão aplicados agora para variáveis de modelo. Se você começar com um manifesto bruto, ele permanecerá inalterado. Essa renderização é feita pelo Skaffold.

   No entanto, é possível ter outras variáveis no manifesto para as quais os valores não são aplicados no tempo de renderização. Esses são os parâmetros de implantação descritos neste documento.

   Na criação da versão, todos os parâmetros de implantação são compilados em um dicionário, que é usado para substituir valores antes que os manifestos sejam aplicados.

3. Após a renderização, o Cloud Deploy substitui os valores dos parâmetros de implantação.

   Esses são os valores configurados na primeira etapa.

   O processo de renderização já aplicou valores aos modelos de manifesto, substituindo alguns valores e adicionando rótulos específicos do Cloud Deploy. No entanto, os valores desses parâmetros de implantação são substituídos após a renderização. As diferenças entre modelos de manifesto e parâmetros de implantação são descritas aqui.

4. O manifesto é aplicado ao ambiente de execução de destino para implantar o aplicativo.

   Isso inclui os valores substituídos no tempo de renderização e os valores de todos os parâmetros de implantação.

Diferentes maneiras de transmitir valores

É possível fornecer parâmetros e valores para esses parâmetros de três maneiras:

• Na definição do pipeline de entrega

  Você fornece o parâmetro e o valor dele na definição de um estágio na progressão do pipeline de entrega. O parâmetro é transmitido ao destino representado por esse estágio. Se esse estágio fizer referência a um destino múltiplo, os valores definidos aqui serão usados para todos os destinos filhos.

  Esse método permite substituir um valor para todas as versões em um determinado pipeline, para todos os destinos afetados. Os parâmetros definidos para um estágio identificam um rótulo, e o destino correspondente para esse estágio precisa ter um rótulo correspondente.

• Na definição de destino

  Você configura o parâmetro e o valor dele na definição do próprio destino. Esse método permite substituir um valor para esse destino em todas as versões.

• Na linha de comando, ao criar uma versão

  Você inclui o parâmetro e o valor dele usando a flag --deploy-parameters no comando gcloud deploy releases create.

  Esse método permite substituir um valor no momento da criação da versão, aplicando esse valor aos manifestos de todos os destinos afetados.

A configuração deles é explicada com mais detalhes aqui.

Posso usar mais de um desses métodos?

Sim, é possível incluir parâmetros de implantação no estágio do pipeline, na configuração de destino e na linha de comando. O resultado é que todos os parâmetros são aceitos e adicionados ao dicionário. No entanto, se um parâmetro específico for transmitido em mais de um lugar, mas com valores diferentes, o comando gcloud deploy releases create falhará com um erro.

Qual é a diferença em relação aos modelos de manifesto

Os parâmetros de implantação, conforme descrito neste artigo, são diferenciados dos marcadores em um manifesto com modelo pela sintaxe. No entanto, se você estiver se perguntando por que precisaria de parâmetros de implantação em vez de apenas usar as técnicas padrão para manifestos com modelo, a tabela a seguir mostra as diferentes finalidades:

Este documento trata apenas de parâmetros de implantação (na linha de comando, no pipeline e no destino), não de manifestos com modelo.

Limitações

• Para cada tipo de parâmetro, é possível criar um máximo de 50 parâmetros.

• Um destino filho também pode herdar até 50 parâmetros do destino múltiplo pai, até um máximo de 200 parâmetros nos destinos, incluindo aqueles definidos no estágio do pipeline.

• O nome da chave é limitado a um máximo de 63 caracteres e à seguinte expressão regular:

  ^[a-zA-Z0-9]([-A-Za-z0-9_.]{0,61}[a-zA-Z0-9])?$
  

  Uma exceção a isso é quando você está usando um parâmetro de implantação como uma variável de ambiente em um destino personalizado. Nesse caso, é necessário usar uma barra entre a palavra-chave customTarget e o nome da variável (customTarget/VAR_NAME). Consulte Entradas e saídas necessárias para a sintaxe compatível.

• O prefixo CLOUD_DEPLOY_ é reservado e não pode ser usado para um nome de chave.

• Não é possível ter duas chaves com o mesmo nome aplicadas ao mesmo destino.

• O valor pode estar vazio, mas tem um máximo de 512 caracteres.

• Os marcadores de parâmetros de implantação não podem ser usados para valores de configuração do Helm, mas precisam ser transmitidos por convenção.

Configurar parâmetros de implantação

Esta seção descreve como configurar valores de parâmetros de implantação que serão aplicados ao manifesto do Kubernetes, ao serviço do Cloud Run ou ao modelo do Helm.

Além de configurar esses pares de chave-valor, é necessário adicionar o marcador ou os marcadores ao manifesto, conforme descrito nesta seção.

Adicionar marcadores ao manifesto

No manifesto do Kubernetes (para GKE) ou no YAML de serviço (para Cloud Run), adicione marcadores para todos os valores que você quer substituir após a renderização.

Sintaxe

Para versões que não estão usando o Helm renderizador com Skaffold, use a seguinte sintaxe para os marcadores:

[PROPERTY]: [DEFAULT_VALUE] # from-param: ${VAR_NAME}

Nesta linha...