Docker Compose 模板文件指令详解

image#

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

1
image: ubuntu
2
image: orchardup/postgresql
3
image: a4bc65fd

build#

指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 Compose 文件的路径）。Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

1
services:
2
  webapp:
3
    build: ./dir

也可以使用 context 指令指定 Dockerfile 所在文件夹的路径，使用 dockerfile 指令指定 Dockerfile 文件名，使用 arg 指令指定构建镜像时的变量：

1
services:
2
  webapp:
3
    build:
4
      context: ./dir
5
      dockerfile: Dockerfile-alternate
6
      args:
7
        buildno: 1

使用 cache_from 指定构建镜像的缓存：

1
build:
2
  context: .
3
  cache_from:
4
    - alpine:latest
5
    - corp/web_app:3.14

command#

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

1
command: echo "hello world"

depends_on#

解决容器的依赖、启动先后的问题。以下例子中会先启动 db、redis，再启动 web：

1
services:
2
  web:
3
    build: .
4
    depends_on:
5
      - db
6
      - redis
7

8
  redis:
9
    image: redis
10

11
  db:
12
    image: postgres

注意：上述简写形式中，web 服务不会等待 redis、db “完全启动” 之后才启动。

如果需要等待依赖服务就绪，可以使用 condition 字段配合 healthcheck：

1
services:
2
  web:
3
    build: .
4
    depends_on:
5
      db:
6
        condition: service_healthy
7
      redis:
8
        condition: service_healthy
9

10
  redis:
11
    image: redis
12
    healthcheck:
13
      test: ["CMD", "redis-cli", "ping"]
14
      interval: 5s
15
      timeout: 3s
16
      retries: 5
17

18
  db:
19
    image: postgres
20
    healthcheck:
21
      test: ["CMD-SHELL", "pg_isready -U postgres"]
22
      interval: 5s
23
      timeout: 3s
24
      retries: 5

condition 支持三个值：

• service_started：容器启动即满足（默认）。
• service_healthy：容器的 healthcheck 状态为 healthy 时满足。
• service_completed_successfully：容器成功退出（退出码为 0）时满足，适用于初始化任务等一次性容器。

healthcheck#

通过命令检查容器是否健康运行。

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

environment#

设置环境变量。可以使用数组或字典两种格式。

只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据：

1
environment:
2
  RACK_ENV: development
3
  SESSION_SECRET:

1
environment:
2
  - RACK_ENV=development
3
  - SESSION_SECRET

如果变量名称或者值中用到表达布尔含义的词汇，最好放到引号里，避免 YAML 自动解析为布尔语义。这些特定词汇包括：

1
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF

env_file#

从文件中获取环境变量，可以是单独的文件路径或列表。

如果通过 docker compose -f FILE 方式指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，按照惯例，以 environment 为准。

1
env_file: .env

1
env_file:
2
  - ./common.env
3
  - ./apps/web.env
4
  - /opt/secrets.env

环境变量文件中每一行必须符合 VAR=VAL 格式，支持 # 开头的注释行：

1
# common.env: Set development environment
2
PROG_ENV=development

secrets#

存储敏感数据，例如 mysql 服务密码：

1
services:
2
  mysql:
3
    image: mysql
4
    environment:
5
      MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
6
    secrets:
7
      - db_root_password
8
      - my_other_secret
9

10
secrets:
11
  db_root_password:
12
    file: ./db_root_password.txt
13
  my_other_secret:
14
    external: true

读取环境变量#

Compose 模板文件支持动态读取主机的系统环境变量和当前目录下 .env 文件中的变量。

例如，下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值：

1
services:
2
  db:
3
    image: "mongo:${MONGO_VERSION}"

执行 MONGO_VERSION=3.2 docker compose up 则会启动一个 mongo:3.2 镜像的容器；执行 MONGO_VERSION=2.8 docker compose up 则会启动 mongo:2.8。

若当前目录存在 .env 文件，执行 docker compose 命令时将从该文件中读取变量。新建 .env 文件并写入：

1
# 支持 # 号注释
2
MONGO_VERSION=3.6

执行 docker compose up 则会启动一个 mongo:3.6 镜像的容器。

ports#

暴露端口信息。使用宿主端口<容器端口>（HOST:CONTAINER）格式，或者仅指定容器端口（宿主将会随机选择端口）：

1
ports:
2
  - "3000"
3
  - "8000:8000"
4
  - "49100:22"
5
  - "127.0.0.1:8001:8001"

注意：当使用 HOST:CONTAINER 格式映射端口时，如果容器端口小于 60 并且没加引号，可能会得到错误结果，因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现问题，建议数字串都采用引号包括的字符串格式。

expose#

暴露端口，但不映射到宿主机，只被连接的服务访问。仅可以指定内部端口为参数：

1
expose:
2
  - "3000"
3
  - "8000"

networks#

配置容器连接的网络。容器之间应通过 Docker 网络进行互联：

1
services:
2
  some-service:
3
    networks:
4
      - some-network
5
      - other-network
6

7
networks:
8
  some-network:
9
  other-network:

network_mode#

设置网络模式。使用和 docker run 的 --network 参数一样的值：

1
network_mode: "bridge"
2
network_mode: "host"
3
network_mode: "none"
4
network_mode: "service:[service name]"
5
network_mode: "container:[container name/id]"

dns 与 dns_search#

自定义 DNS 服务器，可以是一个值，也可以是一个列表：

1
dns: 8.8.8.8

1
dns:
2
  - 8.8.8.8
3
  - 114.114.114.114

配置 DNS 搜索域：

1
dns_search: example.com

1
dns_search:
2
  - domain1.example.com
