合并

Compose 允许您通过多个 Compose 文件定义 Compose 应用模型。这样做时,Compose 会遵循某些规则来合并 Compose 文件。

这些规则如下所述。

映射

YAML `mapping` 通过添加缺失的条目和合并冲突的条目来合并。

合并以下示例 YAML 树

services:
  foo:
    key1: value1
    key2: value2
services:
  foo:
    key2: VALUE
    key3: value3

结果与以下 YAML 树等效的 Compose 应用模型

services:
  foo:
    key1: value1
    key2: VALUE
    key3: value3

序列

YAML `sequence` 通过将覆盖 Compose 文件中的值附加到前一个文件来合并。

合并以下示例 YAML 树

services:
  foo:
    DNS:
      - 1.1.1.1
services:
  foo:
    DNS: 
      - 8.8.8.8

结果与以下 YAML 树等效的 Compose 应用模型

services:
  foo:
    DNS:
      - 1.1.1.1
      - 8.8.8.8

异常

Shell 命令

合并使用 services 属性 commandentrypointhealthcheck:`test` 的 Compose 文件时,值将被最新的 Compose 文件覆盖,而不是附加。

合并以下示例 YAML 树

services:
  foo:
    command: ["echo", "foo"]
services:
  foo:
    command: ["echo", "bar"]

结果与以下 YAML 树等效的 Compose 应用模型

services:
  foo:
    command: ["echo", "bar"]

唯一资源

适用于 portsvolumessecretsconfigs services 属性。虽然这些类型在 Compose 文件中建模为序列,但它们具有特殊的唯一性要求。

属性唯一键
volumestarget
secretssource
configssource
ports{ip, target, published, protocol}

合并 Compose 文件时,Compose 会附加不会违反唯一性约束的新条目,并合并共享唯一键的条目。

合并以下示例 YAML 树

services:
  foo:
    volumes:
      - foo:/work
services:
  foo:
    volumes:
      - bar:/work

结果与以下 YAML 树等效的 Compose 应用模型

services:
  foo:
    volumes:
      - bar:/work

重置值

除了前面描述的机制之外,覆盖 Compose 文件还可以用于从您的应用程序模型中删除元素。为此,可以使用自定义 YAML 标签 `!reset`。必须提供属性的有效值,但该值将被忽略,目标属性将设置为类型的默认值或 `null`。

为了提高可读性,建议显式地将属性值设置为 null(`null`)或空数组 `[]`(使用 `!reset null` 或 `!reset []`),以便清楚地表明结果属性将被清除。

一个基本的 `compose.yaml` 文件

services:
  app:
    image: myapp
    ports:
      - "8080:80" 
    environment:
      FOO: BAR           

以及一个 `compose.override.yaml` 文件

services:
  app:
    image: myapp
    ports: !reset []
    environment:
      FOO: !reset null

结果为

services:
  app:
    image: myapp

替换值

在 Docker Compose 版本 2.24.4 中引入

虽然可以使用 `!reset` 从使用覆盖文件的 Compose 文件中删除声明,但 `!override` 允许您完全替换属性,绕过标准合并规则。一个典型的示例是完全替换资源定义,以便依赖不同的模型但使用相同的名称。

一个基本的 `compose.yaml` 文件

services:
  app:
    image: myapp
    ports:
      - "8080:80"            

要删除原始端口,但公开一个新端口,可以使用以下覆盖文件

services:
  app:
    ports: !override
      - "8443:443" 

结果为

services:
  app:
    image: myapp
    ports:
      - "8443:443" 

如果没有使用 `!override`,则根据 上面概述的合并规则,将公开 `8080:80` 和 `8443:443`。

其他资源

有关如何使用合并创建组合 Compose 文件的更多信息,请参阅 使用多个 Compose 文件