docker-compose.yml文件配置详解

简介

Compose 是用于定义和运行多容器 Docker 应用程序的工具。通过 Compose，您可以使用 YML 文件来配置应用程序需要的所有服务。然后，使用一个命令，就可以从 YML 文件配置中创建并启动所有服务。
docker compose文件是一个yaml格式的文件，所以注意行首的缩进很严格，docker compose文件的格式很不同版本，版本不同，语法和格式有所不同
默认docker-compose命令会调用当前目录下的docker-compose.yml的文件，因此一般执行docker-compose命令前先进入docker-compose.yml文件所在目录

• Compose 使用的三个步骤：

1.使用 Dockerfile 定义应用程序的环境。

2.使用 docker-compose.yml 定义构成应用程序的服务，这样它们可以在隔离环境中一起运行。

3.执行 docker-compose up 命令来启动并运行整个应用程序。

https://zhuanlan.zhihu.com/p/387840381

compose 的诸多优点：

• • 在单个主机上建立多个隔离环境，Compose 使用项目名称将环境彼此隔离。您可以在多个不同的上下文中使用此项目名称。默认项目名称是项目目录的基本名称。您可以使用-p 命令行选项或 COMPOSE_PROJECT_NAME 环境变量设置自定义项目名称 。默认项目目录是 Compose 文件的基本目录。可以使用--project-directory 命令行选项自定义项目目录。
  • 创建容器时保留卷数据
  • 仅重新创建已更改的容器，当您重新启动未更改的服务时，Compose 会使用现有容器。
  • 变量在环境之间组合重复使用

多个配置文件

我们可以为同一个项目配置多个compose文件，使用多个 Compose 文件使您能够针对不同的环境或不同的工作流程自定义 Compose 应用程序。
默认情况下，Compose 读取两个文件，docker-compose.yml和一个可选的
docker-compose.override.yml文件。按照惯例，docker-compose.yml包含您的基本配置。override.yml 文件，顾名思义，就是包含现有服务或全新服务的配置覆盖。
如果在两个文件中都定义了服务，Compose 会使用 override 进行合并配置。
要使用多个覆盖文件或具有不同名称的覆盖文件，您可以使用该-f选项来指定文件列表。Compose 按照在命令行中指定的顺序合并文件。
当您使用多个配置文件时，您必须确保文件中的所有路径都相对于基本 Compose 文件（ 指定的第一个 Compose 文件-f）。

docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d

docker-compose.yml完整选项样式

version: "3.7"
services:
  #部署的项目名称，容器名称如果没有定，此项会变成容器名并添加 _1.
  nginx_config_web: 

  #镜像名称地址
  image: docker.com/nginx:app1

  #指定容器名称，由于容器名称是唯一的，如果指定自定义名称，则无法scale
  container_name: my-nginx-container

  #容器主机名
  hostname: nginx-server

  #执行命令，覆盖默认命令
  command: bundle exec thin -p 3000
  # or
  command: ["bundle", "exec", "thin", "-p", "3000"]

  #重启策略，默认no，always，no-failure，unless-stoped ，在 swarm 使用 restart_policy 代替 restart)
  restart: always

  # 添加环境变量。您可以使用数组或字典、任何布尔值，布尔值需要用引号引起来，
  # 以确保 YML 解析器不会将其转换为 True 或 False。
  environment:
  - TZ=Asia/Shanghai
  - SHOW: 'true'

  #暴露容器端口，与-p相同，但不能低于60，映射到宿主机。  
  ports:
  - 80:80
  - 443:443
  #暴露端口，但不映射到宿主机，只被连接的服务访问。与 Dockerfile 中的 EXPOSE 指令一样，用于指定暴露的端口，仅可以指定内部端口为参数：，实际上 docker-compose.yml 的端口映射还得 ports 这样的标签
  expose:
  - "3000"
  - "8000”

  # 设置容器DNS,可以是单个值或列表。
  dns: 8.8.8.8
  dns:
  - 8.8.8.8
  - 9.9.9.9
  
  # 自定义 DNS 搜索域。可以是单个值或列表。
  dns_search:dc1.example.com
  dns_search:
  - dc1.example.com
  - dc2.example.com
  
  # 挂载宿主机路径或命令卷 
  volumes:
  - ./conf.d:/etc/nginx/conf.d
  - ./logs:/var/log/nginx
  - ./ssl:/ssl_certs

  # 从其它容器或者服务挂载数据卷，可选的参数是:ro或 :rw，前者表示容器只读，后者表示容器对数据卷是可读可写的（默认情况为可读可写的）。
  volumes_from:
  - service_name
  - service_name:ro
  - container:container_name
  - container:container_name:rw
  
  #设置依赖关系。
  depends_on:
  - db
  - redis
  
  # 服务的日志记录配置。
  logging:
    driver: json-file
    options:
      max-size: "200k" 
      max-file: "10" 
  
  # 用于检测 docker 服务是否健康运行。
  healthcheck:
    disable: true
    test: ["CMD", "curl", "-f", "http://localhost"] # 
    interval: 1m30s 
    timeout: 10s 
    retries: 3 
    start_period: 40s  

  # 添加或删除容器拥有的宿主机的内核功能，ALL # 开启或关闭全部权限
  cap_add:
  - SYS_PTRACE
  
  cap_drop:
  - NET_ADMIN
  - SYS_PTRACE 
  
  # sysctls设置容器中的内核参数，可以使用数组或字典格式。
  sysctls:
    net.core.somaxconn: 1024
    net.ipv4.tcp_syncookies: 0
  
  # 为容器指定父 cgroup 组，意味着将继承该组的资源限制。
  cgroup_parent: m-executor-abcd

  # 在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令，用于指定接入点。
  # 在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义：
  # 单个值:(entrypoint: /code/entrypoint.sh)
  entrypoint:
  - php
  - -d
  - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so

  # 从文件添加环境变量。可以是单个值(env_file: .env)或列表的多个值。
  env_file:
  - ./tomcat/config/env

  # 指定设备映射列表。
  devices:
  - "/dev/ttyUSB0:/dev/ttyUSB0"

  # 链接到 docker-compose.yml 外部的容器，甚至 并非 Compose 项目文件管理的容器。参数格式跟 links 类似
  # 在使用Docker过程中，会有许多单独使用 docker run 启动的容器的情况，
  # 为了使 Compose 能够连接这些不在docker-compose.yml 配置文件中定义的容器，
  # 那么就需要一个特殊的标签，就是 external_links，
  # 它可以让Compose 项目里面的容器连接到那些项目配置外部的容器
  # （前提是外部容器中必须至少有一个容器是连接到与项目内的服务的同一个网络里面）。
  external_links:
  - redis_1
  - project_db_1:mysql
  - project_db_1:postgresql

  # 链接到其它服务的中的容器，可以指定服务名称也可以指定链接别名（SERVICE：ALIAS)，
  # 与 Docker 客户端的 --link 有一样效果，会连接到其它服务中的容器, 
  # 使用的别名将会自动在服务容器中的 /etc/hosts 里创建
  links:
   - db:database
   - redis
    
  # 添加主机名映射。类似 docker客户端中的 --add-host。
  # 以上会在此服务的内部容器中 /etc/hosts 创建一个具有 ip 地址和主机名的映射关系：
  extra_hosts:
  - "somehost:162.242.195.82"

  # 网络模式，用法类似于 Docke 客户端的 --net 选项，格式为：service:[service name]
  # 可以指定使用服务或者容器的网络
  network_mode: “bridge”
  network_mode: “host”
  network_mode: “none”
  network_mode: “service:[service name]”
  network_mode: “container:[container name/id]”

    
  # 存储敏感数据，例如密码：
  secrets
  - my_user_scerets   #调用密码文件
 
  # 加入指定网络,下面定义的网络
  networks:  
  - front-tier
  - back-tier
  
  # 定义的网络,与 services字段同级 如：nginx  mysql 。
