Docker Compose是 Docker 官方编排(Orchestration)项目之一,负责实现对 Docker 容器集群的快速编排,快速的部署分布式应用。
通过之前学习已经了解到使用一个 Dockerfile 模板文件,可以很方便的定义一个单独的应用容器。然而在日常工作中,经常碰到的情况是需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目,除了 Web 服务容器本身,往往还需要再加上后端的数据库服务容器、负载均衡容器等等。Compose 就是用来处理这些事情的。它通过一个单独的 docker-compose.yml 模板文件(YAML 格式)来定义一组相关联的应用容器为一个项目project。
Compose 中有两个重要的概念:
- 服务 (
service):一个应用的容器,实际上可以包括若干运行相同镜像的容器实例 - 项目 (
project):由一组关联的应用容器组成的一个完整业务单元,在docker-compose.yml文件中定义
Compose 的默认管理对象是项目,通过子命令对项目中的一组容器进行便捷地生命周期管理,Compose 项目由 Python 编写,实现上调用了 Docker 服务提供的 API 来对容器进行管理。因此只要所操作的平台支持 Docker API 就可以在其上利用 Compose 来进行编排管理。
安装#
Compose 支持 Linux、macOS、Windows 10 三大平台,安装方式:
- 通过 Python 的包管理工具
pip进行安装 - 直接下载编译好的二进制文件使用
- 直接在 Docker 容器中运行
前两种方式是传统方式,适合本地环境下安装使用;最后一种方式则不破坏系统环境,更适合云计算场景,Docker for Mac 、 Docker for Windows 自带 docker-compose 二进制文件,安装 Docker 之后可以直接使用。
查看本机是否安装
[root@wangpengliang ~]# docker-compose --version
-bash: docker-compose: 未找到命令Linux下安装 Compose
在 Linux 上安装十分简单,从 官方 GitHub Release 处直接下载编译好的二进制文件即可。
例如,在 Linux 64 位系统上直接下载对应的二进制包
$ sudo curl -L https://github.com/docker/compose/releases/download/1.17.1/docker-compose-uname -s-uname -m > /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose查看本机架构
[root@wangpengliang ~]# uname -m
x86_64这里选择使用二进制包下载安装
[root@wangpengliang ~]# curl -L https://github.com/docker/compose/releases/download/1.17.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 633 100 633 0 0 63 0 0:00:10 0:00:09 0:00:01 155
100 8649k 100 8649k 0 0 292k 0 0:00:29 0:00:29 --:--:-- 1989k
[root@wangpengliang ~]# curl -L https://raw.githubusercontent.com/docker/compose/1.8.0/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 10554 100 10554 0 0 1435 0 0:00:07 0:00:07 --:--:-- 2753
[root@wangpengliang ~]# chmod +x /usr/local/bin/docker-compose
[root@wangpengliang ~]# docker-compose --version
docker-compose version 1.17.1, build 6d101fbPIP 安装
注意:
x86_64架构的 Linux 建议按照上边的方法下载二进制包进行安装,如果计算机的架构是ARM(例如,树莓派),再使用 pip 安装
这种方式是将 Compose 当作一个 Python 应用来从 pip 源中安装
执行安装命令:
sudo pip install -U docker-compose看到类似如下输出,说明安装成功
Collecting docker-compose
Downloading docker-compose-1.17.1.tar.gz (149kB): 149kB downloaded
...
Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl-match-hostname ipaddressbash 补全命令
$ curl -L https://raw.githubusercontent.com/docker/compose/1.8.0/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose容器中执行 Compose 既然是一个 Python 应用,自然也可以直接用容器来执行
$ curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose查看下载的 run.sh 脚本内容
set -e
VERSION="1.8.0"
IMAGE="docker/compose:$VERSION"
# Setup options for connecting to docker host
if [ -z "$DOCKER_HOST" ]; then
DOCKER_HOST="/var/run/docker.sock"
fi
if [ -S "$DOCKER_HOST" ]; then
DOCKER_ADDR="-v $DOCKER_HOST:$DOCKER_HOST -e DOCKER_HOST"
else
DOCKER_ADDR="-e DOCKER_HOST -e DOCKER_TLS_VERIFY -e DOCKER_CERT_PATH"
fi
# Setup volume mounts for compose config and context
if [ "$(pwd)" != '/' ]; then
VOLUMES="-v $(pwd):$(pwd)"
fi
if [ -n "$COMPOSE_FILE" ]; then
compose_dir=$(dirname $COMPOSE_FILE)
fi
# TODO: also check --file argument
if [ -n "$compose_dir" ]; then
VOLUMES="$VOLUMES -v $compose_dir:$compose_dir"
fi
if [ -n "$HOME" ]; then
VOLUMES="$VOLUMES -v $HOME:$HOME -v $HOME:/root" # mount $HOME in /root to share docker.config
fi
# Only allocate tty if we detect one
if [ -t 1 ]; then
DOCKER_RUN_OPTIONS="-t"
fi
if [ -t 0 ]; then
DOCKER_RUN_OPTIONS="$DOCKER_RUN_OPTIONS -i"
fi
exec docker run --rm $DOCKER_RUN_OPTIONS $DOCKER_ADDR $COMPOSE_OPTIONS $VOLUMES -w "$(pwd)" $IMAGE "$@"可以看到,其实是下载了 docker/compose 镜像并运行
卸载#
如果是二进制包方式安装的,删除二进制文件即可
$ sudo rm /usr/local/bin/docker-compose如果是通过 pip 安装的,则执行如下命令即可
$ sudo pip uninstall docker-compose使用#
之前说到Compose 中有两个重要的概念:
- 服务 (
service):一个应用容器,实际上可以运行多个相同镜像的实例 - 项目 (
project):由一组关联的应用容器组成的一个完整业务单元
可见,一个项目可以由多个服务(容器)关联而成,Compose 面向项目进行管理。
创建Web应用
示例用 Python 创建一个能够记录页面访问次数的 web 网站。新建文件夹,在该目录中编写 app.py 文件
from flask import Flask
from redis import Redis
app = Flask(__name__)
redis = Redis(host='redis', port=6379)
@app.route('/')
def hello():
count = redis.incr('hits')
return 'Hello World! 该页面已被访问 {} 次。\n'.format(count)
if __name__ == "__main__":
app.run(host="0.0.0.0", debug=True)Dockerfile
编写 Dockerfile 文件内容为:
FROM python:3.6-alpine
ADD . /code
WORKDIR /code
RUN pip install redis flask
CMD ["python", "app.py"]docker-compose.yml
编写 docker-compose.yml 文件,这个是 Compose 使用的主模板文件
version: '3'
services:
web:
build: .
ports:
- "5000:5000"
redis:
image: "redis:alpine"运行 compose
docker-compose up创建 pythontests 目录,创建 app.py Dockerfile docker-compose.yml 文件
[root@wangpengliang pythontests]# ls
app.py docker-compose.yml Dockerfile运行 docker-compose
[root@wangpengliang pythontests]# docker-compose up
Building web
Step 1/5 : FROM python:3.6-alpine # 下载基础镜像python:3.6-alpine
3.6-alpine: Pulling from library/python
540db60ca938: Pull complete
a7ad1a75a999: Pull complete
5545670c3922: Pull complete
c89910f38943: Pull complete
b6a40d090e87: Pull complete
Digest: sha256:492bb540e9c9bc9f586d5d69467c66bc32072d9af48463b1f0054d4ff9b93709
Status: Downloaded newer image for python:3.6-alpine
---> ac438c122d19
Step 2/5 : ADD . /code # 拷贝文件到/code目录
---> 68cbe5b2f598
Step 3/5 : WORKDIR /code # 设置/code目录为工作目录
---> Running in 4fd09a1580a8
Removing intermediate container 4fd09a1580a8 # 拆卸中间容器:4fd09a1580a8
---> 2e4bbd31555d
Step 4/5 : RUN pip install redis flask # 运行pip安装redis、flask
---> Running in c12f4ece64f1
Collecting redis
Downloading redis-3.5.3-py2.py3-none-any.whl (72 kB)
Collecting flask
Downloading Flask-2.0.1-py3-none-any.whl (94 kB)
Collecting click>=7.1.2
Downloading click-8.0.1-py3-none-any.whl (97 kB)
Collecting Werkzeug>=2.0
Downloading Werkzeug-2.0.1-py3-none-any.whl (288 kB)
Collecting itsdangerous>=2.0
Downloading itsdangerous-2.0.1-py3-none-any.whl (18 kB)
Collecting Jinja2>=3.0
Downloading Jinja2-3.0.1-py3-none-any.whl (133 kB)
Collecting importlib-metadata
Downloading importlib_metadata-4.5.0-py3-none-any.whl (17 kB)
Collecting MarkupSafe>=2.0
Downloading MarkupSafe-2.0.1.tar.gz (18 kB)
Collecting dataclasses
Downloading dataclasses-0.8-py3-none-any.whl (19 kB)
Collecting typing-extensions>=3.6.4
Downloading typing_extensions-3.10.0.0-py3-none-any.whl (26 kB)
Collecting zipp>=0.5
Downloading zipp-3.4.1-py3-none-any.whl (5.2 kB)
Building wheels for collected packages: MarkupSafe
Building wheel for MarkupSafe (setup.py): started
Building wheel for MarkupSafe (setup.py): finished with status 'done'
Created wheel for MarkupSafe: filename=MarkupSafe-2.0.1-py3-none-any.whl size=9761 sha256=e2a25263f4c7babbdd0cdda87cad139e54eb972cf742f2f7b7893003e0ecfe97
Stored in directory: /root/.cache/pip/wheels/05/46/9b/189d9acb1f643857fb8ad990ca04c02509c35d3ad6fac81794
Successfully built MarkupSafe
Installing collected packages: zipp, typing-extensions, MarkupSafe, importlib-metadata, dataclasses, Werkzeug, Jinja2, itsdangerous, click, redis, flask
Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 Werkzeug-2.0.1 click-8.0.1 dataclasses-0.8 flask-2.0.1 importlib-metadata-4.5.0 itsdangerous-2.0.1 redis-3.5.3 typing-extensions-3.10.0.0 zipp-3.4.1
WARNING: Running pip as root will break packages and permissions. You should install packages reliably by using venv: https://pip.pypa.io/warnings/venv
Removing intermediate container c12f4ece64f1
---> 061f502fa95e
Step 5/5 : CMD ["python", "app.py"]
---> Running in c6ac95ba9659
Removing intermediate container c6ac95ba9659
---> aabe65a53ffd
Successfully built aabe65a53ffd
Successfully tagged pythontests_web:latest
WARNING: Image for service web was built because it did not already exist. To rebuild this image you must use `docker-compose build` or `docker-compose up --build`.
Pulling redis (redis:alpine)...
alpine: Pulling from library/redis
29712d301e8c: Pull complete
8173c12df40f: Pull complete
8cc52074f78e: Pull complete
aa7854465cce: Pull complete
6ab1d05b4973: Pull complete
Digest: sha256:eaaa58f8757d6f04b2e34ace57a71d79f8468053c198f5758fd2068ac235f303
Status: Downloaded newer image for redis:alpine
Creating pythontests_web_1
Creating pythontests_redis_1
Attaching to pythontests_redis_1, pythontests_web_1
redis_1 | 1:C 09 Jun 2021 03:16:24.588 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
redis_1 | 1:C 09 Jun 2021 03:16:24.588 # Redis version=6.2.4, bits=64, commit=00000000, modified=0, pid=1, just started
redis_1 | 1:C 09 Jun 2021 03:16:24.588 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf
redis_1 | 1:M 09 Jun 2021 03:16:24.588 * monotonic clock: POSIX clock_gettime
redis_1 | 1:M 09 Jun 2021 03:16:24.590 * Running mode=standalone, port=6379.
redis_1 | 1:M 09 Jun 2021 03:16:24.590 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128.
redis_1 | 1:M 09 Jun 2021 03:16:24.590 # Server initialized
redis_1 | 1:M 09 Jun 2021 03:16:24.590 # WARNING overcommit_memory is set to 0! Background save may fail under low memory condition. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.
redis_1 | 1:M 09 Jun 2021 03:16:24.590 * Ready to accept connections
web_1 | * Serving Flask app 'app' (lazy loading)
web_1 | * Environment: production
web_1 | WARNING: This is a development server. Do not use it in a production deployment.
web_1 | Use a production WSGI server instead.
web_1 | * Debug mode: on
web_1 | * Running on all addresses.
web_1 | WARNING: This is a development server. Do not use it in a production deployment.
web_1 | * Running on http://172.19.0.2:5000/ (Press CTRL+C to quit)
web_1 | * Restarting with stat
web_1 | * Debugger is active!
web_1 | * Debugger PIN: 103-300-970
web_1 | 172.19.0.1 - - [09/Jun/2021 03:17:00] "GET / HTTP/1.1" 200 -测试结果
[root@wangpengliang pythontests]# curl 172.18.0.2:5000
Hello World! 该页面已被访问 1 次。
[root@wangpengliang pythontests]# curl 172.18.0.2:5000
Hello World! 该页面已被访问 2 次。
[root@wangpengliang pythontests]# curl 172.18.0.2:5000
Hello World! 该页面已被访问 3 次。
[root@wangpengliang pythontests]# curl 172.18.0.2:5000
Hello World! 该页面已被访问 4 次。
[root@wangpengliang pythontests]# curl 172.18.0.2:5000
Hello World! 该页面已被访问 5 次。命令对象与格式#
对于 Compose 来说,大部分命令的对象既可以是项目本身,也可以指定为项目中的服务或者容器。如果没有特别的说明,命令对象将是项目。这意味着项目中所有的服务都会受到命令影响。
查看具体某个命令的使用格式:
docker-compose [COMMAND] --help
或
docker-compose help [COMMAND]docker-compose 命令的基本使用格式:
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]命令选项#
-f, --file FILE指定使用的 Compose 模板文件,默认为docker-compose.yml,可以多次指定-p, --project-name NAME指定项目名称,默认将使用所在目录名称作为项目名--x-networking使用 Docker 的可拔插网络后端特性--x-network-driver DRIVER指定网络后端的驱动,默认为bridge--verbose输出更多调试信息-v, --version打印版本并退出
命令使用说明#
build#
格式: docker-compose build [options] [SERVICE...]
构建(重新构建)项目中的服务容器。服务容器一旦构建后,将会带上一个标记名,例如对于 web 项目中的一个 db 容器,可能是 web_db。可以随时在项目目录下运行
docker-compose build来重新构建服务
选项:
--force-rm删除构建过程中的临时容器--no-cache构建镜像过程中不使用 cache(这将加长构建过程)--pull始终尝试通过 pull 来获取更新版本的镜像
config#
验证 Compose 文件格式是否正确,若正确则显示配置,若格式错误显示错误原因。
down#
此命令将会停止 up 命令所启动的容器,并移除网络。
exec#
进入指定容器。
help#
获得一个命令的帮助。
images#
列出 Compose 文件中包含的镜像。
kill#
格式: docker-compose kill [options] [SERVICE...]
通过发送
SIGKILL信号来强制停止服务容器。支持通过-s参数来指定发送的信号,例如通过如下指令发送SIGINT信号
$ docker-compose kill -s SIGINTlogs#
格式: docker-compose logs [options] [SERVICE...]
查看服务容器的输出。默认情况下,docker-compose 将对不同的服务输出使用不同的颜色来区分。可以通过
--no-color来关闭颜色。该命令在调试问题的时候经常使用
pause#
格式:docker-compose pause [SERVICE...]
暂停一个服务容器
port#
格式: docker-compose port [options] SERVICE PRIVATE_PORT
打印某个容器端口所映射的公共端口
选项:
--protocol=proto指定端口协议,tcp(默认值)或者 udp--index=index如果同一服务存在多个容器,指定命令对象容器的序号(默认为 1)
ps#
格式: docker-compose ps [options] [SERVICE...]
列出项目中目前的所有容器。
选项:
-q只打印容器的 ID 信息
pull#
格式: docker-compose pull [options] [SERVICE...]
拉取服务依赖的镜像
选项:
--ignore-pull-failures忽略拉取镜像过程中的错误
push#
推送服务依赖的镜像到 Docker 镜像仓库
restart#
格式:docker-compose restart [options] [SERVICE...]
重启项目中的服务
选项:
-t, --timeout TIMEOUT指定重启前停止容器的超时(默认10 秒)
rm#
格式:docker-compose rm [options] [SERVICE...]
删除所有(停止状态的)服务容器。推荐先执行
docker-compose stop命令来停止容器
选项:
-f, --force强制直接删除,包括非停止状态的容器。一般尽量不要使用该选项-v删除容器所挂载的数据卷
run#
格式: docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服务上执行一个命令
例如:
$ docker-compose run ubuntu ping docker.com这将会启动一个 ubuntu 服务容器,并执行 ping docker.com 命令。默认情况下,如果存在关联,则所有关联的服务将会自动被启动,除非这些服务已经在运行中。该命令类似启动容器后运行指定的命令,相关卷、链接等等都将会按照配置自动创建。
两个不同点:
- 给定命令将会覆盖原有的自动运行命令
- 不会自动创建端口,以避免冲突
如果不希望自动启动关联的容器,可以使用 --no-deps 选项,例如:
$ docker-compose run --no-deps web python manage.py shell将不会启动 web 容器所关联的其它容器。
选项:
-d后台运行容器--name NAME为容器指定一个名字--entrypoint CMD覆盖默认的容器启动指令-e KEY=VAL设置环境变量值,可多次使用选项来设置多个环境变量-u, --user=""指定运行容器的用户名或者 uid--no-deps不自动启动关联的服务容器--rm运行命令后自动删除容器,d模式下将忽略-p, --publish=[]映射容器端口到本地主机--service-ports配置服务端口并映射到本地主机-T不分配伪 tty,意味着依赖 tty 的指令将无法运行
scale#
格式: docker-compose scale [options] [SERVICE=NUM...]
设置指定服务运行的容器个数。
通过 service=num 的参数来设置数量。例如:
$ docker-compose scale web=3 db=2这将启动 3 个容器运行 web 服务,2 个容器运行 db 服务。
一般的,当指定数目多于该服务当前实际运行容器,将新创建并启动容器;反之,将停止容器。
选项:
-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
start#
格式: docker-compose start [SERVICE...]
启动已经存在的服务容器
stop#
格式: docker-compose stop [options] [SERVICE...]
停止已经处于运行状态的容器,但不删除它。通过
docker-compose start可以再次启动这些容器
选项:
-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
top#
查看各个服务容器内运行的进程
unpause#
格式: docker-compose unpause [SERVICE...]
恢复处于暂停状态中的服务
up#
格式: docker-compose up [options] [SERVICE...]
该命令十分强大,它将尝试自动完成包括构建镜像,(重新)创建服务,启动服务,并关联服务相关容器的一系列操作。链接的服务都将会被自动启动,除非已经处于运行状态。大部分时候都可以直接通过该命令来启动一个项目。默认情况,
docker-compose up启动的容器都在前台,控制台将会同时打印所有容器的输出信息,可以很方便进行调试。
当通过 Ctrl-C 停止命令时,所有容器将会停止。
如果使用 docker-compose up -d,将会在后台启动并运行所有的容器。一般推荐生产环境下使用该选项。
默认情况,如果服务容器已经存在,docker-compose up 将会尝试停止容器,然后重新创建(保持使用 volumes-from 挂载的卷),以保证新启动的服务匹配 docker-compose.yml 文件的最新内容。如果不希望容器被停止并重新创建,可以使用 docker-compose up --no-recreate。这样将只会启动处于停止状态的容器,而忽略已经运行的服务。如果只想重新部署某个服务,可以使用 docker-compose up --no-deps -d <SERVICE_NAME> 来重新创建服务并后台停止旧服务,启动新服务,并不会影响到其所依赖的服务。
选项:
-d在后台运行服务容器。--no-color不使用颜色来区分不同的服务的控制台输出。--no-deps不启动服务所链接的容器。--force-recreate强制重新创建容器,不能与--no-recreate同时使用。--no-recreate如果容器已经存在了,则不重新创建,不能与--force-recreate同时使用。--no-build不自动构建缺失的服务镜像。-t, --timeout TIMEOUT停止容器时候的超时(默认为 10 秒)。
version#
格式: docker-compose version
打印版本信息
Compose 模板文件#
模板文件是使用 Compose 的核心,涉及到的指令关键字也大部分指令跟 docker run 相关参数的含义都是类似的。默认的模板文件名称为 docker-compose.yml,格式为 YAML 格式。
version: "3"
services:
webapp:
image: examples/web
ports:
- "80:80"
volumes:
- "/data"注意:每个服务都必须通过
image指令指定镜像或build指令(需要 Dockerfile)等来自动构建生成镜像
如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取,无需在 docker-compose.yml 中再次设置。
build#
指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 docker-compose.yml 文件的路径)。 Compose 将会利用它自动构建这个镜像,然后使用这个镜像。
version: '3'
services:
webapp:
build: ./dir也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定构建镜像时的变量。
version: '3'
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1使用 cache_from 指定构建镜像的缓存
build:
context: .
cache_from:
- alpine:latest
- corp/web_app:3.14cap_add, cap_drop#
指定容器的内核能力(capacity)分配。 例如,让容器拥有所有能力:
cap_add:
- ALL去掉 NET_ADMIN 能力:
cap_drop:
- NET_ADMINcommand#
覆盖容器启动后默认执行的命令。
command: echo "hello world"cgroup_parent#
指定父 cgroup 组,意味着将继承该组的资源限制。
例如,创建了一个 cgroup 组名称为 cgroups_1。
cgroup_parent: cgroups_1container_name#
指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。
container_name: docker-web-container注意: 指定容器名称后,该服务将无法进行扩展(scale),因为 Docker 不允许多个容器具有相同的名称
devices#
指定设备映射关系。
devices:
- "/dev/ttyUSB1:/dev/ttyUSB0"depends_on#
解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web。
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres注意:
web服务不会等待redisdb「完全启动」之后才启动
dns#
自定义 DNS 服务器。可以是一个值,也可以是一个列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 114.114.114.114dns_search#
配置 DNS 搜索域。可以是一个值,也可以是一个列表。
dns_search: example.com
dns_search:
- domain1.example.com
- domain2.example.comtmpfs#
挂载一个 tmpfs 文件系统到容器。
tmpfs: /run
tmpfs:
- /run
- /tmpenv_file#
从文件中获取环境变量,可以为单独的文件路径或列表。如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则 env_file 中变量的路径会基于模板文件路径。如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env环境变量文件中每一行必须符合格式,支持 # 开头的注释行。
# common.env: Set development environment
PROG_ENV=developmentenvironment#
设置环境变量。可以使用数组或字典两种格式。只给定名称的变量会自动获取运行 Compose 主机上对应变量的值,可以用来防止泄露不必要的数据。
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET如果变量名称或者值中用到 true|false,yes|no 等表达 布尔 含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFFexpose#
暴露端口,但不映射到宿主机,只被连接的服务访问。仅可以指定内部端口为参数。
expose:
- "3000"
- "8000"external_links#
链接到 docker-compose.yml 外部的容器,甚至并非 Compose 管理的外部容器。
注意:不建议使用该指令
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresqlextra_hosts#
类似 Docker 中的 --add-host 参数,指定额外的 host 名称映射信息。
extra_hosts:
- "googledns:8.8.8.8"
- "dockerhub:52.1.157.61"会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目
8.8.8.8 googledns
52.1.157.61 dockerhubhealthcheck#
通过命令检查容器是否健康运行。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3image#
指定为镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。
image: ubuntu
image: orchardup/postgresql
image: a4bc65fdlabels#
为容器添加 Docker 元数据(metadata)信息。例如可以为容器添加辅助说明信息。
labels:
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
com.startupteam.release: "rc3 for v1.0"links#
注意:不推荐使用该指令
logging#
配置日志选项。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"目前支持三种日志驱动类型
driver: "json-file"driver: "syslog"driver: "none"
options 配置日志驱动的相关参数
options:
max-size: "200k"
max-file: "10"network_mode#
设置网络模式。使用和 docker run 的 --network 参数一样的值。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"networks#
配置容器连接的网络。
version: "3"
services:
some-service:
networks:
- some-network
- other-network
networks:
some-network:
other-network:pid#
跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。pid: "host"
ports#
暴露端口信息。使用宿主端口:容器端口 (HOST:CONTAINER) 格式,或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"注意:当使用
HOST:CONTAINER格式来映射端口时,如果使用的容器端口小于 60 并且没放到引号里,可能会得到错误结果,因为YAML会自动解析xx:yy这种数字格式为 60 进制。为避免出现这种问题,建议数字串都采用引号包括起来的字符串格式
secrets#
存储敏感数据,例如 mysql 服务密码。
version: "3.1"
services:
mysql:
image: mysql
environment:
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
secrets:
- db_root_password
- my_other_secret
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: truesecurity_opt#
指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。例如配置标签的用户名和角色名。
security_opt:
- label:user:USER
- label:role:ROLEstop_signal#
设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。stop_signal: SIGUSR1
sysctls#
配置容器内核参数。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0ulimits#
指定容器的 ulimits 限制值。例如,指定最大进程数为 65535,指定文件句柄数为 20000(软限制,应用可以随时修改,不能超过硬限制) 和 40000(系统硬限制,只能 root 用户提高)。
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000volumes#
数据卷所挂载路径设置。可以设置宿主机路径 (HOST:CONTAINER) 或加上访问模式 (HOST:CONTAINER:ro)。该指令中路径支持相对路径。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro其它指令#
此外,还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令,基本跟 docker run 中对应参数的功能一致。
指定服务容器启动后执行的入口文件
entrypoint: /code/entrypoint.sh
指定容器中运行应用的用户名
user: nginx
指定容器中工作目录
working_dir: /code
指定容器中搜索域名、主机名、mac 地址等
domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A允许容器中运行一些特权命令
privileged: true
指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效,在生产环境中推荐配置为 always 或者 unless-stopped
restart: always
以只读模式挂载容器的 root 文件系统,意味着不能对容器内容进行修改
read_only: true
打开标准输入,可以接受外部输入
stdin_open: true
模拟一个伪终端
tty: true
读取变量#
Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。
例如,下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值,并写入执行的指令中。
version: "3"
services:
db:
image: "mongo:${MONGO_VERSION}"如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器;如果执行 MONGO_VERSION=2.8 docker-compose up 则会启动一个 mongo:2.8 镜像的容器。
若当前目录存在 .env 文件,执行 docker-compose 命令时将从该文件中读取变量。
在当前目录新建 .env 文件并写入以下内容。
# 支持 # 号注释
MONGO_VERSION=3.6执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。