Configurar variáveis de ambiente para serviços

Esta página descreve como configurar variáveis de ambiente para seu serviço do Cloud Run.

É possível usar variáveis de ambiente para a configuração do serviço, mas não recomendamos que elas sejam usadas para armazenar segredos, como credenciais de banco de dados ou chaves de API. Os valores sensíveis precisam ser armazenados fora do código-fonte e das variáveis de ambiente externas. Para armazenar secrets, recomendamos o uso do Secret Manager. Para configurar serviços para acessar secrets armazenados no Secret Manager, consulte Configurar secrets.

Qualquer mudança na configuração leva à criação de uma nova revisão. As próximas revisões também recebem essa configuração de modo automático, a menos que você faça atualizações explícitas para alterar esse comportamento.

Funções exigidas

Para receber as permissões necessárias para configurar e implantar os serviços do Cloud Run, peça ao administrador para conceder a você os seguintes papéis do IAM:

• Desenvolvedor do Cloud Run (roles/run.developer) no serviço do Cloud Run
• Usuário da conta de serviço (roles/iam.serviceAccountUser) na identidade do serviço

Para uma lista de papéis e permissões do IAM associados ao Cloud Run, consulte Papéis do IAM do Cloud Run e Permissões do IAM do Cloud Run. Se o serviço do Cloud Run interagir com APIsGoogle Cloud , como as bibliotecas de cliente do Cloud, consulte o guia de configuração de identidade de serviço. Para mais informações sobre como conceder papéis, consulte permissões de implantação e gerenciar acesso.

Número máximo de variáveis e limites de ambiente

É possível definir no máximo 1.000 variáveis de ambiente para um serviço do Cloud Run.

O comprimento máximo da variável é 32 KB.

Defina as variáveis de ambiente

É possível definir variáveis de ambiente para serviços novos e atuais. A flag --set-env-vars é uma ação destrutiva que exclui variáveis de ambiente definidas anteriormente que não estão incluídas na nova lista de variáveis de ambiente.

As variáveis de ambiente estão vinculadas a uma revisão de serviço específica e não são visíveis para outros serviços no projeto Google Cloud .

É possível definir variáveis de ambiente usando o Google Cloud console, a CLI gcloud ou um arquivo YAML ao criar um novo serviço ou implantar uma nova revisão:

gcloud run deploy SERVICE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

gcloud run services update SERVICE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

   [...]
   --set-env-vars "KEY1=VALUE1" \
   --set-env-vars "KEY2=VALUE2" \
   --set-env-vars "KEY3=VALUE3"

--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-env-var"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      # Environment variables
      env {
        name  = "foo"
        value = "bar"
      }
      env {
        name  = "baz"
        value = "quux"
      }
    }
  }
}

Como definir variáveis de ambiente padrão no contêiner

Use a instrução ENV em um Dockerfile para definir valores padrão para variáveis de ambiente:

ENV KEY1=VALUE1,KEY2=VALUE2

Ordem de precedência: variáveis de contêiner x serviço

Se você definir uma variável de ambiente padrão no contêiner e também definir uma variável de ambiente com o mesmo nome no serviço Cloud Run, o valor definido no serviço terá precedência.

Atualizar variáveis de ambiente

É possível atualizar variáveis de ambiente para serviços atuais. Essa é uma abordagem não destrutiva que altera ou adiciona variáveis de ambiente, mas não exclui as variáveis de ambiente definidas anteriormente.

gcloud run services update SERVICE --update-env-vars KEY1=VALUE1,KEY2=VALUE2

Ver as configurações das variáveis de ambiente

Para ver as configurações atuais das variáveis de ambiente do serviço do Cloud Run:

Excluir variáveis de ambiente

É possível excluir variáveis de ambiente para serviços atuais.

gcloud run services update SERVICE --remove-env-vars KEY1,KEY2

gcloud run services update SERVICE --clear-env-vars

Práticas recomendadas

A seção a seguir destaca algumas das práticas recomendadas para configurar variáveis de ambiente.

Variáveis de ambiente reservadas para serviços

As variáveis de ambiente definidas no contrato de ambiente de execução do contêiner são reservadas e não podem ser configuradas. Mais especificamente, a variável de ambiente PORT é injetada no seu contêiner pelo Cloud Run. Não configure isso.

Outras variáveis de ambiente reservadas ao implantar funções

O Cloud Run define automaticamente as seguintes variáveis de ambiente de execução ao implantar funções:

• FUNCTION_TARGET: a função a ser executada.
• FUNCTION_SIGNATURE_TYPE: o tipo da função: http para funções HTTP e event para funções orientadas a eventos.

Algumas outras variáveis de ambiente são definidas automaticamente, dependendo do ambiente de execução usado pela função. Eles são baseados no sistema operacional do ambiente de execução, por exemplo, DEBIAN_FRONTEND, SHLVL ou PATH, e no ambiente de execução da linguagem por exemplo, NODE_ENV, VIRTUAL_ENV ou GOPATH.

As variáveis de ambiente fornecidas pelo ambiente (exceto as definidas automaticamente) podem ser alteradas em futuras versões do ambiente de execução. Como prática recomendada, não dependa de ou modifique variáveis de ambiente que você não tenha definido explicitamente.

Modificar variáveis de ambiente que são fornecidas pelo ambiente pode levar a resultados imprevisíveis. As tentativas de modificar essas variáveis de ambiente podem ser bloqueadas ou, o que seria pior, levar a consequências não intencionais, como funções que não podem ser iniciadas. Como prática recomendada, considere prefixar qualquer variável de ambiente com uma chave exclusiva para evitar conflitos.

Variáveis de ambiente inválidas

Não é possível usar as seguintes variáveis de ambiente:

Código de amostra

Para ver um exemplo de código que mostra como acessar as variáveis de ambiente no código, consulte Como processar a configuração confidencial com o Secret Manager no tutorial de autenticação de usuário final.

A seguir

Você pode usar variáveis de ambiente para definir a configuração do buildpack. Para detalhes específicos da linguagem, consulte a documentação de Buildpacks para:

• Node.js
• Python
• Go
• Ruby
• PHP
• Java

Se você estiver implantando da origem e precisar personalizar variáveis no momento do build, consulte Definir variáveis de ambiente de build.