对于docker-composev3版本命令详解参考感兴趣的读者，本文将会是一篇不错的选择，我们将详细介绍docker-composeversion，并为您提供关于DockerCLI实战指南：从基础命

对于docker-compose v3 版本命令详解参考感兴趣的读者，本文将会是一篇不错的选择，我们将详细介绍docker-compose version，并为您提供关于Docker CLI 实战指南：从基础命令到 Dockerfile 构建和 Docker Compose、Docker Compose 命令详解、Docker Compose 版本过高（Docker 版本不匹配），降低 docker-compose 版本、Docker Compose 部署 Nexus3 时的 docker-compose,yml 代码的有用信息。

• docker-compose v3 版本命令详解参考（docker-compose version）
• Docker CLI 实战指南：从基础命令到 Dockerfile 构建和 Docker Compose
• Docker Compose 命令详解
• Docker Compose 版本过高（Docker 版本不匹配），降低 docker-compose 版本
• Docker Compose 部署 Nexus3 时的 docker-compose,yml 代码

docker-compose v3 版本命令详解参考（docker-compose version）

参考和指南

这些主题描述了 Compose 文件格式的第 3 版。这是最新的版本.

Compose and Docker 兼容性矩阵

有几个版本的 Compose 文件格式 - 1，2，2.x 和 3.x. 下表是快速浏览。有关每个版本包含和如何升级的详细信息，请参阅关于版本和升级.

Compose 文件结构和示例

version: "3"
services:

  redis:
    image: redis:alpine
    ports:
      - "6379"
    networks:
      - frontend
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        constraints: [node.role == manager]

  vote:
    image: dockersamples/examplevotingapp_vote:before
    ports:
      - 5000:80
    networks:
      - frontend
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
      restart_policy:
        condition: on-failure

  result:
    image: dockersamples/examplevotingapp_result:before
    ports:
      - 5001:80
    networks:
      - backend
    depends_on:
      - db
    deploy:
      replicas: 1
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 1
      labels: [APP=VOTING]
      restart_policy:
        condition: on-failure
        delay: 10s
        max_attempts: 3
        window: 120s
      placement:
        constraints: [node.role == manager]

  visualizer:
    image: dockersamples/visualizer:stable
    ports:
      - "8080:8080"
    stop_grace_period: 1m30s
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
    deploy:
      placement:
        constraints: [node.role == manager]

networks:
  frontend:
  backend:

volumes:
  db-data:

此参考页面上的主题按顶级按键按字母顺序组织，以反映撰写文件本身的结构。定义配置文件中的一部分，如顶级键 build，deploy，depends_on， networks，等等，都与所有支持他们的子课题的选项中列出。这将映射到 <key>: <option>: <value>Compose 文件的缩进结构。

一个好的开始是入门教程，它使用版本 3 编写堆栈文件来实现多容器应用程序，服务定义和群组模式。以下是本教程中使用的一些撰写文件。，

• 你的第一个 docker-compose.yml 文件

• 添加新服务并重新部署

另一个很好的参考是在 Docker for Beginners 实验室 主题 将应用程序部署到 Swarm. 上的投票应用程序示例的 compose 文件 。这也在本节顶部上展示。

服务配置参考

Compose 文件是一个定义 服务 , 网络 和 卷的 YAML 文件. Compose 文件的默认路径是 ./docker-compose.yml.

提示：您可以对此文件使用.yml 或.yaml 扩展名。他们都工作.

服务定义包含将应用于为该服务启动的每个容器的配置，就像传递命令行参数一样 docker run。同样，网络和卷的定义类似于 docker network create 和 docker volume create。

正如 docker run 在 Dockerfile 指定选项（例如，CMD， EXPOSE，VOLUME，ENV）是默认的尊重 - 你不需要再次指定它们 docker-compose.yml。

您可以使用类似 Bash 的 ${VARIABLE} 语法在配置值中使用环境变量 - 有关详细信息，请参阅 变量替换 for full details.

本节包含版本 3 中服务定义支持的所有配置选项的列表。

build

build 可以指定为包含构建上下文的路径的字符串：

version: ''2''
services:
  webapp:
    build: ./dir

或者，作为一个对象，具有 上下文 和可选的 Dockerfile 和 args 下指定的路径:

