Docker-compose---模板文件

标题模板文件简介

Compose允许用户通过一个docker-compose.yml模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project）。
Compose模板文件是一个定义服务、网络和卷的YAML文件。Compose模板文件默认路径是当前目录下的docker-compose.yml，可以使用.yml或.yaml作为文件扩展名。
Docker-Compose标准模板文件应该包含version、services、networks 三大部分，最关键的是services和networks两个部分。

1. image***

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

services:
  web:
    image: hello-world

2. build***

指定服务镜像Dockerfile所在路径。服务除了可以基于指定的镜像，还可以基于一份Dockerfile，在使用up启动时执行构建任务，构建表情是build，可以指定Dockerfile所在文件的路径。Compose将会利用Dockerfile自动构建镜像，然后使用镜像启动服务容器。

build: /path/to/build/dir

也可以是相对路径，只要上下文确定就可以读取到Dockerfile

build: ./dir

设置上下文根目录，然后以该目录为准指定Dockerfile

build:
  context: ../
  dockerfile: path/Dockerfile

build都是一个目录，如果要指定Dockerfile文件需要在build标签的子级标签中使用Dockerfile标签指定。
如果同时指定image和build两个标签，那么Compose会构建镜像并且把镜像名为image值指定的名字。

3. context***

context选项可以是Dockerfile的文件路径，也可以是到链接到git仓库的url，当提供的值是相对路径时，被解析为相对于撰写文件的路径，此目录也是发送到Docker守护进程的context

build:
  context: ./dir

4. dockerfile

指定额外编译镜像的Dockerfile文件，可以为单独的文件路径或列表。使用dockerfile文件来构建，必须指定构建路径

build:
  context: .
  dockerfile: Dockerfile-alternate

该指令不能跟image同时使用，否则compose将不知道根据哪个指令来生成最终的服务镜像

5. command***

使用command可以覆盖容器启动后默认执行的命令

command: echo "hello world"

6. container_name***

指定容器名称。默认将会使用项目名称_服务名称_序号
可以自定义的项目名称、服务名称、但如果想完全控制容器的命名，可以使用标签指定:

container_name: app

7. depends_on***

在使用Compose时，最大的好处就是少打启动命令，但一般项目容器启动的顺序是有要求的，如果直接从上到下启动容器，必然会因为容器依赖问题而启动失败。例如在没启动数据库容器的时候启动应用容器，应用容器会因为找不到数据库而退出。depends_on标签用于解决容器的依赖、启动先后的问题

version: '2'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

上述YML文件定义的容器会先启动redis和db两个服务，最后才会启动web服务

8. pid

pid: "host"

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

9. ports***

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

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

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

10. extra_hosts

添加主机名的标签，会在/etc/hosts文件中添加一些记录

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

启动后查看容器内部hosts:
162.242.195.82 somehost
50.31.209.229 otherhost

11. volumes***

数据卷所挂载路径设置。挂载一个目录或者一个已存在的数据容器卷，可以直接使用[HOST:CONTAINER]格式，或者使用[HOST:CONTAINER:ro]格式, 后者对于容器来说，数据卷是只读的，可有效保护宿主机的文件系统。Compose的数据卷指定路径可以是相对路径，使用 .或者 . . 来指定相对目录。

volumes:
  // 只是指定一个路径，Docker会自动在创建一个数据卷(这个路径是容器内部的)。
  - /var/lib/mysql
  // 使用绝对路径挂载数据卷
  - /opt/data:/var/lib/mysql
  // 以Compose配置文件为中心的相对路径作为数据卷挂载到容器
  - ./cache:/tmp/cache
  // 使用用户的相对路径（~/ 表示的目录是 /home/<用户目录>/ 或者 /root/）
  - ~/configs:/etc/configs/:ro
  // 已经存在的命名的数据卷。
  - datavolume:/var/lib/mysql

如果不适用宿主局的路径，可以指定一个volume_driver
volume_driver:mydriver

12. volumes_from

从另一个服务或容器挂载其数据卷:

volumes_from:
  - service_name
  - container_name

13. dns

自定义DNS服务器。可以是一个值，也可以是一个列表。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 9.9.9.9

14. dns_search

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

dns_search：example.com

dns_search：
    - domain1.example.com
    - domain2.example.com

15. entrypoint

在Dockerfile中有一个指令叫做ENTRYPOINT指令，用于指定接入点。
在docker-compose.yml中可以定义接入点，覆盖Dockerfile中的定义：

entrypoint: /code/entrypoint.sh

16. env_file

在docker-compose.yml中可以定义一个专门存放变量的文件。
如果通过docker-compose -f FILE指定配置文件，则env_file中路径会使用配置文件路径。
如果有变量名称与environment指令冲突，则以后者为准。格式如下：

env_file: .env

或者根据docker-compose.yml设置多个：

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

18. cap_add

增加指定容器的内核能力（capacity）。
让容器具有所有能力可以指定：

cap_add:
    - ALL

19. cap_drop

去掉指定容器的内核能力（capacity）。
去掉NET_ADMIN能力可以指定：

cap_drop:
    - NET_ADMIN

20. expose

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

expose:
    - "3000"
    - "8000"

21. environment***

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

 environment:
      - RUN_ACTIVE=test
      - DB_HOST=192.168.100.112
      - DB_PORT=3336
      - DB_NAME=c_model_automat
      - DB_USERNAME=root
      - DB_PASSWORD=root
      - VIRTUAL_HOST=www.baibai.com
      - VIRTUAL_PORT=8080

或者

environment:
	RUN_ACTIVE:test
	DB_HOST:192.168.100.112

22. extends

基于其它模板文件进行扩展。例如，对于webapp服务定义了一个基础模板文件为common.yml：

# common.yml
webapp:
    build: ./webapp
    environment:
        - DEBUG=false
        - SEND_EMAILS=false

再编写一个新的development.yml文件，使用common.yml中的webapp服务进行扩展：

# development.yml
web:
    extends:
        file: common.yml
        service: webapp
    ports:
        - "8000:8000"
    links:
        - db
    environment:
        - DEBUG=true
db:
    image: mysql

后者会自动继承common.yml中的webapp服务及环境变量定义。
extends限制如下：
A、要避免出现循环依赖
B、extends不会继承links和volumes_from中定义的容器和数据卷资源
推荐在基础模板中只定义一些可以共享的镜像和环境变量，在扩展模板中具体指定应用变量、链接、数据卷等信息

23. external_links

链接到docker-compose.yml外部的容器，可以是非Compose管理的外部容器。

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

24. labels

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

labels：
    com.startupteam.description: "webapp for a strtup team"

25. net***

设置网络模式

net: "bridge"
net: "none"
net: "host"