Docker Compose

Compose 简介

Docker ComposeDocker 官方编排(Orchestration)项目之一,负责快速在集群中部署分布式应用。前面我们使用Docker的时候,定义 Dockerfile 文件,然后使用 docker build、docker run等命令操作容器。

然而微服务架构的应用系统一般包含若干个微服务,每个微服务一般都会部署多个实例,如果每个微服务都要手动启停,那么效率之低,维护量之大可想而知使用 Docker Compose 可以轻松、高效的管理容器,它是一个用于定义和运行多容器 Docker 的应用程序工具

Compose架构

Compose 中有两个重要的概念:

  • 服务(service):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例。
  • 项目(project):由一组关联的应用容器组成的一个完整业务单元,在 docker- compose.yml 文件中定义。

Compose 的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理。

Compose安装

桌面客户端安装

Windows和Mac的Docker桌面版已经集成了Docker-compose,无效再单独安装。

PIP 安装

Compose 可以通过 Python 的 pip工具进行安装,可以直接下载编译好的二进制文件。
执行安装命令:

1
$ sudo pip install -U docker-compose

二进制文件安装

  1. 在Liunx环境可以使用二进制文件安装,要安装其他版本的Compose,请替换1.25.3 为要使用的Compose版本。
1
sudo curl -L "https://github.com/docker/compose/releases/download/1.25.3/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
  1. 安装完成后,将可执行权限应用于二进制文件。
1
sudo chmod +x /usr/local/bin/docker-compose

安装校验

使用如下命令校验安装是否成功。

1
2
$ docker-compose -v 
docker-compose version 1.20.1, build 5d8c71b2

Compose模板文件

Compose模板文件是一个YAML文件,默认的模板文件名称为 docker-compose.yml格式为 YAML 格式。模板文件用于定义 servicesnetworksvolumes 。模板文件格式如下:

docker-compose.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
version: '3.7'
services:
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image: redis
volumes:
logvolume01: {}

Dockerfile类似,模板文件也有很多字段,不同字段有不同的功能。接下来将介绍常用的字段含义。

version

该字段用于指出当前配置文件是为哪一个docker compose版本编写的。因为不同版本间的配置文件可能不兼容。写出响应版本的version字段,程序就会按照那个版本的规则解析配置文件。

指定Compose文件版本,截止目前为止(2020.2) Compose有三个版本,最新的版本是3.7 版本详情:https://docs.docker.com/compose/compose-file/

services

这个字段列举的就是需要建立的docker容器了。每一个容器对应着各自的配置参数。

1
2
3
4
5
6
7
services:
webapp: # 定义容器名称为webapp
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1

image

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

格式:image: 镜像URI:版本tag(使用最新版可填写latest)”

1
2
3
4
5
image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

build

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

1
2
3
4
5
6
7
8
9
build: /path/to/build/dir  #绝对路径
build: ./dir # 也可以是相对路径

build: # 设定上下文根目录,然后以该目录为准指定 Dockerfile。
context: ../
dockerfile: path/of/Dockerfile

build: ./dir # 如果你同时指定了 image 和 build 两个标签,那么 Compose 会构建镜像并且把镜像命名为 image 后面的那个名字。
image: webapp:tag

command

原本在Docker镜像构建的时候,会设置默认执行的入口,使用command字段可以覆盖或者追加。

1
2
3
command: bundle exec thin -p 3000 # 覆盖,使用新的指令作为入口
command: [bundle, exec, thin, -p, 3000] # 也可以写成类似 Dockerfile 中的格式:
command: -p 3000 -mysql=123123 #追加设置

container_name

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

1
container_name: docker-web-container

注意: 指定容器名称后,该服务将无法进行扩展(scale),因为 Docker 不允许多个容器具有相同的名称。

depends on

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
version: '3'

services:
web:
build: .
depends_on:
- db
- redis

redis:
image: redis

db:
image: postgres

注意:web服务不会等待 redis db 「完全启动」之后才启动。

volumes

数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER),并且可以设置访问模式 (HOST:CONTAINER:ro)。

该指令中路径支持相对路径。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
volumes:
- /var/lib/mysql #// 只是指定一个路径,Docker 会自动在创建一个数据卷(这个路径是容器内部的)。
- cache/:/tmp/cache #使用绝对路径挂载数据卷
- ~/configs:/etc/configs/:ro #使用用户的相对路径(~/ 表示的目录是 /home/<用户目录>/ 或者 /root/)。

version: "3"

services:
my_src:
image: mysql:8.0
volumes:
- mysql_data:/var/lib/mysql

volumes:
mysql_data:

volumes_from

从其它容器或者服务挂载数据卷,可选的参数是:ro或者 :rw前者表示容器只读,后者表示容器对数据卷是可读可写的。默认情况下是可读可写的。

1
2
3
4
5
6

volumes_from:
- service_name
- service_name:ro
- container:container_name
- container:container_name:rw

devices

设备映射列表。与Docker client--device参数类似。与volumes字段一致使用HOST:CONTAINER这样的格式。

1
2
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"

environment字段

environmentDockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中,类似 docker run -e 的效果。

environment的书写方式有两种

  • 按照yml的键值对应。
  • 直接写字符串。
1
2
3
4
5
6
7
8
9
environment: #键值对
RACK_ENV: development
SHOW: 'true'
SESSION_SECRET:

environment: #直接写对应字符
- RACK_ENV=development
- SHOW=true
- SESSION_SECRE

port

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

1
2
3
4
5
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"

注意:当使用HOST:CONTAINER格式来映射端口时,如果你使用的容器端口小于60你可能会得到错误得结果,因为YAML将会解析xx:yy这种数字格式为60进制。所以建议采用字符串格式。

networks

networks字段用来配置容器连接的网络。在同一个network中的容器,可以通过service名称来作为相互的ip地址,相互访问。
例如下面例子中同属于some-network的容器,可以使用http://some-service:80来访问其web服务,本质上是使用了host映射。

1
2
3
4
5
6
7
8
9
10
11
version: "3"
services:

some-service:
networks:
- some-network
- other-network

networks:
some-network:
other-network:

links字段容器间简单组网,不创建network,直接链接两个容器,注意:这类链接是单向的。

1
2
3
4
5
6
7
8
version: '2'
services:
web:
build: .
links: #web容器链接到db容器
- "db:database"
db:
image: postgres

expose

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

1
2
3
expose:
- "3000"
- "8000"

dns

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

1
2
3
4
5
dns: 8.8.8.8

dns:
- 8.8.8.8
- 114.114.114.114

labels

为容器添加 Docker 元数据(metadata)信息。例如可以为容器添加辅助说明信息。

1
2
3
4
labels:
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
com.startupteam.release: "rc3 for v1.0"

logging

配置日志选项。

1
2
3
4
5
6
logging:
driver: syslog #指定日志类型
options: #配置日志驱动的相关参数。
syslog-address: "tcp://192.168.0.42:123"
max-size: "200k"
max-file: "10"

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

1
2
3
driver: "json-file" #json格式日志
driver: "syslog" #系统日志
driver: "none" #无格式

Compose命令

概述

对于 Compose 来说,大部分命令的对象既可以是项目本身,也可以指定为项目中的服务或者容器。如果没有特别的说明,命令对象将是项目,这意味着项目中所有
的服务都会受到命令影响。执行 docker-compose [COMMAND] –help 或者 docker-compose help
[COMMAND] 可以查看具体某个命令的使用格式。

Compose 命令的基本的使用格式如下:

1
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 打印版本并退出。

常用命令

build

构建(重新构建)项目中的服务容器。
服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个db 容器,可能是web_db
可以随时在项目目录下运行 docker-compose build来重新构建服务。
格式为 docker-compose build [options] [SERVICE...]

选项包括:

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

--no-cache 构建镜像过程中不使用 cache(这将加长构建过程)。

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

up

该命令十分强大,它将尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的一系列操作。链接的服务都将会被自动启动,除非已经处于运行状态。可以说,大部分时候都可以直接通过该命令来启动一个项目。

默认情况,docker-compose up 启动的容器都在前台,控制台将会同时打印所有容器的输出信息,可以很方便进行调试。当通过Ctrl-C 停止命令时,所有容器将会停止。

如果使用 docker-compose up -d,将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。
默认情况,如果服务容器已经存在,docker-compose up 将会尝试停止容器,然后重新创建(保持使用 volumes-from 挂载的卷),以保证新启动的服务匹配 docker-compose.yml 文件的最新内容。

如果用户不希望容器被停止并重新创建,可以使用 docker-compose up --no-recreate。这样将只会启动处于停止状态的容器,而忽略已经运行的服务。如果用户只想重新部署某个服务,可以使用 docker-compose up --no-deps -d <SERVICE_NAME> 来重新创建服务并后台停止旧服务,启动新服务,并不会影响到其所依赖的服务。

格式为: docker-compose up [options] [SERVICE...]

选项:

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

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

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

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

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

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

-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。

down

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

kill

格式为: docker-compose kill [options] [SERVICE...]

通过发送SIGKILL 信号来强制停止服务容器。
支持通过 -s参数来指定发送的信号,例如通过如下指令发送SIGINT 信号。