networks:
  front-tier:
    driver: bridge
  back-tier:
    driver: bridge
  
  
# 定义密码, 与 services下的字段项目同级
secrets:
  my_secret:
    file: ./my_secret.txt

docker-compose.yml 配选项说明

version

版本信息，定义关乎于docker的兼容性，Compose 文件格式有3个版本,分别为1, 2.x 和 3.x

build

服务除了可以基于指定的镜像，还可以基于一份 Dockerfile，在使用 up 启动之时执行构建任务，这个构建标签就是 build，它可以指定 Dockerfile 所在文件夹的路径。Compose 将会利用它自动构建这个镜像，然后使用这个镜像启动服务容器。

例如 webapp 服务，指定为从上下文路径 ./dir/Dockerfile 所构建的镜像：

version: "3.7"
services:
  webapp:
    build: ./dir   #可以使用绝对路径

或者，作为具有在上下文指定的路径的对象，以及可选的 Dockerfile 和 args：

version: "3.7"
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1
      labels:
      - "com.example.description=Accounting webapp"
      - "com.example.department=Finance"
      - "com.example.label-with-empty-value"
      target: prod

context：

如果 context 中有指定的路径，并且可以选定 Dockerfile 和 args。那么 arg 这个标签，就像 Dockerfile 中的 ARG 指令，它可以在构建过程中指定环境变量，

但是在构建成功后取消，在 docker-compose.yml 文件中也支持这样的写法。

• • context 上下文路径，可以是文件路径，也可以是到链接到 git 仓库的 url。当是相对路径时，它被解释为相对于 Compose 文件的位置。
  • dockerfile：指定构建镜像的 Dockerfile 文件名。
  • args：构建参数，只能在构建过程中访问的环境变量。
  • labels：设置构建镜像的标签。
  • target：多层构建，可以指定构建哪一层。
  • cache_from：缓存解析镜像列表
  • labels: 设置构建镜像的元数据
  • network: 设置网络容器连接，none 表示在构建期间禁用网络
  • shm_size: 设置/dev/shm此构建容器的分区大小

depends_on

表示服务之间的依赖关系。服务依赖会导致以下行为：

• docker-compose up ：以依赖性顺序启动服务。在以下示例中，先启动 db 和 redis ，才会启动 web。
• docker-compose up SERVICE ：自动包含 SERVICE 的依赖项。在以下示例中，docker-compose up web 还将创建并启动 db 和 redis。
• docker-compose stop ：按依赖关系顺序停止服务。在以下示例中，web 在 db 和 redis 之前停止。

注意：web 服务不会等待 redis db 完全启动 之后才启动。

version: "3.7"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

deploy

指定与服务的部署和运行有关的配置。只在 swarm 模式下才会有用。

deploy配置详解

只在 swarm 模式下才会有用。

