使用插值在 Compose 文件中设置、使用和管理变量

目录

Compose 文件可以使用变量来提供更大的灵活性。如果您想快速切换镜像标签以测试多个版本，或者想根据您的本地环境调整卷源，您无需每次都编辑 Compose 文件，只需设置在运行时将值插入 Compose 文件的变量即可。

插值也可以用于在运行时将值插入您的 Compose 文件，然后用于将变量传递到容器的环境中

下面是一个简单的示例

$ cat .env
TAG=v1.5
$ cat compose.yml
services:
  web:
    image: "webapp:${TAG}"

运行 docker compose up 时，Compose 文件中定义的 web 服务将在 .env 文件中设置的镜像 webapp:v1.5 中进行插值。您可以使用config 命令进行验证，该命令会将解析后的应用程序配置打印到终端

$ docker compose config
services:
  web:
    image: 'webapp:v1.5'

插值语法

插值适用于未加引号和双引号的值。支持大括号 (${VAR}) 和无括号 ($VAR) 表达式。

对于大括号表达式，支持以下格式

  • 直接替换
    • ${VAR} -> VAR 的值
  • 默认值
    • ${VAR:-default} -> 如果设置了 VAR 且非空，则为 VAR 的值，否则为 default
    • ${VAR-default} -> 如果设置了 VAR，则为 VAR 的值，否则为 default
  • 必需值
    • ${VAR:?error} -> 如果设置了 VAR 且非空，则为 VAR 的值，否则以错误退出
    • ${VAR?error} -> 如果设置了 VAR，则为 VAR 的值，否则以错误退出
  • 备选值
    • ${VAR:+replacement} -> 如果 VAR 已设置且非空，则为 replacement，否则为空
    • ${VAR+replacement} -> 如果 VAR 已设置，则为 replacement，否则为空

更多信息，请参阅 Compose 规范中的插值。

使用插值设置变量的方法

Docker Compose 可以从多个来源将变量插入到您的 Compose 文件中。

请注意，当同一个变量由多个来源声明时，优先级适用

  1. 来自 shell 环境的变量
  2. 如果未设置 --env-file，则由本地工作目录 (PWD) 中的 .env 文件设置的变量
  3. 来自由 --env-file 或项目目录中的 .env 文件设置的文件的变量

您可以通过运行 docker compose config --environment 来检查 Compose 用于插值 Compose 模型的变量和值。

.env 文件

在 Docker Compose 中，.env 文件是一个文本文件，用于定义在运行 docker compose up 时应提供插值的变量。此文件通常包含变量的键值对，它允许您在一个位置集中管理配置。如果您需要存储多个变量，则 .env 文件非常有用。

.env 文件是设置变量的默认方法。.env 文件应放置在项目目录的根目录下，与您的 compose.yaml 文件相邻。有关环境文件格式的更多信息，请参阅环境文件的语法。

基本示例

$ cat .env
## define COMPOSE_DEBUG based on DEV_MODE, defaults to false
COMPOSE_DEBUG=${DEV_MODE:-false}

$ cat compose.yaml 
  services:
    webapp:
      image: my-webapp-image
      environment:
        - DEBUG=${COMPOSE_DEBUG}

$ DEV_MODE=true docker compose config
services:
  webapp:
    environment:
      DEBUG: "true"

附加信息

  • 如果您在 .env 文件中定义了一个变量，您可以使用environment 属性在 compose.yml 中直接引用它。例如，如果您的 .env 文件包含环境变量 DEBUG=1，并且您的 compose.yml 文件如下所示

     services:
   webapp:
     image: my-webapp-image
     environment:
       - DEBUG=${DEBUG}

    Docker Compose 将 ${DEBUG} 替换为 .env 文件中的值

    重要

    请注意在 .env 文件中使用变量时，环境变量的优先级 会影响容器环境中的环境变量。

  • 您可以将 .env 文件放置在项目目录根目录以外的位置，然后使用CLI 中的 --env-file 选项，以便 Compose 可以导航到它。

  • 如果使用--env-file 替换，您的 .env 文件可以被另一个 .env 文件覆盖。

重要

从 .env 文件进行替换是 Docker Compose CLI 的一项功能。

在运行docker stack deploy时，Swarm 不支持此功能。

.env 文件语法

