Docker-Compose 配置詳解

先來看一份 docker-compose.yml 文件，不用管這是幹嗎的，只是有個格式方便後文解說：

version: '2'
services:
  web:
    image: dockercloud/hello-world
    ports:
      - 8080
    networks:
      - front-tier
      - back-tier

  redis:
    image: redis
    links:
      - web
    networks:
      - back-tier

  lb:
    image: dockercloud/haproxy
    ports:
      - 80:80
    links:
      - web
    networks:
      - front-tier
      - back-tier
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock 

networks:
  front-tier:
    driver: bridge
  back-tier:
driver: bridge

能夠看到一份標準配置文件應該包含 version、services、networks 三大部分，其中最關鍵的就是 services 和 networks 兩個部分，下面先來看 services 的書寫規則。

1. image

services:
  web:
    image: hello-world

在 services 標籤下的第二級標籤是 web，這個名字是用戶本身自定義，它就是服務名稱。
image 則是指定服務的鏡像名稱或鏡像 ID。若是鏡像在本地不存在，Compose 將會嘗試拉取這個鏡像。
例以下面這些格式都是能夠的：

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

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: webapp:tag

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

build:
  context: .
  args:
    buildno: 1
    password: secret

下面這種寫法也是支持的，通常來講下面的寫法更適合閱讀。

build:
  context: .
  args:
    - buildno=1
    - password=secret

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

args:
  - buildno
  - password

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

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

3. command

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

command: bundle exec thin -p 3000

也能夠寫成相似 Dockerfile 中的格式：

command: [bundle, exec, thin, -p, 3000]

4.container_name

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

container_name: app

這樣容器的名字就指定爲 app 了。

5.depends_on

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

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

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

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: /run
tmpfs:
  - /run
  - /tmp

8. entrypoint

在 Dockerfile 中有一個指令叫作 ENTRYPOINT 指令，用於指定接入點，第四章有對比過與 CMD 的區別。
在 docker-compose.yml 中能夠定義接入點，覆蓋 Dockerfile 中的定義：

entrypoint: /code/entrypoint.sh

格式和 Docker 相似，不過還能夠寫成這樣：

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

9.env_file

還記得前面提到的 .env 文件吧，這個文件能夠設置 Compose 的變量。而在 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

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

10. environment

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

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

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

11. expose

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

expose:
 - "3000"
 - "8000"

12. external_links

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

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

13. extra_hosts

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

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

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

162.242.195.82  somehost
50.31.209.229   otherhost

14. 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"

15. links

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

links:
 - db
 - db:database
 - redis

使用的別名將會自動在服務容器中的/etc/hosts裏建立。例如：

172.12.2.186  db
172.12.2.186  database
172.12.2.187  redis

相應的環境變量也將被建立。

16. logging

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

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

默認的driver是json-file。只有json-file和journald能夠經過docker-compose logs顯示日誌，其餘方式有其餘日誌查看方式，但目前Compose不支持。對於可選值可使用options指定。
有關更多這方面的信息能夠閱讀官方文檔：
https://docs.docker.com/engine/admin/logging/overview/

17. pid

pid: "host"

將PID模式設置爲主機PID模式，跟主機系統共享進程命名空間。容器使用這個標籤將可以訪問和操縱其餘容器和宿主機的名稱空間。

18. ports

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

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

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

19. security_opt

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

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

20. stop_signal

設置另外一個信號來中止容器。在默認狀況下使用的是SIGTERM中止容器。設置另外一個信號可使用stop_signal標籤。

stop_signal: SIGUSR1

21. 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

22. volumes_from

從其它容器或者服務掛載數據卷，可選的參數是 :ro或者 :rw，前者表示容器只讀，後者表示容器對數據卷是可讀可寫的。默認狀況下是可讀可寫的。

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

23. cap_add, cap_drop

添加或刪除容器的內核功能。詳細信息在前面容器章節有講解，此處再也不贅述。

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

24. cgroup_parent

指定一個容器的父級cgroup。

cgroup_parent: m-executor-abcd

25. devices

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

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

26. extends

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

extends:
  file: common.yml
  service: webapp

用戶能夠在任何地方使用這個標籤，只要標籤內容包含file和service兩個值就能夠了。file的值能夠是相對或者絕對路徑，若是不指定file的值，那麼Compose會讀取當前YML文件的信息。
更多的操做細節在後面的12.3.4小節有介紹。

27. 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]"

能夠指定使用服務或者容器的網絡。

28. networks

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

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

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

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

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

29. 其它

還有這些標籤：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的效果。

cpu_shares: 73
cpu_quota: 50000
cpuset: 0,1

user: postgresql
working_dir: /code

domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43

mem_limit: 1000000000
memswap_limit: 2000000000
privileged: true

restart: always

read_only: true
shm_size: 64M
stdin_open: true
tty: true

做者：左藍 連接：https://www.jianshu.com/p/2217cfed29d7 來源：簡書 簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。