deploy:                  # v3 版本以上, 指定与部署和运行服务相关的配置, deploy 部分是 docker stack 使用的, docker stack 依赖 docker swarm
  endpoint_mode:         # v3.3 版本中新增的功能, 指定服务暴露的方式
    vip                   # Docker 为该服务分配了一个虚拟 IP(VIP), 作为客户端的访问服务的地址
    dnsrr                 # DNS轮询, Docker 为该服务设置 DNS 条目, 使得服务名称的 DNS 查询返回一个 IP 地址列表, 客户端直接访问其中的一个地址
  labels:                # 指定服务的标签，这些标签仅在服务上设置
  mode:                  # 指定 deploy 的模式
    global                # 每个集群节点都只有一个容器
    replicated            # 用户可以指定集群中容器的数量(默认)
  placement:             #  指定约束和首选项的位置
  replicas:              # deploy 的 mode 为 replicated 时, 指定容器副本的数量
  resources:             # 资源限制
    limits:                # 设置容器的资源限制
      cpus: "0.5"           # 设置该容器最多只能使用 50% 的 CPU 
      memory: 50M           # 设置该容器最多只能使用 50M 的内存空间 
    reservations:       # 设置为容器预留的系统资源(随时可用)
      cpus: "0.2"           # 为该容器保留 20% 的 CPU
      memory: 20M           # 为该容器保留 20M 的内存空间
  restart_policy:        # 定义容器重启策略, 用于代替 restart 参数
    condition:             # 定义容器重启策略(接受三个参数)
      none                  # 不尝试重启
      on-failure            # 只有当容器内部应用程序出现问题才会重启
      any                   # 无论如何都会尝试重启(默认)
    delay:                 # 尝试重启的间隔时间(默认为 0s)
    max_attempts:          # 尝试重启次数(默认一直尝试重启)
    window:                # 检查重启是否成功之前的等待时间(即如果容器启动了, 隔多少秒之后去检测容器是否正常, 默认 0s)
  update_config:         # 用于配置滚动更新配置
    parallelism:           # 一次性更新的容器数量
    delay:                 # 更新一组容器之间的间隔时间
    failure_action:        # 定义更新失败的策略
      continue              # 继续更新
      rollback              # 回滚更新
      pause                 # 暂停更新(默认)
    monitor:               # 每次更新后的持续时间以监视更新是否失败(单位: ns|us|ms|s|m|h) (默认为0)
      max_failure_ratio     # 回滚期间容忍的失败率(默认值为0)
      order:                 # v3.4 版本中新增的参数, 回滚期间的操作顺序
        stop-first            #旧任务在启动新任务之前停止(默认)
        start-first           #首先启动新任务, 并且正在运行的任务暂时重叠
  rollback_config:       # v3.7 版本中新增的参数, 用于定义在 update_config 更新失败的回滚策略
    parallelism:           # 一次回滚的容器数, 如果设置为0, 则所有容器同时回滚
    delay:                 # 每个组回滚之间的时间间隔(默认为0)
    failure_action:        # 定义回滚失败的策略
      continue              # 继续回滚
      pause                 # 暂停回滚
    monitor:               # 每次回滚任务后的持续时间以监视失败(单位: ns|us|ms|s|m|h) (默认为0)
      max_failure_ratio:     # 回滚期间容忍的失败率(默认值0)
      order:                 # 回滚期间的操作顺序
        stop-first            # 旧任务在启动新任务之前停止(默认)
        start-first           # 首先启动新任务, 并且正在运行的任务暂时重叠

可以选参数：

• • endpoint_mode：访问集群服务的方式。
    • vip endpoint_mode: vip, Docker 集群服务一个对外的虚拟 ip。所有的请求都会通过这个虚拟 ip 到达集群服务内部的机器。
    • dnsrr endpoint_mode: dnsrr, DNS 轮询（DNSRR）。所有的请求会自动轮询获取到集群 ip 列表中的一个 ip 地址。
  • labels：在服务上设置标签。可以用容器上的 labels（跟 deploy 同级的配置） 覆盖 deploy 下的 labels。
  • mode：指定服务提供的模式。
    • replicated：复制服务，复制指定服务到集群的机器上。
    • global： 全局服务，服务将部署至集群的每个节点。
  • replicas：mode 为 replicated 时，需要使用此参数配置具体运行的节点数量。
  • resources：配置服务器资源使用的限制，在下面示例中，redis服务被限制为使用不超过 50M 的内存和0.50（单核的 50%）可用处理时间 (CPU)，并保留20M内存和0.25CPU 时间（始终可用）。

version: "3.9"
services:
  redis:
    image: redis:alpine
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 50M
        reservations:
          cpus: '0.25'
          memory: 20M

• • restart_policy：配置是否以及如何在退出时重新启动容器。替换restart。
  • condition: none, on-failure 或 any (默认: any) 之一。
  • delay：重新启动尝试之间等待的时间（默认值：5s）。
  • max_attempts：在放弃之前尝试重新启动容器的次数（默认值：永不放弃）。如果在配置的窗口（window）内重新启动未成功，则此尝试不计入配置max_attempts值。例如，如果 max_attempts 设置为“2”，并且第一次尝试重启失败，则可能会尝试两次以上的重启。
  • window：在决定重启是否成功之前等待多长时间（默认值：立即重启）。
  • condition：可选 none，on-failure 或者 any（默认值：any）。
  • delay：设置多久之后重启（默认值：0）。
  • max_attempts：尝试重新启动容器的次数，超出次数，则不再尝试（默认值：一直重试）。
  • window：设置容器重启超时时间（默认值：0）。
  • rollback_config：配置在更新失败的情况下应如何回滚服务。
  • parallelism：一次回滚的容器数量。如果设置为 0，则所有容器同时回滚。
  • delay：每个容器组回滚之间等待的时间（默认为 0 秒）。
  • failure_action: 如果回滚失败怎么办。continue或者pause（默认pause）
  • monitor：每次任务更新后监控失败的持续时间(ns|us|ms|s|m|h)（默认 5s）注意：设置为 0 将使用默认 5s。
  • max_failure_ratio：回滚期间允许的故障率（默认为 0）。
  • order：回滚期间的操作顺序。stop-first（旧任务在开始新任务之前停止），或start-first（首先启动新任务，并且正在运行的任务短暂重叠）（默认stop-first）。
  • max_replicas_per_node: 如果服务是replicated（默认值），则限制任何时间在节点上运行的副本数
  • update_config：配置应如何更新服务，对于配置滚动更新很有用。
  • parallelism：一次更新的容器数。
  • delay：在更新一组容器之间等待的时间。
  • failure_action：如果更新失败，该怎么办。其中一个 continue，rollback 或者pause （默认：pause）。
  • monitor：每个容器更新后，持续观察是否失败了的时间 (ns|us|ms|s|m|h)（默认为0s）。
  • max_failure_ratio：更新期间可容忍的故障率。
  • order：回滚期间的操作顺序。其中一个 stop-first（串行回滚），或者 start-first（并行回滚）（默认stop-first）。

注：仅支持 V3.4 及更高版本。

• • placement

placement 指定约束和首选项的位置。

version: "3.9"
services:
  db:
    image: postgres
    deploy:
      placement:
        constraints:
          - "node.role==manager"
          - "engine.labels.operatingsystem==ubuntu 18.04"
        preferences:
          - spread: node.labels.zone

您可以通过定义约束表达式来限制可以安排任务的节点集。约束表达式可以使用匹配(==) 或排除(!=) 规则。多个约束查找可以使用 AND 匹配。约束可以匹配节点或 Docker 引擎标签，如下所示：

节点属性	匹配	例子
node.id	节点 ID	node.id==2ivku8v2gvtg4
node.hostname	节点主机名	node.hostname!=node-2
node.role	节点角色 ( manager/ worker)	node.role==manager
node.platform.os	节点操作系统	node.platform.os==windows
node.platform.arch	节点架构	node.platform.arch==x86_64
node.labels	用户定义的节点标签	node.labels.security==high
engine.labels	Docker 引擎的标签	engine.labels.operatingsystem==ubuntu-14.04

restart

定义容器重启策略

• no：默认的重启策略，在任何情况下都不会重启容器。
• always：容器总是重新启动。
• on-failure：在容器非正常退出时（退出状态非0），才会重启容器。
• unless-stopped：在容器退出时总是重启容器，但是不考虑在Docker守护进程启动时就已经停止了的容器

注：swarm 集群模式，请改用 restart_policy代替 restart。

restart: "no"
restart: always
restart: on-failure
restart: unless-stopped

networks

networks下的条目

默认情况下，Compose为您的应用程序设置单个网络。services 服务的每个容器都加入默认网络，并且可以被该网络上的其他容器访问。
您的应用程序网络的名称基于“项目名称”，也就是其所在目录的名称。您可以使用 --project-name 命令行选项 或 COMPOSE_PROJECT_NAME 环境变量覆盖项目名称。

简单示例

例如，假设您的应用程序是在一个名为myapp目录下，docker-compose.yml如下：

version: "3.9"
services:
  web:
    build: .
    ports:
      - "8000:8000"
  db:
    image: postgres
    ports:
      - "8001:5432"

运行docker-compose up，会发生以下情况：

1. 创建了一个名为 myapp_default 的网络。
2. 把web加入网络。
3. 把db加入网络。

上面例子还有一个注意点就是端口号，注意区分HOST_PORT和CONTAINER_PORT，以上面的db为例：

• 8001 是宿主机的端口
• 5432（postgres的默认端口） 是容器的端口

当容器之间通讯时 ， 是通过 CONTAINER_PORT 来连接的。

networks配置容器连接的网络，引用顶级 networks 下的条目 。

networks:  # 定义 networks 信息
  driver:     # 指定网络模式, 大多数情况下, 它 bridge 于单个主机和 overlay Swarm 上
    bridge    # Docker 默认使用 bridge 连接单个主机上的网络
    overlay   # overlay 驱动程序创建一个跨多个节点命名的网络群
    host      # 共享主机网络名称空间(等同于 docker run --net=host)
    none      # 等同于 docker run --net=none
  driver_opts:     # v3.2以上版本, 传递给驱动程序的参数, 这些参数取决于驱动程序
  attachable:       # driver 为 overlay 时使用, 如果设置为 true 则除了服务之外，独立容器也可以附加到该网络; 如果独立容器连接到该网络，则它可以与其他 Docker 守护进程连接到的该网络的服务和独立容器进行通信
  ipam:     # 自定义 IPAM 配置. 这是一个具有多个属性的对象, 每个属性都是可选的
    driver: bridge/default # IPAM 驱动程序, bridge 或者 default
    config:  # 配置项
    - subnet:  # CIDR格式的子网，表示该网络的网段
  external: true/false # 外部网络, 如果设置为 true 则 docker-compose up 不会尝试创建它, 如果它不存在则引发错误
  name:                   # v3.5 以上版本, 为此网络设置名称
  aliases: {aliases_name} # 同一网络上的其他容器可以使用服务名称或此别名来连接到对应容器的服务。

默认情况下，Compose为您的应用程序设置单个网络。services 服务的每个容器都加入默认网络，并且可以被该网络上的其他容器访问。

您的应用程序网络的名称基于“项目名称”，也就是其所在目录的名称。

您可以使用 --project-name 命令行选项 或 COMPOSE_PROJECT_NAME 环境变量覆盖项目名称。

例如，假设您的应用程序是在一个名为myapp目录下，docker-compose.yml如下：

version: "3.9"
services:
  web:
    build: .
    ports:
      - "8000:8000"
  db:
    image: postgres
    ports:
      - "8001:5432"

运行docker-compose up，会发生以下情况：

• 创建了一个名为 myapp_default 的网络。
• 把web加入网络。
• 把db加入网络。

上面例子还有一个注意点就是端口号，注意区分HOST_PORT和CONTAINER_PORT，以上面的db为例：

我们可以通过设置一级配置network自定义网络，创建更复杂的网络选项，也可以用来连接已经存在的网络（不是通过compose创建的）

设置一级配置network自定义网络

我们可以通过设置一级配置network自定义网络，创建更复杂的网络选项，也可以用来连接已经存在的网络（不是通过compose创建的）

每个service 配置下也可以指定networks配置，来指定一级配置的网络。

version: "3"
services:
  proxy:
    build: ./proxy
    networks:
      - frontend
  app:
    build: ./app
    networks:
      - frontend
      - backend
  db:
    image: postgres
    networks:
      - backend
networks:
  frontend:
    # 使用自定义驱动程序
    driver: custom-driver-1
  backend:
    # 使用具有特殊选项的自定义驱动程序
    driver: custom-driver-2
    driver_opts:
      foo: "1"
      bar: "2"

一级配置networks 创建了自定义的网络 。这里配置了两个frontend和backend ，且自定义了网络类型。

每一个services下，proxy , app , db都定义了networks配置。

• proxy 只加入到 frontend网络。
• db 只加入到backend网络。
• app同时加入到 frontend和backend 。
• db和proxy不能通讯，因为不在一个网络中。
• app和两个都能通讯，因为app在两个网络中都有配置。
• db和proxy要通讯，只能通过app这个应用来连接。

服务之间的访问

同一网络上的其他容器可以使用服务名称或别名来连接到其他服务的容器。

services:
  some-service:
    networks:
      some-network:
        aliases:
          - alias1
          - alias3
      other-network:
        aliases:
          - alias2

指定容器静态 IP 地址

加入网络时，还可以指定容器的静态 IP 地址。

version: "3.9"
services:
  app:
    image: nginx:alpine
    networks:
      app_net:
        ipv4_address: 172.16.238.10      #IP地址
        ipv6_address: 2001:3984:3989::10
networks:
  app_net:
    ipam:
      driver: default
      config:
        - subnet: "172.16.238.0/24"  #地址范围
        - subnet: "2001:3984:3989::/64"

一级networks的其它配置

一级networks还有如下这些配置：

driver

指定该网络应使用哪个驱动程序。默认使用bridge单个主机上的网络，overlay代表跨多个节点的网络群

driver: overlay

driver_opts

将选项列表指定为键值对以传递给此网络的驱动程序

driver_opts:
  foo: "bar"
  baz: 1

attachable

attachable 仅在driver设置为 overlay时可用。如果设置为true，那么除了服务之外，独立容器也可以连接到此网络。

networks:
  mynet1:
    driver: overlay
    attachable: true

enable_ipv6

enable_ipv6 在此网络上启用 IPv6 网络。

ipam

ipam 自定义 IPAM （IP地址管理）配置。

ipam:
  driver: default
  config:
    - subnet: 172.28.0.0/16

internal

internal 默认情况下，Docker 会将桥接网络连接到它提供外部连接。如果要创建外部隔离的覆盖网络，可以将此选项设置为true。

labels

labels 添加元数据

external

external如果设置为true，则指定此网络是在 Compose 之外创建的。docker-compose up不会尝试创建它，如果它不存在，则会引发错误。在下面的例子中，proxy是通往外界的门户。

version: "3.9"
services:
  proxy:
    build: ./proxy
    networks:
      - outside
      - default
  app:
    build: ./app
    networks:
      - default
networks:
  outside:
    external: true

name

name为此网络设置自定义名称。

version: "3.9"
networks:
  network1:
    name: my-app-net

configs

为每个服务赋予相应的访问权限，支持两种不同的语法：简单语法和复杂语法
Note: 配置必须存在或在 configs 此堆栈文件的顶层中定义，否则堆栈部署失效

SHORT语法

指定配置名称即可。

SHORT 语法只能指定配置名称，这允许容器访问配置并将其安装在 /<config_name> 容器内，源名称和目标装入点都设为配置名称。

Note: config 定义仅在 3.3 版本或在更高版本的撰写文件格式中受支持，YAML 的布尔值（true, false, yes, no, on, off）必须要使用引号引起来（单引号、双引号均可），否则会当成字符串解析。

以下实例使用 SHORT 语法将 redis 服务访问授予 my_config 和 my_other_config的权限 ,并被 my_other_config 定义为外部资源，这意味着它已经在 Docker 中定义。可以通过 docker config create 命令或通过另一个堆栈部署。如果外部部署配置都不存在，则堆栈部署会失败并出现 config not found 错误。

version: "3.9"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - my_config
      - my_other_config
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

LONG 语法

LONG 语法提供了创建服务配置的更加详细的信息

• • source: 配置名称
  • target:要挂载文件的路径和名称, 如果未指定则默认为 /
  • uid 和 gid: 在服务的任务容器中拥有安装的配置文件的数字 UID 或 GID。如果未指定，则默认为在Linux上。Windows不支持。
  • mode: 在服务的任务容器中安装的文件的权限，以八进制表示法。例如，0444 代表文件可读的。默认是 0444。如果配置文件无法写入，是因为它们安装在临时文件系统中，所以如果设置了可写位，它将被忽略。可执行位可以设置。如果您不熟悉 UNIX 文件权限模式，Unix Permissions Calculator

下面示例在容器中将 my_config 名称设置为 redis_config，将模式设置为 0440（group-readable）并将用户和组设置为 103。该redis服务无法访问 my_other_config 配置。

version: "3.9"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - source: my_config
        target: /redis_config
        uid: '103'
        gid: '103'
        mode: 0440
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

可以同时授予多个配置的服务相应的访问权限，也可以混合使用 LONG 和 SHORT 语法。定义配置并不意味着授予服务访问权限

一级configs详细配置：

• • file: 使用指定路径中的文件内容创建配置。
  • external: 如果设置为 true，则指定此配置已经创建。Docker 不会尝试创建它，如果它不存在， 会报错config not found。
  • name: Docker 中配置对象的名称。此字段可用于引用包含特殊字符的配置。
  • driver和driver_opts：自定义驱动程序的名称，以及作为键/值对传递的特定于驱动程序的选项。
  • template_driver：要使用的模板驱动程序的名称，它控制是否以及如何将配置负载作为模板。如果未设置驱动程序，则不使用模板。当前支持的唯一驱动程序是golang，它使用golang。

在下面例子中，my_first_config是通过confif_data文件内容创建的（就像 <stack_name>_my_first_config)部署堆栈时一样，并且my_second_config已经创建过。

configs:
  my_first_config:
    file: ./config_data
  my_second_config:
    external: true 

当 Docker 中的配置名称与服务中存在的名称不同时，可以使用name进行配置。

configs:
  my_first_config:
    file: ./config_data
  my_second_config:
    external:
      name: redis_config

cap_add, cap_drop

添加或删除容器功能。

cap_add:
  - ALL
 
cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

cgroup_parent

为容器指定一个可选的父 cgroup。

cgroup_parent: m-executor-abcd

command

覆盖容器启动后默认执行的命令

command: bundle exec thin -p 3000
command: ["bundle", "exec", "thin", "-p", "3000"]

container_name

指定自定义容器名称，而不是生成的默认名称。由于 Docker 容器名称必须是唯一的，因此如果您指定了自定义名称，则不能将服务扩展到 1 个以上的容器。

credential_spec

为托管服务帐户配置凭据规范。此选项仅用于使用 Windows 容器的服务。在credential_spec上的配置列表格式为file://<filename>或registry://<value-name>

devices

设备映射列表。使用与--devicedocker 客户端创建选项格式相同。

devices:
  - "/dev/ttyUSB0:/dev/ttyUSB0"

dns

自定义 DNS 服务器。可以是单个值或列表。

dns: 8.8.8.8
dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search

自定义 DNS 搜索域。可以是单个值或列表。

dns_search: example.com
dns_search:
  - dc1.example.com
  - dc2.example.com

entrypoint

在 Dockerfile 中有一个指令叫做ENTRYPOINT指令，用于运行程序。在docker-compose.yml中可以定义覆盖 Dockerfile 中定义的 entrypoint：

entrypoint: /code/entrypoint.sh
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]

env_file

从文件添加环境变量。可以是单个值或列表。
如果您使用指定了 Compose 文件docker-compose -f FILE，则其中的路径 env_file相对于该文件所在的目录。
environment 声明的环境变量会覆盖这些值——即使这些值是空的或未定义的。

env_file: .env
env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/runtime_opts.env

environment

添加环境变量。您可以使用数组或字典。任何布尔值（true、false、yes、no）都需要用引号括起来，以确保它们不会被 YML 解析器转换为 True 或 False。

一般 arg 标签的变量仅用在构建过程中。而environment和 Dockerfile 中的ENV指令一样会把变量一直保存在镜像、容器中，类似docker run -e的效果

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:
 
environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

expose

暴露端口，但不映射到宿主机，只被连接的服务访问。这个标签与 Dockerfile 中的EXPOSE指令一样，用于指定暴露的端口，但是只是作为一种参考，实际上docker-compose.yml的端口映射还得ports这样的标签。

external_links

链接到 docker-compose.yml 外部的容器，甚至 并非 Compose 项目文件管理的容器。

external_links:
  - redis_1
  - project_db_1:mysql
  - project_db_1:postgresql

extra_hosts

添加主机名映射。使用与 docker 客户端--add-host类似。

extra_hosts:
  - "somehost:162.242.195.82"
  - "otherhost:50.31.209.229"

会往/etc/hosts文件中添加一些记录，启动之后查看容器内部 hosts可以看到：

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

配置运行的检查以确定此服务的容器是否“健康”。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"] # 设置检测程序
  interval: 1m30s # 设置检测间隔
  timeout: 10s # 设置检测超时时间
  retries: 3 # 设置重试次数
  start_period: 40s # 启动后，多少秒开始启动检测程序

interval，timeout 和 start_period都是持续时间。test必须是字符串或列表。如果是列表，则第一项必须是NONE,CMD或CMD-SHELL。如果是字符串，则相当于指定CMD-SHELL后跟该字符串。

# Hit the local web app
test: ["CMD", "curl", "-f", "http://localhost"]
test: ["CMD-SHELL", "curl -f http://localhost || exit 1"]
test: curl -f https://localhost || exit 1

如果需要禁用镜像的所有检查项目，可以使用disable:true，相当于test:["NONE"]

healthcheck:
  disable: true 

image

从指定的镜像中启动容器，可以是存储仓库、标签以及镜像 ID。

init

在容器内运行一个 init 来转发信号和取得进程。将此选项设置true为服务启用此功能。

version: "3.9"
services:
  web:
    image: alpine:latest
    init: true

isolation

指定容器的隔离技术。在 Linux 上，唯一支持的值是default。在 Windows 上，可接受的值为default、process和hyperv。

labels

使用 Docker 标签将元数据添加到容器，可以使用数组或字典。与 Dockerfile 中的LABELS类似：

