一、docker-compose简介

Compose项目来源于之前的fig项目,使用python语言编写,与docker/swarm配合度很高。

Compose 是 Docker 容器进行编排的工具,定义和运行多容器的应用,可以一条命令启动多个容器,使用Docker Compose不再需要使用shell脚本来启动容器。 

Compose 通过一个配置文件来管理多个Docker容器,在配置文件中,所有的容器通过services来定义,然后使用docker-compose脚本来启动,停止和重启应用,和应用中的服务以及所有依赖服务的容器,非常适合组合使用多个容器进行开发的场景。

docker-compose默认的模板文件是 docker-compose.yml,其中定义的每个服务都必须通过 image 指令指定镜像或 build 指令(需要 Dockerfile)来自动构建。

其它大部分指令都跟 docker run 中的类似。

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

使用Compose 基本上分为三步:

1.Dockerfile 定义应用的运行环境
2.docker-compose.yml 定义组成应用的各服务
3.docker-compose up 启动整个应用

 

二、安装docker-compose

请参考安装指定版本docker和docker-compose。

三、docker-compose语法介绍

版本: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没有声明版本默认是"version 1"。Version 1将来会被弃用。

配置选项

1.bulid

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

build: /path/to/build/dir

也可以是相对路径

build: ./dir

设定上下文根目录,然后以该目录为准指定 Dockerfile

build:
  context: ../
  dockerfile: path/of/Dockerfile

2. context

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

build:
  context: ./dir

3. dockerfile

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

build:
  context: .
  dockerfile: Dockerfile-alternate

4.image

services:
  web:
    image: nginx

在 services 标签下的第二级标签是 web,这个名字是用户自己自定义,它就是服务名称。
image 则是指定服务的镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。
例如下面这些格式都是可以的:

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: a4bc65fd

5. args

添加构建参数,这些参数是仅在构建过程中可访问的环境变量
首先, 在Dockerfile中指定参数:

ARG fendo
ARG password
 
RUN echo "Build number: $fendo"
RUN script-requiring-password.sh "$password"

 然后指定 build 下的参数,可以传递映射或列表

build:
  context: .
  args:
    fendo: 1
    password: fendo

build:
  context: .
  args:
    - fendo=1
    - password=fendo

 指定构建参数时可以省略该值,在这种情况下,构建时的值默认构成运行环境中的值

args:
  - fendo
  - password

 6.command

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

command: bundle exec thin -p 3000

该命令也可以是一个列表,方法类似于 dockerfile:

command: ["bundle", "exec", "thin", "-p", "3000"]

 7.container_name

Compose 的容器名称格式是:<项目名称><服务名称><序号>

虽然可以自定义项目名称、服务名称,但是如果你想完全控制容器的命名,可以使用这个标签指定:

container_name: app

这样容器的名字就指定为 app 了。

8.depends_on

在使用 Compose 时,最大的好处就是少打启动命令,但是一般项目容器启动的顺序是有要求的,如果直接从上到下启动容器,必然会因为容器依赖问题而启动失败。

例如在没启动数据库容器的时候启动了应用容器,这时候应用容器会因为找不到数据库而退出,为了避免这种情况我们需要加入一个标签,就是 depends_on,这个标签解决了容器的依赖、启动先后的问题。

例如下面容器会先启动 redis 和 db 两个服务,最后才启动 web 服务:

version: '3'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

注意的是,默认情况下使用 docker-compose up web 这样的方式启动 web 服务时,也会启动 redis 和 db 两个服务,因为在配置文件中定义了依赖关系。

9.pid

pid: "host"

将PID模式设置为主机PID模式,跟主机系统共享进程命名空间。容器使用这个标签将能够访问和操纵其他容器和宿主机的名称空间。

10.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文件中添加一些记录,与Docker client的--add-host类似:

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

四、具体应用

这里面将会在 Docker Compose 中构建一个简单的 Python 程序。应用程序将使用 Flask 框架,并在 Redis 中维护一个计数器。

先决条件:确认你已经安装了 Docker Engine 与 Docker Compose。你不需要安装 Python 或者 Redis,这两个都会在 Docker 镜像中提供。

第一步:定义应用依赖

为项目创建目录

$ mkdir composetest
$ cd composetest

创建一个名为 app.py 的文件,并将如下内容粘贴进去:

import time

import redis
from flask import Flask

app = Flask(__name__)
cache = redis.Redis(host='redis', port=6379)

def get_hit_count():
   retries = 5
   while True:
       try:
           return cache.incr('hits')
       except redis.exceptions.ConnectionError as exc:
           if retries == 0:
               raise exc
           retries -= 1
           time.sleep(0.5)

@app.route('/')
def hello():
   count = get_hit_count()
   return 'Hello World! I have been seen {} times.\n'.format(count)

if __name__ == "__main__":
   app.run(host="0.0.0.0", debug=True)

在这个例子中,redis 就是应用网络中" redis "容器的主机名。我们使用 Redis 的默认端口 6379。

在你的项目路径下创建另外一个叫做 requirements.txt 的文件,并将如下内容粘贴进去:

flask
redis

第二步:创建 Dockerfile

在这一步中,你需要编写一个 Dockerfile 来构建一个 Docker 镜像。这个镜像包含 Python 应用的所有依赖,也包含 Python 其本身。

