Docker-Compose简介、安装及常用命令

1、简介

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 来进行编排管理。

2、Docker-Compose安装

下载Docker-Compose文件包

https://github.com/docker/compose/releases/download/v2.2.0/docker-compose-linux-x86_64

将下载的包用xftp或winscp传到linux，也可以简单粗暴的从文件夹拖到虚拟机linux中

添加可执行权限

sudo chmod +x /usr/local/bin/docker-compose

 测试安装结果

docker-compose version

3、常用命令

二、 Docker-Compose 常用命令

1 、 Docker-Compose 命令格式

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

命令选项如下：

-f ， –file FILE 指定 Compose 模板文件，默认为 docker-compose.yml ，可以多次指定。

-p ， –project-name NAME 指定项目名称，默认将使用所在目录名称作为项目名。

-x-network-driver 使用 Docker 的可拔插网络后端特性（需要 Docker 1.9+ 版本）

-x-network-driver DRIVER 指定网络后端的驱动，默认为 bridge （需要 Docker 1.9+ 版本）

-verbose 输出更多调试信息

-v ， –version 打印版本并退出

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 文件中定义的容器

–scale SERVICE=NUM 设置服务运行容器的个数，将覆盖在 compose 中通过 scale 指定的参数

docker-compose up

启动所有服务

docker-compose up -d

在后台所有启动服务

-f 指定使用的 Compose 模板文件，默认为 docker-compose.yml ，可以多次指定。

docker-compose -f docker-compose.yml up -d

3 、 docker-compose ps

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

docker-compose ps

列出项目中目前的所有容器

4 、 docker-compose stop

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

选项包括：

-t, –timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）

docker-compose stop

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

5 、 docker-compose -h

docker-compose -h

查看帮助

6 、 docker-compose down

docker-compose down [options]

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

选项包括：

–rmi type ，删除镜像，类型必须是： all ，删除 compose 文件中定义的所有镜像； local ，删除镜像名为空的镜像

-v, –volumes ，删除已经在 compose 文件中定义的和匿名的附在容器上的数据卷

–remove-orphans ，删除服务中没有在 compose 中定义的容器

docker-compose down

停用移除所有容器以及网络相关

7 、 docker-compose logs

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

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

no-color 来关闭颜色。

docker-compose logs

查看服务容器的输出

8 、 docker-compose build

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 来重新构建服务

9 、 docker-compose pull

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

拉取服务依赖的镜像。

选项包括：

–ignore-pull-failures ，忽略拉取镜像过程中的错误

–parallel ，多个镜像同时拉取

–quiet ，拉取镜像过程中不打印进度信息

docker-compose pull

拉取服务依赖的镜像

10 、 docker-compose restart

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

重启项目中的服务。

选项包括：

-t, –timeout TIMEOUT ，指定重启前停止容器的超时（默认为 10 秒）

docker-compose restart

重启项目中的服务

11 、 docker-compose rm

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

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

选项包括：

–f, –force ，强制直接删除，包括非停止状态的容器

-v ，删除容器所挂载的数据卷

docker-compose rm

删除所有（停止状态的）服务容器。推荐先执行 docker-compose stop 命令来停止容器。

12 、 docker-compose start

docker-compose start [SERVICE...]

docker-compose start

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

13 、 docker-compose run

docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND]

[ARGS...]

在指定服务上执行一个命令。

docker-compose run ubuntu ping www.baidu.com

在指定容器上执行一个 ping 命令。

14 、 docker-compose scale

docker-compose scale web=3 db=2

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

15 、 docker-compose pause

docker-compose pause [SERVICE...]

暂停一个服务容器

16 、 docker-compose kill

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

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

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

docker-compose kill -s SIGINT

17 、 dokcer-compose config

docker-compose config [options]

验证并查看 compose 文件配置。

选项包括：

–resolve-image-digests 将镜像标签标记为摘要

-q, –quiet 只验证配置，不输出。 当配置正确时，不输出任何内容，当文件配置错误，输出错误信息

–services 打印服务名，一行一个

–volumes 打印数据卷名，一行一个

18、docker-compose create

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

为服务创建容器。

选项包括：

