docker-compose简介及使用

前言：

　　Docker-Compose 是用来管理容器的，类似用户容器管家，我们有N多台容器或者应用需要启动的时候，如果手动去操作，是非常耗费时间的，如果有了 Docker-Compose 只需要一个配置文件就可以帮我们搞定，但是 Docker-Compose 只能管理当前主机上的 Docker，不能去管理其他服务器上的服务。意思就是单机环境。docker-compose是基于docker的编排工具，使容器的操作能够批量的，可视的执行，是一个管理多个容器的工具，比如可以解决容器之间的依赖关系，当在宿主机启动较多的容器时候，如果都是手动操作会觉得比较麻烦而且容器出错，这个时候推荐使用 dockerd的单机编排工具 docker-compose。本文将会从docker-compose的历史，安装，使用等方面来介绍这一工具。

一、什么是docker-compose：

　　docker-compose是基于docker的开源项目，托管于github上，由python实现，调用 docker服务的API负责实现对docker容器集群的快速编排，即通过一个单独的yaml文件，来定义一组相关的容器来为一个项目服务。

　　所以，docker-compose默认的管理对象是项目，通过子命令的方式对项目中的一组容器进行生命周期的管理。

二、docker-compose的安装：

　　本文简单介绍两种安装docker-compose的方式，第一种方式相对简单，但是由于网络问题，常常安装不上，并且经常会断开，第二种方式略微麻烦，但是安装过程比较稳定。

1.直接从github上下载安装：

curl -L https://github.com/docker/compose/releases/download/1.24.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose 

chmod +x /usr/local/bin/docker-compose

docker-compose --version
安装成功后查看版本，但常因网络问题无法成功

2.通过python-pip来安装：

使用pip安装docker-compose依赖python3环境，而centos7系统默认自带的Python版本是2.7.5，所以需要安装较多的依赖，流程如下：

yum -y install epel-release python-pip gcc python-devel -y  （执行两次）
pip -V
pip install --upgrade pip
pip install six --user -U
pip install docker-compose
docker-compose version
上面这个流程我测了多次，升级pip和install six --user-U时，报timeout错误，我用手机开了热点，换了个网络，就没问题了

pip install ipython --user -U    网络没问题的情况下还报错，可以试试这个

 如上，网络不好的情况下，就会因此而导致报错。

3.更简便的解决办法：

在安装pip工具的时候，直接选择安装pip3版本，使用pip3安装docker-compose便不需要再安装额外的依赖，流程如下：

yum -y install epel-release python3-pip gcc python-devel -y  （执行两次）

pip3 install docker-compose

docker-compose version

在Ubuntu18.04系统上也不会发生上述问题，因为Ubuntu18.04默认自带的Python环境是3.6.8。

 三、docker-compose常用命令：

1、Docker-Compose命令格式

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

命令选项如下：

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

 

2、docker-compose up

docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]

选项包括：

• -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指定的参数

docker-compose up

启动所有服务

docker-compose up -d

在后台所有启动服务

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

docker-compose -f docker-compose.yml up -d

 

3、docker-compose ps

docker-compose ps [options] [SERVICE...]

docker-compose ps

列出项目中目前的所有容器

 

4、docker-compose stop

docker-compose stop [options] [SERVICE...]

选项包括：

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

docker-compose stop

停止正在运行的容器，可以通过docker-compose start 再次启动

 

5、docker-compose -h

docker-compose -h

查看帮助

 

6、docker-compose down

docker-compose down [options]

停止和删除容器、网络、卷、镜像。

选项包括：

• –rmi type，删除镜像，类型必须是：all，删除compose文件中定义的所有镜像；local，删除镜像名为空的镜像
• -v, –volumes，删除已经在compose文件中定义的和匿名的附在容器上的数据卷
• –remove-orphans，删除服务中没有在compose中定义的容器

docker-compose down

停用移除所有容器以及网络相关

7、docker-compose logs

docker-compose logs [options] [SERVICE...]

查看服务容器的输出。默认情况下，docker-compose将对不同的服务输出使用不同的颜色来区分。可以通过–no-color来关闭颜色。

docker-compose logs

查看服务容器的输出

 

8、docker-compose build

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变量

服务容器一旦构建后，将会带上一个标记名。可以随时在项目目录下运行docker-compose build来重新构建服务

 

9、docker-compose pull

docker-compose pull [options] [SERVICE...]

拉取服务依赖的镜像。

选项包括：

–ignore-pull-failures，忽略拉取镜像过程中的错误

