环境
背景
Wrangler 允许你在部署同一个 Worker 应用程序时,为每个环境配置不同的配置。你必须在 Worker 应用程序的 wrangler.toml
文件中配置环境。
查看以下环境流程:
- 你创建了一个名为
my-worker
的 Worker 应用程序。 - 在 Worker 的
wrangler.toml
配置文件中创建一个环境,例如dev
。 - 在
wrangler.toml
中,你可以通过添加绑定和/或路由来配置dev
环境。 - 使用
npx wrangler deploy -e dev
部署 Worker。 - 在后台,Wrangler 创建了一个名为
my-worker-dev
的新 Worker。 - 现在,你可以更改
my-worker
Worker 代码和配置,并选择将更改部署到哪个环境。
在 wrangler dev
、npx wrangler deploy
和 wrangler secret
中使用--env
或-e
标记时,就可以使用环境。
配置
创造环境:
- 打开 Worker 的
wrangler.toml
文件。 - 添加
[env.<NAME>]
,并将<NAME>
改为所需的环境名称。 - 重复步骤 2,创建多个环境。
在命名环境时,请注意不要包含敏感信息,如 migrating-service-from-company1-to-company2
或 company1-acquisition-load-test
。
查看设置了自定义 dev.example.com
路由的[env.dev]
环境示例的布局:
不能指定多个相同名称的环境。
在部署 Worker 时,Wrangler 会将环境名称附加到顶层名称上。例如,如果 Worker 项目名为 my-worker
,且环境为 [env.dev]
,则将部署名为 my-worker-dev
的 Worker。
配置环境后,在 Worker 项目目录下运行 npx wrangler deploy
使更改生效。
不可继承的键和环境
非继承键可在顶层配置,但不能被环境继承,必须为每个环境指定。
绑定 和环境变量 必须在wrangler.toml
文件中为每个环境 指定。
查看下面的示例 wrangler.toml
文件:
你可以通过运行wrangler secret put <KEY> -env
命令指定特定环境的secrets。
Examples
Staging and production environments
The following wrangler.toml
file adds two environments, [env.staging]
and [env.production]
, to the wrangler.toml
file. If you are deploying to a Custom Domain or route, you must provide a route
or routes
key for each environment.
为了使用具有此配置的环境,您可以通过--env
标志传递环境名称。
通过此配置,Wrangler 将按以下方式运行:
任何定义的环境变量(vars
键)都会作为全局变量公开给您的 Worker。
通过此配置,ENVIRONMENT
变量可用于根据给定环境调用特定代码:
Staging environment with *.workers.dev
要将代码部署到*.workers.dev
子域,请在所需环境中包含workers_dev = true
。您的wrangler.toml
文件可能如下所示:
通过此配置,Wrangler 将按以下方式运行: