Docker Compose使用介绍

背景

Docker Compose是Docker开源项目（项目在github上的地址为： https://github.com/docker/compose）。功能上实现对Docker容器集群的资源定义和快速编排（官网上对项目功能的简述：Defining and running multi-container Docker applications）。

对于单独一个容器，我们通常使用Dockerfile模板文件进行定义，而实际应用场景中我们需要定义和管理多个容器。Compose提供用户使用docker-compose.yml文件定义一组相关联的容器集群。项目使用Python语言编写，实现上，调用Docker提供的API对容器进行管理。

Docker Compose中有两个重要的概念：

服务（service）：一个应用容器；
项目（project）：一组相关联的应用容器组成的整体；

Docker Compose默认管理的对象是项目。通过命令对项目中的容器进行生命周期管理。

第一部分 Docker Compose的安装

Docker Compose支持Linux、MAC、WIN10三个平台。由于项目是Python编写，所以安装方式上支持：

pip安装工具安装
使用编译好的二进制文件安装

其中Docker for Mac 、Docker for Windows 自带 docker-compose 二进制文件，无需单独安装，安装 Docker 之后可以直接使用。所以主要介绍Linux系统安装部署。

1.1 pip安装

这种安装方式将Compose当作一个Python应用使用pip命令安装，需要提前部署Python环境。安装命令：

1	# pip install -U docker-compose

建议ARM架构（比如树莓派）的Linux使用pip源安装，对于X86_64架构的Linux建议使用二进制包安装方式。

1.2 二进制包安装

从Compose在Github上项目网站下载编译好的二进制文件到本地文件系统即可。

# curl -L https://github.com/docker/compose/releases/download/1.17.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   617    0   617    0     0    617      0 --:--:-- --:--:-- --:--:--  5016
100 8648k  100 8648k    0     0  8648k      0  0:00:01 --:--:--  0:00:01 8648k

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

对于卸载，如果是pip安装直接通过pip uninstall卸载，对于二进制文件安装，直接删除相关文件即可。

验证安装（查看版本号）：

1 2	# docker-compose --version docker-compose version 1.16.1, build 6d1ac21

第二部分 Docker Compose的模板

Docker Compose的核心思想是文件定义资源。默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式。下面是一个模板案例：

version: "3"
services:
  webapp:
    image: examples/web
    ports:
      - "80:80"
    volumes:
      - "/data"

注意每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。下面分别介绍各个指令的用法。

2.1 镜像容器类

image

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试从远端镜像服务拉取这个镜像。

image: ubuntu
image: orchardup/postgresql
# 支持使用images id
image: a4bc65fd

build

服务除了可以基于现有的镜像，还可以基于指定的Dockerfile。指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3'
services:
  webapp:
    build: ./dir

另外支持使用 context 指令指定 Dockerfile 所在文件夹的路径。使用 dockerfile 指令指定 Dockerfile 文件名。使用 arg 指令指定构建镜像时的变量。

version: '3'
services:

  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

使用 cache_from 指定构建镜像的缓存：

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

container_name

指定容器名称。

1	container_name: docker-web-container

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

labels

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

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

cap_add, cap_drop

指定容器的内核能力（capacity）分配。例如，让容器拥有所有能力可以指定为：

1 2	cap_add: - ALL

去掉 NET_ADMIN 能力可以指定为：

1 2	cap_drop: - NET_ADMIN

2.2 网络资源类命令

expose

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

1
2
3

expose:
 - "3000"
 - "8000"

network_mode

设置网络模式。使用和 docker run 的 --network 参数一样的值。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

networks

配置容器连接的网络。

version: "3"
services:

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

networks:
  some-network:
  other-network:

dns

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

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

dns_search

配置 DNS 搜索域。可以是一个值，也可以是一个列表。

dns_search: example.com

dns_search:
  - domain1.example.com
  - domain2.example.com

ports

暴露端口信息。使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

*注意：当使用 HOST:CONTAINER 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

extra_hosts

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息。

1
2
3

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。

1 2	8.8.8.8 googledns 52.1.157.61 dockerhub

2.3 系统资源类命令

devices

指定设备映射关系。

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

tmpfs

挂载一个 tmpfs 文件系统到容器。

tmpfs: /run

tmpfs:
  - /run
  - /tmp

sysctls

配置容器内核参数。

sysctls:
  net.core.somaxconn: 1024
  net.ipv4.tcp_syncookies: 0

sysctls:
  - net.core.somaxconn=1024
  - net.ipv4.tcp_syncookies=0

ulimits

指定容器的 ulimits 限制值。例如，指定最大进程数为 65535，指定文件句柄数为 20000（软限制，应用可以随时修改，不能超过硬限制）和 40000（系统硬限制，只能 root 用户提高）。

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000

volumes

数据卷所挂载路径设置。可以设置宿主机路径（HOST:CONTAINER）或加上访问模式（HOST:CONTAINER:ro）。该指令中路径支持相对路径。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

2.4 调度管理类

depends_on

解决容器的依赖、启动先后的问题，比如让数据库内容器先运行起来。以下例子中会先启动 redis db 再启动 web

version: '3'

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

  redis:
    image: redis

  db:
    image: postgres

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

pid

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。

1	pid: "host"

command

覆盖容器启动后默认执行的命令。

1	command: echo "hello world"

cgroup_parent

指定父 cgroup 组，意味着将继承该组的资源限制。例如，创建了一个 cgroup 组名称为 cgroups_1。

1	cgroup_parent: cgroups_1

stop_signal

设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。

1	stop_signal: SIGUSR1

2.5 安全类

secrets

存储敏感数据，例如 mysql 服务密码。

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
    - my_other_secret

secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

security_opt

