Docker Compose 中的环境变量优先级
当同一个环境变量在多个来源中被设置时,Docker Compose 会遵循优先级规则来确定该变量在容器环境中的值。
本页面说明了当环境变量在多个位置定义时,Docker Compose 如何确定其最终值。
优先级顺序(从高到低)如下:
- 使用
docker compose run -e在 CLI 中设置。 - 使用
environment或env_file属性设置,但其值来自 shell 或环境文件的插值(可以是默认的.env文件,或使用 CLI 中的--env-file参数)。 - 仅在 Compose 文件中使用
environment属性 设置。 - 在 Compose 文件中使用
env_file属性。 - 在容器镜像的
ENV 指令 中设置。
只有在 Compose 文件中没有
environment、env_file或run --env条目时,Dockerfile中的任何ARG或ENV设置才会生效。
简单示例
在以下示例中,.env 文件和 Compose 文件中的 environment 属性为同一个环境变量设置了不同的值:
$ cat ./webapp.env
NODE_ENV=test
$ cat compose.yaml
services:
webapp:
image: 'webapp'
env_file:
- ./webapp.env
environment:
- NODE_ENV=production
使用 environment 属性定义的环境变量具有更高的优先级。
$ docker compose run webapp env | grep NODE_ENV
NODE_ENV=production
高级示例
下表以 VALUE 为例,它是一个定义镜像版本的环境变量。
表格说明
每一列代表一个可以设置 VALUE 值或为其代入值的上下文。
Host OS environment 和 .env 文件列仅用于说明目的。实际上,它们本身不会在容器中生成变量,而是需要与 environment 或 env_file 属性结合使用。
每一行代表 VALUE 被设置、代入或两者兼有的上下文组合。Result 列表示每种场景中 VALUE 的最终值。
| # | docker compose run |
environment 属性 |
env_file 属性 |
镜像 ENV |
Host OS 环境 |
.env 文件 |
结果 |
|---|---|---|---|---|---|---|---|
| 1 | - | - | - | - | VALUE=1.4 |
VALUE=1.3 |
- |
| 2 | - | - | VALUE=1.6 |
VALUE=1.5 |
VALUE=1.4 |
- | VALUE=1.6 |
| 3 | - | VALUE=1.7 |
- | VALUE=1.5 |
VALUE=1.4 |
- | VALUE=1.7 |
| 4 | - | - | - | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.5 |
| 5 | --env VALUE=1.8 |
- | - | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.8 |
| 6 | --env VALUE |
- | - | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.4 |
| 7 | --env VALUE |
- | - | VALUE=1.5 |
- | VALUE=1.3 |
VALUE=1.3 |
| 8 | - | - | VALUE |
VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.4 |
| 9 | - | - | VALUE |
VALUE=1.5 |
- | VALUE=1.3 |
VALUE=1.3 |
| 10 | - | VALUE |
- | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.4 |
| 11 | - | VALUE |
- | VALUE=1.5 |
- | VALUE=1.3 |
VALUE=1.3 |
| 12 | --env VALUE |
VALUE=1.7 |
- | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.4 |
| 13 | --env VALUE=1.8 |
VALUE=1.7 |
- | VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.8 |
| 14 | --env VALUE=1.8 |
- | VALUE=1.6 |
VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.8 |
| 15 | --env VALUE=1.8 |
VALUE=1.7 |
VALUE=1.6 |
VALUE=1.5 |
VALUE=1.4 |
VALUE=1.3 |
VALUE=1.8 |
理解优先级结果
结果 1:本地环境具有优先级,但 Compose 文件未设置为在容器内复制此变量,因此不会设置此类变量。
结果 2:Compose 文件中的 env_file 属性为 VALUE 定义了显式值,因此容器环境会相应设置。
结果 3:Compose 文件中的 environment 属性为 VALUE 定义了显式值,因此容器环境会相应设置。
结果 4:镜像的 ENV 指令声明了变量 VALUE,由于 Compose 文件未设置为覆盖此值,因此该变量由镜像定义。
结果 5:docker compose run 命令设置了带有显式值的 --env 标志,并覆盖了镜像设置的值。
结果 6:docker compose run 命令设置了 --env 标志以复制环境中的值。Host OS 值具有优先级并被复制到容器环境中。
结果 7:docker compose run 命令设置了 --env 标志以复制环境中的值。选择 .env 文件中的值来定义容器环境。
结果 8:Compose 文件中的 env_file 属性设置为从本地环境复制 VALUE。Host OS 值具有优先级并被复制到容器环境中。
结果 9:Compose 文件中的 env_file 属性设置为从本地环境复制 VALUE。选择 .env 文件中的值来定义容器环境。
结果 10:Compose 文件中的 environment 属性设置为从本地环境复制 VALUE。Host OS 值具有优先级并被复制到容器环境中。
结果 11:Compose 文件中的 environment 属性设置为从本地环境复制 VALUE。选择 .env 文件中的值来定义容器环境。
结果 12:--env 标志比 environment 和 env_file 属性具有更高的优先级,并设置为从本地环境复制 VALUE。Host OS 值具有优先级并被复制到容器环境中。
结果 13 至 15:--env 标志比 environment 和 env_file 属性具有更高的优先级,因此会设置该值。