扩展

目录

扩展可以使您的 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 合并仅适用于映射，不能与序列一起使用。

在上面的示例中，环境变量使用FOO: BAR映射语法声明，而序列语法- FOO=BAR仅在不涉及片段时才有效。

信息性历史注释

本节内容仅供参考。在撰写本文时，已知存在以下前缀

前缀厂商/组织
dockerDocker
kubernetesKubernetes

指定字节值

值以{amount}{byte unit}格式的字符串表示字节值：支持的单位为b（字节）、k或kb（千字节）、m或mb（兆字节）和g或gb（千兆字节）。

    2b
    1024kb
    2048k
    300m
    1gb

指定持续时间

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

  10ms
  40s
  1m30s
  1h5m30s20ms