version: ''2''
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

如果指定 image 以及 build，然后撰写的名称与内置的图像 webapp 和可选的 tag 规定 image：

build: ./dir
image: webapp:tag

这将导致命名的镜像 webapp 和标签 tag，从建成./dir。

注意：在使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。该 docker stack 命令仅接受预建图像。

上下文

到包含 Dockerfile 的目录的路径，或者是 git 仓库的 URL。

当提供的值是相对路径时，它被解释为相对于撰写文件的位置。该目录也是发送到 Docker 守护程序的构建上下文。

Compose 将使用生成的名称构建并标记它，然后使用该映像。

build:
  context: ./dir

Dockerfile

备用 Docker 文件。

Compose 将使用备用文件来构建。还必须指定构建路径。

build:
  context: .
  dockerfile: Dockerfile-alternate

Args

添加构建参数，环境变量只能在构建过程中访问。

首先，在 Dockerfile 中指定参数：

ARG buildno
ARG password

RUN echo "Build number: $buildno"
RUN script-requiring-password.sh "$password"

然后在 build 密钥下指定参数。您可以传递映射或列表：

build:
  context: .
  args:
    buildno: 1
    password: secret

build:
  context: .
  args:
    - buildno=1
    - password=secret

您可以在指定构建参数时省略该值，在这种情况下，构建时的值是运行 Compose 的环境中的值。

args:
  - buildno
  - password

注：YAML 布尔值（true，false，yes，no，on，off）必须用引号括起来，这样分析器会将它们解释为字符串。

cache_from

注意：此选项在 v3.2 中是新增功能

引擎将用于缓存解析的图像列表。

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

labels

注意：此选项在 v3.3 中是新增的

使用 Docker labels 将元数据添加到生成的图像。您可以使用数组或字典。

建议您使用反向 DNS 符号来防止标签与其他软件使用的标签相冲突。

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


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

cap_add, cap_drop

添加或删除容器功能。查看 man 7 capabilities 完整列表。

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

注意：在 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略这些选项 。

command

覆盖默认命令。

command: bundle exec thin -p 3000

该命令也可以是一个列表，类似于 dockerfile:

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

configs

使用每个服务 configs 配置在每个服务的基础上授予对配置的访问权限。支持两种不同的语法变体。

注意：该配置必须已经存在或 在 configs 该堆栈文件的 顶级配置 中定义，否则堆栈部署将失败

Short syntax

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

以下示例使用简短的语法来授予 redis 对 my_config 和 my_other_config 配置的服务访问权限。将值 my_config 设置为文件的内容./my_config.txt，并将 my_other_config 其定义为外部资源，这意味着它已经在 Docker 中定义，无论是通过运行 docker config create 命令还是通过其他堆栈部署。如果外部配置不存在，则堆栈部署失败并出现 config not found 错误。

注意：config 定义仅在版本 3.3 及更高版本的组合文件格式中受支持。

version: "3.3"
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 syntax

长语法在服务的任务容器中如何创建配置提供了更多的粒度。

• source：Docker 中存在的配置名称。
• target：将要装入服务任务容器的文件的路径和名称。默认为 /<source> 未指定。
• uid 和 gid：数字 UID 或 GID，它将拥有服务的任务容器中的挂载配置文件。0 如果没有指定，则默认为 Linux。Windows 不支持
• mode：将在服务的任务容器中装载的文件的权限，以八进制符号表示。例如，0444 代表世界可读。默认是 0444。配置不能被写入，因为它们被安装在临时文件系统中，所以如果设置可写位，则忽略它。可执行位可以设置。如果您不熟悉 UNIX 文件权限模式，您可能会发现此 权限计算器 很有用.

下面的示例设置的名称 my_config，以 redis_config 在容器内，将模式设定为 0440（组可读），并且将所述用户和组 103。该 redis 服务无法访问该 my_other_config 配置。

version: "3.3"
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

您可以授予对多个配置的服务访问权限，您可以混合长短语法。定义配置并不意味着授予对其的访问权限。

cgroup_parent

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

cgroup_parent: m-executor-abcd

注意：在 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

container_name

指定自定义容器名称，而不是生成的默认名称。

container_name: my-web-container

