# Docker Compose 配置文件

# 基本格式

每个目录下有且仅有一个docker-compose.yml文件用于描述 Docker 配置。该文件的基本格式如下:

version: '3' # 定义版本,不指定默认为版本 1,新版本功能更多

services: # 容器,就像 docker run
  db: # 名称,随便起一个就好,别重名
    image: mysql:5.7 # 镜像,如果像自定义镜像可以不指定这个参数,而用 build
    volumes: # 定义数据卷,类似 -v
      - db_data:/var/lib/mysql
      - .:/aaa # 挂载当前目录到容器中的 /aaa 无需使用绝对路径
    environment: # 定义环境变量,类似 -e
      MYSQL_ROOT_PASSWORD: somewordpress

# version 字段 版本设置

这个字段用于指出当前配置文件是为哪一个 docker compose 版本编写的。因为不同版本间的配置文件可能不兼容。写出响应版本的 version 字段,程序就会按照那个版本的规则解析配置文件。

不同版本的区别可以到 docker 官网查询

当前最新版本是:version: "3.7"

# services 字段 容器列表

这个字段列举的就是需要建立的 docker 容器了。每一个容器对应着各自的配置参数。

接下来按照使用频次介绍配置字段。

# image 字段 指定要启动的镜像

image 则是指定服务的镜像名称或镜像 ID。如果镜像在本地不存在,Compose 将会尝试拉取这个镜像。

格式:image: 镜像 URI: 版本 tag(使用最新版可填写 latest)"

例如下面这些格式都是可以的:

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd

# build 字段 指定 Dockerfile,执行构建任务

服务除了可以基于指定的镜像,还可以基于一份 Dockerfile,在使用 up 启动之时执行构建任务,这个构建标签就是 build,它可以指定 Dockerfile 所在文件夹的路径。Compose 将会利用它自动构建这个镜像,然后使用这个镜像启动服务容器。

build: /path/to/build/dir
build: ./dir # 也可以是相对路径

build: # 设定上下文根目录,然后以该目录为准指定 Dockerfile。
  context: ../
  dockerfile: path/of/Dockerfile

build: ./dir # 如果你同时指定了 image 和 build 两个标签,那么 Compose 会构建镜像并且把镜像命名为 image 后面的那个名字。
image: webapp:tag

# command 字段 设置启动后执行的指令

原本在 Docker 镜像构建的时候,会设置默认执行的入口,使用 command 字段可以覆盖或者追加。

command: bundle exec thin -p 3000 # 覆盖,使用新的指令作为入口
command: [bundle, exec, thin, -p, 3000] # 也可以写成类似 Dockerfile 中的格式:

command: -p 3000 -mysql=123123 #追加设置

# container_name 字段 起个名字吧

container_name: app这样容器的名字就指定为 app 了。

# depends_on 字段 控制启动顺序

在使用 Compose 时,最大的好处就是少打启动命令,但是一般项目容器启动的顺序是有要求的,如果直接从上到下启动容器,必然会因为容器依赖问题而启动失败。 例如在没启动数据库容器的时候启动了应用容器,这时候应用容器会因为找不到数据库而退出,为了避免这种情况我们需要加入一个标签,就是 depends_on,这个标签解决了容器的依赖、启动先后的问题。 例如下面容器会先启动 redis 和 db 两个服务,最后才启动 web 服务:

version: '2'
services:
  web:
    build: .
    depends_on: # 等待数据库启动
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

# volumes 字段 挂载容器外目录

挂载一个目录或者一个已存在的数据卷容器,可以直接使用HOST:CONTAINER这样的格式,或者使用HOST:CONTAINER:ro这样的格式,后者对于容器来说,数据卷是只读的,这样可以有效保护宿主机的文件系统。

注意,再 windows 使用此方式挂载目录将面临权限问题。

volumes:
  // 只是指定一个路径,Docker 会自动在创建一个数据卷(这个路径是容器内部的)。
  - /var/lib/mysql

  // 使用绝对路径挂载数据卷
  - /opt/data:/var/lib/mysql

  // 以 Compose 配置文件为中心的相对路径作为数据卷挂载到容器。
  - ./cache:/tmp/cache

  // 使用用户的相对路径(~/ 表示的目录是 /home/<用户目录>/ 或者 /root/)。
  - ~/configs:/etc/configs/:ro

  // 已经存在的命名的数据卷。
  - datavolume:/var/lib/mysql

# volumes_from 字段 从其他容器挂载目录

从其它容器或者服务挂载数据卷,可选的参数是:ro 或者 :rw 前者表示容器只读,后者表示容器对数据卷是可读可写的。默认情况下是可读可写的。

volumes_from:
  - service_name
  - service_name:ro
  - container:container_name
  - container:container_name:rw

# devices 字段 挂载硬件设备

设备映射列表。与 Docker client 的--device 参数类似。与 volumes 字段一致使用HOST:CONTAINER这样的格式。

devices:
  - "/dev/ttyUSB0:/dev/ttyUSB0"

# extends 字段 继承其他容器配置

extends:
  file: common.yml
  service: webapp

用户可以在任何地方使用这个标签,只要标签内容包含 file 和 service 两个值就可以了。file 的值可以是相对或者绝对路径,如果不指定 file 的值,那么 Compose 会读取当前 YML 文件的信息。

# environment 字段 设置环境变量

