扩展

扩展可用于使您的 Compose 文件更高效且更易于维护。

使用前缀 x- 作为顶级元素，将您想复用的配置模块化。 Compose 会忽略任何以 x- 开头的字段，这是 Compose 静默忽略无法识别字段的唯一例外情况。

扩展也可以与锚点和别名一起使用。

它们也可以用于 Compose 文件中任何不需要用户定义键的结构中。 Compose 使用它们来启用实验性功能，就像浏览器添加对自定义 CSS 功能的支持

示例 1

x-custom:
  foo:
    - bar
    - zot

services:
  webapp:
    image: example/webapp
    x-foo: bar

service:
  backend:
    deploy:
      placement:
        x-aws-role: "arn:aws:iam::XXXXXXXXXXXX:role/foo"
        x-aws-region: "eu-west-3"
        x-azure-region: "france-central"

示例 2

x-env: &env
  environment:
    - CONFIG_KEY
    - EXAMPLE_KEY
 
services:
  first:
    <<: *env
    image: my-image:latest
  second:
    <<: *env
    image: another-image:latest

在此示例中，环境变量不属于任何一个服务。它们已被完全提取到 x-env 扩展字段中。这定义了一个包含 environment 字段的新节点。使用 &env YAML 锚点，以便两个服务都可以将扩展字段的值引用为 *env。

示例 3

x-function: &function
 labels:
   function: "true"
 depends_on:
   - gateway
 networks:
   - functions
 deploy:
   placement:
     constraints:
       - 'node.platform.os == linux'
services:
 # Node.js gives OS info about the node (Host)
 nodeinfo:
   <<: *function
   image: functions/nodeinfo:latest
   environment:
     no_proxy: "gateway"
     https_proxy: $https_proxy
 # Uses `cat` to echo back response, fastest function to execute.
 echoit:
   <<: *function
   image: functions/alpine:health
   environment:
     fprocess: "cat"
     no_proxy: "gateway"
     https_proxy: $https_proxy

nodeinfo 和 echoit 服务都通过 &function 锚点包含了 x-function 扩展，然后设置了它们特定的镜像和环境。

示例 4

使用 YAML 合并也可以使用多个扩展，并根据特定需求共享和覆盖额外的属性：

x-environment: &default-environment
  FOO: BAR
  ZOT: QUIX
x-keys: &keys
  KEY: VALUE
services:
  frontend:
    image: example/webapp
    environment: 
      << : [*default-environment, *keys]
      YET_ANOTHER: VARIABLE

注意
YAML 合并仅适用于映射（mapping），不能用于序列（sequence）。
在上面的示例中，环境变量使用 FOO: BAR 映射语法进行声明，而序列语法 - FOO=BAR 仅在不涉及片段时才有效。

信息性历史说明

本节为资料性内容。在撰写本文时，已知存在以下前缀：

前缀	供应商/组织
Docker	Docker
Kubernetes	Kubernetes

指定字节值

数值以 {amount}{byte unit} 格式的字符串表示字节值：支持的单位有 b (字节)、k 或 kb (千字节)、m 或 mb (兆字节) 以及 g 或 gb (吉字节)。

指定持续时间

数值以字符串形式表示持续时间，格式为 {value}{unit}。支持的单位有 us (微秒)、ms (毫秒)、s (秒)、m (分钟) 和 h (小时)。数值可以组合多个值，无需分隔符。

  10ms
  40s
  1m30s
  1h5m30s20ms