3
  - domain2.example.com

extra_hosts#

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息：

1
extra_hosts:
2
  - "googledns:8.8.8.8"
3
  - "dockerhub:52.1.157.61"

会在启动后的服务容器的 /etc/hosts 文件中添加如下两条条目：

1
8.8.8.8 googledns
2
52.1.157.61 dockerhub

volumes#

数据卷所挂载路径设置。可以设置为宿主机路径（HOST:CONTAINER）或者数据卷名称（VOLUME:CONTAINER），并且可以设置访问模式（HOST:CONTAINER:ro）。该指令中路径支持相对路径：

1
volumes:
2
  - /var/lib/mysql
3
  - cache/:/tmp/cache
4
  - ~/configs:/etc/configs/:ro

如果路径为数据卷名称，必须在文件中配置数据卷：

1
services:
2
  my_src:
3
    image: mysql:8.4
4
    volumes:
5
      - mysql_data:/var/lib/mysql
6

7
volumes:
8
  mysql_data:

tmpfs#

挂载一个 tmpfs 文件系统到容器：

1
tmpfs: /run

1
tmpfs:
2
  - /run
3
  - /tmp

read_only#

以只读模式挂载容器的 root 文件系统，意味着不能对容器内容进行修改：

1
read_only: true

cap_add 与 cap_drop#

指定容器的内核能力（capability）分配。

例如，让容器拥有所有能力：

1
cap_add:
2
  - ALL

去掉 NET_ADMIN 能力：

1
cap_drop:
2
  - NET_ADMIN

privileged#

允许容器中运行一些特权命令。privileged: true 会显著扩大容器对宿主机设备和 Linux capability 的访问范围，生产环境应优先使用更窄的 cap_add、devices 或只读挂载：

1
privileged: true

security_opt#

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名：

1
security_opt:
2
  - label:user:USER
3
  - label:role:ROLE

devices#

指定设备映射关系：

1
devices:
2
  - "/dev/ttyUSB1:/dev/ttyUSB0"

pid#

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作：

1
pid: "host"

cgroup_parent#

指定父 cgroup 组，意味着将继承该组的资源限制。例如创建了一个 cgroup 组名称为 cgroups_1：

1
cgroup_parent: cgroups_1

ulimits#

指定容器的 ulimits 限制值。

例如，指定最大进程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制）和 40000（系统硬限制，只能 root 用户提高）：

1
ulimits:
2
  nproc: 65535
3
  nofile:
4
    soft: 20000
5
    hard: 40000

sysctls#

配置容器内核参数：

1
sysctls:
2
  net.core.somaxconn: 1024
3
  net.ipv4.tcp_syncookies: 0

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

container_name#

指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式：

1
container_name: docker-web-container

注意：指定容器名称后，该服务将无法进行扩展（scale），因为 Docker 不允许多个容器具有相同的名称。

restart#

指定容器退出后的重启策略。该命令对保持服务始终运行十分有效，在生产环境中推荐配置为 always 或者 unless-stopped：

1
restart: always

stop_signal#

设置另一个信号来停止容器。默认情况下使用的是 SIGTERM 停止容器：

1
stop_signal: SIGUSR1

logging#

配置日志选项：

1
logging:
2
  driver: syslog
3
  options:
4
    syslog-address: "tcp://192.168.0.42:123"

Docker 支持十余种日志驱动（json-file、local、syslog、journald、gelf、fluentd、awslogs、splunk、gcplogs、none 等，默认为 json-file），完整清单见官方文档。下面是几个常见取值：

1
driver: "json-file"
2
driver: "syslog"
3
driver: "none"

options 配置日志驱动的相关参数：

1
options:
2
  max-size: "200k"
3
  max-file: "10"

profiles#

profiles 用于按场景选择性启动服务。未指定 profiles 的服务默认始终启动；标记了 profiles 的服务仅在激活对应 profile 时才启动：

1
services:
2
  web:
3
    image: nginx
4

5
  debug:
6
    image: busybox
7
    profiles:
8
      - debug
9

10
  test:
11
    image: node
12
    profiles:
13
      - test

启动时通过 --profile 激活：

1
docker compose --profile debug up    # 启动 web + debug
2
docker compose up                    # 仅启动 web

也可以通过环境变量激活：

1
COMPOSE_PROFILES=debug,test docker compose up

如果在命令行里显式指定某个带 profile 的服务，Compose 会自动启动这个目标服务及其声明的依赖；但不会自动启动同一 profile 下的其他服务，除非也显式指定或通过 --profile / COMPOSE_PROFILES 启用。

labels#

为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息：

1
labels:
2
  com.startupteam.description: "webapp for a startup team"
3
  com.startupteam.department: "devops department"
4
  com.startupteam.release: "rc3 for v1.0"

deploy#

deploy 用于描述副本数、更新策略、资源限制等部署参数。该字段在 Swarm 中支持最完整；在本地 docker compose up 场景下通常只有部分字段生效。

configs#

configs 来自 Compose Specification。它在 Swarm 中是原生对象；在本地 docker compose 模式下通常以文件挂载的形式实现，具体能力取决于 Compose 版本与运行平台。

links#

不推荐使用该指令。容器之间应通过 Docker 网络（networks）进行互联。

external_links#

不建议使用该指令。它的作用是链接到 Compose 文件外部的容器，甚至并非 Compose 管理的外部容器：

1
external_links:
2
  - redis_1
3
  - project_db_1:mysql
4
  - project_db_1:postgresql

本文整理自开源书籍 《Docker —— 从入门到实践》 第 11.5 节「Compose 模板文件」，按功能重新归类整理。