Docker-Compose 项目是 Docker 官方的开源项目,负责实现对 Docker 容器集 群的快速编排。 Docker-Compose 将所管理的容器分为三层,分别是工程(project),服务 (service)以及容器(container)。Docker-Compose 运行目录下的所有文件 (docker-compose.yml,extends 文件或环境变量文件等)组成一个工程,若无特 殊指定工程名即为当前目录名。一个工程当中可包含多个服务,每个服务中定义 了容器运行的镜像,参数,依赖。
Docker-Compose 通过一个配置文件来管理多个 Docker 容器,在配置文件 (docker-compose.yml)中,所有的容器通过 services 来定义,然后使用 docker-compose 脚本来启动,停止和重启应用,和应用中的服务以及所有依赖服 务的容器,非常适合组合使用多个容器进行开发的场景。
1、Compose 安装
Compose 目前已经完全支持 Linux、Mac OS 和 Windows,在我们安装 Compose 之前,需要先安装 Docker,对于 Mac OS 和 Windows 的安装比较容易,可以参考 Install Docker for Mac(https://docs.docker.com/docker-for-mac/install/)和 Install Docker for Windows(https://docs.docker.com/docker-for-windows/install/),
(1)、Linux 平台的安装
这里是使用了官方编译好的二进制包,地址:https://github.com/docker/compose/releases。把这些二进制文件下载后直接放到执行
路径下面,并添加权限即可。
curl -L https://github.com/docker/compose/releases/download/1.22.0-rc1/docker-compose-`uname -s`-`uname -m`-o /usr/local/bin/docker-compose chmod +x /usr/local/bin/docker-compose然后我们执行 docker-compose -version 可以查看到具体的信息。
(2)、Mac OS 系统 & Windows 系统安装
对于Mac和windows用户来说,Docker for Mac 、Docker for Windows 和 Docker Toolbox 早 已 经 集 成 了 docker-compose , 所 以 用 户 不 需 要 分 别 再 安 装 docker-compose 了。
(3)、其他可选方式安装(个人安装方式)
因为 Compose 是 Python 编写的,我们可以将其当做一个 Python 应用从 pip 源中安装。
如果是使用 virtualenv 环境,则执行如下命令:
pip install docker-compose当在本地环境安装,则执行:
sudo pip install docker-compose如果是二进制包方式安装的,删除二进制文件即可:
sudo rm /usr/local/bin/docker-compose如果是通过 Python pip 工具安装的,则执行如下命令删除:
sudo pip uninstall docker-compose执行 docker-compose --help我们也可以通过执行 docker-compose [COMMAND] --help 来查看某个具体的使用格式。
命令选项如下:
-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 打印版本并退出Docker Compose 常用命令列表如下:
命令 说明
build 构建项目中的服务容器 help 获得一个命令的帮助 kill 通过发送 SIGKILL 信号来强制停止服务容器 config 验证和查看 compose 文件配置 create 为服务创建容器。只是单纯的 create,还需要使用 start 启动 compose down 停止并删除容器,网络,镜像和数据卷 exec 在运行的容器中执行一个命令logs 查看服务容器的输出 pause 暂停一个服务容器 port 打印某个容器端口所映射的公共端口 ps 列出项目中目前的所有容器 pull 拉取服务依赖的镜像 push 推送服务镜像 restart 重启项目中的服务 rm 删除所有(停止状态的)服务容器 run 在指定服务上执行一个命令 scale 设置指定服务运行的容器个数 start 启动已经存在的服务容器 stop 停止已经处于运行状态的容器,但不删除它 top 显示运行的进程 unpause 恢复处于暂停状态中的服务 up 自动完成包括构建镜像、创建服务、启动服务并关闭关联服务相关容器的 一些列操作 version 打印版本信息(构建项目中的服务容器)【重新构建】
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 变量获得一个命令帮助
通过发送 SIGKILL 信号来强制停止服务容器
例如停止 eureka
docker-compose kill eureka验证并查看 compose 文件配置。)
选项包括:
–resolve-image-digests 将镜像标签标记为摘要 -q, --quiet 只验证配置,不输出。 当配置正确时,不输出任何内容,当文件配置错误,输出错误信息
–services 打印服务名,一行一个 –volumes 打印数据卷名,一行一个为服务创建容器.只是单纯的 create,还需要使用 start 启动 compose。
docker-compose create [options] [SERVICE...]选项包括:
–force-recreate 重新创建容器,即使它的配置和镜像没有改变,不兼容–no-recreate 参数 –no-recreate 如果容器已经存在,不需要重新创建. 不兼容–force-recreate 参数 –no-build 不创建镜像,即使缺失 –build 创建容器前,生成镜像停止和删除容器、网络、卷、镜像,这些内容是通过 docker-compose up 命令创建
的. 默认值删除 容器 网络,可以通过指定 rmi 、volumes 参数删除镜像和卷。
选项包括:
–rmi type 删除镜像,类型必须是: ‘all’: 删除 compose 文件中定义的所以镜像; ‘local’: 删除镜像名为空的镜像 -v, --volumes 删除已经在 compose 文件中定义的和匿名的附在容器上的数据卷 –remove-orphans 删除服务中没有在 compose 中定义的容器与 docker exec 命令功能相同,可以通过 service name 登陆到容器中。
选项包括:
-d 分离模式,后台运行命令. –privileged 获取特权. –user USER 指定运行的用户. -T 禁用分配 TTY. By default docker-compose exec 分配 a TTY. –index=index 当一个服务拥有多个容器时,可通过该参数登陆到该服务下的任何 服务,例如:docker-compose exec --index=1 web /bin/bash ,web 服务中 包 含多个容器查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜
色来区分。可以通过–no-color 来关闭颜色。
暂停一个服务容器。
显示某个容器端口所映射的公共端口。
选项包括:
–protocol=proto 指定端口协议,TCP(默认值)或者 UDP –index=index 如果同意服务存在多个容器,指定命令对象容器的序号(默认为 1)列出项目中目前的所有容器。
选项包括:
-q 只打印容器的 ID 信息拉取服务依赖的镜像。
选项包括:
–ignore-pull-failures 忽略拉取镜像过程中的错误 –parallel 多个镜像同时拉取 –quiet 拉取镜像过程中不打印进度信息推送服务依的镜像。选项包括:
–ignore-push-failures 忽略推送镜像过程中的错误重启项目中的服务。
选项包括:
-t, --timeout TIMEOUT 指定重启前停止容器的超时(默认为 10 秒)删除所有(停止状态的)服务容器。
选项包括:
–f, --force 强制直接删除,包括非停止状态的容器 -v 删除容器所挂载的数据卷在指定服务上执行一个命令。
例如:
docker-compose run ubuntu ping www.anumbrella.net将会执行一个 ubuntu 容器,并执行 ping www.anumbrella.net 命令。
默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在
运行中。该命令类似于启动容器后运行指定的命令,相关卷、链接等都会按照配置自动创建。
有两个不同点:
给定命令将会覆盖原有的自动运行命令 不会自动创建端口,以避免冲突如果不希望自动启动关联的容器,可以使用–no-deps 选项,例如:
docker-compose run --no-deps web将不会启动 web 容器关联的其他容器。
选项包括:
-d 在后台运行服务容器 –name NAME 为容器指定一个名字 –entrypoint CMD 覆盖默认的容器启动指令 -e KEY=VAL 设置环境变量值,可多次使用选项来设置多个环境变量 -u, --user="" 指定运行容器的用户名或者 uid –no-deps 不自动启动管理的服务容器 –rm 运行命令后自动删除容器,d 模式下将忽略 -p, --publish=[] 映射容器端口到本地主机 –service-ports 配置服务端口并映射到本地主机 -v, --volume=[] 绑定一个数据卷,默认为空 -T 不分配伪 tty,意味着依赖 tty 的指令将无法运行 -w, --workdir="" 为容器指定默认工作目录设置指定服务运行的容器个数。
通过 service=num 的参数来设置数量。例如:
docker-compose scale web=3 db=2
将启动 3 个容器运行 web 服务,2 个容器运行 db 服务。一般情况下,当指定书目多于
该服务当前实际运行容器,将新创建并启动容器;反之,将停止容器。
选项包括:
-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)docker-compose start [SERVICE...]
启动已经存在的服务容器。
停止已经处于运行状态的容器,但不删除它。
选项包括:
-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)显示各个容器运行的进程情况。
恢复处于暂停状态中的服务。
up 命令十分强大,它尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并
关联服务相关容器的一些列操作。链接的服务都将会被自动启动,除非已经处于运行状态。
多数情况下我们可以直接通过该命令来启动一个项目。
选项包括:
-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 指定的参数打印版本信息。
模板文件是使用 Compose 的核心,涉及的指令关键字也比较多,大部分指令与 docker run 相关参数的含义都是类似的。 默认的模板文件为 docker-compose.yml,格式为 YAML 格式。
比如一个 Compose 模板文件:
version: '3' services: wordpress: image: wordpress ports: - 8080:80 environment: - WORDPRESS_DB_HOST=mysql - WORDPRESS_DB_PASSWORD=root networks: - my-bridge mysql: image: mysql environment: - MYSQL_ROOT_PASSWORD=root - MYSQL_DATABASE=wordpress volumes: - mysql-data:/var/lib/mysql networks: - my-bridge volumes: mysql-data: wordpress: networks: my-bridge: driver: bridgeversion: ‘3’
Docker Compose 的模版文件主要分为 3 个区域,为
service (服务)
在它下面可以定义应用需要的一些服务,每个服务都有自己的名字、使用的镜像、挂载
的数据卷、所属的网络、依赖哪些其他服务等等。
volumes (数据卷)
定义数据卷,然后挂载到不同的服务使用。
networks (应用网络)
定义应用名字,使用的网络类型。
Docker Compose 常用模板文件主要命令:
指令 功能
Build 指定服务镜像 Dockerfile 所在路径 cap_add,cap_drop 指定容器的内核能力(capacity)分配command 覆盖容器启动后默认执行的命令 cgroup_parent 指定父 cgroup 组,意味着将基础该组的资源限制 container_name 指定容器名称。默认将会使用项目名称_服务名称_序号这样的格式 devices 指定设置映射关系 dns 自定义 DNS 服务器。可以是一个值,也可以是一个列表 dns_search 配置 DNS 搜索域。可以是一个值,也可以是一个列表 dockerfile 指定额外编译镜像的 Dockerfile 文件,可以通过该指令来指定 env_file 从文件中获取环境变量,可以为单独的文件路径或列表 environment 设置环境变量,可以使用数组或字典两种格式 expose 暴露端口 extends 基于其他模板文件进行扩展 external_links 链接到 docker-compose.yml 外部的容器,甚至可以是非 Compose 管理的外部容器 extra_hosts 指定额外的 host 名称映射信息 image 指定为镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取 这个镜像 labels 指定服务镜像 Dockerfile 所在路径 links 链接到其他服务中的容器 log_driver 指定日志驱动类型,类似于 Docker 中的–log-driver 参数。目前支持三种 日 志 驱 动 类 型 : log_driver:“json-file” 、 log_driver:“syslog” 、 log_driver:“none” log_opt 日志驱动的相关参数 net 设置网络模式。参数类似于 docker clinet 的–net 参数一样 pid 跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之 间可以通过进程 ID 来相互访问和操作 ports 暴露端口信息 security_opt 指定容器模板标签(label)机制的默认属性(如用户、角色、类型、级 别等) ulimits 指定容器的 ulimits 限制值 volumes 数据卷所挂载路径设置。可以设置宿主机路径(HOST:CONTAINER)或加 上访问模式(HOST:CONTAINER:ro) volumes_driver 较新版本的 Docker 支持数据卷的插件驱动 volumes_from 从另一个服务或容器挂载它的数据卷下面分别介绍一些主要指令的用法:
指 定 Dockerfile 所 在 文 件 夹 的 路 径 ( 可 以 是 绝 对 路 径 ,或者相对docker-compose.yml 文件的路径)。Compose 将会利用它自动构建这个镜像,然后使用这个镜像:
build: /path/to/build/dir指定容器的内核能力(capacity)分配。
例如,让容器具有所有能力可以指定为:
cap_add: - ALL去掉 NET_ADMIN 能力可以指定为:
cap_drop: - NET_ADMIN覆盖容器启动后默认执行的命令:
command: echo "hello world"
例如,创建了一个 cgroup 组名称为 cgroups_1:
cgroup_parent: cgroups_1指定容器名称。默认将会使用“项目名称_服务名称_序号”这样的格式。例如:
container_name: docker-web-container指定设备映射关系,例如:
devices: - "/dev/ttyUSB1:/dev/ttyUSB0"自定义 DNS 服务器。可以是一个值,也可以是一个列表,例如:
配置 DNS 搜索域。可以是一个值,也可以是一个列表,例如:
dns_search:example.com dns_search: - domain1.example.com - domain2.example.com如果需要,指定额外的编译镜像的 Dockerfile 文件,可以通过该指令来指定,例如:
dockerfile: Dockerfile-alternate注意:该指令不能跟 image 同时使用,否则 Compose 将不知道根据哪个指令来生成
最终的服务镜像。
从文件中获取环境变量,可以为单独的文件路径或列表。 如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则 env_file 中 变量的路径会基于模板文件路径。 如果有变量名称与 environment 指定冲突,则按照惯例,以后者为准:
env_file: .env env_file: - ./common.env - ./apps/web.env - /opt/secrets.env环境变量文件中每一行必须符合格式,支持#开头的注释行:
# common.ev Set development environment PROG_ENV=development设置环境变量,可以使用数组或字典两种格式。 只给定名称的变量会自动获取运行 Compose 主机上对应变量的值,可以用来防止防 泄露不必要的数据。例如:
environment: RACK_ENV: development SESSION_SECRET:或者:
environment: - RACK_ENV=development - SESSION_SECRET注意:如果变量名称或者值中用到 true|false,yes|no 等表达布尔含义的词汇,最好 放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义:
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF暴露端口,但不映射到宿主机,只允许能被连接的服务访问。仅可以指定内部端口为参 数,如下所示:
expose: - "3000"- "8000"基于其他模板文件进行扩展。例如,我们已经有了一个 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,B 依赖 C,C 反过来依赖 A 的情况 。
extends 不会继承 links 和 volumes_from 中定义的容器和数据卷资源
一般情况下,推荐在基础模板中只定义一些可以共享的镜像和环境变量,在扩展模板中 具体指定应用变量、链接、数据卷等信息
链接到 docker-compose.yml 外部的容器,甚至可以是非 Compose 管理的外部容器。
参数格式跟 links 类似:
external_links: - redis_1 - project_db_1:mysql - project_db_1:postgresql类似于 Docker 中的–add-host 参数,指定额外的 host 名称映射信息,例如:
extra_hosts: - "googledns:8.8.8.8" - "dockerhub:52.1.157.61"会在启动后的服务容器中/etc/hosts 文件中添加如下两条目录:
指定为镜像名称或镜像 ID。如果镜像本地不存在,Compose 将会尝试拉取这个镜像,
例如:
image: ubuntu image: mysql为容器添加 Docker 元数据(metadata)信息。例如,可以为容器添加辅助说明信息:
labels: com.startupteam.description: "webapp for a strtup team"链接到其他服务中的容器。使用服务名称(同时作为别名),或者“服务名称:服务别名”
(如 SERVICE:ALIAS),这样的格式都可以,例如:
links: - db - db:database - redis使用别名将会自动在服务容器中的/etc/hosts 里创建。例如:
172.17.2.186 db 172.17.2.186 database 172.17.2.187 redis类似于 Docker 中的–log-driver 参数,指定日志驱动类型。目前支持三种日志驱动类型:
log_driver: "json-file" log_driver: "syslog" log_driver: "none"日志驱动的相关参数。例如:
log_driver: "syslog" log_opt: syslog-address: "tcp://192.168.0.126:456"设置网络模式。参数类似于 docker client 的–net 参数:
net: "bridge" net: "none" net: "host"跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之间可
以通过进程 ID 来相互访问和操作:
pid: "host"暴露端口信息。 使用“宿主机:容器”(如 “HOST:CONTAINER”)格式,或者仅仅指定容器的端口(宿主机将会随机选择端口):
ports: - "3000" - "8000:8000" - "8080:22"指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。例如,
配置标签的用户名和角色名:
security_opt: - label:user:USER- label:role:ROLE指定容器的 ulimits 值限制值。例如,指定最大进程数为 65535,指定文件句柄数为
2000(软限制,应用可以随时修改,不能超过硬限制)和 4000(系统硬限制,只能 root
用户提高)。
ulimits: nproc: 65535 nofile: soft: 20000 hard: 40000数据卷所挂载路径设置。可以设置宿主机路径(HOST:CONTAINER)或加上访问模
式(HOST:CONTAINER:ro)。该指令中路径支持相对路径。例如:
volumes: - /var/lib/mysql - cache/:/tmp/cache - ~/configs:/etc/configs/:ro从另一个服务或容器挂载它的数据卷:
volumes_from: - service_name - container_name此外,还有包括 cpu_shares、cpuset、domainname、entrypoint、hostname、ipc、 mac_address 、 mem_limit、 memswap_limit 、 privileged 、 read_only 、 restart 、 stdin_open、tty、user、working_dir 等指令,基本跟 docker-run 中对应参数的功能一 致。
例如,指定使用 CPU 核 0 和核 1,只用 50%的 CPU 资源:
cpu_shares: 73 cpuset: 0,1指定服务容器启动后执行的命令:
entrypoint: /code/entrypoint.sh指定容器中运行应用的应用名:
user: nginx指定容器中的工作目录:
working_dir: /code指定容器中搜索域名、主机名、mac 地址等:domainname: anumbrella.net
hostname: dev mac_address: 08-00-27-0C-0A指定容器:
ipc: host指定容器中内存和内存交换区限制都为 1G:
mem_limit: 1g memswap_limit: 1g允许容器中运行一些特权命令:
privileged: true指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效,在生产
环境中推荐配置为 always 或者 unless-stopped:
restart: always以只读模式挂载容器的 root 文件系统,意味着不能对容器内容进行修改:
read_only: true打开标准输入,可以接受外部输入:
stdin_open: true模拟一个假的远程控制台
tty: true
从 1.5.0 版本开始,Compose 模板文件支持动态读取主机的系统环境变量。
例如,下面的 Compose 文件将从运行它的环境变量中读取变量${MONGO_VERSION} 的值,并将其写入执行的命令中:
db: image: "mongo:${MONGO_VERSION}"如果执行 MONGO_VERSION=3.0 docker-compoe up 则会启动一个 mongo:3.0 镜像的容器;如果执行 MONGO_VERSION=2.8 docker-compoe up 则会启动一个 mongo:2.8 镜像的容器 对应 Compose 模板文件命令,官方也是在不断更新,目前版本已经是第三版了,更 多更详细的用法可以参考官方文档 compose-file。
这里我们以前面使用的 docker-compose 模版为例,不过作出一些调整:
version: '3' services: web: image: wordpress ports: - "127.0.0.1:8080:80" environment: - WORDPRESS_DB_HOST=mysql - WORDPRESS_DB_PASSWORD=root links: - mysql working_dir: /var/www/html volumes: - wordpress:/var/www/html mysql: image: mysql:5.7 environment: - MYSQL_ROOT_PASSWORD=root - MYSQL_DATABASE=wordpress volumes: - mysql-data:/var/lib/mysql volumes: mysql-data: wordpress:如图,新建一个文件夹,取名为 docker-compose-demo,进入文件夹,新建 docker-compose.yml,将以上内容填入文件,保存。
在当前目录打开终端,执行
docker-compose up启动两个容器。 浏览器访问:http://127.0.0.1:8080,即可看到如下页面:
现在关闭两个容器。
docker-compose stop关闭以后,这两个容器文件还是存在的,写在里面的数据不会丢失。下次启动的时候, 还可以复用。下面的命令可以把这两个容器文件删除(容器必须已经停止运行)。
docker-compose rm如图: