Docker（四）Docker Compose

2018-09-16 阅读量

× 文章目录

1. Quick Guide

Docker Compose是 Docker 提供的一个命令行工具，使用 Docker Compose 可以轻松、高效的管理容器，它是一个用于定义和运行多容器 Docker 的应用程序工具 。通过 Compose，您可以使用 YML 文件来配置应用程序需要的所有服务。然后，使用一个命令，就可以从 YML 文件配置中创建并启动所有服务。

本文章介绍如何使用 Docker Compose 。

Quick Guide

安装

macOS和windows PC 桌面版的Docker自带，不需要安装。下面介绍Linux的安装

Linux 上我们可以从 Github 上下载最新发行的版本包来使用。

# 下载 1.24.1 版本包
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
# 授权可执行权限
sudo chmod +x /usr/local/bin/docker-compose

# 创建软链
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

# 测试是否安装成功
docker-compose --version

使用步骤

工程、服务、容器
Docker Compose 将所管理的容器分为三层，分别是工程（project）、服务（service）、容器（container）
Docker Compose 运行目录下的所有文件（docker-compose.yml）组成一个工程,一个工程包含多个服务，每个服务中定义了容器运行的镜像、参数、依赖，一个服务可包括多个容器实例.

使用 docker-compose 构建一个在docker中运行的基于python flask框架的web应用。

# 预计最终目录结构
└── compose_project
    ├── docker
    │   └── docker-compose.yml
    ├── Dockerfile
    └── src
        ├── app.py
        └── requirements.txt

1.准备

1.1.创建工程目录

mkdir compose_project
cd compose_project
mkdir src # 源码文件夹
mkdir docker # docker配置文件夹

1.2.在compose_project/src/目录下创建python flask应用 compose_project/src/app.py文件

rom flask import Flask
from redis import Redis
 
app = Flask(__name__)
redis = Redis(host='redis_ip', port=6666)
 
@app.route('/')
def count_num():
    count = redis.incr('hits')
    return f'{count} times.\n'
 
if __name__ == "__main__":
    app.run(host="0.0.0.0", debug=True)

1.3.创建python 需求文件 compose_project/src/requirements.txt
1
2
flask
redis

2. 定义创建容器的Dockerfile文件

compose_project/目录下创建Dockerfile文件：

FROM python:3.7
 
COPY src/ /opt/src
WORKDIR /opt/src
 
RUN pip install -r requirements.txt
CMD ["python", "app.py"]

3. 定义docker-compose脚本

在compose_project/docker/目录下创建docker-compose.yml文件，并在里面定义服务。

version: '3'
services:
  web:
    build: ../../../../../09.cahe/Desktop
    ports:
     - "5000:5000"
  redis:
    image: "redis:3.0.7"

web容器：
- 使用当前docker-compose.yml文件所在目录的上级目录（compose_project/Dockerfile）中的Dockerfile构建映像。
- Flask Web服务器的默认端口5000,将容器上的暴露端口5000映射到主机上的端口5000。
redis容器: redis 服务使用从Docker Hub提取的官方redis镜像3.0.7版本

4. 使用Compose构建并运行您的应用程序

在compose_project/docker/目录下执行docker-compose.yml文件：

docker-compose up
# 若是要后台运行，命令需要-d：
docker-compose up -d
# 若不使用默认的docker-compose.yml 文件名：
docker-compose -f server.yml up -d

Docker Compose 常用命令

ps：列出所有运行容器
1
docker-compose ps
logs：查看服务日志输出
1
docker-compose logs

port：打印绑定的公共端口，下面命令可以输出 flask 服务 8761 端口所绑定的公共端口
1
docker-compose port flask 8761
build：构建或者重新构建服务
1
docker-compose build
start：启动指定服务已存在的容器
1
docker-compose start flask
stop：停止已运行的服务的容器
1
docker-compose stop flask
rm：删除指定服务的容器
1
docker-compose rm flask
up：构建、启动容器
1
docker-compose up
kill：通过发送 SIGKILL 信号来停止指定服务的容器
1
docker-compose kill flask
pull：下载服务镜像
scale：设置指定服务运气容器的个数，以 service=num 形式指定
1
docker-compose scale user=3 movie=3
run：在一个服务上执行一个命令
1
docker-compose run web bash

yml 配置指令参考

version：指指定本 yml 依从的 compose 哪个版本制定的

services：多个容器集合

build：指定为构建镜像上下文路径，该值可以是一个路径，也可以是一个对象，用于指定 Dockerfile 参数,例如

version: "3.7"
services:
  webapp:
    build: ./dir

version: "3.7"
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1
      labels:
        - "com.example.description=Accounting webapp"
        - "com.example.department=Finance"
        - "com.example.label-with-empty-value"
      target: prod

context：上下文路径。
dockerfile：指定构建镜像的 Dockerfile 文件名。
args：添加构建参数，这是只能在构建过程中访问的环境变量。
labels：设置构建镜像的标签。
target：多层构建，可以指定构建哪一层。

cap_add cap_drop:添加或删除容器拥有的宿主机的内核功能。

cap_add:
  - ALL # 开启全部权限

cap_drop:
  - SYS_PTRACE # 关闭 ptrace权限

cgroup_parent:为容器指定父 cgroup 组，意味着将继承该组的资源限制。
1
cgroup_parent: m-executor-abcd
container_name:指定自定义容器名称，而不是生成的默认名称。
1
container_name: my-web-container
depends_on:设置依赖关系
- docker-compose up ：以依赖性顺序启动服务。在以下示例中，先启动 db 和 redis ，才会启动 web。
- docker-compose up SERVICE ：自动包含 SERVICE 的依赖项。在以下示例中，docker-compose up web 还将创建并启动 db 和 redis。
- docker-compose stop ：按依赖关系顺序停止服务。在以下示例中，web 在 db 和 redis 之前停止。
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  version: "3.7"
  services:
  web:
  build: .
  depends_on:
  - db
  - redis
  redis:
  image: redis
  db:
  image: postgres
  注意：web 服务不会等待 redis db 完全启动之后才启动。

deploy:指定与服务的部署和运行有关的配置,只在 swarm 模式下才会有用。

version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      mode：replicated
      replicas: 6
      endpoint_mode: dnsrr
      labels: 
        description: "This redis service label"
      resources:
        limits:
          cpus: '0.50'
          memory: 50M
        reservations:
          cpus: '0.25'
          memory: 20M
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s

可以选参数：

endpoint_mode：访问集群服务的方式。

endpoint_mode: vip 
# Docker 集群服务一个对外的虚拟 ip。所有的请求都会通过这个虚拟 ip 到达集群服务内部的机器。
endpoint_mode: dnsrr
# DNS 轮询（DNSRR）。所有的请求会自动轮询获取到集群 ip 列表中的一个 ip 地址。

labels：在服务上设置标签。可以用容器上的 labels（跟 deploy 同级的配置）覆盖 deploy 下的 labels。

mode：指定服务提供的模式。

replicated：复制服务，复制指定服务到集群的机器上。
global：全局服务，服务将部署至集群的每个节点。
图解：下图中黄色的方块是 replicated 模式的运行情况，灰色方块是 global 模式的运行情况。

replicas：mode 为 replicated 时，需要使用此参数配置具体运行的节点数量。

resources：配置服务器资源使用的限制，例如上例子，配置 redis 集群运行需要的 cpu 的百分比和内存的占用。避免占用资源过高出现异常。

restart_policy：配置如何在退出容器时重新启动容器。
condition：可选 none，on-failure 或者 any（默认值：any）。
delay：设置多久之后重启（默认值：0）。
max_attempts：尝试重新启动容器的次数，超出次数，则不再尝试（默认值：一直重试）。
window：设置容器重启超时时间（默认值：0）。

rollback_config：配置在更新失败的情况下应如何回滚服务。
parallelism：一次要回滚的容器数。如果设置为0，则所有容器将同时回滚。
delay：每个容器组回滚之间等待的时间（默认为0s）。
failure_action：如果回滚失败，该怎么办。其中一个 continue 或者 pause（默认pause）。
monitor：每个容器更新后，持续观察是否失败了的时间 (ns|us|ms|s|m|h)（默认为0s）。
max_failure_ratio：在回滚期间可以容忍的故障率（默认为0）。
order：回滚期间的操作顺序。其中一个 stop-first（串行回滚），或者 start-first（并行回滚）（默认 stop-first ）。

update_config：配置应如何更新服务，对于配置滚动更新很有用。
parallelism：一次更新的容器数。
delay：在更新一组容器之间等待的时间。
failure_action：如果更新失败，该怎么办。其中一个 continue，rollback 或者pause （默认：pause）。
monitor：每个容器更新后，持续观察是否失败了的时间 (ns|us|ms|s|m|h)（默认为0s）。
max_failure_ratio：在更新过程中可以容忍的故障率。
order：回滚期间的操作顺序。其中一个 stop-first（串行回滚），或者 start-first（并行回滚）（默认stop-first）。

注：仅支持 V3.4 及更高版本。

devices：指定设备映射列表

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

dns：自定义 DNS 服务器，可以是单个值或列表的多个值。
1
2
3
4
5
dns: 8.8.8.8

