Docker Compose 配置文件詳解

先看上次製做的docker-compose文件

version: '2'
services:
    server-redmine:
        image: redmine:latest
        
        links:
            - server-mysql:server-mysql
        ports:
            - '8087:3000'
        environment:
            - MYSQL_ROOT_PASSWORD=pass
        volumes:
          - '/root/docker/redmine/redmine_dir:/usr/src/redmine/files'

    server-mysql:
        image: mysql:latest
        environment:
            - MYSQL_ROOT_PASSWORD=pass
        volumes:
          - '/root/docker/redmine/mysql__dir:/var/lib/mysql'

　　一份標準配置文件應該包含 version、services、networks 三大部分，其中最關鍵的就是 services 和 networks 兩個部分，下面先來看 services 的書寫規則。我這裏的networks直接使用 version: '2'

1. image

services:
    server-redmine:
        image: redmine:latest

　　在 services 標籤下的第二級標籤是server-redmine，這個名字是用戶本身自定義，它就是服務名稱。

　　image 則是指定服務的鏡像名稱或鏡像 ID。若是鏡像在本地不存在，Compose 將會嘗試拉取這個鏡像。

 

2. build

　　服務除了能夠基於指定的鏡像，還能夠基於一份 Dockerfile，在使用 up 啓動之時執行構建任務，這個構建標籤就是 build，它能夠指定 Dockerfile 所在文件夾的路徑。Compose 將會利用它自動構建這個鏡像，而後使用這個鏡像啓動服務容器。

build: /path/to/build/dir

　　也能夠是相對路徑，只要上下文肯定就能夠讀取到 Dockerfile。

build: ./dir

　　設定上下文根目錄，而後以該目錄爲準指定 Dockerfile。

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

　　注意 build 都是一個目錄，若是你要指定 Dockerfile 文件須要在 build 標籤的子級標籤中使用 dockerfile 標籤指定，如上面的例子。

　　若是你同時指定了 image 和 build 兩個標籤，那麼 Compose 會構建鏡像而且把鏡像命名爲 image 後面的那個名字。

build: ./dir
image: image_name:tag

　　既然能夠在 docker-compose.yml 中定義構建任務，那麼必定少不了 arg 這個標籤，就像 Dockerfile 中的 ARG 指令，它能夠在構建過程當中指定環境變量，可是在構建成功後取消，在 docker-compose.yml 文件中也支持這樣的寫法：

build:
  context: .
  args:
    - prots=8080
    - password=yatho

　　與 ENV 不一樣的是，ARG 是容許空值的。例如：

args:
  - ports
  - password

　　這樣構建過程能夠向它們賦值。

　　注意：YAML 的布爾值（true, false, yes, no, on, off）必需要使用引號引發來（單引號、雙引號都可），不然會當成字符串解析。

 

3. command

　　使用 command 能夠覆蓋容器啓動後默認執行的命令。

command: bundle exec thin -p 3000

4.container_name

　　 前面說過 Compose 的容器名稱格式是：<項目名稱><服務名稱><序號>
　　雖然能夠自定義項目名稱、服務名稱，可是若是你想徹底控制容器的命名，可使用這個標籤指定：

container_name: server-redmine

　　這樣容器的名字就指定爲 server-redmine 了。

 

5.depends_on

　　在使用 Compose 時，最大的好處就是少打啓動命令，可是通常項目容器啓動的順序是有要求的，若是直接從上到下啓動容器，必然會由於容器依賴問題而啓動失敗。
　　例如在沒啓動數據庫容器的時候啓動了應用容器，這時候應用容器會由於找不到數據庫而退出，爲了不這種狀況咱們須要加入一個標籤，就是 depends_on，這個標籤解決了容器的依賴、啓動前後的問題。
　　例以下面容器會先啓動 mysql 服務，以後後才啓動 redmine服務：

version: '2'
services:
  redmine:
    image: redmine
    depends_on:
      - mysql 
  mysql:
    image: mysql

　　注意的是，默認狀況下使用 docker-compose up redmine這樣的方式啓動 redmine服務時，也會啓動 mysql 服務，由於在配置文件中定義了依賴關係。

6.dns

　　和 --dns 參數同樣用途，格式以下：

dns: 8.8.8.8

　　也能夠是一個列表：

dns:
  - 8.8.8.8
  - 9.9.9.9

　　此外 dns_search 的配置也相似：

dns_search: example.com
dns_search:
  - dc1.example.com
  - dc2.example.com

7. tmpfs

　　掛載臨時目錄到容器內部，與 run 的參數同樣效果：

tmpfs: /dir
tmpfs:
  - /dir
  - /tmp

　　

8. entrypoint

　　在 Dockerfile 中有一個指令叫作 ENTRYPOINT 指令，用於指定接入點。
　　在 docker-compose.yml 中能夠定義接入點，覆蓋 Dockerfile 中的定義。

9.env_file

 　　.env 文件能夠設置 Compose 的變量。而在 docker-compose.yml 中能夠定義一個專門存放變量的文件。
　　若是經過 docker-compose -f FILE 指定了配置文件，則 env_file 中路徑會使用配置文件路徑。若是有變量名稱與 environment 指令衝突，則之後者爲準。格式以下：

env_file: .env

　　注意:這裏所說的環境變量是對宿主機的 Compose 而言的，若是在配置文件中有 build 操做，這些變量並不會進入構建過程當中，若是要在構建中使用變量仍是首選前面剛講的 arg 標籤。

10. environment