因为 Docker 容器名称必须是唯一的，如果您指定了自定义名称，则无法将服务扩展到超过 1 个容器。尝试这样做会导致错误。

注意：在 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

credential_spec

注意：此选项已在 v3.3 中添加

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

在使用时 file:，引用的文件必须存在于 CredentialSpecs docker 数据目录的子目录中，这 C:\ProgramData\Docker\ 在 Windows 上是默认的。以下示例从名为 C:\ProgramData\Docker\CredentialSpecs\my-credential-spec.json 以下文件的文件加载凭据规范 ：

credential_spec:
  file: my-credential-spec.json

使用时 registry:，凭据规范从守护程序主机上的 Windows 注册表中读取。具有给定名称的注册表值必须位于：

HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs

以下示例从 my-credential-spec 注册表中指定的值加载凭据规范：

credential_spec:
  registry: my-credential-spec

deploy

仅限版本 3

指定与部署和运行相关的配置。这只能部署到时生效 swarm 与 docker stack deploy, 并且被忽略 docker-compose up 和 docker-compose run。

version: ''3''
services:
  redis:
    image: redis:alpine
    deploy:
      replicas: 6
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

有几个子选项可用：

endpoint_mode

为连接到群组的外部客户端指定服务发现方法。

版本 3.3 .

• endpoint_mode: vip - Docker 为服务分配虚拟 IP（VIP），作为客户端到达网络服务的 “前端”。Docker 在服务的客户端和可用的工作者节点之间路由请求，而无需客户端了解有多少个节点参与服务或其 IP 地址或端口。（这是默认值。）

• endpoint_mode: dnsrr - DNS 循环（DNSRR）服务发现不使用单个虚拟 IP。Docker 为服务设置 DNS 条目，以便服务名称的 DNS 查询返回 IP 地址列表，客户端直接连接到其中一个。如果要使用自己的负载均衡器，或混合 Windows 和 Linux 应用程序，则 DNS 循环是非常有用的。

version: "3.3"

services:
  wordpress:
    image: wordpress
    ports:
      - 8080:80
    networks:
      - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: vip

  mysql:
    image: mysql
    volumes:
       - db-data:/var/lib/mysql/data
    networks:
       - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: dnsrr

volumes:
  db-data:

networks:
  overlay:

endpoint_mode 在 swarm 模式 CLI 命令 docker service create 也可用作标志 的选项。有关所有群集相关 docker 命令的快速列表，请参阅 Swarm 模式 CLI 命令.

labels

指定服务的标签。这些标签只能在服务上设置，而不能在服务的任何容器上设置。

version: "3"
services:
  web:
    image: web
    deploy:
      labels:
        com.example.description: "This label will appear on the web service"

要在容器上设置标签，请使用以下 labels 键 deploy：

version: "3"
services:
  web:
    image: web
    labels:
      com.example.description: "This label will appear on all containers for the web service"

mode

任一 global（正好一个每群节点容器）或 replicated（一个指定的数量的容器）。默认是 replicated。

version: ''3''
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    deploy:
      mode: global

placement

指定布局约束

version: ''3''
services:
  db:
    image: postgres
    deploy:
      placement:
        constraints:
          - node.role == manager
          - engine.labels.operatingsystem == ubuntu 14.04

replicas

如果服务是 replicated（默认为），请指定在任何给定时间应运行的容器数。

version: ''3''
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 6

resources

配置资源约束。

注意：这取代了旧的资源约束选项在撰写非群模式文件之前版本 3（ cpu_shares，cpu_quota，cpuset， mem_limit，memswap_limit，mem_swappiness 如在 升级版本 2.x 到 3.x.

这些都是一个单一的值，类似于 docker service create 对应的.

在这个通用示例中，redis 服务被限制为使用不超过 50M 的内存和 0.001（0.1％）的可用处理时间（CPU），并且具有 保留 20M 的内存和 0.0001CPU 时间（一直可用）。

version: ''3''
services:
  redis:
    image: redis:alpine
    deploy:
      resources:
        limits:
          cpus: ''0.001''
          memory: 50M
        reservations:
          cpus: ''0.0001''
          memory: 20M

下面的主题描述了为群集中的服务或容器设置资源约束的可用选项。

