简介

Compose 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。从功能上看，跟 OpenStack 中的Heat十分类似。Compose 定位是定义和运行多个 Docker 容器的应用。

通过Dockerfile模板文件，可以很方便的定义一个单独的应用容器，然而在日常工作中，经常会碰到需要多个容器相互配合的情况，而Compose 恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。

Compose 中有两个重要的概念：

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

Compose的默认管理对象是项目，通过子命令对项目中的一组容器进行便捷地生命周期管理。
Compose项目由 Python 编写，实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用 Compose 来进行编排管理。

Compose V2

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

安装与卸载

Docker Desktop for Mac/Windows 自带 docker-compose 二进制文件，安装 Docker 之后可以直接使用，Linux环境可以通过二进制包和Pip安装

  1. $ docker-compose --version
  3. docker-compose version 1.27.4, build 40524192

二进制包

  1. $ sudo curl -L https://github.com/docker/compose/releases/download/1.27.4/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
  3. # 国内用户可以使用以下方式加快下载
  4. $ sudo curl -L https://download.fastgit.org/docker/compose/releases/download/1.27.4/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
  6. $ sudo chmod +x /usr/local/bin/docker-compose

PIP安装

  1. $ sudo pip install -U docker-compose
  3. Collecting docker-compose
  4.   Downloading docker-compose-1.27.4.tar.gz (149kB): 149kB downloaded
  5. ...
  6. Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl-match-hostname ipaddress

bash补全命令

  1. $ curl -L https://raw.githubusercontent.com/docker/compose/1.27.4/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose

卸载

  1. $ sudo rm /usr/local/bin/docker-compose
  3. $ sudo pip uninstall docker-compose

使用

以flask框架的web应用为例，新建文件夹，在该目录中编写 app.py 文件。

  1. from flask import Flask
  2. from redis import Redis
  4. app = Flask(__name__)
  5. redis = Redis(host='redis', port=6379)
  7. @app.route('/')
  8. def hello():
  9.     count = redis.incr('hits')
  10.     return 'Hello World! 该页面已被访问 {} 次。\n'.format(count)
  12. if __name__ == "__main__":
  13.     app.run(host="0.0.0.0", debug=True)

Dockerfile

编写Dockerfile文件，内容为

  1. FROM python:3.6-alpine
  2. ADD . /code
  3. WORKDIR /code
  4. RUN pip install redis flask
  5. CMD ["python", "app.py"]

docker-compose.yml

编写 docker-compose.yml 文件，这个是 Compose 使用的主模板文件。

  1. version: '3'
  2. services:
  4.   web:
  5.     build: .
  6.     ports:
  7.      - "5000:5000"
  9.   redis:
  10.     image: "redis:alpine"

运行compose项目

  1. $ docker-compose up

Compose命令说明

命令对象与格式

对于 Compose 来说，大部分命令的对象既可以是项目本身，也可以指定为项目中的服务或者容器。如果没有特别的说明，命令对象将是项目，这意味着项目中所有的服务都会受到命令影响。
执行 docker-compose [COMMAND] —help 或者 docker-compose help [COMMAND] 可以查看具体某个命令的使用格式。
docker-compose 命令的基本的使用格式是

  1. docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]

命令选项 options

  • -f, —file FILE：指定使用的 Compose 模板文件，默认为 docker-compose.yml，可以多次指定。
  • -p, —project-name NAME：指定项目名称，默认将使用所在目录名称作为项目名。
  • —verbose：输出更多调试信息。
  • -v, —version：打印版本并退出。

命令使用说明 COMMAND

详见链接

命令 作用
build 构建（重新构建）项目中的服务容器，服务容器一旦构建后，将会带上一个标记名。可以随时在项目目录下运行 docker-compose build 来重新构建服务。
config 验证 Compose 文件格式是否正确，若正确则显示配置，若格式错误显示错误原因。
down 此命令将会停止 up 命令所启动的容器，并移除网络。
exec 进入指定的容器。
help 获得一个命令的帮助。
images 列出 Compose 文件中包含的镜像。
kill 通过发送 SIGKILL 信号来强制停止服务容器。
支持通过 -s 参数来指定发送的信号，例如docker-compose kill -s SIGINT发送SIGINT信号
logs 查看服务容器的输出。默认情况下，docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过 —no-color 来关闭颜色。
pause 暂停一个服务容器。
port 打印某个容器端口所映射的公共端口。
ps 列出项目中目前的所有容器。
pull 拉取服务依赖的镜像。
push 推送服务依赖的镜像到 Docker 镜像仓库。
restart 重启项目中的服务。
rm 删除所有（停止状态的）服务容器。推荐先执行 docker-compose stop 命令来停止容器。
run 在指定服务上执行一个命令。
scale 设置指定服务运行的容器个数。
start 启动已经存在的服务容器。
stop 停止已经处于运行状态的容器，但不删除它。通过 docker-compose start 可以再次启动这些容器。
top 查看各个服务容器内运行的进程。
unpause 恢复处于暂停状态中的服务。
up 自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作，链接的服务都将会被自动启动，除非已经处于运行状态，可以说，大部分时候都可以直接通过该命令来启动一个项目。

