Docker Compose

Compose 简介

Compose 是用于界说和运转多容器 Docker 利用法式的东西。经由历程 Compose,您能够利用 YML 文件来设置装备摆设利用法式须要的一切办事。而后,利用一个号令,就能够从 YML 文件设置装备摆设中建立并启动一切办事。

若是你还不领会 YML 文件设置装备摆设,能够先浏览 快乐飞艇是犯法的吗:YAML 入门教程

Compose 利用的三个步骤:

  • 利用 Dockerfile 界说利用法式的环境。

  • 利用 docker-compose.yml 界说组成利用法式的办事,如许它们能够在断绝环境中一路运转。

  • 最初,履行 docker-compose up 号令来启动并运转全数利用法式。

docker-compose.yml 的设置装备摆设案比方下(设置装备摆设参数参考下文):

实例

# yaml 设置装备摆设实例
version
: '3'
services
:
  web
:
    build
: .
    ports
:
   - "5000:5000"
    volumes
:
   - .:/code
    - logvolume01:/var/log
    links
:
   - redis
  redis
:
    image
: redis
volumes
:
  logvolume01
: {}

Compose 装置

Linux

Linux 上咱们能够从 Github 高低载它的二进制包来利用,最新刊行的版本地点://github.com/docker/compose/releases

运转以下号令以下载 Docker Compose 确以后不变版本:

$ sudo curl -L "//github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

要装置其余版本的 Compose,请替换 1.24.1。

将可履行权限利用于二进制文件:

$ sudo chmod +x /usr/local/bin/docker-compose

建立软链:

$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

测试是不是装置胜利:

$ docker-compose --version
cker-compose version 1.24.1, build 4667896b

注重: 对 alpine,须要以下依靠包: py-pip,python-dev,libffi-dev,openssl-dev,gcc,libc-dev,和 make。

macOS

Mac 的 Docker 桌面版和 Docker Toolbox 已包罗 Compose 和其余 Docker 利用法式,因此 Mac 用户不须要零丁装置 Compose。Docker 装置申明能够参阅 快乐飞艇是犯法的吗:MacOS Docker 装置

windows PC

Windows 的 Docker 桌面版和 Docker Toolbox 已包罗 Compose 和其余 Docker 利用法式,因此 Windows 用户不须要零丁装置 Compose。Docker 装置申明能够参阅快乐飞艇是犯法的吗: Windows Docker 装置


利用

1、筹办

建立一个测试目次:

$ mkdir composetest
$ cd composetest

在测试目次中建立一个名为 app.py 的文件,并复制粘贴以下内容:

composetest/app.py 文件代码

import time

import redis
from flask import Flask

app = Flask(__name__)
cache = redis.Redis(host='redis', port=6379)


def get_hit_count():
    retries = 5
    while True:
        try:
            return cache.incr('hits')
        except redis.exceptions.ConnectionError as exc:
            if retries == 0:
                raise exc
            retries -= 1
            time.sleep(0.5)


@app.route('/')
def hello():
    count = get_hit_count()
    return 'Hello 法式员! I have been seen {} times.\n'.format(count)

在此示例中,redis 是利用法式收集上的 redis 容器的主机名,该主机利用的端口为 6379。

在 composetest 目次中建立另外一个名为 requirements.txt 的文件,内容以下:

flask
redis

2、建立 Dockerfile 文件

在 composetest 目次中,建立一个名为的文件 Dockerfile,内容以下:

FROM python:3.7-alpine
WORKDIR /code
ENV FLASK_APP app.py
ENV FLASK_RUN_HOST 0.0.0.0
RUN apk add --no-cache gcc musl-dev linux-headers
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
COPY . .
CMD "flask", "run"