内存异常 (OOME)

如果您的服务或容器尝试使用比系统可用的更多内存，则可能会遇到内存异常（OOME），并且容器或 Docker 守护程序可能被内核 OOM 杀手杀死。为了防止这种情况发生，请确保您的应用程序在具有足够内存的主机上运行，并且了解内存不足的风险。

restart_policy

配置在退出时是否以及如何重新启动容器。替换 restart.

• condition: 其中之一 none，on-failure 或 any（默认：）any。
• delay: 在重新启动尝试之间等待多长时间，指定为 持续时间（默认值：0）。
• max_attempts: 在放弃之前尝试重新启动一个容器多少次（默认：永不放弃）.
• window: 在决定重新启动成功之前等待多长时间，指定为持续时间（默认：立即决定）.

version: "3"
services:
  redis:
    image: redis:alpine
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s

update_config

配置服务如何更新。用于配置滚动更新。

• parallelism: 一次更新的容器数量。
• delay: 更新一组容器之间等待的时间。
• failure_action: 如果更新失败，该怎么办？其中之一 continue，rollback或pause （默认：）pause。
• monitor: 每个任务更新后的持续时间来监视失败 (ns|us|ms|s|m|h)（默认为 0）。
• max_failure_ratio: 更新期间容忍的故障率。
• order: 更新期间的操作顺序。其中一个 stop-first（旧任务，开始新的一个前停止），或者 start-first（新的任务首先启动，并且正在运行的任务将简要重叠）（默认 stop-first）注：仅支持 V3.4 及更高版本。

注意：order 仅支持 v3.4 及更高版本的撰写文件格式。

version: ''3.4''
services:
  vote:
    image: dockersamples/examplevotingapp_vote:before
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
        order: stop-first

不支持 docker stack deploy

下面的子选项（支持 docker compose up 和 docker compose run）是不支持的 docker stack deploy 或 deploy 键的。

• build
• cgroup_parent
• container_name
• devices
• dns
• dns_search
• tmpfs
• external_links
• links
• network_mode
• security_opt
• stop_signal
• sysctls
• userns_mode

devices

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

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

注意：在使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

depends_on

服务之间的快速依赖，有两个作用：

• docker-compose up 将依依次顺序启动服务。在下面的例子中，db 并 redis 会开始之前 web。

• docker-compose up SERVICE 将自动包含 SERVICE 的依赖关系。在下面的例子中，docker-compose up web 也将创建和启动 db 和 redis。

简单的例子:

version: ''3''
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

使用时需要注意几件事情 depends_on:

• depends_on 在开始之前不会等待 db 并且 redis“准备好”，web 直到它们被启动为止

• 版本 3 不再支持的 condition 形式 depends_on

• depends_on 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

DNS

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

dns: 8.8.8.8
dns:
  - 8.8.8.8
  - 9.9.9.9

注意: 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

dns_search

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

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

注意: 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

tmpfs

版本 2 文件格式 and up.

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

tmpfs: /run
tmpfs:
  - /run
  - /tmp

注意: 使用（版本 3）Compose 文件以群组模式部署堆栈 时，将忽略此选项 。

entrypoint

覆盖默认入口点。

entrypoint: /code/entrypoint.sh

entrypoint 也可以是一个列表，类似于 dockerfile:

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

注意：设置 entrypoint 将使用 ENTRYPOINTDockerfile 指令覆盖服务映像上的任何默认入口点集，并 清除映像上的任何默认命令 - 这意味着如果CMD Dockerfile 中有指令，则将忽略它。

env_file

从文件添加环境变量。可以是单个值或列表。

如果您指定了一个 Compose 文件 docker-compose -f FILE，则路径 env_file 相对于该文件所在的目录。

环境变量 部分中 声明的环境变量将覆盖这些值 - 即使这些值为空或未定义，这也将成立。

env_file: .env

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

Compose 期望 env 文件中的每一行都是 VAR=VAL 格式化的。以#（即注释）开始的行将被忽略，空白行也将被忽略。

# Set Rails/Rack environment
RACK_ENV=development

注意：如果您的服务指定构建选项，则在构建期间将不会自动显示在环境文件中定义的变量。使用 args 子选项 build 定义构建时环境变量。