　　與上面的 env_file 標籤徹底不一樣，反而和 arg 有幾分相似，這個標籤的做用是設置鏡像變量，它能夠保存變量到鏡像裏面，也就是說啓動的容器也會包含這些變量設置，這是與 arg 最大的不一樣。
　　通常 arg 標籤的變量僅用在構建過程當中。而 environment 和 Dockerfile 中的 ENV 指令同樣會把變量一直保存在鏡像、容器中，相似 docker run -e 的效果。

environment:
            - MYSQL_ROOT_PASSWORD=pass

11. expose

　　這個標籤與Dockerfile中的EXPOSE指令同樣，用於指定暴露的端口，可是隻是做爲一種參考，實際上docker-compose.yml的端口映射還得ports這樣的標籤。

    ports:
        - '8087:3000'

　　expose:
 　　　　- "8087"

　　

12. external_links

　　在使用Docker過程當中，咱們會有許多單獨使用docker run啓動的容器，爲了使Compose可以鏈接這些不在docker-compose.yml中定義的容器，咱們須要一個特殊的標籤，就是external_links，它可讓Compose項目裏面的容器鏈接到那些項目配置外部的容器（前提是外部容器中必須至少有一個容器是鏈接到與項目內的服務的同一個網絡裏面）。

external_links:
 - db2

　　

13. extra_hosts

　　添加主機名的標籤，就是往/etc/hosts文件中添加一些記錄，與Docker client的--add-host相似：

extra_hosts:
 - "baiduhost:58.217.200.14"

　　啓動以後查看容器內部hosts：

58.217.200.14 baiduhost

　　

14. labels

　　向容器添加元數據，和Dockerfile的LABEL指令一個意思，格式以下：

labels:
  com.example.description: "redmine"
  com.example.department: ""
  com.example.label-with-empty-value: ""

　　

15. links

　　上面的 depends_on 解決的是啓動順序問題，這個標籤解決的是容器鏈接問題，與Docker client的--link同樣效果，會鏈接到其它服務中的容器。
　　格式以下：

        links:
            - server-mysql:server-mysql

　　使用的別名將會自動在服務容器中的/etc/hosts裏建立。相應的環境變量也將被建立。

16. logging

　　這個標籤用於配置日誌服務。格式以下：

logging:
  driver: syslog
  options:
    syslog-address: "xxx"

　　默認的driver是json-file。只有json-file和journald能夠經過docker-compose logs顯示日誌，其餘方式有其餘日誌查看方式，但目前Compose不支持。對於可選值可使用options指定。

17. pid

　　容器使用這個標籤將可以訪問和操縱其餘容器和宿主機的名稱空間。

pid: "host"

　　將PID模式設置爲主機PID模式，跟主機系統共享進程命名空間。

18. ports

　　映射端口的標籤。
　　使用HOST:CONTAINER格式或者只是指定容器的端口，宿主機會隨機映射端口。

        ports:
            - '8087:3000'

　　注意：當使用HOST:CONTAINER格式來映射端口時，若是你使用的容器端口小於60你可能會獲得錯誤得結果，由於YAML將會解析xx:yy這種數字格式爲60進制。因此建議採用字符串格式。

19. security_opt

　　爲每一個容器覆蓋默認的標籤。簡單說來就是管理所有服務的標籤。好比設置所有服務的user標籤值爲USER。

security_opt:
  - label:user:USER
  - label:role:ROLE

　　

20. volumes

　　掛載一個目錄或者一個已存在的數據卷容器，能夠直接使用 [HOST:CONTAINER] 這樣的格式，或者使用 [HOST:CONTAINER:ro] 這樣的格式設置目錄權限，能夠有效保護宿主機的文件系統。
　　Compose的數據卷指定路徑能夠是相對路徑，使用 . 或者 .. 來指定相對目錄。
　　數據卷的格式能夠是下面多種形式：

volumes:
  // 只是指定一個路徑，Docker 會自動在建立一個數據卷（這個路徑是容器內部的），不推薦這種模式，容器結束後，數據會自動清除
  - /var/lib/mysql

  // 使用絕對路徑掛載數據卷
  - /root/docker/redmine/redmine_dir:/usr/src/redmine/files

  // 以 Compose 配置文件爲中心的相對路徑做爲數據卷掛載到容器
  - ./redmine_dir:/usr/src/redmine/files

  // 使用用戶的相對路徑
  - ~/docker/redmine/mysql__dir:/var/lib/mysql

  // 已經存在的命名的數據卷。
  - datavolume:/var/lib/mysql

　　若是你不使用宿主機的路徑，你能夠指定一個volume_driver。

volume_driver: mydriver

　　

21. volumes_from

　　從其它容器或者服務掛載數據卷

22. cap_add, cap_drop

　　添加或刪除容器的內核功能。

23. cgroup_parent

　　指定一個容器的父級cgroup。

24. devices

　　設備映射列表。與Docker client的--device參數相似。

25. extends

　　這個標籤能夠擴展另外一個服務，擴展內容能夠是來自在當前文件，也能夠是來自其餘文件，相同服務的狀況下，後來者會有選擇地覆蓋原有配置。

26. network_mode

　　能夠指定使用服務或者容器的網絡模式，與Docker client的--net參數相似，只是相對多了一個service:[service name] 的格式。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

27. networks

　　加入指定網絡，格式以下：

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

　　關於這個標籤還有一個特別的子標籤aliases，這是一個用來設置服務別名的標籤，例如：

services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
         - alias3
      other-network:
        aliases:
         - alias2

　　相同的服務能夠在不一樣的網絡有不一樣的別名。

28. 其它

　　單值的標籤，相似於使用docker run的效果。

　　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