É possível definir variáveis de ambiente para o Workflows no momento da implantação. Por exemplo, você pode criar um fluxo de trabalho configurado dinamicamente dependendo do ambiente em que ele é implantado. Ou, você pode criar um fluxo de trabalho que pode ser reutilizado como um modelo e configurado de acordo com variáveis de ambiente mantidas separadamente.
As variáveis de ambiente são definidas como pares de strings de chave e valor arbitrários que podem ser acessados pelo fluxo de trabalho durante a execução. Elas são armazenadas no back-end do Workflows, têm escopo para a execução do fluxo de trabalho e são imutáveis durante a execução de um fluxo de trabalho.
Todas as variáveis de ambiente estão vinculadas a uma implantação de um fluxo de trabalho e só podem ser definidas ou alteradas com uma implantação. A criação ou alteração de uma variável de ambiente exige uma implantação bem-sucedida. Se uma implantação falhar por algum motivo, todas as alterações feitas nas variáveis de ambiente não serão aplicadas.
É possível adicionar, atualizar ou remover variáveis de ambiente definidas pelo usuário usando a Google Cloud CLI.
Nomes reservados
As variáveis de ambiente integradas definidas para o Workflows são reservadas e não podem ser definidas.
Observação: não é possível usar o seguinte ao definir variáveis de ambiente para o Workflows:
| Chave | Descrição |
|---|---|
Vazio ('') |
As chaves não podem ser uma string vazia. |
GOOGLE_ |
As chaves não podem conter o prefixo GOOGLE_. |
WORKFLOWS_ |
As chaves não podem conter o prefixo WORKFLOWS_. |
Defina as variáveis de ambiente
É possível definir novas variáveis ou substituir as atuais ao implantar um fluxo de trabalho. Para fazer mudanças aditivas, consulte Atualizar variáveis de ambiente neste documento.
Console
No Google Cloud console, acesse a página Fluxos de trabalho:
Na página Fluxos de trabalho, clique em Criar.
Na página Criar fluxo de trabalho, preencha os campos apropriados para configurar a definição do fluxo de trabalho.
Na seção Variáveis de ambiente (opcional), clique em Adicionar variável.
No campo Nome 1, especifique o nome da variável.
No campo Valor 1, especifique o valor da variável.
Para adicionar outra variável, clique em Adicionar variável.
Clique em Próxima.
Depois de definir o fluxo de trabalho, clique em Implantar para implantá-lo.
gcloud
Para definir uma variável de ambiente, use a flag --set-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars KEY1=VALUE1
Substitua:
WORKFLOW_NAME: o ID do fluxo de trabalho.KEY1=VALUE1: o nome da variável de ambiente e o valor dela. Por exemplo,MONTH=January.
Terraform
Para criar um fluxo de trabalho, use o
google_workflows_workflow recurso
e modifique o arquivo main.tf, conforme mostrado no exemplo. Para mais informações,
consulte
Criar um fluxo de trabalho usando o Terraform.
Use o argumento user_env_vars para associar uma variável de ambiente à revisão do fluxo de trabalho.
Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.
Definir várias variáveis de ambiente
Para definir várias variáveis de ambiente, use uma lista separada por vírgulas:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars KEY1=VALUE1,KEY2=VALUE2
Escape de caracteres de vírgula
Como o caractere de vírgula (,) é usado para delimitar variáveis de ambiente, se os valores da variável incluírem vírgulas, especifique um caractere delimitador diferente, por exemplo, @:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars ^@^KEY1=VALUE1,VALUE2,VALUE3@KEY2=VALUE2
Armazenar variáveis em um arquivo
Para armazenar as variáveis em um arquivo (por exemplo, no controle de origem), use um arquivo YAML e a flag --env-vars-file:
gcloud workflows deploy WORKFLOW_NAME \ --env-vars-file FILE_PATH
Substitua FILE_PATH pelo caminho de um arquivo YAML local que liste as definições das variáveis de ambiente. Os nomes e valores das variáveis precisam ser strings. Todas as variáveis de ambiente atuais são removidas pelo Workflows antes que as novas sejam adicionadas.
Por exemplo, o conteúdo do arquivo YAML pode ser o seguinte:
KEY1: "value1" KEY2: "value2"
Para mais informações sobre o comando deploy, consulte
gcloud workflows deploy.
Acessar variáveis de ambiente
Para acessar uma variável de ambiente, faça uma chamada para a
sys.get_env() função em uma
expressão, transmitindo o nome da variável de ambiente como um parâmetro. O nome da variável de ambiente precisa ser transmitido como uma string.
Por exemplo, o fluxo de trabalho a seguir atribui o valor da variável de ambiente KEY1 a uma variável de fluxo de trabalho chamada keyValue e, em seguida, gera esse valor:
main: steps: - init: assign: - keyValue: ${sys.get_env("KEY1")} - returnResult: return: ${keyValue}
Atualizar variáveis de ambiente
É possível atualizar variáveis de ambiente definidas pelo usuário para fluxos de trabalho atuais. Essa é uma abordagem não destrutiva que altera ou adiciona variáveis de ambiente, mas não as exclui.
Console
No Google Cloud console, acesse a página Fluxos de trabalho.
Clique no nome do fluxo de trabalho que você quer atualizar.
A página Detalhes do fluxo de trabalho aparece.
Para editar uma variável de ambiente atual, faça uma destas ações:
Clique na guia Detalhes.
- Ao lado de Variáveis de ambiente, clique no ícone.
- Faça suas alterações.
- Para implantar o fluxo de trabalho atualizado, clique em Salvar.
Clique em Editar.
- Na seção Variáveis de ambiente (opcional), faça as alterações.
- Para implantar o fluxo de trabalho atualizado, clique em Próxima e depois em Implantar.
gcloud
Para atualizar uma variável, use a flag --update-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --update-env-vars KEY1=VALUE1
Para atualizar várias variáveis de ambiente, use uma lista separada por vírgulas:
gcloud workflows deploy WORKFLOW_NAME \ --update-env-vars KEY1=VALUE1,KEY2=VALUE2
Excluir variáveis de ambiente
É possível excluir variáveis de ambiente definidas pelo usuário para fluxos de trabalho atuais.
Console
No Google Cloud console, acesse a página Fluxos de trabalho.
Clique no nome do fluxo de trabalho que você quer atualizar.
A página Detalhes do fluxo de trabalho aparece.
Para excluir uma variável de ambiente atual, faça uma destas ações:
Clique na guia Detalhes.
- Clique na edição apropriada .
- Ao lado da variável de ambiente que você quer excluir, clique no ícone.
- Para implantar o fluxo de trabalho atualizado, clique em Salvar.
Clique em Editar.
- Ao lado da variável de ambiente que você quer excluir, clique no ícone.
- Para implantar o fluxo de trabalho atualizado, clique em Próxima e depois em Implantar.
gcloud
Para remover seletivamente as variáveis de ambiente, use a flag --remove-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --remove-env-vars KEY1,KEY2
Também é possível apagar todas as variáveis de ambiente definidas anteriormente com a flag --clear-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --clear-env-vars
Práticas recomendadas
Uma prática recomendada é não depender de ou modificar as variáveis de ambiente que você não tenha definido explicitamente. Se você modificar variáveis de ambiente diferentes daquelas que definiu explicitamente, isso poderá levar a consequências indesejadas.
Como gerenciar secrets
As variáveis de ambiente podem ser usadas para configurar fluxos de trabalho, mas não são recomendadas como uma maneira de armazenar e consumir secrets, como credenciais de banco de dados ou chaves de API. Esses valores confidenciais precisam ser armazenados separadamente do código-fonte e das variáveis de ambiente, e não enviados acidentalmente para registros.
Para armazenar secrets, recomendamos consultar as práticas recomendadas para gerenciamento de secrets e seguir as instruções para usar o Secret Manager com o Workflows.
Convenções de nomenclatura
Via de regra, recomendamos que as chaves de variável de ambiente tenham apenas letras maiúsculas, números e sublinhados (_) e não iniciem com um número. Considere prefixar as variáveis de ambiente definidas pelo usuário com uma chave exclusiva para evitar conflitos com outras variáveis.
Limites de tamanho
É possível definir no máximo 20 variáveis de ambiente definidas pelo usuário. Cada string de definição (KEY=value) é limitada a 4 KiB.
A seguir
- Executar um fluxo de trabalho.
- Transmitir argumentos de ambiente de execução em uma solicitação de execução.