dns:
- 8.8.8.8
- 9.9.9.9

dns_search：自定义 DNS 搜索域，可以是单个值或列表。

dns_search: example.com

dns_search:
  - dc1.example.com
  - dc2.example.com

entrypoint：覆盖容器默认的 entrypoint。
1
entrypoint: /code/entrypoint.sh

也可以是以下格式：

1
2
3
4
5
6
7
entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit


------

env_file：从文件添加环境变量。可以是单个值或列表的多个值。
1
env_file: .env

1
2
3
4
env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env


------

environment：添加环境变量。您可以使用数组或字典、任何布尔值，布尔值需要用引号引起来，以确保 YML 解析器不会将其转换为 True 或 False。
1
2
3
environment:
RACK_ENV: development
SHOW: 'true'
- expose：暴露端口，但不映射到宿主机，只被连接的服务访问。仅可以指定内部端口为参数。
  1
  2
  3
  expose:
  - "3000"
  - "8000"

extra_hosts：添加主机名映射。类似 docker client –add-host。

1
2
3

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

以上会在此服务的内部容器中 /etc/hosts 创建一个具有 ip 地址和主机名的映射关系：

1
2
162.242.195.82  somehost
50.31.209.229   otherhost


------

healthcheck：用于检测 docker 服务是否健康运行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"] # 设置检测程序
  interval: 1m30s # 设置检测间隔
  timeout: 10s # 设置检测超时时间
  retries: 3 # 设置重试次数
  start_period: 40s # 启动后，多少秒开始启动检测程序

image：指定容器运行的镜像。以下格式都可以：

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd # 镜像id

logging：服务的日志记录配置。

driver：指定服务容器的日志记录驱动程序，默认值为json-file。有以下三个选项
1
2
3
driver: "json-file"
driver: "syslog"
driver: "none"

仅在 json-file 驱动程序下，可以使用以下参数，限制日志得数量和大小。

1
2
3
4
5
logging:
  driver: json-file
  options:
    max-size: "200k" # 单个文件大小为200k
    max-file: "10" # 最多10个文件



当达到文件限制上限，会自动删除旧得文件。

syslog 驱动程序下，可以使用 syslog-address 指定日志接收地址。

1
2
3
4
logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"


------

network_mode：设置网络模式

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

networks

配置容器连接的网络，引用顶级 networks 下的条目 。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
      other-network:
        aliases:
         - alias2
networks:
  some-network:
    # Use a custom driver
    driver: custom-driver-1
  other-network:
    # Use a custom driver which takes special options
    driver: custom-driver-2



**aliases** ：同一网络上的其他容器可以使用服务名称或此别名来连接到对应容器的服务。
------

restart
- no：是默认的重启策略，在任何情况下都不会重启容器。
- always：容器总是重新启动。
- on-failure：在容器非正常退出时（退出状态非0），才会重启容器。
- unless-stopped：在容器退出时总是重启容器，但是不考虑在Docker守护进程启动时就已经停止了的容器
  1
  2
  3
  4
  restart: "no"
  restart: always
  restart: on-failure
  restart: unless-stopped

注：swarm 集群模式，请改用 restart_policy。
------

secrets：存储敏感数据，例如密码

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret
  secrets:
    - my_secret

secrets:
  my_secret:
    file: ./my_secret.txt

security_opt：修改容器默认的 schema 标签。

security-opt：
  - label:user:USER   # 设置容器的用户标签
  - label:role:ROLE   # 设置容器的角色标签
  - label:type:TYPE   # 设置容器的安全策略标签
  - label:level:LEVEL  # 设置容器的安全等级标签

stop_grace_period：指定在容器无法处理 SIGTERM (或者任何 stop_signal 的信号)，等待多久后发送 SIGKILL 信号关闭容器。
1
2
stop_grace_period: 1s # 等待 1 秒
stop_grace_period: 1m30s # 等待 1 分 30 秒

默认的等待时间是 10 秒。
------

stop_signal：设置停止容器的替代信号。默认情况下使用 SIGTERM 。以下示例，使用 SIGUSR1 替代信号 SIGTERM 来停止容器。
1
stop_signal: SIGUSR1

sysctls：设置容器中的内核参数，可以使用数组或字典格式。

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

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

tmpfs：在容器内安装一个临时文件系统。可以是单个值或列表的多个值。
1
2
3
4
5
tmpfs: /run

tmpfs:
- /run
- /tmp

ulimits：覆盖容器默认的 ulimit。

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

volumes：将主机的数据卷或着文件挂载到容器里。

version: "3.7"
services:
  db:
    image: postgres:latest
    volumes:
      - "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
      - "/localhost/data:/var/lib/postgresql/data"