Compose模板文件

模板文件是使用 Compose 的核心，默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式。
注意：每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。
如果使用 build 指令，在 Dockerfile 中设置的选项(例如：CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取，无需在 docker-compose.yml 中重复设置。

build

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

  1. version: '3'
  2. services:
  4.   webapp:
  5.     build: ./dir

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

  1. version: '3'
  2. services:
  4.   webapp:
  5.     build:
  6.       context: ./dir
  7.       dockerfile: Dockerfile-alternate
  8.       args:
  9.         buildno: 1
  10.       cache_from:
  11.         - alpine:latest
  12.         - corp/web_app:3.14

cap_add, cap_drop

指定容器的内核能力（capacity）分配。（搜了一下大多数情况下貌似不需要配这玩意，先略过）

command

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

  1. command: echo "hello world"

configs

仅用于 Swarm mode。

cgroup_parent

指定父 cgroup 组，意味着将继承该组的资源限制。

  1. cgroup_parent: cgroups_1

container_name

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

  1. container_name: docker-web-container

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

deploy

仅用于Swarm mode。

devices

指定设备映射关系

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

depends_on

解决容器的依赖、启动先后的问题，以下例子会先启动redis、db再启动web，但注意，web服务不会等待redis和db完全启动后才启动。

  1. version: '3'
  3. services:
  4.   web:
  5.     build: .
  6.     depends_on:
  7.       - db
  8.       - redis
  10.   redis:
  11.     image: redis
  13.   db:
  14.     image: postgres

dns

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

  1. dns: 8.8.8.8
  3. dns:
  4.   - 8.8.8.8
  5.   - 114.114.114.114

dns_search

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

  1. dns_search: example.com
  3. dns_search:
  4.   - domain1.example.com
  5.   - domain2.example.com

tmpfs

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

  1. tmpfs: /run
  2. tmpfs:
  3.   - /run
  4.   - /tmp

env_file

从文件中获取环境变量，可以为单独的文件路径或列表。
如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。
如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

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

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

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

environment

设置环境变量。你可以使用数组或字典两种格式。
只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

  1. environment:
  2.   RACK_ENV: development
  3.   SESSION_SECRET:
  5. environment:
  6.   - RACK_ENV=development
  7.   - SESSION_SECRET

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

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

expose

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

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

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

healthcheck

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

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

image

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

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"

logging

配置日志选项。

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

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

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

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

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

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]"

networks

配置容器连接的网络。

  1. version: "3"
  2. services:
  4.   some-service:
  5.     networks:
  6.      - some-network
  7.      - other-network
  9. networks:
  10.   some-network:
  11.   other-network:

pid

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

  1. pid: "host"

ports

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

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

secrets

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

  1. version: "3.1"
  2. services:
  4. mysql:
  5.   image: mysql
  6.   environment:
  7.     MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  8.   secrets:
  9.     - db_root_password
  10.     - my_other_secret
  12. secrets:
  13.   my_secret:
  14.     file: ./my_secret.txt
  15.   my_other_secret:
  16.     external: true

security_opt

为每个容器覆盖默认的标签。简单说来就是管理全部服务的标签。比如设置全部服务的user标签值为USER。（原文实在太牛马了，很难懂）

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

stop_signal

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

  1. stop_signal: SIGUSR1

sysctls

配置容器内核参数

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

ulimits

指定容器的 ulimits 限制值。

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

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

volumes

挂载一个目录或者一个已存在的数据卷容器，可以直接使用 [HOST:CONTAINER] 这样的格式，或者使用 [HOST:CONTAINER:ro] 这样的格式，后者对于容器来说，数据卷是只读的，这样可以有效保护宿主机的文件系统。Compose的数据卷指定路径可以是相对路径，使用 . 或者 .. 来指定相对目录。
数据卷的格式可以是下面多种形式：

  1. volumes:
  2.   // 只是指定一个路径，Docker 会自动在创建一个数据卷（这个路径是容器内部的）。
  3.   - /var/lib/mysql
  5.   // 使用绝对路径挂载数据卷
  6.   - /opt/data:/var/lib/mysql
  8.   // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器。
  9.   - ./cache:/tmp/cache
  11.   // 使用用户的相对路径（~/ 表示的目录是 /home/<用户目录>/ 或者 /root/）。
  12.   - ~/configs:/etc/configs/:ro
  14.   // 已经存在的命名的数据卷。
  15.   - datavolume:/var/lib/mysql

参考文献

Docker Compose 配置文件详解 https://www.jianshu.com/p/2217cfed29d7