使用环境变量

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

预留名称

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

设置环境变量

您可以为 Cloud Run 服务或作业设置环境变量。

对于 Cloud Run 服务

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

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

控制台

  1. 转到 Cloud Run

  2. 如果您是要配置一个新服务来作为部署目标，请点击创建服务。如果您要配置现有服务，请点击该服务，然后点击修改和部署新的修订版本。

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

  4. 点击容器标签页。

    映像

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

  5. 点击创建或部署。

命令行

要设置、更新或移除现有服务的环境变量，请使用 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 时，网址的格式为 REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG。。

YAML

您可以使用 gcloud run services describe --format export 命令下载并查看现有服务配置，该命令会生成清理后的 YAML 格式的结果。然后按照后续说明修改字段，最后使用 gcloud run services replace 命令上传修改后的 YAML。请务必严格按照说明修改字段。

  1. 如需查看和下载配置，请运行以下命令：

    gcloud run services describe SERVICE --format export > service.yaml

  2. 更新 containers: 下 env 特性下的 name 和 value 特性：

    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 时，网址的格式为 REGION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG。
    • 将 KEY-1、VALUE-1 替换为环境变量和值。（可选）根据需要添加更多的变量和值。
    • 将 REVISION 替换为新的修订版本名称或者将其删除（如果存在）。如果您提供新的修订版本名称，则该名称必须满足以下条件：
      • 开头为 SERVICE-
      • 仅包含小写字母、数字和 -
      • 不以 - 结尾
      • 不超过 63 个字符

  3. 使用以下命令将服务替换为其新配置：

    gcloud run services replace service.yaml

Terraform

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

将以下内容添加到 Terraform 配置中的 template.spec.containers 下的 google_cloud_run_service 资源中。以下示例将 foo 环境变量设置为 bar，并将 baz 环境变量设置为 quux：

run/container_template/main.tf 
# Environment variables
# https://cloud.google.com/run/docs/configuring/environment-variables
env {
  name  = "foo"
  value = "bar"
}
env {
  name  = "baz"
  value = "quux"
}

对于 Cloud Run 作业

如需为 Cloud Run 作业设置环境变量，请执行以下操作：

控制台

  1. 转到 Cloud Run

  2. 如果要配置新作业，请点击作业标签页，然后根据需要填写初始作业设置页面。如果要配置现有作业，请点击作业，然后点击修改。

  3. 点击容器、变量和 Secret、连接、安全性以展开作业属性页面。

  4. 点击变量标签页。

    图片

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

  5. 点击创建或更新。

命令行

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

  • --set-env-vars
  • --update-env-vars
  • --remove-env-vars

  • --clear-env-vars

    您可以在创建作业或更新作业时指定环境变量：

    gcloud run jobs create JOB_NAME --image IMAGE_URL --update-env-vars KEY1=VALUE1,KEY2=VALUE2

gcloud run jobs update JOB_NAME --update-env-vars KEY1=VALUE1,KEY2=VALUE2

  • 将 JOB_NAME 替换为作业的名称。

  • 将 KEY1=VALUE1,KEY2=VALUE2 替换为所需变量名称及其值的英文逗号分隔列表。

  • 将 IMAGE_URL 替换为对容器映像的引用，例如 us-docker.pkg.dev/cloudrun/container/job:latest。

YAML

使用 gcloud run jobs describe --format export 命令下载并查看现有作业配置，该命令会生成清理后的 YAML 格式的结果。然后，修改下述字段，并使用 gcloud run jobs replace 命令上传修改后的 YAML。请务必严格按照说明修改字段。

  1. 如需查看和下载配置，请运行以下命令：

    gcloud run jobs describe JOB_NAME --format export > job.yaml
    1. 更新 env 下的 name 和 value 属性，如 containers: 下所示：
    apiVersion: run.googleapis.com/v1
kind: Job
metadata:
  name: JOB
spec:
  template:
    spec:
      template:
        spec:
          containers:
          - image: IMAGE
            env:
            - name: KEY-1
              value: VALUE-1
            - name: KEY-N
              value: VALUE-N

    将 KEY-1、VALUE-1 替换为环境变量和值。（可选）根据需要添加更多的变量和值。

    您还可以指定更多配置，例如环境变量或内存限制。

  3. 更新现有作业配置：

    gcloud run jobs replace job.yaml

设置多个环境变量

如果您有太多环境变量，这些变量无法以 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. 转到 Cloud Run

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

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

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

命令行

  1. 使用以下命令：

    gcloud run services describe SERVICE

  2. 在返回的配置中找到环境变量设置。

如需查看 Cloud Run 作业的当前环境变量设置，请按照以下所述操作：

控制台

  1. 转到 Cloud Run 作业

  2. 点击相关作业以打开作业详情页面。

  3. 点击配置标签页。

  4. 在配置详细信息中找到环境变量设置。

命令行

  1. 使用以下命令：

    gcloud run jobs describe JOB_NAME

  2. 在返回的配置中找到环境变量设置。

示例代码

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

后续步骤

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