该值 VAL 是按原样使用的，完全没有修改。例如，如果值被引号包围（通常是 shell 变量的情况），引号将包含在传递给 Compose 的值中。

请记住，在确定分配给显示多次的变量的值时，列表中文件的顺序很重要。列表中的文件从上到下处理。对于在文件中指定的相同变量，a.env 并在文件中 分配了不同的值 b.env，如果 b.env 在下面列出（之后），则来自 b.envstand 的值。例如，给出以下声明 docker_compose.yml：

services:
  some-service:
    env_file:
      - a.env
      - b.env

和以下文件：

# a.env
VAR=1

和

# b.env
VAR=hello

$ VAR 将会 hello

environment

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

仅具有密钥的环境变量将被解析为其正在运行的机器上的值，这对于秘密或主机特定值有帮助。

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

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

注意：如果您的服务指定构建选项，environment 则在构建期间不会自动显示定义的变量。使用 args 子选项 build 定义构建时环境变量。

expose

暴露端口而不将它们发布到主机 - 它们只能被链接服务访问。只能指定内部端口。

expose:
 - "3000"
 - "8000"

external_links

连接到组合之外 docker-compose.yml 或甚至外部的容器，尤其是提供共享或公共服务的容器。 在指定容器名称和链接别名（）时，external_links 遵循与 legacy 选项相似的语义。linksCONTAINER:ALIAS

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

注意： 如果您使用的是版本 2 或以上的文件格式，外部创建的容器必须连接至至少一个与要链接的服务相同的网络。链接是遗留选项。我们建议使用网络。
使用（版本 3）Compose 文件在群集模式下部署堆栈时，将忽略此选项。

extra_hosts

添加主机名映射。使用与 docker 客户端 --add-host 参数相同的值。

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

将在 /etc/hosts 此服务的内部容器中创建具有 ip 地址和主机名的条目，例如：

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

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

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3

interval 并被 timeout 指定为持续时间。

test 必须是字符串或列表。如果它是一个列表，第一项必须是 NONE，CMD 或 CMD-SHELL。如果它是一个字符串，则相当于指定 CMD-SHELL 该字符串。

# Hit the local web app
test: ["CMD", "curl", "-f", "http://localhost"]

# As above, but wrapped in /bin/sh. Both forms below are equivalent.
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。

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

如果图像不存在，Compose 尝试拉它，除非您也指定了构建，在这种情况下，它使用指定的选项构建它，并使用指定的标签进行标记。

isolation

指定容器的隔离技术。在 Linux 上，唯一支持的值是 default。在 Windows 中，可接受的值是 default，process 和 hyperv。有关详细信息，请参阅 Docker Engine docs .

labels

使用 Docker 标签将元数据添加到容器。您可以使用数组或字典。

建议您使用反向 DNS 符号来防止标签与其他软件使用的标签相冲突。

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:
  links:
   - db
   - db:database
   - redis

链接服务的容器将以与别名相同的主机名或者未指定别名的服务名称可访问。

链接不需要启用服务进行通信 - 默认情况下，任何服务都可以达到该服务名称的任何其他服务。

链接还以与 depends_on 相同的方式表示服务之间的依赖关系 ，因此它们确定服务启动的顺序。

Notes

如果您定义了链接和网络，那么它们之间链接的服务必须至少共享一个网络以进行通信。

使用（版本 3）Compose 文件在群集模式下部署堆栈时，将忽略此选项

logging

记录该服务的配置。

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

该 driver 名称指定服务的容器的日志记录驱动程序，以及 --log-driverdocker 运行的选项（在此记录）。

默认值为 json-file。

driver: "json-file"
driver: "syslog"
driver: "none"

Note: 只有 json-file 和 journald 驱动程序可以直接从 docker-compose up 和 docker-compose logs。使用任何其他驱动程序不会打印任何日志。

使用 options 键指定记录驱动程序的日志记录选项，与 --log-opt 选项一样 docker run。

记录选项是键值对。syslog 选项示例：

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

默认驱动程序 json-file 具有限制存储的日志数量的选项。为此，请使用键值对来获取最大存储大小和最大文件数：

options:
  max-size: "200k"
  max-file: "10"

上面显示的示例将存储日志文件，直到它们达到 max-size200kB，然后旋转它们。存储的各个日志文件的数量由 max-file 值指定。当日志超出最大限制时，会删除较旧的日志文件以允许存储新日志。

这是一个 docker-compose.yml 限制日志存储的示例文件：

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

上述用于控制日志文件和大小的示例使用特定于 json 文件驱动程序的选项。这些特定选项在其他日志记录驱动程序中不可用。

network_mode

网络模式。使用与 docker 客户端 --net 参数相同的值，加上特殊格式 service:[service name]。

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

Notes

• 使用（版本 3）Compose 文件在群集模式下部署堆栈时，将忽略此选项 。

• network_mode: "host" 不能与 links 混合.

networks

加入网络，引用顶级 networks 密钥下的条目

services:
  some-service:
    networks:
     - some-network
     - other-network

aliases

网络上此服务的别名（替代主机名）。同一网络上的其他容器可以使用服务名称或此别名来连接到其中一个服务的容器。

由于 aliases 是网络范围的，相同的服务可以在不同的网络上有不同的别名。

Note: 全网域别名可由多个容器共享，甚至可以由多个服务共享。如果是，则不能保证名称解决的哪个容器。

一般格式如下所示。

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

在下面的例子中，提供了三种服务（web，worker，和 db），其中两个网络（沿 new 和 legacy）。该 db 服务是在到达的主机名 db 或 database 上 new 网络，并 db 或 mysql 将上 legacy 网络。

version: ''2''

services:
  web:
    build: ./web
    networks:
      - new

  worker:
    build: ./worker
    networks:
      - legacy

  db:
    image: mysql
    networks:
      new:
        aliases:
          - database
      legacy:
        aliases:
          - mysql

networks:
  new:
  legacy:

ipv4_address, ipv6_address

在加入网络时为该服务指定容器的静态 IP 地址。

顶级网络部分中的相应网络配置 必须具有 ipam 覆盖每个静态地址的子网配置的 块。如果需要 IPv6 寻址，则 enable_ipv6 必须设置该选项，您必须使用版本 2.x Compose 文件，如下所示。

一个例子：

version: ''2.1''

services:
  app:
    image: busybox
    command: ifconfig
    networks:
      app_net:
        ipv4_address: 172.16.238.10
        ipv6_address: 2001:3984:3989::10

networks:
  app_net:
    driver: bridge
    enable_ipv6: true
    ipam:
      driver: default
      config:
      -
        subnet: 172.16.238.0/24
      -
        subnet: 2001:3984:3989::/64

pid

pid: "host"

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

ports

Expose ports.

Short syntax

既可以指定端口（HOST:CONTAINER），也可以指定容器端口（将选择随机的主机端口）。

Note: 以 HOST:CONTAINER 格式映射端口时，使用低于 60 的容器端口时，可能会遇到错误的结果，因为 YAML 会将格式的数字解析 xx:yy 为六进制（基数为 60）。因此，我们建议您始终将端口映射明确指定为字符串。

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"
 - "6060:6060/udp"

Long syntax

长格式语法允许配置不能以简短形式表达的其他字段。

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

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

Note: v3.2 中的长语法是新的

secrets

使用每个服务 secrets 配置在每个服务的基础上授予访问权限。支持两种不同的语法变体。

Note: 该秘密必须已经存在或者 在 secrets 该堆栈文件的顶级配置中定义，否则堆栈部署将失败

For more information on secrets, see secrets.

Short syntax

短语法变体仅指定秘密名称。这允许容器访问秘密，并将其安装在 /run/secrets/<secret_name> 容器内。源名称和目标挂载点都设置为秘密名称。

以下示例使用简短的语法来授予 redis 对该 my_secret 和 my_other_secret 机密的服务访问权限。将值 my_secret 设置为文件的内容./my_secret.txt，并将 my_other_secret 其定义为外部资源，这意味着它已经在 Docker 中定义，无论是通过运行 docker secret create 命令还是通过其他堆栈部署。如果外部机密不存在，则堆栈部署失败并出现 secret not found 错误。

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

Long syntax

The long syntax provides more granularity in how the secret is created within the service''s task containers.

