默认的模版文件名
docker-compose.ymlversion: '3'services: webapp: image: examples/web ports: - '80:80' volumes: - '/data'
build
指定Dockerfile所在文件夹的路径, Compose将会利用它自动构建这个镜像，然后使用这个镜像context 指定Dockerfile所在文件夹的路径dockerfile 指定Dockerfile文件名arg 指定构建镜像时的变量cache_from 指定构建镜像的缓存version: '3'services: webapp: build: context: ./dir cache_from: - alpine:latest - corp/web_app:3.14 dockerfile: Dockerfile-alternate args: buildno: 1
cap_add, cap_drop
指定容器的内核能力(capacity)分配cap_add: - ALL #用于所有能力cap_drop: - NET_ADMIN #去掉NET_ADMIN能力
command
覆盖容器启动后默认执行的命令command: echo 'hello world'
configs
仅用于Swarm mode
cgroup_parent
指定父cgroup组 继承改组的资源限制cgroup_parent: cgroups_1 #创建了一个cgroup组名称为cgroups_1
container_name
指定容器名称 默认使用 项目名称_服务名称_序号 container_name: docker-web-container # 指定名称后无法使用扩展(scale)
deploy
仅用于Swarm mode
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服务不会等待redis db 完全启动之后才启动
dns
自定义DNS服务器。dns: 8.8.8.8dns: - 8.8.8.8 - 114.114.114.114
dns_search
配置DNS搜索域dns_search: examples.comdns_search: - domain1.example.com - domain2.example.com
tmpfs
挂载一个tmpfs文件系统到容器tmpfs: /runtmpfs: - /run - /tmp
env_file
从文件中获取环境变量，可以为单独的文件路径或列表env_file: .envenv_file: - ./common.env - ./apps/web.env - /opt/secrets.env 环境变量文件每一行必须符合格式，支持 # 开头的注释行# common.env: Set development environmentPROG_ENV=development
environment
设置环境变量 可以使用数组和字典两种格式environment: PACK_ENV: development SESSION_SECRET: environment: - RACK_ENV=development - SESSION_SECRET
expose
暴露端口，但不映射到宿主机，只被连接的服务访问。expose: - "3000" - "8000"
external_links[不建议使用]
链接到外部容器，甚至到非Compose管理的外部容器
extra_hosts
类似Docker中的 --add-host，指定额外的host名称映射信息extra_hosts: - "googledns:8.8.8.8" - "dockerhub:52.1.157.61" 会在启动后的服务容器中/etc/hosts文件中添加如下两条8.8.8.8 googledns52.1.157.61 dockerhub
healthcheck
检查容器是否健康运行healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] interval: 1m30s tomeout: 10s retries: 3
image
指定为镜像名称或镜像ID，不存在则会去拉取image: ubuntuimage: orchardup/postgresqlimage: a4bc65fd
labels
为容器添加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
暴露端口信息。使用宿主端口:容器端口格式，或者仅仅指定容器端口(宿主机将随机端口)ports: - "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001"
secrets
存储敏感数据，例如mysql服务密码version: "3"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:true
security_opt
指定容器模版标签(label)机制的默认属性(用户，角色，类型， 级别)security_opt: - label:user:USER - label:role:ROLE
stop_signal
设置另一个信号来停止容器stop_signal: SIGUSER1
sysctls
配置容器内核参数sysctls: net.core.somaxconn: 1024 net.ipv4.tcp_syncookies: 0 sysctls: - net.core.somaxconn=1024 - net.ipv4.tcp_syncookies=0
指定容器的ulimits限制值
ulimits: nproc: 65535 nofile: soft:20000 hard:40000
volumes
数据卷所挂载路径设置，可以设置宿主机路径或加上访问模式，支持相对路径volumes: - /var/lib/mysql - cache/:/tmp/cache - ~/configs:/etc/configs/:ro
其他指令
entrypoint: /code/entrypoint.sh # 指定服务容器启动后执行的入口文件user: nginx # 指定容器中运行应用的用户名working_dir: /code # 指定容器中的工作目录domainname: your_website.com # 指定容器中搜索域名hostname: test # 主机名mac_address: 08-00-27-00-0C-0A # MAC地址privileged: true # 允许容器中运行一些特权命令restart: always # 指定容器退出后的重启策略为始终重启read_only: true # 以只读模式挂载容器的root文件系统，意味着不能对容器内容修改stdin_open: true # 打开标准输入，可以接受外部输入tty: true # 模拟一个伪终端
读取变量
Compose模版文件支持动态读取主机的系统环境变量和当前目录下.env文件中的变量eg: 从运行它的环境变量中读取变量${MONGO_VERSION}的值，并写入执行的指令中。version: '3'services:db: image: "mongo:${MONGO_VERSION}" 当前目录若存在.env文件，执行docker-compose则将从该文件中读取变量# 支持 # 号注释MONGO_VERSION=3.6