Docker-Compose模板⽂件参数详解
前⾔
模板⽂件是使⽤compose的核⼼,涉及到的指令关键字⽐较多,但是⼤部分和docker run相关参数的含义都是类似的。
默认的模板⽂件名称为l,为yaml格式,如下:
version: "3"
services:
webapp:
image: examples/web
ports:
- "80:80"
volumes:
- "/data"
注意每个服务都必须通过 image 指令指定镜像或 build 指令(需要 Dockerfile)等来⾃动构建⽣成镜像。
如果使⽤ build 指令,在 Dockerfile 中设置的选项(例如:CMD, EXPOSE, VOLUME, ENV 等) 将会⾃动被获取,⽆需在 l 中重复设置。
1、build
指定Dockerfile所在⽂件夹的路径(可以是绝对路径,或者相对l⽂件的路径)。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.14
2、cap_add,cap_drop
指定容器的内核能⼒(capacity)分配。
例如,让容器拥有所有能⼒可以指定为:
cap_add:
- ALL
去掉 NET_ADMIN 能⼒可以指定为:
cap_drop:
- NET_ADMIN
3、command
覆盖容器启动后默认执⾏的命令。
command: echo "hello world"
4、configs
仅⽤于swarm mode。
5、cgroup_parent
指定⽗ cgroup 组,意味着将继承该组的资源限制。
例如,创建了⼀个 cgroup 组名称为 cgroups_1。
cgroup_parent: cgroups_1
所谓cgroup组就是在下⾯的路径中,创建了⼀个⽬录,这个⽬录命令就是⼀个组,如下:
$ pwd
/sys/fs/cgroup/memory
$ mkdir xx1
$ ls | wc -l #当上⾯的⽬录创建成功后,⽬录下会⾃动产⽣好多⽂件,都是来做限制的。
31
6、container_name
指定容器名称,默认将会使⽤“项⽬名称_服务名称_序号” 这样的格式。
container_name: docker-web-container
注意: 指定容器名称后,该服务将⽆法进⾏扩展(scale),因为 Docker 不允许多个容器具有相同的名称。
7、deploy
仅⽤于docker swarm集。
8、devices
指定设备映射关系。
devices:
- "/dev/ttyUSB1:/dev/ttyUSB0"
9、depends_on
解决容器的依赖、启动先后的问题。以下⽂件中会先启动 redis、db,再启动 web。
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
注意:web 服务不会等待 redis、db、完全启动之后才启动。
10、dns
⾃定义 DNS 服务器。可以是⼀个值,也可以是⼀个列表。
dns: 8.8.8.8
或者:
dns:docker重启容器命令
- 8.8.8.8
- 114.114.114.114
11、dns_search
配置 DNS 搜索域。可以是⼀个值,也可以是⼀个列表。
dns_search: example
或者:
dns_search:
- ample
- ample
12、tmpfs
挂载⼀个 tmpfs ⽂件系统到容器。
tmpfs: /run
tmpfs:
- /run
- /tmp
13、env_file
从⽂件中获取环境变量,可以为单独的⽂件路径或列表。
如果通过 docker-compose -f FILE ⽅式来指定 Compose 模板⽂件,则 env_file 中变量的路径会基于模板⽂件路径。如果有变量名称与 environment 指令冲突,则按照惯例,以后者为准。
env_file:
- ./v
- ./v
- /v
环境变量⽂件中每⼀⾏必须符合格式,⽀持 # 开头的注释⾏,如下:
# v: Set development environment
PROG_ENV=development
14、environment
设置环境变量。可以使⽤数组或字典两种格式。
只给定名称的变量会⾃动获取运⾏ 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|O
15、expose
暴露端⼝,但不映射到宿主机,只被连接的服务访问。
仅可以指定内部端⼝为参数
expose:
- "3000"
- "8000"
16、external_links
不建议使⽤该指令。
链接到 l 外部的容器,甚⾄并⾮ Compose 管理的外部容器。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
17、extra_hosts
类似 Docker 中的 --add-host 参数,指定额外的 host 名称映射信息。
- "googledns:8.8.8.8"
-
"dockerhub:52.1.157.61"
会在启动后的服务容器中 /etc/hosts ⽂件中添加如下两条条⽬。
8.8.8.8 googledns
52.1.157.61 dockerhub
18、healthcheck
通过命令检查容器是否健康运⾏。
healthcheck:
test: ["CMD", "curl", "-f", "localhost"]
interval: 1m30s
timeout: 10s
retries: 3
19、image
指定为镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。
image: ubuntu
image: orchardup/postgresql
image: a4bc65fd
20、labels
为容器添加 Docker 元数据(metadata)信息。例如可以为容器添加辅助说明信息。
labels:
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
lease: "rc3 for v1.0"
21、loggin
配置⽇志选项。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论