概述

什么是Docker-Compose

Docker-Compose 项目是Docker官方的开源项目，负责实现对Docker容器集群的快速编排。

在单个机器上部署和管理繁多的Docker容器是困难的，而这正是 Docker Compose 要解决的问题。Docker Compose 并不是通过脚本和各种冗长的 docker 命令来将应用组件组织起来，而是通过一个声明式的配置文件描述整个应用，从而使用一条命令完成部署。应用部署成功后，还可以通过一系列简单的命令实现对其完整声明周期的管理。甚至，配置文件还可以置于版本控制系统中进行存储和管理。

Docker-Compose 项目由 Python 编写，调用 Docker 服务提供的API来对容器进行管理。因此，只要所操作的平台支持 Docker API，就可以在其上利用Compose 来进行编排管理。

Compose、Machine 和 Swarm 是Docker 原生提供的三大编排工具。简称Docker三剑客。

Compose模板文件

Compose模板文件是一个定义服务、网络和卷的YAML文件，它定义一组相关联的应用容器为一个项目（project）。有了Docker-Compose，不需要使用shell命令来启动容器，而是使用Compose模板文件来配置应用程序需要的所有服务，然后使用一个命令，根据Compose模板文件的配置创建并启动所有服务。

1. Compose模板文件默认路径是当前目录，使用.yml或.yaml作为文件扩展名，文件默认为 docker-compose.yml，可通过环境变量 COMPOSB_FILE 或 -f 参数自定义文件名。
2. Compose标准模板文件应该包含version、services、networks三大部分。
3. 一个项目中可包含多个服务，每个服务中定义了容器运行的镜像、参数、依赖等。
4. 一个服务当中可包括多个容器实例，但是Docker-Compose 并没有解决负载均衡的问题，因此需要借助其它工具实现服务发现及负载均衡，比如 Consul 技术。

安装Docker-Compose

1

yum -y install docker-compose

Docker-Compose语法说明

image

指定镜像名称或镜像id，使用此镜像。如果本地不存在这个镜像，Compose会从镜像仓库去拉取这个镜像

1
2
3

services:
  web:
    image: nginx:1.14

build

指定Dockerfile所在文件夹的路径。Compose将会利用此文件夹中的Dockerfile文件自动构建这个镜像，然后使用这个镜像。

1
2
3

services:
  web:
    build: path

command

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

1
2

image: nginx:1.14
command: /bin/sh

links

连接到其他服务容器，使用服务名称(同时作为别名)或服务别名（SERVICE:ALIAS）都可以

注意：用别名会自动在容器中的/etc/hosts 里创建解析名，相应的环境变量也会被创建。

1
2
3

links:
  - db:database
  - redis

external_links

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

1
2
3

external_links: 
  - redis_1
  - project_db_1:mysql

ports

指定暴露的端口，或者仅仅指定容器的端口（宿主机器将会随机分配端口），格式：宿主机端口：容器端口。

注意：建议采用字符串写法，因为如果使用的容器端口小于 60 可能会得到错误的结果，因为 YAML 会将解xx:yy这种数字格式解析为 60 进制。

1
2
3
4

ports:
  - "3306"
  - "8080:80"
  - "127.0.0.1:8090:8001"

expose

也是指定暴露的端口，与posts不同的是expose只是提供一个声明，便于使用。

1
2
3

expose:
  - "3000"
  - "8000"

volumes

设置卷挂载的路径，可以设置宿主机路径:容器路径，也可以设置卷名：容器路径（卷名若不存在会自动创建），或加上访问模式

1
2
3

volumes:
  - db_data:/var/lib/mysql
  - /configs/mysql:/etc/configs/:ro

volumes_from

挂载另一个服务或容器的所有数据卷，使用相同的卷名和目录。

1
2
3

volumes_from:
  - service_name
  - container_name

environment

设置环境变量。如果只给定变量的名称则会自动加载它在Compose主机上的值，可以用来防止泄露不必要的数据。

1
2
3

environment:
  - RACK_ENV=development
  - SESSION_SECRET

env_file

从文件中获取环境变量，基于Compose模板文件的相对路径，可以为单独的文件或列表。如果有变量与environment指令冲突则以后者为准。

1
2
3
4
5

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

注意：环境变量文件格式如下，每一行都必须有#开头的注释行

1
2

# common.env: Set Rails/Rack environment
RACK_ENV=development

net

设置网络模式，与docker run 命令中的 --network选项一样

1

net: "bridge"		# 可选：none/host/container:容器名/自定义网络名

dns

配置DNS服务器。可以是一个值，也可以是一个列表

1
2
3
4

dns: 8.8.8.8
dns:
  - 8.8.8.8
  - 9.9.9.9

depends_on

依赖的服务，优先启动

1
2

depends_on:
  - redis

deploy

部署相关的配置都在这里，若无特殊需求，下面的例子可以通用

1
2
3
4
5
6
7
8
9
10
11
12
13

deploy:
  mode: replicated
  replicas: 2
  restart_policy:
    condition: on-failure
    max_attempts: 3
  update_config:
    delay: 5s
    order: start-first # 默认为 stop-first，推荐设置先启动新服务再终止旧的
  resources:
    limits:
      cpus: "0.50"
      memory: 1g

Docker-Compose常用命令

命令格式：

1

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

常用选项：

1
2

-f 文件名		指定docker-compose模板文件，默认是当前目录下的docker-compose.yml
-p 项目名		指定项目名，默认是当前目录名

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

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

docker-compose up

启动项目中的容器

1

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

1
2
3

docker-compose up		# 启动所有服务
docker-compose up -d	# 在后台启动所有服务
docker-compose up -d --scale SERVICE=3 nginx		# 在后台启动三个nginx服务

docker-compose down

停止并且删除项目中定义的容器和网络

1

docker-compose down [options]

1
2
3

docker-compose down --rmi 镜像类型		# 顺便把镜像也删了，all：删除所有用到的镜像；local：仅删除未指定标签的镜像
docker-compose down -v		# 顺便把用到的存储卷也删了，包括声明卷和匿名卷
--remove-orphans 		# 把模板文件中没有定义的容器也删了

docker-compose ps

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

1

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

1
2
3

docker-compose ps		# 列出项目中目前的所有容器
docker-compose ps -q	# 列出项目中目前的所有容器，仅展示容器id
docker-compose ps nginx		# 列出项目中nginx服务的所有容器

docker-compose stop

停止正在运行的容器

1

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

1
2

docker-compose stop		# 停止所有正在运行的容器
docker-compose stop	nginx		# 停止所有正在运行nginx服务的容器

docker-compose start

启动已经存在的容器

1

docker-compose start [SERVICE...]

1
2

docker-compose start		# 启动已经存在的容器
docker-compose start nginx		# 启动已经存在的nginx服务的容器

docker-compose restart

重启正在运行的容器

1

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

1
2

docker-compose restart -t 20		# 重启运行中的容器，默认超时时间是10s
docker-compose restart nginx		# 重启运行中的nginx服务中的容器

docker-compose logs

查看服务容器的输出

1

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

1
2

docker-compose logs		# 展示所有容器的输出
docker-compose logs	nginx		# 展示nginx服务中容器的输出

docker-compose build

构建（重新构建）项目中的容器，当更改了构建目录或者服务的Dockerfile文件时，可以使用此命令

1

docker-compose build [options] [--build-arg key=val...] [SERVICE...]

1
2

docker-compose build		# 重新构建所有容器
docker-compose build nginx		# 重新构建nginx服务中的容器