–parallel，多个镜像同时拉取

–quiet，拉取镜像过程中不打印进度信息

docker-compose pull

拉取服务依赖的镜像

 

10、docker-compose restart

docker-compose restart [options] [SERVICE...]

重启项目中的服务。

选项包括：

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

docker-compose restart

重启项目中的服务

 

11、docker-compose rm

docker-compose rm [options] [SERVICE...]

删除所有（停止状态的）服务容器。

选项包括：

• –f, –force，强制直接删除，包括非停止状态的容器
• -v，删除容器所挂载的数据卷

docker-compose rm

删除所有（停止状态的）服务容器。推荐先执行docker-compose stop命令来停止容器。

 

12、docker-compose start

docker-compose start [SERVICE...]

docker-compose start

启动已经存在的服务容器。

 

13、docker-compose run

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

在指定服务上执行一个命令。

docker-compose run ubuntu ping www.baidu.com

在指定容器上执行一个ping命令。

 

14、docker-compose scale

docker-compose scale web=3 db=2

设置指定服务运行的容器个数。通过service=num的参数来设置数量

 

15、docker-compose pause

docker-compose pause [SERVICE...]

暂停一个服务容器

 

16、docker-compose kill

docker-compose kill [options] [SERVICE...]

通过发送SIGKILL信号来强制停止服务容器。 

支持通过-s参数来指定发送的信号，例如通过如下指令发送SIGINT信号：

docker-compose kill -s SIGINT

 

17、dokcer-compose config

docker-compose config [options]

验证并查看compose文件配置。

选项包括：

• –resolve-image-digests 将镜像标签标记为摘要
• -q, –quiet 只验证配置，不输出。 当配置正确时，不输出任何内容，当文件配置错误，输出错误信息
• –services 打印服务名，一行一个
• –volumes 打印数据卷名，一行一个

 

18、docker-compose create

docker-compose create [options] [SERVICE...]

为服务创建容器。

选项包括：

• –force-recreate：重新创建容器，即使配置和镜像没有改变，不兼容–no-recreate参数
• –no-recreate：如果容器已经存在，不需要重新创建，不兼容–force-recreate参数
• –no-build：不创建镜像，即使缺失
• –build：创建容器前，生成镜像

 

19、docker-compose exec

docker-compose exec [options] SERVICE COMMAND [ARGS...]

选项包括：

• -d 分离模式，后台运行命令。
• –privileged 获取特权。
• –user USER 指定运行的用户。
• -T 禁用分配TTY，默认docker-compose exec分配TTY。
• –index=index，当一个服务拥有多个容器时，可通过该参数登陆到该服务下的任何服务，例如：docker-compose exec –index=1 web /bin/bash ，web服务中包含多个容器

 

20、docker-compose port

docker-compose port [options] SERVICE PRIVATE_PORT

显示某个容器端口所映射的公共端口。

选项包括：

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

 

21、docker-compose push

docker-compose push [options] [SERVICE...]

推送服务依的镜像。

选项包括：

• –ignore-push-failures 忽略推送镜像过程中的错误

 

22、docker-compose stop

docker-compose stop [options] [SERVICE...]

显示各个容器运行的进程情况。

 

23、docker-compose unpause

docker-compose unpause [SERVICE...]

恢复处于暂停状态中的服务。

 

24、docker-compose version

docker-compose version

打印版本信息。

四、定义docker-compose的yaml文件：

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 。

 

四、Docker-Compose模板文件示例

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

 

4.mysql数据库模板

docker-compose部署mysql：

version: '2'
services:
    mysql:
        network_mode: "bridge"
        environment:
            MYSQL_ROOT_PASSWORD: "111111"
            MYSQL_USER: 'test'
            MYSQL_PASS: '111111'
        image: "mysql:latest"
        restart: always
        volumes:
            - "./db:/var/lib/mysql"
            - "./conf/my.cnf:/etc/my.cnf"
            - "./init:/docker-entrypoint-initdb.d/"
        ports:
            - "33060:3306"

解析：

network_mode为容器的网络模式

MYSQL_ROOT_PASSWORD为数据库的密码，也就是root用户的密码。

MYSQL_USER和MYSQL_PASS另外一个用户名和密码。

image为你拉取镜像的地址和版本，当然也可以换成自己的镜像仓库，这里使用官方的。

volumes里面的参数为映射本地和docker容器里面的文件夹和目录。

./db 用来存放了数据库表文件

./conf/my.cnf存放自定义的配置文件

./init存放初始化的脚本。ports 为映射主机和容器的端口