本页介绍了如何为 Cloud Run 作业配置环境变量。
如果您设置了环境变量,那么这些变量将被注入容器并可供代码访问。环境变量设置为键值对。
预留名称
容器运行时合同中定义的环境变量会预留给系统,不得设置。
环境变量数上限
请注意,您可以为每个 Cloud Run 作业的每个容器最多设置 1000 个环境变量。
所需的角色
如需获得配置 Cloud Run 作业所需的权限,请让您的管理员为您授予作业的以下 IAM 角色:
-
Cloud Run Developer (
roles/run.developer
) - Cloud Run 作业 -
Service Account User (
roles/iam.serviceAccountUser
) - 服务身份
如需查看与 Cloud Run 关联的 IAM 角色和权限的列表,请参阅 Cloud Run IAM 角色和 Cloud Run IAM 权限。如果您的 Cloud Run 作业与Google Cloud API(例如 Cloud 客户端库)进行交互,请参阅服务身份配置指南。如需详细了解如何授予角色,请参阅部署权限和管理访问权限。
设置环境变量
您可以为新作业和现有作业设置环境变量。请注意,--set-env-vars
标志是一种破坏性操作,会删除所有先前设置但未包含在新环境变量列表中的变量。
您可以使用 Google Cloud 控制台、gcloud CLI 或 YAML 文件设置环境变量:
控制台
在 Google Cloud 控制台中,前往 Cloud Run 作业页面:
从菜单中选择作业,然后点击部署容器以填写初始作业设置页面。如果要配置现有作业,请选择作业,然后点击修改。
点击容器、卷、连接和安全性以展开作业属性页面。
点击变量标签页。
- 在“变量和 Secret”标签页中,点击添加变量,然后在名称和值字段中指定要对变量使用的名称和值。如需详细了解如何设置多个环境变量或转义特殊字符,请参阅设置多个环境变量。
点击创建或更新。
gcloud
如需在创建作业时指定环境变量,请使用 --set-env-vars
标志:
gcloud run jobs create JOB_NAME --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2
替换以下内容:
- JOB_NAME:您的作业的名称。
- KEY1=VALUE1,KEY2=VALUE2:以英文逗号分隔的变量名称及其值列表。
- IMAGE_URL:对容器映像的引用,例如
us-docker.pkg.dev/cloudrun/container/job:latest
。
如需详细了解如何设置多个环境变量或转义特殊字符,请参阅设置多个环境变量。
YAML
如果您要创建新的作业,请跳过此步骤。如果您要更新现有作业,请下载其 YAML 配置:
gcloud run jobs describe JOB_NAME --format export > job.yaml
- 更新
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 替换为环境变量和值。(可选)根据需要添加更多的变量和值。
您还可以指定更多配置,例如环境变量或内存限制。
- 更新
更新现有作业配置:
gcloud run jobs replace job.yaml
Terraform
如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令。
将以下内容添加到 Terraform 配置中的google_cloud_run_v2_job
资源:resource "google_cloud_run_v2_job" "default" {
name = "JOB_NAME"
location = "REGION"
template {
template {
containers {
image = "us-docker.pkg.dev/cloudrun/container/job"
env {
name = "KEY-1"
value = "VALUE-1"
}
env {
name = "KEY-N"
value = "VALUE-N"
}
}
}
}
}
替换以下内容:
- JOB_NAME:Cloud Run 作业的名称
- REGION: Google Cloud 区域。例如
europe-west1
。 - KEY-1:环境变量。
- VALUE-1:与键关联的值。
(可选)添加更多 env
块以设置其他环境变量。
在容器中设置默认环境变量
您可以使用 Dockerfile 中的 ENV
语句设置环境变量的默认值:
ENV KEY1=VALUE1,KEY2=VALUE2
优先顺序:容器变量与作业变量
如果您在容器中设置默认环境变量,并在 Cloud Run 作业上设置具有相同名称的环境变量,则该作业上设置的值优先。
设置多个环境变量
您可以使用 .env
文件或 --set-env-vars
标志设置多个环境变量。
使用 .env
文件设置多个环境变量
控制台
在 Google Cloud 控制台中,前往 Cloud Run 作业页面:
从菜单中选择作业,然后点击部署容器以填写初始作业设置页面。如果要配置现有作业,请选择作业,然后点击修改。
点击容器、卷、连接和安全性以展开作业属性页面。
点击容器标签页。
- 在“变量和 Secret”标签页中,点击添加变量,然后将
.env
文件的内容粘贴到名称字段中。Cloud Run 会自动填充值字段,并为在.env
文件中定义的每个键值对创建新变量。
- 在“变量和 Secret”标签页中,点击添加变量,然后将
点击创建或更新。
gcloud
如需从 .env
文件中指定多个环境变量,请运行以下命令:
gcloud beta run jobs create JOB_NAME --image=IMAGE_URL --env-vars-file=ENV_FILE_PATH
替换以下内容:
- JOB_NAME:Cloud Run 作业的名称
- IMAGE_URL:对容器映像的引用,例如
us-docker.pkg.dev/cloudrun/container/job:latest
。 - ENV_FILE_PATH:
.env
文件的路径。
使用 --set-env-vars
标志设置多个环境变量
如果您有多个无法以 KEY1=VALUE1,KEY2=VALUE2
格式列出的环境变量,则可以多次重复使用 --set-env-vars
标志:
[...] --set-env-vars "KEY1=VALUE1" \ --set-env-vars "KEY2=VALUE2" \ --set-env-vars "KEY3=VALUE3"
转义英文逗号字符
由于英文逗号字符,
用于分隔环境变量,因此,如果您的环境变量包含英文逗号字符作为值,则您需要将这些分隔符进行转义,方法是指定其他分隔符(例如 @
):
--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."
更新环境变量
您可以更新现有作业的环境变量。这种方法不会造成破坏,即它只会更改或添加环境变量,而不会删除先前设置的环境变量。
控制台
如需使用 Google Cloud 控制台更新环境变量,请执行以下操作:
在 Google Cloud 控制台中,前往 Cloud Run:
从列表中选择您的作业,然后点击修改和部署新的修订版本。
点击容器标签页。
在变量和密钥标签页中,修改名称或值字段,然后点击完成。
点击部署。
gcloud
如需更新现有作业的环境变量,请使用 --update-env-vars
标志:
gcloud run jobs update JOB_NAME --update-env-vars KEY1=VALUE1,KEY2=VALUE2
替换以下内容:
- JOB_NAME:您的作业的名称。
- KEY1=VALUE1,KEY2=VALUE2:以英文逗号分隔的变量名称和值列表。
查看环境变量设置
如需查看 Cloud Run 作业的当前环境变量设置,请按照以下所述操作:
控制台
在 Google Cloud 控制台中,前往 Cloud Run 作业页面:
点击相关作业以打开作业详情页面。
点击查看和修改作业配置。
在配置详细信息中找到环境变量设置。
gcloud
使用以下命令:
gcloud run jobs describe JOB_NAME
在返回的配置中找到环境变量设置。
删除环境变量
您可以删除现有作业的环境变量。
控制台
如需使用 Google Cloud 控制台删除环境变量,请执行以下操作:
在 Google Cloud 控制台中,前往 Cloud Run:
从列表中选择您的作业,然后点击修改和部署新的修订版本。
点击容器标签页。
在变量和密钥标签页中,将光标移至要移除的环境变量的值字段左侧,以显示
删除图标,然后点击该图标。点击完成。
点击部署。
gcloud
如需有选择地移除现有作业的环境变量,请使用 --remove-env-vars
标志:
gcloud run jobs update JOB_NAME --remove-env-vars KEY1,KEY2
替换以下内容:
- JOB_NAME:您的作业的名称。
- KEY1,KEY2:以英文逗号分隔的变量名称列表。
或者,您也可以使用 --clear-env-vars
标志清除所有先前设置的环境变量:
gcloud run jobs update JOB_NAME --clear-env-vars