以下语法规则适用于环境文件

  • 以#开头的行被视为注释并被忽略。
  • 空行被忽略。
  • 未加引号和双引号 (") 的值会应用插值。
  • 每一行代表一个键值对。值可以可选地用引号括起来。
    • VAR=VAL -> VAL
    • VAR="VAL" -> VAL
    • VAR='VAL' -> VAL
  • 未加引号的值的内联注释必须以空格开头。
    • VAR=VAL # comment -> VAL
    • VAR=VAL# not a comment -> VAL# not a comment
  • 带引号的值的内联注释必须跟在结束引号之后。
    • VAR="VAL # not a comment" -> VAL # not a comment
    • VAR="VAL" # comment -> VAL
  • 单引号 (') 值按字面意思使用。
    • VAR='$OTHER' -> $OTHER
    • VAR='${OTHER}' -> ${OTHER}
  • 引号可以用\转义。
    • VAR='Let\'s go!' -> Let's go!
    • VAR="{\"hello\": \"json\"}" -> {"hello": "json"}
  • 双引号值支持常见的shell转义序列，包括\n、\r、\t和\\。
    • VAR="some\tvalue" -> some value
    • VAR='some\tvalue' -> some\tvalue
    • VAR=some\tvalue -> some\tvalue

使用 --env-file 替换

您可以在.env文件中为多个环境变量设置默认值，然后将该文件作为参数传递到CLI。

这种方法的优点是您可以将文件存储在任何位置并为其命名，例如，此文件路径相对于执行Docker Compose命令的当前工作目录。文件路径的传递是使用--env-file选项完成的。

$ docker compose --env-file ./config/.env.dev up

附加信息

  • 如果您想临时覆盖compose.yml文件中已引用的.env文件，此方法非常有用。例如，您可能拥有用于生产（.env.prod）和测试（.env.test）的不同.env文件。在以下示例中，有两个环境文件，.env和.env.dev。两者都为TAG设置了不同的值。
    $ cat .env
TAG=v1.5
$ cat ./config/.env.dev
TAG=v1.6
$ cat compose.yml
services:
  web:
    image: "webapp:${TAG}"
    如果命令行中未使用--env-file，则默认加载.env文件。
    $ docker compose config
services:
  web:
    image: 'webapp:v1.5'
    传递--env-file参数会覆盖默认文件路径。
    $ docker compose --env-file ./config/.env.dev config
services:
  web:
    image: 'webapp:v1.6'
    当将无效的文件路径作为--env-file参数传递时，Compose 会返回错误。
    $ docker compose --env-file ./doesnotexist/.env.dev  config
ERROR: Couldn't find env file: /home/user/./doesnotexist/.env.dev
  • 您可以使用多个--env-file选项来指定多个环境文件，Docker Compose会按顺序读取它们。后面的文件可以覆盖前面文件中的变量。
    $ docker compose --env-file .env --env-file .env.override up
  • 启动容器时，您可以从命令行覆盖特定的环境变量。
    $ docker compose --env-file .env.dev up -e DATABASE_URL=mysql://new_user:new_password@new_db:3306/new_database

本地 .env 文件与.env 文件

.env文件也可以用来声明预定义的环境变量，用于控制Compose行为和要加载的文件。

在没有显式--env-file标志的情况下执行时，Compose会在您的工作目录(PWD)中搜索.env文件，并加载自身配置和插值的值。如果此文件中的值定义了COMPOSE_FILE预定义变量，这会导致项目目录设置为另一个文件夹，Compose将加载第二个.env文件（如果存在）。第二个.env文件的优先级较低。

这种机制使得可以使用自定义变量集作为覆盖来调用现有的Compose项目，而无需通过命令行传递环境变量。

$ cat .env
COMPOSE_FILE=../compose.yaml
POSTGRES_VERSION=9.3

$ cat ../compose.yaml 
services:
  db:
    image: "postgres:${POSTGRES_VERSION}"
$ cat ../.env
POSTGRES_VERSION=9.2

$ docker compose config
services:
  db:
    image: "postgres:9.3"

从 shell 替换

您可以使用主机上的现有环境变量或执行docker compose命令的shell环境中的现有环境变量。这允许您在运行时动态地将值注入到Docker Compose配置中。例如，假设shell包含POSTGRES_VERSION=9.3，并且您提供了以下配置

db:
  image: "postgres:${POSTGRES_VERSION}"

当您使用此配置运行docker compose up时，Compose会在shell中查找POSTGRES_VERSION环境变量，并替换其值。对于此示例，Compose在运行配置之前将映像解析为postgres:9.3。

如果没有设置环境变量，Compose将用空字符串替换。在上一个示例中，如果未设置POSTGRES_VERSION，则映像选项的值为postgres:。

注意

postgres:不是有效的镜像引用。Docker 期望一个没有标签的引用，例如postgres（默认为最新镜像），或带标签的引用，例如postgres:15。