插值
Compose 文件中的值可以通过变量设置,并在运行时进行插值。Compose 文件使用类似 Bash 的语法 ${VARIABLE}。同时支持 $VARIABLE 和 ${VARIABLE} 语法。
对于大括号表达式,支持以下格式:
- 直接替换
${VAR}->VAR的值
- 默认值
${VAR:-default}-> 如果VAR已设置且非空,则为其值,否则为default${VAR-default}-> 如果VAR已设置,则为其值,否则为default
- 必需的值
${VAR:?error}-> 如果已设置且非空,则值为VAR,否则报错退出${VAR?error}-> 如果已设置,则值为VAR,否则报错退出
- 替代值
${VAR:+replacement}-> 如果设置了VAR且非空,则为replacement,否则为空${VAR+replacement}-> 如果设置了VAR,则为replacement,否则为空
插值也可以嵌套:
${VARIABLE:-${FOO}}${VARIABLE?$FOO}${VARIABLE:-${FOO:-default}}
其他扩展的 shell 风格特性,例如 ${VARIABLE/foo/bar},不被 Compose 支持。
Compose 处理任何跟随在 $ 符号后的字符串,只要它能构成一个有效的变量定义 —— 无论是字母数字名称 ([_a-zA-Z][_a-zA-Z0-9]*) 还是以 ${ 开头的带大括号的字符串。在其他情况下,它将被保留,而不会尝试插入值。
当您的配置需要字面美元符号时,可以使用 $$(双美元符号)。这也可以防止 Compose 插入值,因此 $$ 允许您引用不想被 Compose 处理的环境变量。
web:
build: .
command: "$$VAR_NOT_INTERPOLATED_BY_COMPOSE"如果 Compose 无法解析替换变量且未定义默认值,它会显示警告并将该变量替换为空字符串。
由于 Compose 文件中的任何值都可以通过变量替换进行插值,包括复杂元素的紧凑字符串表示法,因此插值是在合并之前按文件逐个应用的。
插值仅适用于 YAML 值,不适用于键。对于少数键实际上是任意用户定义字符串的地方,例如 标签或 环境变量,必须使用替代的等号语法才能应用插值。例如:
services:
foo:
labels:
"$VAR_NOT_INTERPOLATED_BY_COMPOSE": "BAR"services:
foo:
labels:
- "$VAR_INTERPOLATED_BY_COMPOSE=BAR"