配置环境变量

如果您设置了环境变量,那么这些变量将被注入容器并可供代码访问。环境变量设置为键值对。

预留名称

容器运行时合同中定义的环境变量会预留给系统,不得设置。需特别指出的是,PORT 环境变量会由 Cloud Run 注入容器内部,您不应自行对其进行设置。

所需的角色

如需获得配置和部署 Cloud Run 服务所需的权限,请让您的管理员为您授予以下 IAM 角色:

如需查看与 Cloud Run 关联的 IAM 角色和权限的列表,请参阅 Cloud Run IAM 角色Cloud Run IAM 权限。如果您的 Cloud Run 服务与 Google Cloud API(例如 Cloud 客户端库)进行交互,请参阅服务身份配置指南。如需详细了解如何授予角色,请参阅部署权限管理访问权限

设置环境变量

任何配置更改都会导致新修订版本的创建。后续修订版本也将自动采用此配置设置,除非您进行了明确更新。

您可以在创建新服务部署新修订版本时使用 Google Cloud 控制台、gcloud 命令行或 YAML 文件来设置环境变量:

控制台

  1. 在 Google Cloud 控制台中,前往 Cloud Run:

    转到 Cloud Run

  2. 点击部署容器,然后选择服务以配置新服务。如果您要配置现有服务,请点击该服务,然后点击修改和部署新的修订版本

  3. 如果您要配置新服务,请根据需要填写初始服务设置页面,然后点击容器、网络、安全性以展开服务配置页面。

  4. 点击容器标签页。

    图片

    • 执行以下操作:
      • 如果要添加变量,请点击添加变量,然后在名称文本框中分别指定您想要使用的变量名称及其值。
      • 如果要更改变量的值,请将文本框中的当前值替换为所需的值。
      • 如果要移除一个或多个环境变量,请将光标悬停在待移除变量对应的文本框的左侧,以显示垃圾箱图标,然后点击该图标。
  5. 点击创建部署

gcloud

要设置、更新或移除现有服务的环境变量,请使用 gcloud run services update 命令。您可以根据需要使用以下任意标志:

您可以在部署服务时指定环境变量,也可以在创建服务后更新环境变量:

gcloud run deploy [SERVICE] --image IMAGE_URL --update-env-vars KEY1=VALUE1,KEY2=VALUE2

gcloud run services update SERVICE --update-env-vars KEY1=VALUE1,KEY2=VALUE2
  • SERVICE 替换为服务的名称。
  • KEY1=VALUE1,KEY2=VALUE2 替换为所需变量名称及其值的英文逗号分隔列表。
  • IMAGE_URL 替换为对容器映像的引用,例如 us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry,则必须预先创建制品库 REPO_NAME。网址格式为 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG

YAML

  1. 如果您要创建新的服务,请跳过此步骤。如果您要更新现有服务,请下载其 YAML 配置

    gcloud run services describe SERVICE --format export > service.yaml
  2. 更新 containers:env 特性下的 namevalue 特性:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: SERVICE
    spec:
      template:
        metadata:
          name: REVISION
        spec:
          containers:
          - image: IMAGE
            env:
            - name: KEY-1
              value: VALUE-1
            - name: KEY-N
              value: VALUE-N

    请进行以下替换:

    • SERVICE 替换为您的 Cloud Run 服务的名称
    • IMAGE_URL 替换为对容器映像的引用,例如 us-docker.pkg.dev/cloudrun/container/hello:latest。 如果您使用 Artifact Registry,则必须预先创建制品库 REPO_NAME。网址格式为 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
    • KEY-1VALUE-1 替换为环境变量和值。(可选)根据需要添加更多的变量和值。
    • REVISION 替换为新的修订版本名称或者将其删除(如果存在)。如果您提供新的修订版本名称,则该名称必须满足以下条件:
      • 开头为 SERVICE-
      • 仅包含小写字母、数字和 -
      • 不以 - 结尾
      • 不超过 63 个字符
  3. 使用以下命令创建或更新服务:

    gcloud run services replace service.yaml

Terraform

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

以下 google_cloud_run_v2_service 资源指定将 foo 环境变量设置为 bar,并将 baz 环境变量设置为 quux。如果需要,根据您的具体需求更新环境变量:

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"
      }
    }
  }
}

设置多个环境变量

如果您有太多环境变量,这些变量无法以 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=..."

在容器中设置默认环境变量

您可以使用 Dockerfile 中的 ENV 语句设置环境变量的默认值:

ENV KEY1=VALUE1,KEY2=VALUE2

优先顺序:容器变量与服务或作业变量

如果您在容器中设置默认环境变量,并在 Cloud Run 服务或作业上设置具有相同名称的环境变量,则该服务上设置的值优先。

查看环境变量设置

如需查看 Cloud Run 服务的当前环境变量设置,请按照以下所述操作:

控制台

  1. 在 Google Cloud 控制台中,前往 Cloud Run:

    转到 Cloud Run

  2. 点击您感兴趣的服务以打开“服务详细信息”页面。

  3. 点击修订版本标签页。

  4. 在右侧的详细信息面板中,“容器”标签页下列出了环境变量设置。

gcloud

  1. 使用以下命令:

    gcloud run services describe SERVICE
  2. 在返回的配置中找到环境变量设置。

示例代码

如需查看展示如何访问代码中的环境变量的代码示例,请参阅最终用户身份验证教程中的使用 Secret Manager 处理敏感配置

后续步骤

您可以使用环境变量来设置 Buildpack 配置。如需了解特定语言的详细信息,请参阅适用于以下语言的 Buildpack 文档: