DockerCompose简介

Docker-Compose项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。Compose允许用户通过一个单独的docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。Docker-Compose项目由Python编写，调用Docker服务提供的API来对容器进行管理。因此，只要所操作的平台支持Docker API，就可以在其上利用Compose来进行编排管理。
Docker-Compose将所管理的容器分为三层，分别是工程（project），服务（service）以及容器（container）。Docker-Compose运行目录下的所有文件（docker-compose.yml，extends文件或环境变量文件等）组成一个工程，若无特殊指定工程名即为当前目录名。一个工程当中可包含多个服务，每个服务中定义了容器运行的镜像，参数，依赖。一个服务当中可包括多个容器实例，Docker-Compose并没有解决负载均衡的问题，因此需要借助其它工具实现服务发现及负载均衡。
Docker-Compose的工程配置文件默认为docker-compose.yml，可通过环境变量COMPOSE_FILE或-f参数自定义配置文件，其定义了多个有依赖关系的服务及每个服务运行的容器。
使用一个Dockerfile模板文件，可以让用户很方便的定义一个单独的应用容器。在工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个Web项目，除了Web服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。

docker-compose的常用命令表

DockerCompose入门 - 图1

常见的命令格式如下

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

    docker-compose up

    1. $ 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指定的参数

    1. $ docker-compose up

    启动所有服务

    1. $ docker-compose up -d

    在后台所有启动服务
    -f 指定使用的Compose模板文件，默认为docker-compose.yml，可以多次指定。

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

    docker-compose ps

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

    docker-compose start

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

    1. $ docker-compose start [SERVICE...]
    2. $ docker-compose start

    docker-compose stop

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

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

    docker-compose restart

    重启项目中的服务。

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

    选项包括：

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

    docker-compose down

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

    1. $ docker-compose down [options]

    选项包括

  • –rmi type，删除镜像，类型必须是：all，删除compose文件中定义的所有镜像；local，删除镜像名为空的镜像

  • -v, –volumes，删除已经在compose文件中定义的和匿名的附在容器上的数据卷

  • –remove-orphans，删除服务中没有在compose中定义的容器

    docker-compose logs

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

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

    docker-compose build

    构建（重新构建）项目中的服务容器。

    1. $ 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 pull

    拉取服务依赖的镜像。

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

    选项包括：

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

  • –parallel，多个镜像同时拉取
  • –quiet，拉取镜像过程中不打印进度信息

    docker-compose rm

    删除所有（停止状态的）服务容器。
    1. $ docker-compose rm [options] [SERVICE...]
    选项包括：
    –f, –force，强制直接删除，包括非停止状态的容器
    -v，删除容器所挂载的数据卷

    docker-compose run

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

    docker-compose 模版文件

    Compose允许用户通过一个docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
    Compose模板文件是一个定义服务、网络和卷的YAML文件。Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名。
    Docker-Compose标准模板文件应该包含version、services、networks 三大部分，最关键的是services和networks两个部分。
    1. version: "2.1"
    2. services:
    3. img-name:
    4.   image: xxxx

    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将来会被弃用。

挂载文件

docker-compose支持两种方式设置持久化的文件

  1. servicename:
  2.   image: image-name
  3.   volumes:
  4.   - /path/to/file:/path/to/container/file

这种方式将文件直接挂载到容器中，使用起来比较直观，但是需要管理本地路径。

  1. servicename:
  2.   image: image-name
  3.   volumes:
  4.   - volume-name:/path/to/container/file
  5. volumes:
  6.   volume-name: /path/to/local/file

使用docker volume ls命令可以查看本地挂载的文件。
使用docker volume inspect volume-name命令可以查看具体的真实地址

DockerCompose的配置文件

YAML文件格式及编写注意事项

YAML是一种标记语言很直观的数据序列化格式,可读性高。类似于XML数据描述语言,语法比XML简单的很多。
YAML数据结构通过缩进来表示,连续的项目通过减号来表示,键值对用冒号分隔,数组用中括号括起来,hash用花括号括起来。
YAML文件格式注意事项:

    1. 不支持制表符tab键缩进,需要使用空格缩进
    1. 通常开头缩进2个空格
    1. 字符后缩进1个空格,如冒号、逗号、横杆
    1. 用井号注释
    1. 如果包含特殊字符用单引号引起来
    1. 布尔值(true、false、yes、no、on、off)必须用引号括起来,这样分析器会将他们解释为字符串。

      配置文件的常用字段

      DockerCompose入门 - 图2
      更多请参见：官方文档

      DockerCompose配置示例

      此处只对docker-compose的配置文件进行简单的介绍，如需要具体应用的配置文件请关注我的博客

  1. # yaml 配置
  2.  # 指定 compose 文件的版本
  3. version: '3'
  4. services:
  5.   redis:
  6.     # 指定 docker 镜像, 可以是远程仓库镜像、本地镜像
  7.     image: redis
  8.     ports:
  9.       - "6379:6379"
  10.     networks:
  11.       - app
  12.   nginx:
  13.     image: nginx
  14.     # 建立宿主机和容器之间的端口映射关系
  15.     ports:
  16.       - 80:80
  17.       - "443:443"
  18.    # 定义容器和宿主机的卷映射关系, 
  19.     volumes:
  20.       - ./nginx/nginx.conf:/etc/nginx/nginx.conf
  21.       - ./nginx/logs:/var/log/nginx
  22.       - ./nginx/html:/usr/share/nginx/myhtml
  23.       - ./nginx/crt:/etc/nginx/crt  
  24.     # 将容器加入指定网络
  25.     networks:
  26.       - app
  27.   es:      
  28.     image: es_ik:1.2 
  29.     ports:
  30.       - "9200:9200"
  31.       - "9300:9300"     
  32.     networks:
  33.       - app     
  34.   mongo-connector:
  35.     image: mongo_connector:1.6  
  36.     volumes: 
  37.       - ./mongo-connect/mongo_es_config_3_20.json:/usr/local/mongo-connector/config/mongo_es_config_3_20.json
  38.       - ./mongo-connect/log:/usr/local/mongo-connector/log  
  39.     # 覆盖容器启动后默认执行的命令, 支持 shell 格式和 [] 格式
  40.     command: 
  41.       - /bin/sh
  42.       - -c
  43.       - | 
  44.           mongo-connector -c /usr/local/mongo-connector/config/mongo_es_config_3_20.json   
  45.     # 定义容器启动顺序 
  46.     depends_on:
  47.       - es 
  48.     networks:
  49.       - app      
  50.   es_head:
  51.     image: mobz/elasticsearch-head:5
  52.     ports:
  53.       - "9000:9100"
  54.     networks:
  55.       - app
  56.     depends_on:
  57.       - es     
  58.   project:
  59.     image: adoptopenjdk/openjdk8
  60.     volumes: 
  61.       - ./workapp:/usr/local/workapp
  62.     ports:
  63.       - 8080:8080    
  64.     command:
  65.       - /bin/sh
  66.       - -c
  67.       - |
  68.           sh /usr/local/workapp/mysh.sh    
  69.     depends_on:
  70.       - es
  71.       - redis
  72.       - nginx  
  73. # 定义 networks 信息    
  74. networks:
  75.   app:
  76.     external: true