docker compose 简介

发表于 2022-08-30 更新于 2024-05-21 上层目录 Docker 阅读次数：

Compose 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群 的快速编排。

Compose 定位是 「定义和运行多个 Docker 容器的应用（Defining and running multi-container Docker applications）」，其前身是开源项目 Fig。

使用一个 Dockerfile 模板文件，可以让用户很方便的定义一个单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web 服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。

Compose 恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
Compose 中有两个重要的概念：

服务 (service) ：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。
项目 (project) ：由一组关联的应用容器组成的一个完整业务单元，在 docker-compose.yml 文件中定义。

Compose 的默认管理对象是项目，通过子命令对项目中的一组容器进行便捷地生命周期管理。

Compose 目前分为 2 个大版本： ^[1]

Compose V1 : 目前已经不提供官方支持。使用 Python 编写，通过 docker-compose 命令来调用。Compose V1 的 docker-compose.yml 最开始要包含 version 命令，取值范围 2.0 到 3.8
Compose V2 : 使用 Go 编写，通过 docker compose 命令来调用。Compose V2 忽略 docker-compose.yml 最开始的 version 指令。Compose V2 向后兼容 Compose V1 版本

Compose v2

目前 Docker 官方用 GO 语言 重写了 Docker Compose，并将其作为了 docker cli 的子命令，称为 Compose V2。你可以参照官方文档安装，然后将熟悉的 docker-compose 命令替换为 docker compose，即可使用 Docker Compose。

Compose 模板文件

模板文件是使用 Compose 的核心，里面大部分指令跟 docker run 相关参数的含义类似。

Compose V2 默认的模板文件名是 compose.yaml 或者 compose.yml，为了向后兼容，也支持 docker-compose.yaml 和 docker-compose.yml。如果同时存在这些文件，Compose 优先使用 compose.yaml

默认的模板文件名称为 compose.yaml，格式为 YAML 格式。

compose.yaml

services:
  webapp:
    image: examples/web
    ports:
      - "80:80"
    volumes:
      - "/data"

每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。

