Docker 系列之 docker-compose 容器编排详解

---

前言

微服务架构 的应用系统一般包含若干个微服务，每个微服务一般都会部署多个实例，如果每个微服务都要手动启停，那么效率之低，维护量之大可想而知。
使用 Docker Compose 可以轻松、高效的管理容器，它是一个用于定义和运行多容器 Docker 的应用程序工具

---

一、Docker-compose简介

Docker-Compose 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。 Docker-Compose 将所管理的容器分为三层，分别是工程（project），服务（service）以及容器（container）。

Docker-Compose 运行目录下的所有文件（docker-compose.yml，extends文件或环境变量文件等）组成一个工程，若无特殊指定工程名即为当前目录名。一个工程当中可包含多个服务，每个服务中定义了容器运行的镜像，参数，依赖。一个服务当中可包括多个容器实例，Docker-Compose 并没有解决负载均衡的问题，因此需要借助其它工具实现服务发现及负载均衡。

Docker-Compose的工程配置文件默认为 docker-compose.yml ，可通过环境变量 COMPOSE_FILE 或 -f 参数自定义配置文件，其定义了多个有依赖关系的服务及每个服务运行的容器。 使用一个 Dockerfile 模板文件，可以让用户很方便的定义一个单独的应用容器。

在工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。 Compose 允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。 Docker-Compose 项目由 Python 编写，调用 Docker 服务提供的API来对容器进行管理。因此，只要所操作的平台支持Docker API，就可以在其上利用 Compose 来进行编排管理。

二、Docker-compose 的安装

安装 Docker Compose 可以通过下面命令自动下载适应版本的 Compose，并为安装脚本添加执行权限。

sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

查看安装是否成功

docker-compose -v

三、Docker-compose卸载

apt-get remove docker-compose

四、Docker-compose常用命令

4.1 Docker-compose命令格式

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

命令选项如下：

-f --file FILE指定Compose模板文件，默认为docker-compose.yml
-p --project-name NAME 指定项目名称，默认使用当前所在目录为项目名
–verbose 输出更多调试信息
-v，-version 打印版本并退出
–log-level LEVEL 定义日志等级(DEBUG, INFO, WARNING, ERROR, CRITICAL)

4.2 docker-compose up

docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]

选项包括：

-d 在后台运行服务容器
-no-color 不是有颜色来区分不同的服务的控制输出
-no-deps 不启动服务所链接的容器
–force-recreate 强制重新创建容器，不能与-no-recreate同时使用
–no-recreate 如果容器已经存在，则不重新创建，不能与–force-recreate同时使用
–no-build 不自动构建缺失的服务镜像
–build 在启动容器前构建服务镜像
–abort-on-container-exit 停止所有容器，如果任何一个容器被停止，不能与-d同时使用
-t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
–remove-orphans 删除服务中没有在compose文件中定义的容器

4.3 docker-compose ps

列出项目中所有在运行的容器

docker-compose  ps [options] [SERVICE...]

4.4 docker-compose stop

停止正在运行的容器，可以通过 docker-compose start 再次启动

docker-compose stop [options] [SERVICE...]
选项包括
-t, –timeout TIMEOUT 停止容器时候的超时（默认为10秒）
docker-compose stop

4.5 docker-compose -h

查看帮助

docker-compose -h

4.6 docker-compose down

停止和删除容器、网络、卷、镜像。

docker-compose down [options]

选项包括：

–rmi type，删除镜像，类型必须是：all，删除compose文件中定义的所有镜像；local，删除镜像名为空的镜像
-v, –volumes，删除已经在compose文件中定义的和匿名的附在容器上的数据卷
–remove-orphans，删除服务中没有在compose中定义的容器
docker-compose down
停用移除所有容器以及网络相关

4.7 docker-compose logs

查看服务容器的输出。默认情况下，docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过–no-color 来关闭颜色。

docker-compose logs [options] [SERVICE...]

docker-compose logs
查看服务容器的输出
-f 跟踪日志输出

4.8 docker-compose bulid

构建（重新构建）项目中的服务容器。

docker-compose build [options] [--build-arg key=val...] [SERVICE...]

选项包括：

–compress 通过gzip压缩构建上下环境
–force-rm 删除构建过程中的临时容器
–no-cache 构建镜像过程中不使用缓存
–pull 始终尝试通过拉取操作来获取更新版本的镜像
-m, –memory MEM为构建的容器设置内存大小
–build-arg key=val为服务设置build-time变量
服务容器一旦构建后，将会带上一个标记名。可以随时在项目目录下运行docker-compose build来重新构建服务。

4.9 docker-compose pull

拉取服务依赖的镜像。

docker-compose pull [options] [SERVICE...]

选项包括：

–ignore-pull-failures，忽略拉取镜像过程中的错误
–parallel，多个镜像同时拉取
–quiet，拉取镜像过程中不打印进度信息
docker-compose pull
拉取服务依赖的镜像

4.10 docker-compose restart

重启项目中的服务。

docker-compose restart [options] [SERVICE...]

选项包括：

-t, –timeout TIMEOUT，指定重启前停止容器的超时（默认为10秒）
docker-compose restart
重启项目中的服务

4.11 docker-compose rm

删除所有（停止状态的）服务容器。

docker-compose rm [options] [SERVICE...]

选项包括：

–f, –force，强制直接删除，包括非停止状态的容器
-v，删除容器所挂载的数据卷
docker-compose rm
删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。

4.12 docker-compose start

启动已经存在的服务容器。

docker-compose start [SERVICE...]
docker-compose start

4.13 docker-compose run

docker compose run 命令用于启动一个新容器并运行一个特定的服务，而不启动整个 Compose 文件中定义的所有服务。

docker compose run 命令允许你在单个服务上执行任务，如运行一次性命令或调试。

🆚与 docker compose up 的区别在于，run 命令只会运行指定的服务，不会启动依赖它的其他服务。

docker compose run [OPTIONS] SERVICE [COMMAND] [ARGS...]
#SERVICE：Compose 文件中定义的服务名称。
#COMMAND 和 ARGS：可选参数，指定要在容器内运行的命令及其参数。

常用参数

–rm：运行后自动删除容器。
-d：以分离模式运行容器。
-T：禁用伪TTY。

实例
1、运行一个特定服务的命令

docker compose run web python manage.py migrate

这个命令将在 web 服务的容器中执行 python manage.py migrate 命令，而不启动其他服务。

2、自动删除容器

docker compose run --rm web bash

这个命令会运行 web 服务并启动一个 Bash 终端，任务完成后会删除容器。

docker compose run 非常适合用来在服务中执行一次性任务，而不影响其他服务的运行。

4.14 docker-compose scale

设置指定服务运行的容器个数。通过 service=num 的参数来设置数量

docker-compose scale web=3 db=2

4.15 docker-compose pause

暂停一个服务容器

docker-compose pause [SERVICE...]

4.16 docker-compose kill

通过发送SIGKILL信号来强制停止服务容器。

docker-compose kill [options] [SERVICE...]

支持通过-s参数来指定发送的信号，例如通过如下指令发送SIGINT信号：
docker-compose kill -s SIGINT

4.17 docker-compose config

验证并查看compose文件配置。

docker-compose config [options]

选项包括：

–resolve-image-digests 将镜像标签标记为摘要
-q, –quiet 只验证配置，不输出。 当配置正确时，不输出任何内容，当文件配置错误，输出错误信息
–services 打印服务名，一行一个
–volumes 打印数据卷名，一行一个

4.18 docker-compose create

为服务创建容器。

docker-compose create [options] [SERVICE...]

选项包括：

–force-recreate：重新创建容器，即使配置和镜像没有改变，不兼容–no-recreate参数
–no-recreate：如果容器已经存在，不需要重新创建，不兼容–force-recreate参数
–no-build：不创建镜像，即使缺失
–build：创建容器前　　，生成镜像

4.19 docker-compose exec

docker-compose exec [options] SERVICE COMMAND [ARGS...]

选项包括：

-d 分离模式，后台运行命令。
–privileged 获取特权。
–user USER 指定运行的用户。
-T 禁用分配TTY，默认docker-compose exec分配TTY。
–index=index，当一个服务拥有多个容器时，可通过该参数登陆到该服务下的任何服务，例如：docker-compose exec –index=1 web /bin/bash ，web服务中包含多个容器

4.20 docker-compose port

显示某个容器端口所映射的公共端口。
docker-compose port [options] SERVICE PRIVATE_PORT

选项包括：

–protocol=proto，指定端口协议，TCP（默认值）或者UDP
–index=index，如果同意服务存在多个容器，指定命令对象容器的序号（默认为1）

4.21 docker-compose push

推送服务依的镜像。

docker-compose push [options] [SERVICE...]

选项包括：

–ignore-push-failures 忽略推送镜像过程中的错误

4.22 docker-compose stop

停止运行的容器

docker-compose stop [options] [SERVICE...]

4.23 docker-compose uppause

恢复处于暂停状态中的服务。

docker-compose unpause [SERVICE...]

五、Docker-compose模板文件

5.1 Docker-compose模板文件简介

Compose 允许用户通过一个 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。 Compose 模板文件是一个定义服务、网络和卷的YAML文件。Compose 模板文件默认路径是当前目录下的 docker-compose.yml，可以使用 .yml 或 .yaml 作为文件扩展名。
Docker-Compose 标准模板文件应该包含 version、services、networks 三大部分，最关键的是 services 和networks 两个部分。

🌰举个栗子