1
$ docker-compose kill -s SIGINT

logs

格式为: docker-compose logs [options] [SERVICE...]

查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过--no-color来关闭颜色。
该命令在调试问题的时候十分有用。

run

在指定服务上执行一个命令,格式为:

1
docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]。

例如:

1
$ docker-compose run ubuntu ping docker.com

将会启动一个ubuntu服务容器,并执行 ping docker.com 命令。
默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在运行中。该命令类似启动容器后运行指定的命令,相关卷、链接等等都将会按照配置自动创建。
两个不同点:

  1. 给定命令将会覆盖原有的自动运行命令;
  2. 不会自动创建端口,以避免冲突。

如果不希望自动启动关联的容器,可以使用 --no-deps 选项,例如

1
$ docker-compose run --no-deps web python manage.py shell

将不会启动 web 容器所关联的其它容器。

选项:

-d 后台运行容器。

--name NAME 为容器指定一个名字。

--entrypoint CMD 覆盖默认的容器启动指令。

-e KEY=VAL 设置环境变量值,可多次使用选项来设置多个环境变量。

-u, --user="" 指定运行容器的用户名或者 uid。

--no-deps 不自动启动关联的服务容器。

--rm 运行命令后自动删除容器,d 模式下将忽略。

-p, --publish=[] 映射容器端口到本地主机。

--service-ports 配置服务端口并映射到本地主机。

-T 不分配伪 tty,意味着依赖 tty 的指令将无法运行。

start

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

pause

暂停一个服务容器,格式为 docker-compose pause [SERVICE...]

unpause

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

stop

停止已经处于运行状态的容器,但不删除它。通过 docker-compose start 可以再次启动这些容器。
格式为 docker-compose stop [options] [SERVICE...]

选项:

-t, --timeout TIMEOUT 停止容器时候的超时(默认为 10 秒)。

rm

删除所有(停止状态的)服务容器。推荐先执行 docker-compose stop 命令来停止容器。
格式为 docker-compose rm [options] [SERVICE...]

选项:

-f, --force 强制直接删除,包括非停止状态的容器。一般尽量不要使用该选项。
-v 删除容器所挂载的数据卷。

实践案例

项目概述

使用Compose构建wordpress环境。wordpress是一款流行的博客系统:https://zh-cn.wordpress.com/

创建空文件夹

假设新建一个名为wordpress的文件夹,然后进入这个文件夹。

创建 docker-compose.yml 文件

docker-compose.yml 文件将开启一个 wordpress服务和一个独立的 MySQL 实例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
version: "3"
services:

db: #数据库容器配置
image: mysql:8.0
command: #数据库配置命令
- --default_authentication_plugin=mysql_native_password
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_unicode_ci
volumes: #数据卷挂载
- db_data:/var/lib/mysql
restart: always #重启策略:一直重启
environment: #环境变量配置
MYSQL_ROOT_PASSWORD: somewordpress
MYSQL_DATABASE: wordpress
MYSQL_USER: wordpress
MYSQL_PASSWORD: wordpress

wordpress: #wordpress容器配置
depends_on: #依赖容器
- db
image: wordpress:latest
ports: #端口映射配置
- "8000:80"
restart: always
environment:
WORDPRESS_DB_HOST: db:3306
WORDPRESS_DB_USER: wordpress
WORDPRESS_DB_PASSWORD: wordpress
volumes:
db_data:

构建并运行项目

运行 docker-compose up -d Compose 就会拉取镜像再创建我们所需要的镜像,然后启动 wordpress 和数据库容器。 接着浏览器访问 容器ip:8000端口就能看到WordPress 安装界面了。

1
2
3
4
5
6
7
8
9
10
11
12
$ docker-compose up -d
Creating network "wordpress_default" with the default driver
Creating volume "wordpress_db_data" with default driver
Pulling db (mysql:8.0)...
8.0: Pulling from library/mysql
804555ee0376: Pull complete
....
Status: Downloaded newer image for mysql:8.0
Pulling wordpress (wordpress:latest)...
latest: Pulling from library/wordpress
Status: Downloaded newer image for wordpress:latest
Creating wordpress_db_1 ... done

如下图所示:wordpress安装界面

image

输入命令docker-compose查看正在运行的容器可以看到模板文件中的dbwordpress容器在运行。

1
2
3
4
5
6
$ docker-compose ps

Name Command State Ports
-------------------------------------------------------------------------------------
wordpress_db_1 docker-entrypoint.sh --def ... Up 3306/tcp, 33060/tcp
wordpress_wordpress_1 docker-entrypoint.sh apach ... Up 0.0.0.0:8000->80/tcp

参考资料