labels:
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"
 
labels:
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

links

链接到另一个服务中的容器。指定服务名称和链接别名 ("SERVICE:ALIAS")，或仅指定服务名称。

它们不需要启用服务进行通信 - 默认情况下，任何服务都可以以该服务的名称访问任何其他服务。在以下示例中，web可以访问db，并且设置别名为database：

version: "3.9"
services:
  web:
    build: .
    links:
      - "db:database"
  db:
    image: postgres

logging

日志记录配置。

服务的日志记录配置。
driver：
指定服务容器的日志记录驱动程序，默认值为json-file。
有以下三个选项 "json-file" "syslog" "none"

json-file

仅在 json-file 驱动程序下，可以使用以下参数，限制日志得数量和大小。
当达到文件限制上限，会自动删除旧得文件。

version: "3.9"
services:
  some-service:
    image: some-service
    logging:
      driver: "json-file"
      options:
        max-size: "200k"
        max-file: "10"
network_mode

syslog

syslog驱动程序下，可以使用 syslog-address 指定日志接收地址。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

network_mode

网络模式。使用与 docker 客户端--network相同，可以使用特殊形式service:[service name]。
host or none 使用主机的网络堆栈，或者不使用网络。
相当于docker run --net=host或docker run --net=none。
仅在使用docker stack命令时使用。
如果docker-compose使用该命令，请改用 network_mode。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

pid

pid将 PID 模式设置为主机 PID 模式。
这会在容器和主机操作系统之间共享 PID 地址空间。
使用此标志启动的容器可以访问和操作裸机命名空间中的其他容器，反之亦然。

pid: "host"

ports

暴露端口。

简短语法

共有三种写法：

• 指定两个端口 ( HOST:CONTAINER)
• 仅指定容器端口（为主机端口选择了一个临时主机端口）。
• 指定要绑定到两个端口的主机IP 地址（默认为 0.0.0.0，表示所有接口）：( IPADDR:HOSTPORT:CONTAINERPORT)。如果 HOSTPORT 为空（例如127.0.0.1::80），则会选择一个临时端口来绑定到主机上。

ports:
  - "3000"
  - "3000-3005"
  - "8000:8000"
  - "9090-9091:8080-8081"
  - "49100:22"
  - "127.0.0.1:8001:8001"
  - "127.0.0.1:5000-5010:5000-5010"
  - "127.0.0.1::5000"
  - "6060:6060/udp"
  - "12400-12500:1240"

长语法

• target: 容器内的端口
• published: 公开的端口
• protocol：端口协议（tcp或udp）
• mode：host用于在每个节点上发布主机端口，或ingress用于负载平衡的群模式端口。

ports:
  - target: 80
    published: 8080
    protocol: tcp
    mode: host

profiles

允许通过有选择地启用服务来针对各种用途和环境调整 Compose 应用程序模型。这是通过将每个服务分配给单个或多个配置文件来实现的。如果未分配，则始终启动该服务，但如果已分配，则仅在激活配置文件时才启动。

这允许人们在单个docker-compose.yml文件中定义额外的服务，这些服务应该只在特定场景中启动，例如用于调试或开发任务。

profiles: ["frontend", "debug"]
profiles:
  - frontend
  - debug

secrets

存储敏感数据，例如密码。为每个服务机密授予相应的访问权限

简短语法

简短的语法仅指定机密名称。

以下示例授予redis服务对my_secret和my_other_secret机密的访问权限。./my_secret.txt文件的内容被设置为 my_secret，my_other_secret被定义为外部机密，这意味着它已经在Docker中定义，无论是通过运行docker secret create命令还是通过另一个堆栈部署，都不会重新创建。如果外部机密不存在，堆栈部署将失败并显示secret not found错误。

version: "3.9"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    environment:
      MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret
    secrets:
      - my_secret
      - my_other_secret
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

长语法

• source：定义机密标识符。
• target：要挂载在/run/secrets/服务的任务容器中的文件的名称，默认是 source。
• uid和gid：/run/secrets/在服务的任务容器中拥有文件的数字 UID 或 GID 。
• mode：要挂载在/run/secrets/ 服务的任务容器中的文件的权限，以八进制表示法。例如，0444 代表可读。

下面的示例表示将my_secret 命名为redis_secret，模式为0440（组可读），和用户组为103。该redis服务无权访问该my_other_secret机密。

version: "3.9"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    secrets:
      - source: my_secret
        target: redis_secret
        uid: '103'
        gid: '103'
        mode: 0440
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

一级secrets详细配置：

• file：使用指定路径中的文件内容创建机密。
• external：如果设置为 true，则指定此机密已创建。Docker 不会尝试创建它，如果它不存在， 会报错secret not found。
• name：Docker 中秘密对象的名称。此字段可用于引用包含特殊字符的机密。
• template_driver：要使用的模板驱动程序的名称，它控制是否以及如何将机密负载评估为模板。如果未设置驱动程序，则不使用模板。当前支持的唯一驱动程序是golang，它使用golang。

在本示例中，my_first_secret在<stack_name>_my_first_secret 部署堆栈时创建 ，并且my_second_secret已存在于 Docker 中。

secrets:
  my_first_secret:
    file: ./secret_data
  my_second_secret:
    external: true 

security_opt

为每个容器覆盖默认的标签。简单说来就是管理全部服务的标签，比如设置全部服务的 user 标签值为USER。

security_opt修改容器默认的 schema 标签。

security-opt：
  - label:user:USER   # 设置容器的用户标签
  - label:role:ROLE   # 设置容器的角色标签
  - label:type:TYPE   # 设置容器的安全策略标签
  - label:level:LEVEL  # 设置容器的安全等级标签

stop_grace_period

指定在尝试停止容器时等待多长时间。
stop_grace_period指定在容器无法处理 SIGTERM (或者任何 stop_signal 的信号)，等待多久后发送 SIGKILL 信号关闭容器。默认的等待时间是 10 秒。

• stop_grace_period: 1s # 等待 1 秒
• stop_grace_period: 1m30s # 等待 1 分 30 秒

在docker stop命令执行的时候，会先向容器中的进程发送系统信号SIGTERM，然后等待容器中的应用程序终止执行。如果等待时间达到设定的超时时间，或者默认的10秒，会继续发送SIGKILL的系统信号强行kill掉进程。
在容器中的应用程序，可以选择忽略和不处理SIGTERM信号，不过一旦达到超时时间，程序就会被系统强行kill掉，因为SIGKILL信号是直接发往系统内核的，应用程序没有机会去处理它。

stop_grace_period: 1s

默认情况下，stop在发送 SIGKILL 之前等待容器退出 10 秒。

stop_signal

设置一个替代信号来停止容器。默认情况下stop使用 SIGTERM。使用stop_signal设置替代信号来stop。

stop_signal: SIGUSR1

sysctls

在容器中设置的内核参数，可以为数组或字典

sysctls:
  net.core.somaxconn: 1024
  net.ipv4.tcp_syncookies: 0

tmpfs

在容器内挂载一个临时文件系统。可以是单个值或列表。

tmpfs: /run
# or
tmpfs:
  - /run
  - /tmp

ulimits

设置当前进程以及其子进程的资源使用量，覆盖容器的默认限制，可以单一地将限制值设为一个整数，也可以将soft/hard限制指定为映射

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000

userns_mode

如果 Docker 守护程序配置了用户命名空间，则禁用此服务的用户命名空间。

userns_mode:"host"

volumes

挂载一个目录或者一个已存在的数据卷容器，可以直接使用HOST:CONTAINER这样的格式，或者使用HOST:CONTAINER:ro这样的格式，后者对于容器来说，数据卷是只读的，这样可以有效保护宿主机的文件系统
您可以将主机路径挂载为单个服务定义的一部分，无需在一级volumes键中定义它。
但是，如果您想在多个服务中重用一个卷，则需要在一级volumes 中定义一个命名卷。
如下实例，web 服务使用命名卷 (mydata)，以及为单个服务定义的绑定安装（dbservice下的第一个路径volumes）。db服务还使用名为dbdata（dbservice下的第二个路径volumes）的命名卷，使用了旧字符串格式定义它以安装命名卷。命名卷必须列在顶级volumes键下。

version: "3.9"
services:
  web:
    image: nginx:alpine
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static
 
  db:
    image: postgres:latest
    volumes:
      - "/var/run/postgres/postgres.sock:/var/run/postgres/postgres.sock"
      - "dbdata:/var/lib/postgresql/data"
 
volumes:
  mydata:
  dbdata:

简短语法

简短语法使用通用[SOURCE:]TARGET[:MODE]格式，其中 SOURCE可以是主机路径或卷名。TARGET是安装卷的容器路径。标准模式ro用于只读和rw读写（默认）。
您可以在主机上挂载一个相对路径，该路径相对于正在使用的 Compose 配置文件的目录展开。相对路径应始终以.或开头..。

volumes:
  # Just specify a path and let the Engine create a volume
  - /var/lib/mysql
 
  # Specify an absolute path mapping
  - /opt/data:/var/lib/mysql
 
  # Path on the host, relative to the Compose file
  - ./cache:/tmp/cache
 
  # User-relative path
  - ~/configs:/etc/configs/:ro
 
  # 命名卷
  - datavolume:/var/lib/mysql

长语法

(v3.2 新增的语法格式)

• type: 安装类型， bind,tmpfs或npipe
• source: 安装源、主机上用于绑定安装的路径或在顶级volumes 中定义的卷的名称 。不适用于 tmpfs 挂载。
• target：安装卷的容器中的路径
• read_only: 将卷设置为只读的标志
• bind: 配置额外的绑定选项

1. propagation：用于绑定的传播模式

• volume: 配置额外的选项

1. nocopy: 创建卷时禁用从容器复制数据的标志

• tmpfs: 配置额外的 tmpfs 选项

1. size：tmpfs 挂载的大小（以字节为单位）

version: "3.9"
services:
  web:
    image: nginx:alpine
    ports:
      - "80:80"
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static
 
networks:
  webnet:
 
volumes:
  mydata:

一级 Volume 详细配置：

• driver 指定该卷应使用哪个卷驱动程序
• driver_opts 将选项列表指定为键值对以传递给此卷的驱动程序

volumes:
  example:
    driver_opts:
      type: "nfs"
      o: "addr=10.40.0.199,nolock,soft,rw"
      device: ":/docker/example"

• external 如果设置为true，则指定该卷是在 Compose 之外创建的
• labels 添加元数据
• name 为此卷设置自定义名称

version: "3.9"
volumes:
  data:
    name: my-app-data

变量置换

你可以使用 $VARIABLE 或者 ${VARIABLE} 来置换变量

• ${VARIABLE:-default}VARIABLE在环境中未设置或为空时设置为default。
• ${VARIABLE-default}仅当VARIABLE在环境中未设置时才设置为default。
• ${VARIABLE:?err}退出并显示一条错误消息，其中包含环境中的errif VARIABLE未设置或为空。
• ${VARIABLE?err}退出并显示一条错误消息，其中包含errif VARIABLE在环境中未设置。
• 如果想使用一个不被compose处理的变量，可用使用 $$