在你的项目路径下创建一个 Dockerfile 文件,并将如下内容粘贴进去:

FROM python:3.4-alpine
ADD . /code
WORKDIR /code
RUN pip install -r requirements.txt
CMD ["python", "app.py"]

这会告诉容器:

  • 构建一个基于 Python 3.4 的镜像
  • 把当前目录添加到镜像中的 /code 路径下
  • 把工作路径设置成 /code
  • 安装 Python 依赖
  • 设置容器的默认命令为 python app.py

 了解更多Dockerfile信息可以参考Dockerfile指令详解

第三步:在 Compose 文件中定义一个服务

在工作路径下创建一个叫做 docker-compose.yml 并粘贴如下内容:

version: '3'
services:
  web:
    build: .
    ports:
     - "5000:5000"
  redis:
    image: "redis:alpine"

这个 Compose 文件中定义了两个服务 web 与 redis。此 Web 服务:

  • 使用当前目录 Dockerfile 构建出来的镜像
  • 将容器上暴露的5000端口转发到主机的5000端口。我们使用 Flask Web 服务器的默认端口 5000。

而 Redis 服务使用从 Docker Hub 注册表中拉取的公有镜像。

第四步:在 Compose 中构建并运行你的应用

在你的项目路径下通过 docker-compose up

容器运行内容输出如下:

Creating network "composetest_default" with the default driver
Creating composetest_web_1 ...
Creating composetest_redis_1 ...
Creating composetest_web_1
Creating composetest_redis_1 ... done
Attaching to composetest_web_1, composetest_redis_1
web_1    |  * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
redis_1  | 1:C 17 Aug 22:11:10.480 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
redis_1  | 1:C 17 Aug 22:11:10.480 # Redis version=4.0.1, bits=64, commit=00000000, modified=0, pid=1, just started
redis_1  | 1:C 17 Aug 22:11:10.480 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf
web_1    |  * Restarting with stat
redis_1  | 1:M 17 Aug 22:11:10.483 * Running mode=standalone, port=6379.
redis_1  | 1:M 17 Aug 22:11:10.483 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
web_1    |  * Debugger is active!
redis_1  | 1:M 17 Aug 22:11:10.483 # Server initialized
redis_1  | 1:M 17 Aug 22:11:10.483 # WARNING you have Transparent Huge Pages (THP) support enabled in your kernel. This will create latency and memory usage issues with Redis. To fix this issue run the command 'echo never > /sys/kernel/mm/transparent_hugepage/enabled' as root, and add it to your /etc/rc.local in order to retain the setting after a reboot. Redis must be restarted after THP is disabled.
web_1    |  * Debugger PIN: 330-787-903
redis_1  | 1:M 17 Aug 22:11:10.483 * Ready to accept connections

Compose 拉取一个 Redis 镜像,以你自己的代码构建一个镜像,并启动你定义的服务。在这种情况下,代码在构建时静态拷贝到镜像中。

在浏览器中输入 http://0.0.0.0:5000 查看应用的运行情况。

你将在你的浏览器中看到如下信息:

Hello World! I have been seen 1 times.

 刷新一下浏览器,数值将会增加:

Hello World! I have been seen 2 times.

docker image ls 列举所有本地镜像。

镜像列表中将返回 reidis 与 web。

UDP docker 启动 启动docker-compose_docker-compose

停止镜像,即可以在你的项目路径下使用 docker-compose down

第五步:编辑 Compose 文件添加一个绑定挂载

在你的项目路径下编辑 docker-compose.yml 为 web 服务添加一个绑定挂载:

version: '3'
services:
  web:
    build: .
    ports:
     - "5000:5000"
    volumes:
     - .:/code
  redis:
    image: "redis:alpine"

这个新的 volumes 键将当前路径(项目路径)与容器中的 /code 路径挂载到一起,允许你及时修改代码而不用重新构建镜像。

第六步:重新构建并在 Compose 中运行应用

在你的项目路径下,输入 docker-compose up 命令使用更新后的 Compose 文件构建应用并启动。

$ docker-compose up
Creating network "composetest_default" with the default driver
Creating composetest_web_1 ...
Creating composetest_redis_1 ...
Creating composetest_web_1
Creating composetest_redis_1 ... done
Attaching to composetest_web_1, composetest_redis_1
web_1    |  * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
...

再次检查 Web 浏览器中的 Hello World 消息,然后刷新以查看计数增量。

第七步:更新应用程序

因为应用程序的代码通过 volume 挂载到容器中,你可以更改其代码并立即查看更改,而不必重新生成镜像。

修改 app.py 中的欢迎语并保存。例如,将 Hello World! 改成 Hello Docker!:

return 'Hello Docker! I have been seen {} times.\n'.format(count)

刷新你的浏览器。欢迎语已经更新,而计数器仍然在增长。

第八步:尝试一些其它命令

如果你希望你的应用程序在后台运行,你可以将 -d 标记传递给 docker-compose up 并使用 docker-compose ps

UDP docker 启动 启动docker-compose_docker编排工具_02

docker-compose run

$ docker-compose run web env

通过 docker-compose --help

如果你使用 docker-compose up -d 启动了 Compose,你可能希望在它们运行完成后停止服务:

$ docker-compose stop

你可以停掉所有一切,使用 down 命令完全移除容器。传递--volumes

$ docker-compose down --volumes