Docker-Compose 是什么？

Docker-Compose 项目是 Docker 官方的开源项目，负责实现对 Docker 容器集群的快速编排。Docker-Compose 的工程配置文件名是默认为 docker-compose.yml 的，在整个文件中，我们可以通过环境变量 COMPOSE_FILE 或者 -f参数来对配置进行定义。我们可以看一个很简单的 docker-compose.yml 的配置文件：

couchdb:
    container_name: couchdb
    image: hyperledger/fabric-couchdb
    # Populate the COUCHDB_USER and COUCHDB_PASSWORD to set an admin user and password
    # for CouchDB.  This will prevent CouchDB from operating in an "Admin Party" mode.
    environment:
      - COUCHDB_USER=
      - COUCHDB_PASSWORD=
    # Comment/Uncomment the port mapping if you want to hide/expose the CouchDB service,
    # for example map it to utilize Fauxton User Interface in dev environments.
    ports:
      - "5984:5984"

这就是一个通过 docker-compose.yml 配置实现 CouchDB 在 Docker 中运行的配置实例。

Docker-Compose 是用 Python 来编写的，我们可以通过 pip 命令进行对 Docker-Compose 的安装，之后就调用Docker服务提供的API来对容器进行管理。因此，只要所操作的平台支持Docker API，就可以在其上利用Compose来进行编排管理。

Docker-Compose 怎么用？

具体的安装过程，因为种类繁多，而且可以很容易的找到，因此在这里不过多说明。但是在 Windows 中使用时，一定要保证 Windows 是可以安装 Docker 的。我们具体要说的是关于 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 启动格式

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
在后台所有启动服务--需要在后台使用时可以通过添加 -d 来后台启动
-f 指定使用的 Compose 模板文件，默认为docker-compose.yml，可以多次指定。

3、Docker-Compose 查看格式

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

这条命令与 Docker 中查看容器的命令基本功能和方法是一样的。一般我们使用的是 docker-compose ps。

4、Docker-Compose 终止格式

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

选项包括：

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

我们在执行 stop 命令之后，是需要通过 docker-compose start 来启动的，而不是刚才我们所讲的 up 命令。

5、Docker-Compose 停止格式

docker-compose down [options]

选项包括：

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

6、Docker-Compose 日志格式

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

默认情况下使用 docker-compose logs来查看服务容器的输出，或者我们可以通过指定 --no-color来关闭颜色。

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

8、Docker-Compose pull

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

选项包括：

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

9、Docker-Compose restart

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

选项包括：

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

10、Docker-Compose start

docker-compose start [SERVICE...]

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

11、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命令。

12、Docker-Compose scale

docker-compose scale web=3 db=2

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

13、Docker-Compose pause

docker-compose pause [SERVICE...]

暂停一个服务容器。

14、Docker-Compose rm

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

选项包括：

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

15、Docker-Compose kill

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

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

16、Docker-Compose config

docker-compose [options]

验证并查看 compose 配置文件。

选项包括：

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

17、Docker-Compose create

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

选项包括：

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

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

19、Docker-Compose port

docker-compose port [options] SERVICE PRIVATE_PORT

选项包括：

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

20、Docker-Compose push

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

选项包括：

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

21、Docker-Compose unpause

docker-compose unpause [SERVICE...]

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

22、Docker-Compose version

docker-compose version

用于打印版本信息。

Docker-Compose 怎么写？

Docker-Compose标准模板文件应该包含version、services、networks 三大部分，最关键的是services和networks两个部分。我们想要实现对其的配置，就要通过 docker-compose.yml 来实现。

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

image

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

image: dockercloud/hello-world

build

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

build: /path/to/build/dir
也可以是相对路径，只要上下文确定就可以读取到Dockerfile。
build: ./dir
设定上下文根目录，然后以该目录为准指定Dockerfile。

context

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

build:
 context: ./dir

dockerfile

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

build:
 context: ./dir
 dockerfile: Dokcerfile-alternate

command

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

command:
 bundle exec thin -p 3000

container_name

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

container_name:
 app

depends_on

depends_on:
 - couchdb
 - redis

这里就是代替启动命令的执行内容，一般按照顺序来执行。例如上面这个语句，执行的就是 couchdb 和 redis 两个服务。

ports

ports用于映射端口的标签。

ports:
 - "3000:3000"

extra_hosts

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

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

volumes

挂载一个目录或者一个已存在的数据卷容器

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

dns

dns: 8.8.8.8
dns:
 - 8.8.8.8

自定义一个 dns 服务器。

dns_search

dns_search: example.com
dns_search:
 - domin1.example.com
 - domin2.example.com

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

entrypoint

定义接入点，覆盖 Dockerfile 中的定义：

entrypoint: /code/entrypoint.sh

env_file

定义一个专门存放变量的文件：

env_file:
 - ./common.env
 - ./apps/web.env
 - /opt/secrets.env

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

cap_add

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

cap_add:
 - ALL

cap_drop

与上面一条命令相反，去掉指定容器的内核能力（capacity）：

cap_drop:
 - NET_ADMIN

cgroup_parent

创建一个 cgroup 组：

cgroup_parent: cgroups_1

devices

指定设备映射关系：

devices:
 - "/dev/ttyUSB1:/DEV/ttyUSB0"

expose

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

expose:
 - "3000"
 - "8000"

extends

基于其他模板文件进行扩展：

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服务及环境变量定义。

external_links

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

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

label

为容器添加元数据信息：

labels:
 com.startupteam.description: "webapp for a startup team"

links

链接到其它服务中的容器：

links:
 - db
 - db:database
 - redis

log_driver

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

log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

log_opt

日志驱动的相关参数：

log_driver: "syslog"
log_opt: 
 syslog-address: "tcp://192.168.0.42:8080"

net

设置网络格式：

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

security_opt

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

security_opt:
 - label:user:USER
 - label:role:ROLE

参考：https://blog.51cto.com/9291927/2310444