environment 和 Dockerfile 中的 ENV 指令一样会把变量一直保存在镜像、容器中,类似 docker run -e 的效果。

environment 的书写方式有两种,一种是按照 yml 的键值对应,一种是直接写字符串。

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET

# env_file 字段 从文件设置环境变量

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

如果有变量名称与 environment 指令冲突,则以后者为准。

注意的是这里所说的环境变量是对宿主机的 Compose 而言的,如果在配置文件中有 build 操作,这些变量并不会进入构建过程中,如果要在构建中使用变量还是首选前面刚讲的 arg 标签。

# ports 字段 向外暴露端口

使用 HOST:CONTAINER 格式或者只是指定容器的端口,宿主机会随机映射端口。

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

注意:当使用 HOST:CONTAINER 格式来映射端口时,如果你使用的容器端口小于 60 你可能会得到错误得结果,因为 YAML 将会解析 xx:yy 这种数字格式为 60 进制。所以建议采用字符串格式。

# networks 字段 容器间组网

所指的 network 可以由 networks 字段 创建虚拟网络 来设置。

services:
  some-service:
    networks:
     - some-network
     - other-network

services: # 关于这个标签还有一个特别的子标签 aliases,这是一个用来设置服务别名的标签
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
         - alias3
      other-network:
        aliases:
         - alias2

在同一个 network 中的容器,可以通过 service 名称来作为相互的 ip 地址,相互访问。例如上述例子中同属于some-network的容器,可以使用http://some-service:80来访问其 web 服务,本质上是使用了 host 映射。

不创建 network,直接链接两个容器,**注意:**这类链接是单向的。

version: '2'
services:
  web:
    build: .
    links:
      - "db:database"
  db:
    image: postgres

使用的别名将会自动在服务容器中的/etc/hosts 里创建。例如:

172.12.2.186  db # ip 就是 docker 虚拟网络的 ip
172.12.2.186  database
172.12.2.187  redis

# expose 字段 向内暴露端口

链接 network 或者 link 之后,在被访问的容器使用expose来向内网暴露端口。

expose:
 - "3000"
 - "8000"

在使用 Docker 过程中,我们会有许多单独使用 docker run 启动的容器,为了使 Compose 能够连接这些不在 docker-compose.yml 中定义的容器,我们需要一个特殊的标签,就是 external_links,它可以让 Compose 项目里面的容器连接到那些项目配置外部的容器(前提是外部容器中必须至少有一个容器是连接到与项目内的服务的同一个网络里面)。

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

# dns 字段 设置容器的 dns

dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search: example.com # 此外 dns_search 的配置也类似
dns_search:
  - dc1.example.com
  - dc2.example.com

# extra_hosts 字段 添加 host 配置

就是往/etc/hosts 文件中添加一些记录,与 Docker client 的--add-host 类似:

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

# labels 字段 向容器添加元数据

向容器添加元数据,和 Dockerfile 的 LABEL 指令一个意思,格式如下:

labels:
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""
labels:
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"

# entrypoint 字段 指定启动指令

在 docker-compose.yml 中可以定义接入点,覆盖 Dockerfile 中的定义:

entrypoint: /code/entrypoint.sh

entrypoint:
  - php
  - -d
  - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
  - -d
  - memory_limit=-1
  - vendor/bin/phpunit

# pid 字段 设置 PID 模式

将 PID 模式设置为主机 PID 模式,跟主机系统共享进程命名空间。容器使用这个标签将能够访问和操纵其他容器和宿主机的名称空间。

pid: "host"

# stop_signal 字段 设置停止容器信号

设置另一个信号来停止容器。在默认情况下使用的是 SIGTERM 停止容器。设置另一个信号可以使用 stop_signal 标签。

stop_signal: SIGUSR1

# logging 字段 配置日志服务

默认的 driver 是 json-file。只有 json-file 和 journald 可以通过 docker-compose logs 显示日志,其他方式有其他日志查看方式,但目前 Compose 不支持。对于可选值可以使用 options 指定。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

有关更多这方面的信息可以阅读官方文档: https://docs.docker.com/engine/admin/logging/overview/

# tmpfs 字段 挂载临时目录到容器

挂载临时目录到容器内部,与 run 的参数一样效果:

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

# 其他字段

security_opt,cpu_shares, cpu_quota, cpuset, domainname, hostname, ipc, mac_address, mem_limit, memswap_limit, privileged, read_only, restart, shm_size, stdin_open, tty, user, working_dir 此类内容与 docker run 命令的先关参数对应。

# networks 字段 创建虚拟网络

version: "2"
services:
    mongodb:
        image: mongo:4
        container_name: devops-mongo # 容器名
        ports:
            - "27017:27017"
        volumes:
            - "/data/docker_local/mongo/configdb:/data/configdb"
            - "/data/docker_local/mongo/data/db:/data/db"
        command: --auth # 开启授权验证
        networks:
            - mongo_net
networks:
  mongo_net: # 创建了一个虚拟网络

如果你想要你的容器加入到一个已存在的网络中,使用 external 选项:

version: "3.7"

services:
  proxy:
    build: ./proxy
    networks:
      - outside
      - default
  app:
    build: ./app
    networks:
      - default

networks:
  outside:
    external: true

这时候不会去创建一个 [projectname]_outside 的网络, Compose 会去查找一个已存在的叫做 outside 的网络,并且将它和 proxy 服务相连。

Last Updated: 7/4/2020, 6:34:41 AM