Docker 系列（九）：docker-compose
介绍
开发最常见的场景：我们要有数据库，应用代码，nginx，互相配合才是完整的环境。
docker 官方推荐每个 docker 容器中只运行一个进程，我们需要分别为我们的应用、数据库、nginx 创建单独的 docker 容器，然后分别启动它。
此时这几个 docker 是分散独立的，如果我们单独运行就需要分三次启动，很不方便管理。
既然这几个 docker 都是为了同一个网站服务，可以把这些容器组织到一起，这就引出了 docker-compose 项目。
Compose 项目是 Docker 官方的开源项目，使用 python 编写，实现上调用了 Docker 服务的 API 进行容器管理。 负责实现对 Docker 容器集群的快速编排。从功能上看，跟 OpenStack 中的 Heat 十分类似。 其代码目前在 https://github.com/docker/compose 上开源。 Compose 定位是 「定义和运行多个 Docker 容器的应用（Defining and running multi-container Docker applications）」，其前身是开源项目 Fig。
安装
默认情况下，windows 和 mac 下的 docker 已经自带了 docker-compose 工具，可以使用 `docker-compose -v` 命令查看。
对于 linux 系统，需要自己手动安装，可以直接下载二进制文件安装，也可以直接使用 pip 安装：
pip install docker-compose
查看版本
docker-compose -v
Docker Compose 常用命令与配置
常见命令
列出所有运行容器：docker-compose ps 查看nginx服务日志输出：docker-compose logs nginx 查看nginx服务的实时日志：docker-compose logs -f nginx 打印绑定的公共端口，下面命令可以输出 eureka 服务 8761 端口所绑定的公共端口：docker-compose port eureka 8761 构建或者重新构建服务：docker-compose build 启动指定服务已存在的容器：docker-compose start eureka 停止已运行的服务的容器：docker-compose stop eureka 删除指定服务的容器：docker-compose rm eureka 构建、启动容器：docker-compose up 通过发送 SIGKILL 信号来停止指定服务的容器：docker-compose kill eureka 暂停nignx容器：docker-compose pause nginx 恢复ningx容器：docker-compose unpause nginx 登录到nginx容器中：docker-compose exec nginx bash 以json的形式输出nginx的docker日志：docker-compose events --json nginx 设置指定服务运气容器的个数，以 service=num 形式指定：docker-compose scale user=3 movie=3 在一个服务上执行一个命令：docker-compose run web bash 验证（docker-compose.yml）文件配置，当配置正确时，不输出任何内容，当文件配置错误，输出错误信息：docker-compose config -q
docker-compose使用 YAML 文件对容器进行管理。
工程、服务、容器
- Docker Compose 将所管理的容器分为三层，分别是工程（project）、服务（service）、容器（container）。
- Docker Compose 运行目录下的所有文件（docker-compose.yml）组成一个工程,一个工程包含多个服务，每个服务中定义了容器运行的镜像、参数、依赖，一个服务可包括多个容器实例。
docker-compose.yml 属性
version：指定 docker-compose.yml 文件的写法格式
services：多个容器集合
app:定义服务名
build：配置构建时，Compose 会利用它自动构建镜像，该值可以是一个路径，也可以是一个对象，用于指定 Dockerfile 参数
command：覆盖容器启动后默认执行的命令
dns：配置 dns 服务器，可以是一个值或列表
dns_search：配置 DNS 搜索域，可以是一个值或列表
environment：环境变量配置，可以用数组或字典两种方式
env_file：从文件中获取环境变量，可以指定一个文件路径或路径列表，其优先级低于 environment 指定的环境变量
expose：暴露端口，只将端口暴露给连接的服务，而不暴露给主机
image：指定服务所使用的镜像
network_mode：设置网络模式
ports：对外暴露的端口定义，和 expose 对应
links：将指定容器连接到当前连接，可以设置别名，避免ip方式导致的容器重启动态改变的无法连接情况
volumes：卷挂载路径
logs：日志输出信息
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 - 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 。
一个部署实例
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