指定容器模板标签（label）机制的默认属性（用户、角色、类型、级别等）。例如配置标签的用户名和角色名。

1
2
3

security_opt:
    - label:user:USER
    - label:role:ROLE

2.6 日志和监控类

healthcheck

通过命令检查容器是否健康运行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3

logging

配置日志选项。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

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

1
2
3

driver: "json-file"
driver: "syslog"
driver: "none"

options 配置日志驱动的相关参数。

1
2
3

options:
  max-size: "200k"
  max-file: "10"

configs

仅用于 Swarm mode，详细内容请查看 Swarm mode 一节。

deploy

仅用于 Swarm mode，详细内容请查看 Swarm mode 一节

env_file

从文件中获取环境变量，可以为单独的文件路径或列表。

如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件，则 env_file中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

环境变量文件中每一行必须符合格式，支持 # 开头的注释行。

1 2	# common.env: Set development environment PROG_ENV=development

environment

设置环境变量。你可以使用数组或字典两种格式。只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

如果变量名称或者值中用到 true|false，yes|no 等表达布尔含义的词汇，最好放到引号里，避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇，包括

1	y\|Y\|yes\|Yes\|YES\|n\|N\|no\|No\|NO\|true\|True\|TRUE\|false\|False\|FALSE\|on\|On\|ON\|off\|Off\|OFF

external_links

注意：不建议使用该指令。

链接到 docker-compose.yml 外部的容器，甚至并非 Compose 管理的外部容器。

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

links

注意：不推荐使用该指令。

其它指令

此外，还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir等指令，基本跟 docker run 中对应参数的功能一致。

指定服务容器启动后执行的入口文件。

1	entrypoint: /code/entrypoint.sh

指定容器中运行应用的用户名。

1	user: nginx

指定容器中工作目录。

1	working_dir: /code

指定容器中搜索域名、主机名、mac 地址等。

1
2
3

domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A

允许容器中运行一些特权命令。

1	privileged: true

指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效，在生产环境中推荐配置为 always 或者 unless-stopped。

1	restart: always

以只读模式挂载容器的 root 文件系统，意味着不能对容器内容进行修改。

1	read_only: true

打开标准输入，可以接受外部输入。

1	stdin_open: true

模拟一个伪终端。

tty: true

读取变量

Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。

例如，下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值，并写入执行的指令中。

version: "3"
services:

db:
  image: "mongo:${MONGO_VERSION}"

如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器；如果执行 MONGO_VERSION=2.8 docker-compose up 则会启动一个 mongo:2.8镜像的容器。

若当前目录存在 .env 文件，执行 docker-compose 命令时将从该文件中读取变量。

在当前目录新建 .env 文件并写入以下内容。

1 2	# 支持 # 号注释 MONGO_VERSION=3.6

执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。

第三部分案例

下面是一个启动Elasticsearch集群的docker compose资源定义文件，我们使用注释进行介绍。

一共定义了5个服务容器

version: '3'
services:
  cerebro:
    image: lmenezes/cerebro:0.8.3
    container_name: hwc_cerebro
    ports:
      - "9000:9000"
    command:
      - -Dhosts.0.host=http://elasticsearch:9200
    networks:
      - hwc_es7net
  kibana:
    image: docker.elastic.co/kibana/kibana:7.1.0
    container_name: hwc_kibana7
    environment:
      #- I18N_LOCALE=zh-CN
      - XPACK_GRAPH_ENABLED=true
      - TIMELION_ENABLED=true
      - XPACK_MONITORING_COLLECTION_ENABLED="true"
    ports:
      - "5601:5601"
    networks:
      - hwc_es7net
  elasticsearch:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.1.0
    container_name: es7_hot
    environment:
      - cluster.name=elasticsearch
      - node.name=es7_hot
      - node.attr.box_type=hot
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
      - discovery.seed_hosts=es7_hot,es7_warm,es7_cold
      - cluster.initial_master_nodes=es7_hot,es7_warm,es7_cold
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - hwc_es7data_hot:/usr/share/elasticsearch/data
    ports:
      - 9200:9200
    networks:
      - hwc_es7net
  elasticsearch2:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.1.0
    container_name: es7_warm
    environment:
      - cluster.name=elasticsearch
      - node.name=es7_warm
      - node.attr.box_type=warm
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
      - discovery.seed_hosts=es7_hot,es7_warm,es7_cold
      - cluster.initial_master_nodes=es7_hot,es7_warm,es7_cold
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - hwc_es7data_warm:/usr/share/elasticsearch/data
    networks:
      - hwc_es7net
  elasticsearch3:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.1.0
    container_name: es7_cold
    environment:
      - cluster.name=elasticsearch
      - node.name=es7_cold
      - node.attr.box_type=cold
      - bootstrap.memory_lock=true
      - "ES_JAVA_OPTS=-Xms1g -Xmx1g"
      - discovery.seed_hosts=es7_hot,es7_warm,es7_cold
      - cluster.initial_master_nodes=es7_hot,es7_warm,es7_cold
    ulimits:
      memlock:
        soft: -1
        hard: -1
    volumes:
      - hwc_es7data_cold:/usr/share/elasticsearch/data
    networks:
      - hwc_es7net


volumes:
  hwc_es7data_hot:
    driver: local
  hwc_es7data_warm:
    driver: local
  hwc_es7data_cold:
    driver: local

networks:
  hwc_es7net:
    driver: bridge

参考文献

项目文档：https://yeasy.gitbooks.io/docker_practice/compose/compose_file.html

Docker Compose 配置文件详解 https://www.jianshu.com/p/2217cfed29d7

Docker：Docker Compose 详解 https://www.jianshu.com/p/658911a8cff3

目录

背景