插值


Compose 文件中的值可以通过变量设置,并在运行时进行插值。Compose 文件使用类似 Bash 的语法 ${VARIABLE}。同时支持 $VARIABLE${VARIABLE} 两种语法。

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

  • 直接替换
    • ${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,否则为空

插值也可以嵌套:

  • ${VARIABLE:-${FOO}}
  • ${VARIABLE?$FOO}
  • ${VARIABLE:-${FOO:-default}}

Compose 不支持其他扩展的 shell 风格功能,例如 ${VARIABLE/foo/bar}

Compose 会将任何以 $ 符号开头的字符串处理为有效的变量定义 - 要么是字母数字名称 ([_a-zA-Z][_a-zA-Z0-9]*),要么是以 ${ 开头的大括号字符串。在其他情况下,它将保留而不尝试插值。

当您的配置需要一个字面美元符号时,您可以使用 $$(双美元符号)。这也可以防止 Compose 插值一个值,因此 $$ 允许您引用不希望被 Compose 处理的环境变量。

web:
  build: .
  command: "$$VAR_NOT_INTERPOLATED_BY_COMPOSE"

如果 Compose 无法解析替换的变量且未定义默认值,则会显示警告并将变量替换为空字符串。

由于 Compose 文件中的任何值都可以通过变量替换进行插值,包括复杂元素的紧凑字符串表示法,因此插值在按文件合并之前应用。

插值仅适用于 YAML 值,不适用于键。对于键实际上是任意用户定义字符串的少数情况,例如 labelsenvironment,必须使用等号语法进行插值。例如:

services:
  foo:
    labels:
      "$VAR_NOT_INTERPOLATED_BY_COMPOSE": "BAR"
services:
  foo:
    labels:
      - "$VAR_INTERPOLATED_BY_COMPOSE=BAR"