前言

docker-compose 项目是 Docker 官方的开源项目,负责实现对 Docker 容器集群的快速编排。从功能上看,跟 OpenStack 中的 Heat 十分类似。

一个项目中，我们会应用到多个容器一起工作。这样子我们就需要写多个 Dockerfile，而且要分别运行起来，可以写个脚本启动，但是这样子太麻烦了。docker-copomse 就是为了解决多个容器同时完成某项任务的情况。

安装

docker-compose 是 Python 写的，支持 Windows、Linux 和 Mac 平台，可以直接通过 pip 安装。

pip install  docker-compose

在 github 上的 docker/compose 项目，也提供了二进制下载，直接在 release 页面，直接下载解压就可以使用了。

使用

查看帮助：

 docker-compose -h

Define and run multi-container applications with Docker.

Usage:
  docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
  docker-compose -h|--help

Options:
  -f, --file FILE             Specify an alternate compose file
                              (default: docker-compose.yml)
  -p, --project-name NAME     Specify an alternate project name
                              (default: directory name)
  --verbose                   Show more output
  --log-level LEVEL           Set log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  --no-ansi                   Do not print ANSI control characters
  -v, --version               Print version and exit
  -H, --host HOST             Daemon socket to connect to

  --tls                       Use TLS; implied by --tlsverify
  --tlscacert CA_PATH         Trust certs signed only by this CA
  --tlscert CLIENT_CERT_PATH  Path to TLS certificate file
  --tlskey TLS_KEY_PATH       Path to TLS key file
  --tlsverify                 Use TLS and verify the remote
  --skip-hostname-check       Don't check the daemon's hostname against the
                              name specified in the client certificate
  --project-directory PATH    Specify an alternate working directory
                              (default: the path of the Compose file)
  --compatibility             If set, Compose will attempt to convert deploy
                              keys in v3 files to their non-Swarm equivalent

Commands:
  build              Build or rebuild services
  bundle             Generate a Docker bundle from the Compose file
  config             Validate and view the Compose file
  create             Create services
  down               Stop and remove containers, networks, images, and volumes
  events             Receive real time events from containers
  exec               Execute a command in a running container
  help               Get help on a command
  images             List images
  kill               Kill containers
  logs               View output from containers
  pause              Pause services
  port               Print the public port for a port binding
  ps                 List containers
  pull               Pull service images
  push               Push service images
  restart            Restart services
  rm                 Remove stopped containers
  run                Run a one-off command
  scale              Set number of containers for a service
  start              Start services
  stop               Stop services
  top                Display the running processes
  unpause            Unpause services
  up                 Create and start containers
  version            Show the Docker-Compose version information

Compose 模板文件

例如：

version: "2"
services:
  nginx:
    image: nginx_php:latest
    ports:
      - "80:80"
      - "1443:443"
    volumes:
      - /data/blog/nginx/:/data/nginx/
  mariadb:
    image: mariadb:latest
    volumes:
      - /data/blog/mariadb:/data/mariadb
  wordpress:
    image: wordpress:latest
    depends_on:
      - mariadb
      - nginx
    environment:
      - MYSQL_RANDOM_ROOT_PASSWORD=opcai
    ports:
      - "8080:80"
      - "8081:443"
    volumes:
      - /data/blog/wordpress:/data/wordpress

模板文件是使用 Compose 的核心,涉及到的指令关键字也比较多，大部分指令跟 docker run 相关参数的含义都是类似的。默认的模板文件名称为 docker-compose.yml ,格式为 YAML 格式。在旧版本(版本 1)中,其中每个顶级元素为服务名称,次级元素为服务容器的配置信息

version：版本 2 扩展了 Compose 的语法,同时尽量保持跟版本 1 的兼容,除了可以声明网络和存储信息外,最大的不同一是添加了版本信息,另一个是需要将所有的服务放到 services 根下面。

services：定义服务，nginx、mariadb、wordpress：属于服务名称

build：指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 docker-compose.yml 文件的路径)。 Compose 将会利用它自动构建这个镜像,然后使用这个镜像。

cap_add 或者 cap_drop：指定容器的内核能力(capacity)分配。

例如,让容器拥有所有能力可以指定为:

cap_add:
  - ALL

去掉 NET_ADMIN 能力可以指定为:

cap_drop:
  - NET_ADMIN

image：指定为镜像名称或镜像 ID。如果镜像在本地不存在, Compose 将会尝试拉去这个镜像。

depends_on：指定依赖的镜像

evironment：设置环境变量

ports：暴露端口信息。跟 docker run 的-p 参数相同

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

volumes：数据卷所挂载路径设置。可以设置宿主机路径 ( HOST:CONTAINER ) 或加上访问模式 ( HOST:CONTAINER:ro )。

command：覆盖容器启动后默认执行的命令。例如：command: echo “hello world”

cgroup_parent：指定父 cgroup 组,意味着将继承该组的资源限制。

containername：指定容器名称。默认将会使用 项目名称服务名称_序号 这样的格式。例如:container_name: docker-web-container

devices：指定设备映射关系。

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

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

dns: 8.8.8.8
dns:
 - 8.8.8.8
 - 9.9.9.9

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

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

dockerfile：如果需要指定额外的编译镜像的 Dockefile 文件，可以通过该指令来指定，该指令不能跟 image 同时使用

dockerfile: Dockerfile-new

env_file：从文件中获取环境变量,可以为单独的文件路径或列表。如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则 env_file 中变量的路径会基于模板文件路径。如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。

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

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

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

environment:
  RACK_ENV: development
  SESSION_SECRET:
或者
environment:
  - RACK_ENV=development
  - SESSION_SECRET

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

expose:
  - "3000"
  - "8000"

extends：基于其它模板文件进行扩展。

extends:
  file: common.yml
  service: webapp
（这里是针对common.yaml文件里面的webapp的service进行扩展）

external_links：链接到 docker-compose.yml 外部的容器,甚至 并非 Compose 管理的外部容器。参数格式跟 links 类似。

external_links:
  - redis_1
  - project_db_1:mysql
  - project_db_1:mongodb

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

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

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

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

links 链接到其它服务中的容器。使用服务名称(同时作为别名)或服务名称:服务别名(SERVICE:ALIAS) 格式都可以。

links:
  - db
  - db:database
  - redis

log_driver：类似 Docker 中的 –log-driver 参数,指定日志驱动类型。

目前支持三种日志驱动类型：
log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

log_opt：日志驱动的相关参数。

log_driver: "syslog"
log_opt:
  syslog-address: "tcp://192.168.0.42:123"

net：设置网络模式。使用和 docker client 的 –net 参数一样的值。

net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

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

pid: "host"

security_opt：指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。

例如配置标签的用户名和角色名：

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

ulimits：指定容器的 ulimits 限制值。

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

docker-compose 常用命令

指定 compose 文件，如果不指定就是查找当前目录的 docker-compose.yaml

docker-compose  -f  /data/docker/docker-compose.yaml  ps

创建服务

docker-compose create

创建并启动服务，如果是需要后台执行，需要加-d 参数

docker-compose up

需要同步数据，可以针对服务执行一条命令

docker-compose run web syncdb

启动|停止|重启|暂停|恢复服务

docker-compose  start|stop|restart|pause|unpause

查看服务状态

docker-compose ps

停止并删除所有服务

docker-compose down

列出服务中的所有镜像

docker-compose  images

删除退出的容器

docker-compose rm

查看 compose 配置

docker-compose config