Docker 学习之六：Docker Compose

Docker Compose 是 Docker 官方编排（Orchestration）项目之一，负责快速的部署分布式应用。

####概念和背景
我们知道使用一个 Dockerfile 模板文件，可以让用户很方便的定义一个单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web 服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。

Compose 恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。

docker compose 在windows和mac中的安装包中已存在。linux 需要安装

几个术语

服务 (service)：一个应用容器，实际上可以运行多个相同镜像的实例。
项目 (project)：由一组关联的应用容器组成的一个完整业务单元。
可见，一个项目可以由多个服务（容器）关联而成，Compose 面向项目进行管理。

compose 命令对象和格式

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

命令选项

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

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

–x-networking 使用 Docker 的可拔插网络后端特性

–x-network-driver DRIVER 指定网络后端的驱动，默认为 bridge

–verbose 输出更多调试信息。

-v, –version 打印版本并退出。

compose 的一些命令

build

docker-compose build [options] [SERVICE...]          构建（重新构建）项目中的服务容器。

选项
–force-rm 删除构建过程中的临时容器。

–no-cache 构建镜像过程中不使用 cache（这将加长构建过程）。

–pull 始终尝试通过 pull 来获取更新版本的镜像。

config

验证 Compose 文件格式是否正确，若正确则显示配置，若格式错误显示错误原因

down

此命令将会停止 up 命令所启动的容器，并移除网络。

exec

进入指定的容器。

help

获得一个命令的帮助。

images

列出 Compose 文件中包含的镜像。

kill

docker-compose kill [options] [SERVICE...]     通过发送 SIGKILL 信号来强制停止服务容器。

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

logs

docker-compose logs [options] [SERVICE...]        查看服务容器的输出

pause

docker-compose pause [SERVICE...]           暂停一个服务容器。

port

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

选项：

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

ps

docker-compose ps [options] [SERVICE...]  列出项目中目前的所有容器。

选项：
-q 只打印容器的 ID 信息。

pull

docker-compose pull [options] [SERVICE...]  拉取服务依赖的镜像。

选项：
–ignore-pull-failures 忽略拉取镜像过程中的错误。

push

推送服务依赖的镜像到 Docker 镜像仓库。

restart

docker-compose restart [options] [SERVICE...]        重启项目中的服务。

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

rm

docker-compose rm [options] [SERVICE...]        删除所有（停止状态的）服务容器。

推荐先执行 docker-compose stop 命令来停止容器。
选项：
-f, –force 强制直接删除，包括非停止状态的容器。一般尽量不要使用该选项。
-v 删除容器所挂载的数据卷。

run

docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]        在指定服务上执行一个命令。

如果存在关联，则所有关联的服务将会自动被启动，除非这些服务已经在运行中

如果不希望自动启动关联的容器，可以使用 –no-deps

docker-compose run –no-deps web python manage.py shell
选项：
-d 后台运行容器。
–name NAME 为容器指定一个名字。
–entrypoint CMD 覆盖默认的容器启动指令。
-e KEY=VAL 设置环境变量值，可多次使用选项来设置多个环境变量。
-u, –user=”” 指定运行容器的用户名或者 uid。
–no-deps 不自动启动关联的服务容器。
–rm 运行命令后自动删除容器，d 模式下将忽略。
-p, –publish=[] 映射容器端口到本地主机。
–service-ports 配置服务端口并映射到本地主机。
-T 不分配伪 tty，意味着依赖 tty 的指令将无法运行。

scale

docker-compose scale [options] [SERVICE=NUM...]        设置指定服务运行的容器个数。

通过 service=num 的参数来设置数量。例如：
$ docker-compose scale web=3 db=2

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

start

docker-compose start [SERVICE...]        启动已经存在的服务容器。

stop

docker-compose stop [options] [SERVICE...]    停止已经处于运行状态的容器，但不删除它。

通过 docker-compose start 可以再次启动这些容器。
选项：
-t, –timeout TIMEOUT 停止容器时候的超时（默认为 10 秒）。

top

查看各个服务容器内运行的进程。

unpause

docker-compose unpause [SERVICE...]        恢复处于暂停状态中的服务。

up

docker-compose up [options] [SERVICE...]        它将尝试自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。

链接的服务都将会被自动启动，除非已经处于运行状态。
可以说，大部分时候都可以直接通过该命令来启动一个项目

默认情况，如果服务容器已经存在，docker-compose up 将会尝试停止容器，然后重新创建（保持使用 volumes-from 挂载的卷），以保证新启动的服务匹配 docker-compose.yml 文件的最新内容。
如果用户不希望容器被停止并重新创建，可以使用 docker-compose up –no-recreate。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。
如果用户只想重新部署某个服务，可以使用 docker-compose up –no-deps -d 来重新创建服务并后台停止旧服务，启动新服务，并不会影响到其所依赖的服务。

选项：
-d 在后台运行服务容器。

–no-color 不使用颜色来区分不同的服务的控制台输出。

–no-deps 不启动服务所链接的容器。

–force-recreate 强制重新创建容器，不能与 –no-recreate 同时使用。

–no-recreate 如果容器已经存在了，则不重新创建，不能与 –force-recreate 同时使用。

–no-build 不自动构建缺失的服务镜像。

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

version

docker-compose version        打印版本信息。

####compose 模板文件
模板文件是Compose 的核心。
默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式。

注意每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。

如果使用 build 指令，在 Dockerfile 中设置的选项(例如：CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取，无需在 docker-compose.yml 中重复设置

指令用法

build

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

使用 cache_from 指定构建镜像的缓存。

cap_add, cap_drop

指定容器的内核能力（capacity）分配。

command

覆盖容器启动后默认执行的命令。
command: echo “hello world”

configs

仅用于 Swarm mode，详细内容请查看 Swarm mode 一节。

cgroup_parent

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

container_name

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

deploy

仅用于 Swarm mode，详细内容请查看 Swarm mode 一节

devices

指定设备映射关系。

depends_on

解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web

dns

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

dns_search

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

tmpfs

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

env_file

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

environment

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

expose

暴露端口，但不映射到宿主机，只被连接的服务访问。

external_links

注意：不建议使用该指令。
链接到 docker-compose.yml 外部的容器，甚至并非 Compose 管理的外部容器。

extra_hosts

类似 Docker 中的 –add-host 参数，指定额外的 host 名称映射信息。

healthcheck

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

image

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

labels

为容器添加 Docker 元数据（metadata）信息。

links

注意：不推荐使用该指令。

logging

配置日志选项。

network_mode

设置网络模式。使用和 docker run 的 –network 参数一样的值。

networks

配置容器连接的网络。

pid

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

ports

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

secrets

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

security_opt

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

stop_signal

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

sysctls

配置容器内核参数。

ulimits

指定容器的 ulimits 限制值。

volumes

数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER)，并且可以设置访问模式 （HOST:CONTAINER:ro）。
该指令中路径支持相对路径。

其它指令

此外，还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令，基本跟 docker run 中对应参数的功能一致。