docker compose模板文件编写说明

简介指令说明versionservicesimagebuildcap_add, cap_dropcommandconfigscgroup_parentcontainer_namedeploydevicesdepends_ondnsdns_searchtmpfsenv_fileenvironmentexposeportsexternal_linksextra_hostshealthchecklabelslinksloggingnetwork_modenetworkspidsecrets

简介

Dockerfile对于定义单独的应用容器。然而，在日常工作中，经常会碰到需要多个容器相互配合来完成某项任务的情况。例如要实现一个 Web 项目，除了 Web 服务容器本身，往往还需要再加上后端的数据库服务容器，甚至还包括负载均衡容器等。

Compose 恰好满足了这样的需求。它允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。

Compose 中有两个重要的概念：

服务 (service)：一个应用的容器，实际上可以包括若干运行相同镜像的容器实例。项目 (project)：由一组关联的应用容器组成的一个完整业务单元，在 docker-compose.yml 文件中定义。

指令说明

version

该指令声明compose模版文件编写的格式，有3种格式：

版本1，传统格式。这是通过省略YAML根目录下的版本密钥来指定的。版本2.x. 这是在YAML的根目录下使用版本：'2’或版本：'2.1’条目指定的。版本3.x，最新推荐版本，旨在在Compose和Docker Engine的群集模式之间交叉兼容。这是使用版本：'3’或版本：'3.1’等指定的，在YAML的根目录下输入。

version 2 和version 3 的区别在于：version 2只支持单机部署，version 3 支持集群部署。

version: "3"

注意：如果指令后面有内容，: 后面要有一个空格。

services

该指令声明项目有哪些服务。 一个项目可以有一个容器，也可以有多个服务。

# 该项目有web、mysql、redis三个服务 version: "3" services: web: mysql: redis:

本文详细介绍docker compose模板文件常用的指令

一个服务可以使用已经编译好的镜像（使用image指令声明要使用的镜像和版本号），也可以使用Dockerfile文件构建镜像（使用build指令构建镜像）。

image

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。（可省略, 使用latest)

image: "mysql:5.7.26" image: "68ce1dd4239a"

build

指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3' services: webapp: build: ./dir

你也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。 使用 dockerfile 指令指定 Dockerfile 文件名。 使用 arg 指令指定构建镜像时的变量。

version: '3' services: webapp: build: context: . dockerfile: docker-compose.yml args: buildno: 1

使用 cache_from 指定构建镜像的缓存。

build: context: . cache_from: - alpine:latest - corp/web_app:3.14

cap_add, cap_drop

指定容器的内核能力（capacity）分配。 例如，让容器拥有所有能力可以指定为：

cap_add: - ALL

去掉 NET_ADMIN 能力可以指定为：

cap_drop: - NET_ADMIN

command

覆盖容器启动后默认执行的命令。

command: echo "hello world"

configs

仅用于 Swarm mode。

cgroup_parent

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

cgroup_parent: cgroups_1

container_name

指定容器名称。默认将会使用 项目名称_服务名称_序号 这样的格式。

container_name: docker-web-container

注意: 指定容器名称后，该服务将无法进行扩展（scale），因为 Docker 不允许多个容器具有相同的名称。

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.8 dns: - 8.8.8.8 - 114.114.114.114

dns_search

配置 DNS 搜索域。可以是一个值，也可以是一个列表。

dns_search: example.com dns_search: - domain1.example.com - domain2.example.com

tmpfs

挂载一个 tmpfs 文件系统到容器。

tmpfs: /run tmpfs: - /run - /tmp

env_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 mysqld environment MYSQL_ROOT_PASSWORD=root_pwd MYSQL_USER=user_name MYSQL_USER_PASSWORD=user_pwd

environment

设置环境变量。你可以使用数组或字典两种格式。 只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

version: '3' services: mysql: image: "mysql:5.7" ports: - "3306" environment: MYSQL_ROOT_PASSWORD: "root_pwd" MYSQL_USER: "user_name" MYSQL_USER_PASSWORD: "user_pwd"

进入到mysql容器中，查看环境变量。

root@5d13d9c87eeb:/# echo $MYSQL_USER user_name root@5d13d9c87eeb:/# echo $MYSQL_USER_PASSWORD user_pwd root@5d13d9c87eeb:/# echo $MYSQL_ROOT_PASSWORD root_pwd

expose

暴露端口，但不映射到宿主机，只被连接的服务访问。 仅可以指定内部端口为参数

ports

暴露端口信息。 使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports: - "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001"

注意：当使用 HOST:CONTAINER 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

external_links

注意：不建议使用该指令。 链接到 docker-compose.yml 外部的容器，甚至并非 Compose 管理的外部容器。

external_links: - redis_1 - project_db_1:mysql - project_db_1:postgresql

extra_hosts

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息。

extra_hosts: - "googledns:8.8.8.8" - "dockerhub:52.1.157.61"

healthcheck

通过命令检查容器是否健康运行。

healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] interval: 1m30s timeout: 10s retries: 3

labels

为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels: com.startupteam.description: "webapp for a startup team" com.startupteam.department: "devops department" com.startupteam.release: "rc3 for v1.0"

使用docker inspect查看容器信息

"Labels": { "com.docker.compose.config-hash": "4661c59c0463d0ad7dc79ad3b54c90a1724768874750aed89938760cbc28dbb6", "com.docker.compose.container-number": "1", "com.docker.compose.oneoff": "False", "com.docker.compose.project": "test001", "com.docker.compose.project.config_files": "docker-compose.yml", "com.docker.compose.project.working_dir": "/test/docker/month10/test001", "com.docker.compose.service": "mysql", "com.docker.compose.version": "1.27.2", "com.startupteam.department": "devops department", "com.startupteam.description": "webapp for a startup team", "com.startupteam.release": "rc3 for v1.0" }

links

依赖其他服务。和depends_on类似。

links: - fpm

注意：不推荐使用该指令，推荐使用depends_on。

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: web: build: . links: - redis ports: - "10000:5000" # 使用网络 networks: - "web001" redis: image: "redis:alpine" ports: - "6379:6379" networks: - "test_3333" # 创建网络 networks: web001:

在宿主机器上查看网络

$ docker network ls NETWORK ID NAME DRIVER SCOPE c4a0a9d41aa4 test001_test_3333 bridge local # 新创建的网络

pid

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

pid: "host"

secrets

存储敏感数据，例如 mysql 服务密码。