Dockerfile 内容诠释:

  • FROM python:3.7-alpine: 从 Python 3.7 映像起头构建镜像。
  • WORKDIR /code: 将任务目次设置为 /code。
  • ENV FLASK_APP app.py
    ENV FLASK_RUN_HOST 0.0.0.0

    设置 flask 号令利用的环境变量。

  • RUN apk add --no-cache gcc musl-dev linux-headers: 装置 gcc,以便诸如 MarkupSafe 和 SQLAlchemy 之类的 Python 包能够编译加快。
  • COPY requirements.txt requirements.txt
    RUN pip install -r requirements.txt

    复制 requirements.txt 并装置 Python 依靠项。

  • COPY . .: 将 . 名目中确以后目次复制到 . 镜像中的任务目次。
  • CMD "flask", "run": 容器供给默许的履行号令为:flask run。

3、建立 docker-compose.yml

在测试目次中建立一个名为 docker-compose.yml 的文件,而后粘贴以下内容:

docker-compose.yml 设置装备摆设文件

# yaml 设置装备摆设
version
: '3'
services
:
  web
:
    build
: .
    ports
:
     - "5000:5000"
  redis
:
    image
: "redis:alpine"

该 Compose 文件界说了两个办事:web 和 redis。

  • web:该 web 办事利用从 Dockerfile 以后目次中构建的镜像。而后,它将容器和主机绑定到裸露的端口 5000。此示例办事利用 Flask Web 办事器的默许端口 5000 。
  • redis:该 redis 办事利用 Docker Hub 的大众 Redis 映像。

4、利用 Compose 号令构建和运转您的利用

在测试目次中,履行以下号令来启动利用法式:

docker-compose up

若是你想在背景履行该办事能够加上 -d 参数:

docker-compose up -d

yml 设置装备摆设指令参考

version

指定本 yml 允从的 compose 哪一个版本拟定的。

build

指定为构建镜像高低文途径:

比方 webapp 办事,指定为从高低文途径 ./dir/Dockerfile 所构建的镜像:

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

或,作为具备在高低文指定的途径的工具,和可选的 Dockerfile 和 args:

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 组,象征着将担当该组的资本限定。

cgroup_parent: m-executor-abcd

command

笼盖容器启动的默许号令。

command: "bundle", "exec", "thin", "-p", "3000"

container_name

指定自界说容器称号,而不是天生的默许称号。

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 之前遏制。
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:
      modereplicated
      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

指定装备映照列表。

devices:
  - "/dev/ttyUSB0:/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:
  - dc1.example.com
  - dc2.example.com

entrypoint

笼盖容器默许的 entrypoint。

entrypoint: /code/entrypoint.sh

也能够因此下格局:

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

从文件增加环境变量。能够是单个值或列表的多个值。

env_file: .env

也能够是列表格局:

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

environment

增加环境变量。您能够利用数组或字典、任何布尔值,布尔值须要用引号引发来,以确保 YML 剖析器不会将其转换为 True 或 False。

environment:
  RACK_ENV: development
  SHOW: 'true'

expose

裸露端口,但不映照到宿主机,只被毗连的办事拜候。

仅能够指定外部端口为参数:

expose:
 - "3000"
 - "8000"

extra_hosts

增加主机名映照。近似 docker client --add-host。

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

以上会在此办事的外部容器中 /etc/hosts 建立一个具备 ip 地点和主机名的映照干系:

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

用于检测 docker 办事是不是安康运转。

healthcheck:
  test: "CMD", "curl", "-f", "//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。有以下三个选项

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

仅在 json-file 驱动法式下,能够利用以下参数,限定日记得数目和巨细。

logging:
  driver: json-file
  options:
    max-size: "200k" # 单个文件巨细为200k
    max-file: "10" # 最多10个文件

当到达文件限定下限,会主动删除旧得文件。

syslog 驱动法式下,能够利用 syslog-address 指定日记领受地点。

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 下的条款 。

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保护历程启动时就已遏制了的容器
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 旌旗灯号封闭容器。

stop_grace_period: 1s # 期待 1 秒
stop_grace_period: 1m30s # 期待 1 分 30 秒 

默许的期待时候是 10 秒。

stop_signal

设置遏制容器的替换旌旗灯号。默许环境下利用 SIGTERM 。

以下示例,利用 SIGUSR1 替换旌旗灯号 SIGTERM 来遏制容器。

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

在容器内装置一个姑且文件体系。能够是单个值或列表的多个值。

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"