扩展您的 Compose 文件

Docker Compose 的 extends 属性允许您在不同的文件甚至不同的项目之间共享通用配置。

如果您的多个服务重复使用一组通用的配置选项，则扩展服务非常有用。使用 extends，您可以在一个地方定义一组通用的服务选项，并在任何地方引用它。您可以引用另一个 Compose 文件，并选择要用于您自己的应用程序的服务，并能够为自己的需求覆盖一些属性。

重要
当您使用多个 Compose 文件时，您必须确保所有文件中的路径都相对于基本 Compose 文件（即您主项目文件夹中的 Compose 文件）。这是必需的，因为扩展文件不必是有效的 Compose 文件。扩展文件可以包含配置的小片段。跟踪哪个服务片段相对于哪个路径很困难且令人困惑，因此为了使路径更易于理解，所有路径都必须相对于基本文件定义。

工作原理

从另一个文件扩展服务

以以下示例为例

services:
  web:
    extends:
      file: common-services.yml
      service: webapp

这会指示 Compose 仅重新使用 common-services.yml 文件中定义的 webapp 服务的属性。webapp 服务本身不是最终项目的一部分。

如果 common-services.yml 看起来像这样

services:
  webapp:
    build: .
    ports:
      - "8000:8000"
    volumes:
      - "/data"

您将获得与直接在 web 下定义相同的 build、ports 和 volumes 配置值一样的结果。

要将 webapp 服务包含在最终项目中，当您从另一个文件扩展服务时，您需要在当前的 Compose 文件中显式包含这两个服务。例如（请注意，这是一个非规范性示例）

services:
  web:
    build: alpine
    command: echo
    extends:
      file: common-services.yml
      service: webapp
  webapp:
    extends:
      file: common-services.yml
      service: webapp

或者，您可以使用 include。

在同一个文件中扩展服务

如果您在同一个 Compose 文件中定义服务，并将一个服务从另一个服务扩展，那么原始服务和扩展服务都将成为您最终配置的一部分。例如

services:
  web:
    build: alpine
    extends: webapp
  webapp:
    environment:
      - DEBUG=1

在同一个文件和另一个文件中扩展服务

您可以更进一步，在 compose.yaml 中本地定义或重新定义配置

services:
  web:
    extends:
      file: common-services.yml
      service: webapp
    environment:
      - DEBUG=1
    cpu_shares: 5

  important_web:
    extends: web
    cpu_shares: 10

其他示例

当您有多个服务具有通用配置时，扩展单个服务非常有用。以下示例是一个具有两个服务的 Compose 应用程序，一个 Web 应用程序和一个队列工作程序。这两个服务都使用相同的代码库，并共享许多配置选项。

common.yaml 文件定义了通用配置

services:
  app:
    build: .
    environment:
      CONFIG_FILE_PATH: /code/config
      API_KEY: xxxyyy
    cpu_shares: 5

docker-compose.yaml 定义了使用通用配置的具体服务

services:
  webapp:
    extends:
      file: common.yaml
      service: app
    command: /code/run_web_app
    ports:
      - 8080:8080
    depends_on:
      - queue
      - db

  queue_worker:
    extends:
      file: common.yaml
      service: app
    command: /code/run_worker
    depends_on:
      - queue

异常和限制

volumes_from 和 depends_on 从未使用 extends 在服务之间共享。这些异常存在是为了避免隐式依赖关系；您始终在本地定义 volumes_from。这确保了在读取当前文件时，服务之间的依赖关系清晰可见。在本地定义这些内容还可以确保对引用文件的更改不会破坏任何内容。

如果您只需要共享一个服务，并且您熟悉要扩展的文件，以便您可以调整配置，那么 extends 非常有用。但是，当您想要重用其他人的不熟悉配置并且您不知道其自己的依赖关系时，这不是一个可接受的解决方案。

相对路径

当使用包含指向另一个文件夹的 file 属性的 extends 时，被扩展服务声明的相对路径将被转换，以便它们在被扩展服务使用时仍然指向相同的文件。以下示例说明了这一点

基本 Compose 文件

services:
  webapp:
    image: example
    extends:
      file: ../commons/compose.yaml
      service: base

commons/compose.yaml 文件

services:
  base:
    env_file: ./container.env

结果服务引用 commons 目录中的原始 container.env 文件。这可以通过 docker compose config 确认，它会检查实际模型

services:
  webapp:
    image: example
    env_file: 
      - ../commons/container.env

参考信息

扩展