如果使用 build 指令，在 Dockerfile 中设置的选项(例如：CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取，无需在 docker-compose.yml 中重复设置。

下面分别介绍各个指令的用法。

compose.yaml 中的常用指令

name

name 指令用于明确的指定项目名称（Project Name）

compose.yaml

name: test_project

include:
   - infra.yaml
services:
  web:
    build: .
    ports:
      - "8000:5000"

include

在编排规模较大（如几十台 Docker 容器）的服务时，为了方便管理和易于维护，可以考虑将 compose.yaml 分割为多个文件。 ^[2]

在 compose.yaml 文件中，使用 include 指令来添加其他配置

compose.yaml

include:
   - infra.yaml
services:
  web:
    build: .
    ports:
      - "8000:5000"

在 infra.yaml 文件中定义其他服务

infra.yaml

services:
  redis:
    image: "redis:alpine"

build

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

compose.yaml


services:

  webapp:
    build: ./dir

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

compose.yaml


services:

  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

image

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

compose.yaml

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

command

覆盖容器启动后默认执行的命令，支持 shell 和列表格式 ^[5]

compose.yaml

command: bundle exec thin -p 3000

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

entrypoint

指定服务容器启动后执行的入口文件。

compose.yaml

entrypoint: /code/entrypoint.sh

container_name

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

compose.yaml

container_name: docker-web-container

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

depends_on

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

compose.yaml


services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

web 服务会等待 redis db 处于 ready 之后才启动。

基于条件的依赖 ^[4]

compose.yaml

services:
  web:
    build: .
    depends_on:
      db:
        condition: service_healthy
        restart: true
      redis:
        condition: service_started
  redis:
    image: redis
  db:
    image: postgres

dns

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

compose.yaml

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

dns_search

配置 DNS 搜索域。可以是一个值，也可以是一个列表。

compose.yaml

dns_search: example.com

dns_search:
  - domain1.example.com
  - domain2.example.com

extra_hosts

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

compose.yaml

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

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

/etc/hosts

8.8.8.8 googledns
52.1.157.61 dockerhub

environment

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

只给定名称的变量（没有赋值）会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。如果系统上没有此变量，Compose 不会警告或错误

compose.yaml

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

如果变量名称或者值中用到 true|false，yes|no 等表达布尔含义的词汇，最好放到引号里，避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇，包括

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

env_file

.env 文件是 Compose 获取环境变量的默认方式。.env 文件应该和 compose.yaml 文件在同一位置。 ^[3]

# cat .env
TAG=v1.5

# cat compose.yml
services:
  web:
    image: "webapp:${TAG}"

当执行 docker compose up 时，Service 中使用的环境变量会自动插入 .env 中定义的值。

自 Docker Compose version 2.24.0 版本起，也可以使用指令 env_file 指定 .env 文件或其他环境变量配置文件

如果 env_file 列表中指定的变量有重复，那么最后定义的值生效（高优先级）

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

如果 .env 文件不在 compose.yaml 所在的位置，可以使用 docker compose 选项 --env-file 来指定

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

如果使用了宿主系统 shell 中的变量，则其会覆盖 .env 文件或者 environment 中配置的变量值

Docker Compose 中环境变量优先级顺序

如果在 env_file 指令中配置了 required 为 false，那么当环境变量文件不存在时，Compose 自动忽略此配置条目。

compose.yaml

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env
  
env_file:
  - path: ./default.env
    required: true # default
  - path: ./override.env
    required: false

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

.env

# common.env: Set development environment
PROG_ENV=development

environment 指令也可以使用 .env 中的变量，假如 .env 中包含了 DEBUG=1，那么可以在 environment 指令中引用它：

services:
  webapp:
    image: my-webapp-image
    environment:
      - DEBUG=${DEBUG}

expose

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

compose.yaml

expose:
 - "3000"
 - "8000"

healthcheck

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

compose.yaml

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

labels

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

compose.yaml

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

logging

配置日志选项。

compose.yaml

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

目前支持三种日志驱动类型。

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

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

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

networks

配置容器连接的网络。

compose.yaml


services:

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

networks:
  some-network:
  other-network:

ports

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

compose.yaml

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

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

sysctls

配置容器内核参数。

compose.yaml

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

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

ulimits

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

compose.yaml

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

volumes

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

compose.yaml

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

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

docker-compose.yml



services:
  my_src:
    image: mysql:8.0
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:

将本地目录配置为 valume

指定本地目录配置为 volume，然后在容器中挂载 volume，参考以下配置

volumes:
  nextcloud_aio_mastercontainer:
    name: nextcloud_aio_mastercontainer
    driver: local
    driver_opts:
      type: none
      o: bind
      device: /path/to/local/directory

选项	说明	示例
`name`	指定 Volume 名称。默认会使用 `<项目名>_<卷名称>`。如上面示例中默认为 `nextcloud_nextcloud_aio_mastercontainer`
`nextcloud_aio_mastercontainer`	volume 名，可以自定义
`driver`	volume 驱动类型。 `local`：使用本地目录
`driver_opts`	指定特定驱动程序的选项. `type: none` 表示该 volume 类型是无类型的 `o: bind` 含义是使用 `bind mount`（绑定挂载）,指定将卷绑定到主机上特定目录 `device: /path/to/local/directory` 指定了本地目录作为挂载点。

使用以上配置后，docker 会首先创建一个 volume，然后根据配置将其挂载到容器中

# docker volume ls 
DRIVER    VOLUME NAME
local     nextcloud_aio_mastercontainer

user

指定容器中运行应用的用户名。

compose.yaml

user: nginx

hostname

指定容器中主机名

compose.yaml

hostname: test

working_dir

指定容器中工作目录。

compose.yaml

working_dir: /code

restart

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

compose.yaml

restart: always

read_only

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

compose.yaml

read_only: true

读取变量

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

例如，下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值，并写入执行的指令中。

compose.yaml


services:

db:
  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 文件并写入以下内容。

# 支持 # 号注释
MONGO_VERSION=3.6

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

cap_add

cap_add 用来来为容器添加额外的权限，例如 NET_ADMIN 和 NET_RAW 等。

compose.yaml

version: '3.8'

services:
  my_service:
    image: ubuntu:24.04
    container_name: my_ubuntu_container
    cap_add:
      - NET_ADMIN
      - NET_RAW
    command: /bin/bash
    stdin_open: true # 允许交互式 shell
    tty: true # 保持终端打开

参考链接

Compose V2 beta
Docker 从入门到实践
 Docker Compose 指令官方文档

Compose v2

Compose 模板文件

compose.yaml 中的常用指令

name

include

build

image

command

entrypoint

container_name

depends_on

dns

dns_search

extra_hosts

environment

env_file

expose

healthcheck

labels

logging

networks

ports

sysctls

ulimits

volumes

将本地目录配置为 valume

user

hostname

working_dir

restart

read_only

读取变量

cap_add

参考链接

脚注