version: '3'
services:web:image: dockercloud/hello-worldports:- 8080networks:- front-tier- back-tierredis:image: redislinks:- webnetworks:- back-tierlb:image: dockercloud/haproxyports:- 80:80links:- webnetworks:- front-tier- back-tiervolumes:- /var/run/docker.sock:/var/run/docker.sock networks:front-tier:driver: bridgeback-tier:driver: bridge

Compose 目前有三个版本分别为Version 1，Version 2，Version 3，Compose区分Version 1和Version 2（Compose 1.6.0+，Docker Engine 1.10.0+）。Version 2支持更多的指令。Version 1将来会被弃用。

5.2 image

image 是指定服务的镜像名称或镜像ID。如果镜像在本地不存在，Compose 将会尝试拉取镜像。

services: web: image: hello-world

5.3 build

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

build: /path/to/build/dir

也可以是相对路径，只要上下文确定就可以读取到 Dockerfile。

build: ./dir

设定上下文根目录，然后以该目录为准指定 Dockerfile。

build:context: ../dockerfile: path/of/Dockerfile

build 都是一个目录，如果要指定 Dockerfile 文件需要在build标签的子级标签中使用 dockerfile 标签指定。 如果同时指定 image 和 build 两个标签，那么 Compose 会构建镜像并且把镜像命名为 image 值指定的名字。

5.4 context

context 选项可以是 Dockerfile 的文件路径，也可以是到链接到 git 仓库的 url，当提供的值是相对路径时，被解析为相对于撰写文件的路径，此目录也是发送到 Docker 守护进程的 context。

build:context: ./dir

5.5 dockerfile

使用 dockerfile 文件来构建，必须指定构建路径。

build:context: .dockerfile: Dockerfile-alternate

5.6 commond

command: bundle exec thin -p 3000

5.7 container_name

Compose 的容器名称格式是：<项目名称><服务名称><序号>
可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：

container_name: app

5.8 depends_on

在使用 Compose 时，最大的好处就是少打启动命令，但一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败。例如在没启动数据库容器的时候启动应用容器，应用容器会因为找不到数据库而退出。depends_on标签用于解决容器的依赖、启动先后的问题

version: '2'
services:web:build: .depends_on:- db- redisredis:image: redisdb:image: postgres

上述YAML文件定义的容器会先启动 redis 和 db 两个服务，最后才启动 web 服务。

5.9 PID

pid: "host"

将 PID 模式设置为主机 PID 模式，跟主机系统共享进程命名空间。容器使用 pid 标签将能够访问和操纵其他容器和宿主机的名称空间。

5.10 ports

ports 用于映射端口的标签。　
使用 HOST:CONTAINER 格式或者只是指定容器的端口，宿主机会随机映射端口。

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

当使用 HOST:CONTAINER 格式来映射端口时，如果使用的容器端口小于60可能会得到错误得结果，因为YAML将会解析xx:yy这种数字格式为60进制。所以建议采用字符串格式。

5.11 extra_hosts

添加主机名的标签，会在 /etc/hosts 文件中添加一些记录。

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

启动后查看容器内部 hosts：

162.242.195.82  somehost
50.31.209.229   otherhost

5.12 volumes

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

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

如果不使用宿主机的路径，可以指定一个 volume_driver。

5.13 volumes_from

从另一个服务或容器挂载其数据卷：

volumes_from:- service_name    - container_name

5.14 dns

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

dns：8.8.8.8
dns：- 8.8.8.8    - 9.9.9.9

5.15 expose

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

expose:- "3000"- "8000"

5.16 links

链接到其它服务中的容器。使用服务名称（同时作为别名），或者服务名称:服务别名（如 SERVICE:ALIAS），例如

links:- db- db:database- redis

5.17 net

设置网络模式。

net: "bridge"
net: "none"
net: "host"

六、Docker-compose模板文件示例

6.1 Docker-compose模板文件编写

📃docker-compose.yml

version: '2'
services:web1:image: nginxports: - "6061:80"container_name: "web1"networks:- devweb2:image: nginxports: - "6062:80"container_name: "web2"networks:- dev- proweb3:image: nginxports: - "6063:80"container_name: "web3"networks:- pro
networks:dev:driver: bridgepro:driver: bridge

docker-compose.yml 文件指定了3个web服务

6.2 启动应用

创建一个 webapp 目录，将 docker-compose.yaml 文件拷贝到 webapp 目录下，使用 docker-compose 启动应用。

docker-compose up -d

6.3 服务访问

通过浏览器访问web1，web2，web3

http://127.0.0.1:6061
http://127.0.0.1:6062
http://127.0.0.1:6063

七、总结

Compose 是用于定义和运行多容器 Docker 应用程序的工具。通过 Compose，您可以使用 YML 文件来配置应用程序需要的所有服务。然后，使用一个命令，就可以从 YML 文件配置中创建并启动所有服务。.Docker Compose 可以基于Compose 文件帮我们快速的部署分布式应用，而无需手动一个个创建和运行容器,Compose 文件是一个文本文件，通过指令定义集群中的每个容器如何运行。