扩展

扩展名可用于提高 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-envextension 字段。这将定义一个包含 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服务都包括x-function扩展名通过&functionanchor 的 Reset，然后设置其特定的 image 和 environment。

示例 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 合并仅适用于映射，不能与序列一起使用。
在上面的示例中，环境变量是使用FOO: BARmapping 语法，而 sequence 语法- FOO=BAR仅在不涉及 fragment 时有效。

翔实的历史笔记

本节内容丰富。在撰写本文时，已知存在以下前缀：

前缀	供应商/组织
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