• source: The name of the secret as it exists in Docker.
• target: The name of the file that will be mounted in /run/secrets/ in the service''s task containers. Defaults to source if not specified.
• uid and gid: The numeric UID or GID which will own the file within /run/secrets/ in the service''s task containers. Both default to 0 if not specified.
• mode: The permissions for the file that will be mounted in /run/secrets/ in the service''s task containers, in octal notation. For instance, 0444 represents world-readable. The default in Docker 1.13.1 is 0000, but will be 0444 in the future. Secrets cannot be writable because they are mounted in a temporary filesystem, so if you set the writable bit, it is ignored. The executable bit can be set. If you aren''t familiar with UNIX file permission modes, you may find this permissions calculator{: target="blank"} useful.

version: "3.1"
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

security_opt:
  - label:user:USER
  - label:role:ROLE

stop_grace_period: 1s
stop_grace_period: 1m30s

stop_signal: SIGUSR1

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

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

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

userns_mode: "host"

version: "3.2"
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:

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

  # Named volume
  - datavolume:/var/lib/mysql

version: "3.2"
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:

version: "3"
services:
  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        constraints: [node.role == manager]

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

user: postgresql
working_dir: /code

domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43

privileged: true


read_only: true
shm_size: 64M
stdin_open: true
tty: true

2.5s
10s
1m30s
2h32m
5h34m56s

version: "3"

services:
  db:
    image: db
    volumes:
      - data-volume:/var/lib/db
  backup:
    image: backup-service
    volumes:
      - data-volume:/var/lib/backup/data

volumes:
  data-volume:

 driver: foobar

 driver_opts:
   foo: "bar"
   baz: 1

version: ''2''

services:
  db:
    image: postgres
    volumes:
      - data:/var/lib/postgresql/data

volumes:
  data:
    external: true

volumes:
  data:
    external:
      name: actual-name-of-volume

labels:
  com.example.description: "Database volume"
  com.example.department: "IT/Ops"
  com.example.label-with-empty-value: ""

labels:
  - "com.example.description=Database volume"
  - "com.example.department=IT/Ops"
  - "com.example.label-with-empty-value"

driver: overlay

services:
  web:
    ...
    networks:
      hostnet: {}

networks:
  hostnet:
    external:
      name: host

services:
  web:
    ...
    networks:
      nonet: {}

networks:
  nonet:
    external:
      name: none

  driver_opts:
    foo: "bar"
    baz: 1

networks:
  mynet1:
    driver: overlay
    attachable: true

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

labels:
  com.example.description: "Financial transaction network"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

labels:
  - "com.example.description=Financial transaction network"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

version: ''2''

services:
  proxy:
    build: ./proxy
    networks:
      - outside
      - default
  app:
    build: ./app
    networks:
      - default

networks:
  outside:
    external: true

networks:
  outside:
    external:
      name: actual-name-of-network

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

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

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

secrets:
  my_first_secret:
    file: ./secret_data
  my_second_secret:
    external:
      name: redis_secret

# Set the base image to use
FROM alpine:3.7
# Update the system and install packages
RUN apk update && apk add curl
# Set the working directory
WORKDIR /app
# Copy the application file
COPY app.sh .
# Set the entry point
ENTRYPOINT ["./app.sh"]

docker build -t my-image .

version: ''3''
services:  
web:    
image: webapp-image    
ports:      - "80:80"  
database:    
image: mysql    
environment:      - MYSQL_ROOT_PASSWORD=my-secret-pw

docker-compose up

docker pull ubuntu:latest

docker run -it ubuntu:latest /bin/bash

docker tag <image-id> <username>/<repository>:<tag>

docker push <username>/<repository>:<tag>

docker run -d --name my-container -v my-named-volume:/var/lib/data my-image

ERROR: The Docker Engine version is less than the minimum required by Compose. Your current project requires a Docker Engine of version 1.10.0 or greater.

[root@Redmine-186 docker-compose]# docker -v
Docker version 1.7.1, build 786b29d/1.7.1

# pip uninstall docker-compose

# pip install docker-compose==1.5.2

version: ''3''
services:
  nexus:
    restart: always
    image: sonatype/nexus3
    container_name: nexus3
    ports:
      - 8081:8081
    volumes:
      - /usr/local/docker/nexus/nexus-data:/nexus-data