–force-recreate ：重新创建容器，即使配置和镜像没有改变，不兼容 –no-recreate 参数

–no-recreate ：如果容器已经存在，不需要重新创建，不兼容 –force-recreate 参数

–no-build ：不创建镜像，即使缺失

–build ：创建容器前，生成镜像

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 服务中包含多个容器

20 、 docker-compose port

docker-compose port [options] SERVICE PRIVATE_PORT

显示某个容器端口所映射的公共端口。

选项包括：

–protocol=proto ，指定端口协议， TCP （默认值）或者 UDP

–index=index ，如果同意服务存在多个容器，指定命令对象容器的序号（默认为 1 ）

21 、 docker-compose push

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

推送服务依的镜像。

选项包括：

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

22 、 docker-compose stop

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

显示各个容器运行的进程情况。

23 、 docker-compose unpause

docker-compose unpause [SERVICE...]

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

24 、 docker-compose version

docker-compose version

打印版本信息。

三、 Docker-Compose 模板文件

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: '2'

services:

web:

image: dockercloud/hello-world

ports:

- 8080

networks:

- front-tier

- back-tier

redis:

image: redis

links:

- web

networks:

- back-tier lb:

image: dockercloud/haproxy

ports:

- 80:80

links:

- web

networks:

- front-tier

- back-tier

volumes:

- /var/run/docker.sock:/var/run/docker.sock

networks:

front-tier:

driver: bridge

back-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 将来会被弃用。

2 、 image

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

services:

web:

image: hello-world

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 值指定的名字。

4 、 context

context 选项可以是 Dockerfile 的文件路径，也可以是到链接到 git 仓库的 url ，当提供的值是相对路径时，被解析为

相对于撰写文件的路径，此目录也是发送到 Docker 守护进程的 context

build:

context: ./dir

5 、 dockerfile

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

build:

context: .

dockerfile: Dockerfile-alternate

dockerfile 指令不能跟 image 同时使用，否则 Compose 将不确定根据哪个指令来生成最终的服务镜像。

6 、 command

使用 command 可以覆盖容器启动后默认执行的命令。

command: bundle exec thin -p 3000

7 、 container_name

Compose 的容器名称格式是： < 项目名称 >< 服务名称 >< 序号 >

可以自定义项目名称、服务名称，但如果想完全控制容器的命名，可以使用标签指定：

container_name: app

8 、 depends_on

在使用 Compose 时，最大的好处就是少打启动命令，但一般项目容器启动的顺序是有要求的，如果直接从上到下

启动容器，必然会因为容器依赖问题而启动失败。例如在没启动数据库容器的时候启动应用容器，应用容器会因

为找不到数据库而退出。 depends_on 标签用于解决容器的依赖、启动先后的问题。 version: '2'

services:

web:

build: .

depends_on:

- db

- redis

redis:

image: redis

db:

image: postgres

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

9 、 pid

pid: "host"

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

宿主机的名称空间。

10 、 ports

ports 用于映射端口的标签。

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

ports:

- "3000"

- "8000 :8000"

- "49100 :22"

- "127.0.0.1 :8001:8001"

当使用 HOST:CONTAINER 格式来映射端口时，如果使用的容器端口小于 60 可能会得到错误得结果，因为 YAML

将会解析 xx:yy 这种数字格式为 60 进制。所以建议采用字符串格式。

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

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 。

volume_driver: mydriver

13 、 volumes_from

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

volumes_from:

- service_name

- container_name

14 、 dns

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

dns：

- 8.8.8.8

- 9.9.9.9

15 、 dns_search

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

dns_search：example.com

dns_search：

- domain1.example.com

- domain2.example.com

16 、 entrypoint

在 Dockerfile 中有一个指令叫做 ENTRYPOINT 指令，用于指定接入点。

在 docker-compose.yml 中可以定义接入点，覆盖 Dockerfile 中的定义：

entrypoint: /code/entrypoint.sh

17 、 env_file

在 docker-compose.yml 中可以定义一个专门存放变量的文件。

如果通过 docker-compose -f FILE 指定配置文件，则 env_file 中路径会使用配置文件路径。

如果有变量名称与 environment 指令冲突，则以后者为准。格式如下：

