# Docker Compose
## 简介
Compose 是用于定义和运行多容器 Docker 应用程序的工具。通过 Compose，您可以使用 YML 文件来配置应用程序需要的所有服务。然后，使用一个命令，就可以从 YML 文件配置中创建并启动所有服务。
Docker Compose 使用的三个步骤：
1. 使用Dockerfile定义应用程序的环境；
2. 使用 `docker-compose.yml` 定义构成应用程序的服务，这样就可以在隔离的环境中一起运行；
3. 最后执行 `docker-compose up` 来启动并运行整个应用程序。
`docker-compose.yml` 的配置示例。
```yaml
# yaml 配置
version: "3"
services:
web:
build: .
ports:
- "8000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image: redis
volumes:
logvolume01: {}
```
## Compose安装
Linux 上我们可以从 Github 上下载它的二进制包来使用，最新发行的版本地址：https://github.com/docker/compose/releases。
```bash
#下载当前稳定版本, 选择正确的版本
sudo curl -L "https://github.com/docker/compose/releases/download/v2.3.4/docker-compose-linux-x86_64" -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
```
## Compose卸载
```bash
#使用curl安装的二进制文件，直接删除完成卸载
sudo rm /usr/local/bin/docker-compose
```
## Compose使用
1、准备
```bash
# 创建一个测试目录
mkdir compose_test
cd compose_test
#在测试目录中创建一个名为 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 World! I have been seen {} times.\n'.format(count)
============================================================================
## redis 是应用程序网络上的 redis 容器的主机名，该主机使用的端口为 6379。
#在 composetest 目录中创建另一个名为 requirements.txt 的文件
===============================================
flask
redis
===============================================
```
2、创建 `Dockerfile` 文件
在 composetest 目录中，创建一个名为 **Dockerfile** 的文件，内容如下
```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 requirement.txt
COPY . .
CMD ["flask", "run"]
```
Dockerfile内容解释：
**FROM python:3.7-alpine**: 从 Python 3.7 映像开始构建镜像。
**WORKDIR /code**: 将工作目录设置为 /code。
**ENV *** : 设置 flask 命令使用的环境变量。
**RUN apk add --no-cache gcc musl-dev linux-headers**: 安装 gcc，以便诸如 MarkupSafe 和 SQLAlchemy 之类的 Python 包可以编译加速。
**COPY requirements.txt requirement.txt**: 复制 requirements.txt 并安装 Python 依赖项。
**COPY . .**: 将 . 项目中的当前目录复制到 . 镜像中的工作目录。
**CMD ["flask", "run"]**: 容器提供默认的执行命令为：flask run。
3、创建 `docker-compose.yml`
在测试目录中创建一个名为 docker-compose.yml 的文件，然后编写以下内容
```yaml
# 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 命令构建和运行应用
```bash
#启动
docker-compose up
#也可以选择后台守护进程启动
docker-compose up -d
```
## yml配置参考
**version**
```yaml
version
#指定本 yml 依从的 compose 哪个版本制定的。
```
**build**
指定为构建镜像上下文路径, 例如 webapp 服务，指定为从上下文路径 ./dir/Dockerfile 所构建的镜像。
- context：上下文路径。
- dockerfile：指定构建镜像的 Dockerfile 文件名。
- args：添加构建参数，这是只能在构建过程中访问的环境变量。
- labels：设置构建镜像的标签。
- target：多层构建，可以指定构建哪一层。
```yaml
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
```
**cap_add, cap_drop**
添加或删除容器拥有的宿主机的内核功能。
```yaml
cap_add:
- ALL #开启全部权限
cap_drop:
- SYS_PTRACE #关闭ptrace权限
```
**cgroup_parent**
为容器指定父 cgroup 组，意味着将继承该组的资源限制。
```yaml
cgroup_parent: m-executor-abcd
```
**command**
覆盖容器启动的默认命令。
```yaml
command: ["bundle", "exec", "thin", "-p", "3000"]
```
**container_name**
指定自定义容器名称，而不是生成的默认名称。
```yam
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 之前停止。
```yaml
version: "3.7"
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
```
注意：web 服务不会等待 redis db 完全启动 之后才启动。
**deploy**
指定与服务的部署和运行有关的配置。只在 swarm 模式下才会有用。
**devices**
指定设备映射列表。
```yaml
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
```
**dns**
自定义 DNS 服务器，可以是单个值或列表的多个值。
```yaml
dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
```
**dns_search**
自定义 DNS 搜索域。可以是单个值或列表。
```yaml
dns_search:
- example1.com
- example2.com
```
**entrypoint**
覆盖容器默认的 entrypoint。
```yaml
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
- verdor/bin/phpunit
```
**env_file**
从文件添加环境变量。可以是单个值或列表的多个值。
```yaml
env_file: .env
#或者
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
```
**environment**
添加环境变量。您可以使用数组或字典、任何布尔值，布尔值需要用引号引起来，以确保 YML 解析器不会将其转换为 True 或 False。
```yaml
environment:
RACK_ENV: development
SHOW: "true"
```
**expose**
暴露端口，但不映射到宿主机，只被连接的服务访问。
```yaml
expose:
- "3000"
- "8000"
```
**extra_hosts**
```yaml
extra_host:
- "somehost: 172.16.33.111"
- "otherhost: 172.16.33.112"
#以上会在此服务的内部容器中 /etc/hosts 创建一个具有 ip 地址和主机名的映射关系
162.242.195.82 somehost
50.31.209.229 otherhost
```
**image**
指定容器运行的镜像。以下格式都可以：
```yaml
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 信号关闭容器。
```yaml
stop_grace_period: 1s # 等待 1 秒
stop_grace_period: 1m30s # 等待 1 分 30 秒
```
默认的等待时间是 10 秒。
### stop_signal
设置停止容器的替代信号。默认情况下使用 SIGTERM 。
以下示例，使用 SIGUSR1 替代信号 SIGTERM 来停止容器。
```
stop_signal: SIGUSR1
```
### sysctls
设置容器中的内核参数，可以使用数组或字典格式。
```yaml
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
```
### tmpfs
在容器内安装一个临时文件系统。可以是单个值或列表的多个值。
```yaml
tmpfs: /run
tmpfs:
- /run
- /tmp
```
### ulimits
覆盖容器默认的 ulimit。
```yaml
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000
```
### volumes
将主机的数据卷或着文件挂载到容器里。
```yaml
version: "3.7"
services:
db:
image: postgres:latest
volumes:
- "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
- "/localhost/data:/var/lib/postgresql/data"
```