Compose 模板文件
模板文件是使用 Compose 的核心,涉及到的指令关键字也比较多。但大家不用担心,这里面大部分指令跟 docker run 相关参数的含义都是类似的。
默认的模板文件名称为 docker-compose.yml,格式为 YAML 格式。
1
version: "3"
2
3
services:
4
webapp:
5
image: examples/web
6
ports:
7
- "80:80"
8
volumes:
9
- "/data"
Copied!
注意每个服务都必须通过 image 指令指定镜像或 build 指令(需要 Dockerfile)等来自动构建生成镜像。
如果使用 build 指令,在 Dockerfile 中设置的选项(例如:CMD, EXPOSE, VOLUME, ENV 等) 将会自动被获取,无需在 docker-compose.yml 中重复设置。
下面分别介绍各个指令的用法。

build

指定 Dockerfile 所在文件夹的路径(可以是绝对路径,或者相对 docker-compose.yml 文件的路径)。 Compose 将会利用它自动构建这个镜像,然后使用这个镜像。
1
version: '3'
2
services:
3
4
webapp:
5
build: ./dir
Copied!
你也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。
使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定构建镜像时的变量。
1
version: '3'
2
services:
3
4
webapp:
5
build:
6
context: ./dir
7
dockerfile: Dockerfile-alternate
8
args:
9
buildno: 1
Copied!
使用 cache_from 指定构建镜像的缓存
1
build:
2
context: .
3
cache_from:
4
- alpine:latest
5
- corp/web_app:3.14
Copied!

cap_add, cap_drop

指定容器的内核能力(capacity)分配。
例如,让容器拥有所有能力可以指定为:
1
cap_add:
2
- ALL
Copied!
去掉 NET_ADMIN 能力可以指定为:
1
cap_drop:
2
- NET_ADMIN
Copied!

command

覆盖容器启动后默认执行的命令。
1
command: echo "hello world"
Copied!

configs

仅用于 Swarm mode,详细内容请查看 Swarm mode 一节。

cgroup_parent

指定父 cgroup 组,意味着将继承该组的资源限制。
例如,创建了一个 cgroup 组名称为 cgroups_1
1
cgroup_parent: cgroups_1
Copied!

container_name

指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。
1
container_name: docker-web-container
Copied!
注意: 指定容器名称后,该服务将无法进行扩展(scale),因为 Docker 不允许多个容器具有相同的名称。

deploy

仅用于 Swarm mode,详细内容请查看 Swarm mode 一节

devices

指定设备映射关系。
1
devices:
2
- "/dev/ttyUSB1:/dev/ttyUSB0"
Copied!

depends_on

解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web
1
version: '3'
2
3
services:
4
web:
5
build: .
6
depends_on:
7
- db
8
- redis
9
10
redis:
11
image: redis
12
13
db:
14
image: postgres
Copied!
注意:web 服务不会等待 redis db 「完全启动」之后才启动。

dns

自定义 DNS 服务器。可以是一个值,也可以是一个列表。
1
dns: 8.8.8.8
2
3
dns:
4
- 8.8.8.8
5
- 114.114.114.114
Copied!

dns_search

配置 DNS 搜索域。可以是一个值,也可以是一个列表。
1
dns_search: example.com
2
3
dns_search:
4
- domain1.example.com
5
- domain2.example.com
Copied!

tmpfs

挂载一个 tmpfs 文件系统到容器。
1
tmpfs: /run
2
tmpfs:
3
- /run
4
- /tmp
Copied!

env_file

从文件中获取环境变量,可以为单独的文件路径或列表。
如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件,则 env_file 中变量的路径会基于模板文件路径。
如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。
1
env_file: .env
2
3
env_file:
4
- ./common.env
5
- ./apps/web.env
6
- /opt/secrets.env
Copied!
环境变量文件中每一行必须符合格式,支持 # 开头的注释行。
1
# common.env: Set development environment
2
PROG_ENV=development
Copied!

environment

设置环境变量。你可以使用数组或字典两种格式。
只给定名称的变量会自动获取运行 Compose 主机上对应变量的值,可以用来防止泄露不必要的数据。
1
environment:
2
RACK_ENV: development
3
SESSION_SECRET:
4
5
environment:
6
- RACK_ENV=development
7
- SESSION_SECRET
Copied!
如果变量名称或者值中用到 true|false,yes|no 等表达 布尔 含义的词汇,最好放到引号里,避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇,包括
1
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF
Copied!

expose

暴露端口,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端口为参数
1
expose:
2
- "3000"
3
- "8000"
Copied!

external_links

注意:不建议使用该指令。
链接到 docker-compose.yml 外部的容器,甚至并非 Compose 管理的外部容器。
1
external_links:
2
- redis_1
3
- project_db_1:mysql
4
- project_db_1:postgresql
Copied!

extra_hosts

类似 Docker 中的 --add-host 参数,指定额外的 host 名称映射信息。
1
extra_hosts:
2
- "googledns:8.8.8.8"
3
- "dockerhub:52.1.157.61"
Copied!
会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。
1
8.8.8.8 googledns
2
52.1.157.61 dockerhub
Copied!

healthcheck

通过命令检查容器是否健康运行。
1
healthcheck:
2
test: ["CMD", "curl", "-f", "http://localhost"]
3
interval: 1m30s
4
timeout: 10s
5
retries: 3
Copied!

image

指定为镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。
1
image: ubuntu
2
image: orchardup/postgresql
3
image: a4bc65fd
Copied!

labels

为容器添加 Docker 元数据(metadata)信息。例如可以为容器添加辅助说明信息。
1
labels:
2
com.startupteam.description: "webapp for a startup team"
3
com.startupteam.department: "devops department"
4
com.startupteam.release: "rc3 for v1.0"
Copied!

links

注意:不推荐使用该指令。

logging

配置日志选项。
1
logging:
2
driver: syslog
3
options:
4
syslog-address: "tcp://192.168.0.42:123"
Copied!
目前支持三种日志驱动类型。
1
driver: "json-file"
2
driver: "syslog"
3
driver: "none"
Copied!
options 配置日志驱动的相关参数。
1
options:
2
max-size: "200k"
3
max-file: "10"
Copied!

network_mode

设置网络模式。使用和 docker run--network 参数一样的值。
1
network_mode: "bridge"
2
network_mode: "host"
3
network_mode: "none"
4
network_mode: "service:[service name]"
5
network_mode: "container:[container name/id]"
Copied!

networks

配置容器连接的网络。
1
version: "3"
2
services:
3
4
some-service:
5
networks:
6
- some-network
7
- other-network
8
9
networks:
10
some-network:
11
other-network:
Copied!

pid

跟主机系统共享进程命名空间。打开该选项的容器之间,以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。
1
pid: "host"
Copied!

ports

暴露端口信息。
使用宿主端口:容器端口 (HOST:CONTAINER) 格式,或者仅仅指定容器的端口(宿主将会随机选择端口)都可以。
1
ports:
2
- "3000"
3
- "8000:8000"
4
- "49100:22"
5
- "127.0.0.1:8001:8001"
Copied!
注意:当使用 HOST:CONTAINER 格式来映射端口时,如果你使用的容器端口小于 60 并且没放到引号里,可能会得到错误结果,因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现这种问题,建议数字串都采用引号包括起来的字符串格式。

secrets

存储敏感数据,例如 mysql 服务密码。
1
version: "3.1"
2
services:
3
4
mysql:
5
image: mysql
6
environment:
7
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
8
secrets:
9
- db_root_password
10
- my_other_secret
11
12
secrets:
13
my_secret:
14
file: ./my_secret.txt
15
my_other_secret:
16
external: true
Copied!

security_opt

指定容器模板标签(label)机制的默认属性(用户、角色、类型、级别等)。例如配置标签的用户名和角色名。
1
security_opt:
2
- label:user:USER
3
- label:role:ROLE
Copied!

stop_signal

设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。
1
stop_signal: SIGUSR1
Copied!

sysctls

配置容器内核参数。
1
sysctls:
2
net.core.somaxconn: 1024
3
net.ipv4.tcp_syncookies: 0
4
5
sysctls:
6
- net.core.somaxconn=1024
7
- net.ipv4.tcp_syncookies=0
Copied!

ulimits

指定容器的 ulimits 限制值。
例如,指定最大进程数为 65535,指定文件句柄数为 20000(软限制,应用可以随时修改,不能超过硬限制) 和 40000(系统硬限制,只能 root 用户提高)。
1
ulimits:
2
nproc: 65535
3
nofile:
4
soft: 20000
5
hard: 40000
Copied!

volumes

数据卷所挂载路径设置。可以设置为宿主机路径(HOST:CONTAINER)或者数据卷名称(VOLUME:CONTAINER),并且可以设置访问模式 (HOST:CONTAINER:ro)。
该指令中路径支持相对路径。
1
volumes:
2
- /var/lib/mysql
3
- cache/:/tmp/cache
4
- ~/configs:/etc/configs/:ro
Copied!
如果路径为数据卷名称,必须在文件中配置数据卷。
1
version: "3"
2
3
services:
4
my_src:
5
image: mysql:8.0
6
volumes:
7
- mysql_data:/var/lib/mysql
8
9
volumes:
10
mysql_data:
Copied!

其它指令

此外,还有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令,基本跟 docker run 中对应参数的功能一致。
指定服务容器启动后执行的入口文件。
1
entrypoint: /code/entrypoint.sh
Copied!
指定容器中运行应用的用户名。
1
user: nginx
Copied!
指定容器中工作目录。
1
working_dir: /code
Copied!
指定容器中搜索域名、主机名、mac 地址等。
1
domainname: your_website.com
2
hostname: test
3
mac_address: 08-00-27-00-0C-0A
Copied!
允许容器中运行一些特权命令。
1
privileged: true
Copied!
指定容器退出后的重启策略为始终重启。该命令对保持服务始终运行十分有效,在生产环境中推荐配置为 always 或者 unless-stopped
1
restart: always
Copied!
以只读模式挂载容器的 root 文件系统,意味着不能对容器内容进行修改。
1
read_only: true
Copied!
打开标准输入,可以接受外部输入。
1
stdin_open: true
Copied!
模拟一个伪终端。
1
tty: true
Copied!

读取变量

Compose 模板文件支持动态读取主机的系统环境变量和当前目录下的 .env 文件中的变量。
例如,下面的 Compose 文件将从运行它的环境中读取变量 ${MONGO_VERSION} 的值,并写入执行的指令中。
1
version: "3"
2
services:
3
4
db:
5
image: "mongo:${MONGO_VERSION}"
Copied!
如果执行 MONGO_VERSION=3.2 docker-compose up 则会启动一个 mongo:3.2 镜像的容器;如果执行 MONGO_VERSION=2.8 docker-compose up 则会启动一个 mongo:2.8 镜像的容器。
若当前目录存在 .env 文件,执行 docker-compose 命令时将从该文件中读取变量。
在当前目录新建 .env 文件并写入以下内容。
1
# 支持 # 号注释
2
MONGO_VERSION=3.6
Copied!
执行 docker-compose up 则会启动一个 mongo:3.6 镜像的容器。

参考资料

Last modified 1yr ago