env_file: .env

或者根据 docker-compose.yml 设置多个：

env_file:

- ./common.env

- ./apps/web.env

- /opt/secrets.env

如果在配置文件中有 build 操作，变量并不会进入构建过程中。

18 、 cap_add

增加指定容器的内核能力（ capacity ）。

让容器具有所有能力可以指定：

cap_add:

- ALL

19 、 cap_drop

去掉指定容器的内核能力（ capacity ）。

去掉 NET_ADMIN 能力可以指定：

cap_drop:

- NET_ADMIN

20 、 cgroup_parent

创建了一个 cgroup 组名称为 cgroups_1:

cgroup_parent: cgroups_1

21 、 devices

指定设备映射关系，例如：

devices:

- "/dev/ttyUSB1:/dev/ttyUSB0"

22 、 expose

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

expose:

- "3000"

- "8000"

23 、 extends

基于其它模板文件进行扩展。例如，对于 webapp 服务定义了一个基础模板文件为 common.yml ：

# common.yml

webapp:

build: ./webapp

environment:

- DEBUG= false

- SEND_EMAILS=false

再编写一个新的 development.yml 文件，使用 common.yml 中的 webapp 服务进行扩展： # development.yml

web:

extends:

file: common.yml

service: webapp

ports:

- "8000:8000"

links:

- db

environment:

- DEBUG=true

db:

image: mysql

后者会自动继承 common.yml 中的 webapp 服务及环境变量定义。

extends 限制如下：

A 、要避免出现循环依赖

B 、 extends 不会继承 links 和 volumes_from 中定义的容器和数据卷资源

推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信

息

24 、 external_links

链接到 docker-compose.yml 外部的容器，可以是非 Compose 管理的外部容器。

external_links:

- redis_1

- project_db_1 :mysql

- project_db_1 :postgresql

25 、 labels

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

labels：

com.startupteam.description: "webapp for a strtup team"

26 、 links

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

SERVICE:ALIAS ），例如：

links:

- db

- db :database

- redis

使用别名将会自动在服务容器中的 /etc/hosts 里创建。例如：

172.17.2.186 db

172.17.2.186 database

172.17.2.187 redis

27 、 log_driver

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

log_driver: "json-file"

log_driver: "syslog"

log_driver: "none"

28 、 log_opt

日志驱动的相关参数。例如：

log_driver: "syslog"log_opt:

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

29 、 net

设置网络模式。

net: "bridge"

net: "none"

net: "host"

30 、 security_opt

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

名：

security_opt:

- label :user:USER 0

0

- label :role:ROLE

31 、环境变量

环境变量可以用来配置 Docker-Compose 的行为。

COMPOSE_PROJECT_NAME

设置通过 Compose 启动的每一个容器前添加的项目名称，默认是当前工作目录的名字。

COMPOSE_FILE

设置 docker-compose.yml 模板文件的路径。默认路径是当前工作目录。

DOCKER_HOST

设置 Docker daemon 的地址。默认使用 unix:///var/run/docker.sock 。 DOCKER_TLS_VERIFY

如果设置不为空，则与 Docker daemon 交互通过 TLS 进行。

DOCKER_CERT_PATH

配置 TLS 通信所需要的验证 (ca.pem 、 cert.pem 和 key.pem) 文件的路径，默认是 ~/.docker 。

四、 Docker-Compose 模板文件示例

1 、 docker-compose 模板文件编写

docker-compose.yaml 文件如下：

version: '2'

services:

web1:

image: nginx

ports:

- "6061:80"

container_name: "web1"

networks:

- dev

web2:

image: nginx

ports:

- "6062:80"

container_name: "web2"

networks:

- dev

- pro

web3:

image: nginx

ports:

- "6063:80"

container_name: "web3"

networks:

- pro

networks:

dev:

driver: bridge

pro:

driver: bridge

#volumes:

docker-compose.yaml 文件指定了三个 web 服务。

2 、启动应用

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

docker-compose up -d

3 、服务访问

通过浏览器访问 web1 ， web2 ， web3 服务 :

http://127.0.0.1:6061

http://127.0.0.1:6062

http://127.0.0.1:6063