模板文件是使用docker-compose的核心,默认的模板文件名称为docker-compose.yml,格式为YAML格式。每个服务都必须通过image指令指定镜像或build指令(需要Dockerfile)等来自动构建生成镜像。
注意:在编写docker-compose.yml文件时,所有的冒号(:)、短横线(-)后面都需要加一个空格,不然会出错。
下面将介绍docker-compose模板文件常用指令:
build
指定Dockerfile所在文件夹的路径(可以是绝对路径,或者相对于docker-compose.yml文件的路径)。docker-compose将会利用它自动构建这个镜像,然后使用这个镜像。
使用 context指令 指定Dockerfile所在文件夹的路径。
使用 dockerfile指令 指定Dockerfile文件名
使用 args指令 指定构建镜像时的变量
例如:
version: '3'services: webapp: build: context: ./dir dockerfile: Dockerfile-alternate args: buildno: 1
command
覆盖容器启动后默认执行的命令
command: echo "hello world"
container_name
指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式
container_name: docker-web-container
configs
仅用于Swarm mode
deploy
仅用于Swarm mode
devices
指定设备映射关系
devices: - "/dev/ttyUSB1:/dev/ttyUSB0"
depends_on
解决容器的依赖、启动先后的问题。
dns
自定义DNS服务器。可以是一个值,也可以是一个列表。
dns: 8.8.8.8dns: - 8.8.8.8 - 114.114.114.114
environment
设置环境变量。可以使用数组或字典两种格式。只给定名称的变量会自动获取运行Compose主机上对应变量的值,可以用来防止泄露不必要的数据。
environment: RACK_ENV: development SESSION_SECRET:environment: - RACK_ENV=development - SESSION_SECRET
expose
暴露端口,但不映射到宿主机,只被连接的服务访问。仅可以指定内部端口为参数。
expose: - "3000" - "8000"
extra_hosts
类似Docker中的--add-host参数,指定额外的host名称映射信息。会在启动后的服务容器中/etc/hosts文件中添加一个条目。如:8.8.8.8 googledns
extra_hosts: - "googledns:8.8.8.8"
healthcheck
通过命令检查容器是否健康运行
healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] interval: 1m30s timeout: 10s retries: 3
image
指定为镜像名或镜像ID,如果镜像在本地不存在,Compose将会尝试拉取这个镜像。
image: session-web:latest
labels
为容器添加Docker元数据(metadata)信息。例如可以为容器添加辅助说明信息。
labels: com.study.department: "devops department" com.study.release: "v1.0"
links
连接到其他容器。注意:不推荐使用该指令。
应该使用docker network,建立网络,而docker run --network来连接特定网络。
或者使用version: '2' 和更高版本的docker-compose.yml直接定义自定义网络并使用。
network_mode
设置网络模式。使用和docker run的--network参数一样的值。
network_mode: "bridge"network_mode: "host"network_mode: "none"
networks
配置容器连接的网络
version: '3'services: some-service: networks: - network-demonetworks: network-demo
ports
暴露端口信息,使用宿主端口:容器端口(HOST:CONTAINER)格式,或者仅仅指定容器的端口(宿主将会随机选择端)都可以。
ports: - "3000" - "8000:8000"
volumes
数据卷所挂载路径设置,可以设置宿主机路径,同时支持相对路径
volumes: - /var/lib/mysql - cache/:/tmp/cache - ~/config:/etc/configs/:ro
ulimits
指定容器的ulimits限制值。
例如,指定最大进程数为65535,指定文件句柄数为20000(软限制,应用可以随时修改,不能超过硬限制)和 40000(系统硬限制,只能root用户提高)
ulimits: nproc: 65535 nofile: soft: 20000 hard: 40000
entrypoint
指定服务容器启动后执行的入口文件
entrypoint: /code/entrypoint.sh
user
指定容器中运行应用的用户名
user: nginx
working_dir
指定容器中工作目录
working_dir: /code
domainname
指定容器中搜索域名
domainname: your_website.com
hostname
指定容器中主机名
hostname: test
mac_address
指定容器中mac地址
mac_address: 08-00-27-0C-0A
privileged
允许容器中运行一些特权命令
privileged: true
restart
指定容器退出后的重启策略为始终重启。在生产环境中推荐配置为 always 或者 unless-stopped
restart: always
read_only
以只读模式挂载容器的root文件系统,意味着不能对容器内容进行修改
read_only: true
stdin_open
打开标准输入,可以接受外部输入
stdin_open: true
tty
模拟一个伪终端
tty: true
读取变量
Compose模板文件支持动态读取主机的系统环境变量和当前目录下 .env 文件中的变量。
例如,下面Compose文件将从运行它的环境中读取变量${MONGO_VERSION}的值,并写入执行的指令中。
version: '3'services: db: image: "mongo:${MONGO_VERSION}"
如果执行MONGO_VERSION=3.2 docker-compse up则会启动一个mongo:3.2镜像的容器 。
若当前目录存在 .env文件,执行docker-compose命令时将从该文件中读取变量。
![2d243e98ce4d148ad57f20733f7a1893.png](https://i-blog.csdnimg.cn/blog_migrate/0bbc6fabc928a7d048337292c0aed098.jpeg)
![ce4e09897aa4de81d38e04bcb5b3c3a9.png](https://i-blog.csdnimg.cn/blog_migrate/e0e07bff09eb2b82e8376f7ec818c5df.jpeg)