使用环境变量

了解如何在 Cloud Run for Anthos on Google Cloud 中创建和使用环境变量。

如果您设置了环境变量,那么这些变量将被注入容器并可供代码访问。环境变量设置为键值对。例如,假设您正在运行一项服务,该服务在环境中读取 LOGGING_VERBOSE: true 时会启用额外的日志记录。在这种情况下,您需要将环境变量键值对设置为 LOGGING_VERBOSE=true。以下部分显示了确切的命令或界面。

预留名称

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

在服务上设置环境变量

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

在部署新服务或更新现有服务和部署修订版本时,您可以使用 Cloud Console、gcloud 命令行工具或 YAML 文件设置环境变量:

控制台

  1. 转到 Cloud Run for Anthos on Google Cloud

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

  3. 在“高级设置”下,点击变量

    图片

  4. 执行以下操作:

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

  5. 点击创建部署

命令行

您可以使用以下任一 gcloud kuberun 命令为新服务设置环境变量或更新现有服务:

  • 对于现有服务,请运行带有以下参数之一的 gcloud kuberun core services update 命令来更新环境变量:

    例如:

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

    您需要将其中的:

    • SERVICE 替换为您的服务名称。
    • KEY1=VALUE1,KEY2=VALUE2 替换为环境变量的名称和值对的逗号分隔列表。为每个 KEY 指定环境变量名称,为 VALUE 指定该环境变量的值。如何指定多个参数
    • 命令参数选项

      • 如需指定包含逗号 (,) 的环境变量,必须使用一个不同的分隔符来转义每个 KEY=VALUE。例如,如果使用 @
        --set-env-vars "^@^KEY1=value,with,commas@KEY2=anothervalue@KEY3..."
        
      • 如需指定多组键值对,您可以指定多个参数以确保可读性。示例:
        [...]
        --set-env-vars "KEY=VALUE1" \
        --set-env-vars "KEY=VALUE2" \
        --set-env-vars "KEY=VALUE3"
        
  • 对于新服务,可运行带有 --set-env-vars 参数的 gcloud kuberun core services create 命令来设置环境变量:

    gcloud kuberun core services create SERVICE --image=IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2
    

    您需要将其中的:

    • IMAGE_URL 替换为对容器映像的引用,例如 gcr.io/myproject/my-image:latest
    • SERVICE 替换为您的服务名称。
    • KEY1=VALUE1,KEY2=VALUE2 替换为环境变量的名称和值对的逗号分隔列表。为每个 KEY 指定环境变量名称,为 VALUE 指定该环境变量的值。如何指定多个参数
    • 命令参数选项

      • 如需指定包含逗号 (,) 的环境变量,必须使用一个不同的分隔符来转义每个 KEY=VALUE。例如,如果使用 @
        --set-env-vars "^@^KEY1=value,with,commas@KEY2=anothervalue@KEY3..."
        
      • 如需指定多组键值对,您可以指定多个参数以确保可读性。示例:
        [...]
        --set-env-vars "KEY=VALUE1" \
        --set-env-vars "KEY=VALUE2" \
        --set-env-vars "KEY=VALUE3"
        

YAML

如需使用 YAML 文件修改现有服务的配置,请获取当前配置的副本,修改相应配置并将更改保存到本地文件内,然后再将这些更改部署到服务中。

  1. 显示为 YAML,然后将服务的配置复制到本地文件(例如 service.yaml)中:

    gcloud kuberun core services describe SERVICE --format yaml

    SERVICE 替换为您的 Cloud Run for Anthos 服务的名称。

  2. 在本地文件中,更新 containers:env 属性下的 namevalue 属性:

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

    替换

    • SERVICE 替换为您的 Cloud Run for Anthos 服务的名称。
    • KEY-1VALUE-1 替换为环境变量和值。(可选)根据需要添加更多的变量和值。
  3. 使用以下命令将服务替换为其新配置:

    gcloud beta run services replace service.yaml

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

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

ENV KEY1=VALUE1,KEY2=VALUE2

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

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

如果您在 Cloud Run for Anthos 中使用 Kubernetes 服务链接并希望继续使用它们,则必须在 2021 年 1 月之前为该功能手动启用支持。由于具有数千个服务和修订版本的命名空间存在性能问题,因此从 2021 年 1 月起,默认情况下,Kubernetes 服务链接将处于停用状态。

如需启用 Kubernetes 服务链接,请运行以下命令,将 knative-serving/config-defaults ConfigMap 中的 data.enable-service-links 设置为 true

kubectl patch cm -n knative-serving config-defaults -p '{"data":{"enable-service-links":"true"}}