Docker Compose檔案詳解

阿新 • • 發佈：2019-02-05

先來看一份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. services

1.1 image

在services標籤下的第二級標籤是web，這個名字由使用者自己定義，它就是服務名稱。
image則是指定服務的映象名稱或映象ID。如果映象在本地不存在，Compose將會嘗試拉取這個映象。

services:
  web:
    image: hello-world

下面這些格式都是可以的。

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

1.2 build

服務除了可以基於指定的映象，還可以基於一份 Dockerfile，在使用 up 啟動之時執行構建任務，這個構建標籤就是 build，它可以指定 Dockerfile 所在資料夾的路徑。Compose 將會利用它自動構建這個映象，然後使用這個映象啟動服務容器。

build: /path/to/build/dir

也可以是相對路徑，只要上下文確定就可以讀取到 Dockerfile。

build: ./dir

設定上下文根目錄，然後以該目錄為準指定 Dockerfile。注意，build 都是一個目錄，如果你要指定 Dockerfile 檔案，需要在 build 標籤的子級標籤中，使用 dockerfile 標籤指定。

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

如果你同時指定了 build 和 image 兩個標籤，那麼 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）必須要使用引號引起來（單引號、雙引號均可），否則會當成字串解析。

1.3 command

使用command可以覆蓋容器啟動後預設執行的命令。

command: bundle exec thin -p 3000

也可以寫成類似 Dockerfile 中的格式：

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

1.4 container_name

前面說過Compose的容器名稱格式是：<專案名稱> <服務名稱> <序號>
雖然可以自定義專案名稱、服務名稱，但是如果你想完全控制容器的命名，可以使用這個標籤指定：

container_name: app

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

1.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兩個服務，因為在配置檔案中定義了依賴關係。

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

1.7 tmpfs

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

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

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

1.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 標籤。

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

1.11 expose

這個標籤與Dockerfile中的EXPOSE指令一樣，用於指定暴露的埠，但只是作為一種參考，實際上docker-compose.yml的埠對映還得ports這樣的標籤。

expose:
 - "3000"
 - "8000"

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

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

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

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

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

1.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/

1.17 pid

pid: "host"

將PID模式設定為主機PID模式，跟主機系統共享程序名稱空間。容器使用這個標籤將能夠訪問和操縱其他容器和宿主機的名稱空間。

1.18 ports

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

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

注意：當使用HOST:CONTAINER格式來對映埠時，如果你使用的容器埠小於60你可能會得到錯誤得結果，因為YAML將會解析xx:yy這種數字格式為60進位制，所以建議採用字串格式。

1.19 security_opt

為每個容器覆蓋預設的標籤。簡單說來就是管理全部服務的標籤，比如設定全部服務的user標籤值為USER。

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

1.20 stop_signal

設定另一個訊號來停止容器。在預設情況下使用的是SIGTERM停止容器，設定另一個訊號可以使用stop_signal標籤。

stop_signal: SIGUSR1

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

1.22 volumes_from

從其它容器或者服務掛載資料卷，可選的引數是:ro或者:rw，前者表示容器只讀，後者表示容器對資料卷是可讀可寫的。預設情況下是可讀可寫的。

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

1.23 cap_add, cap_drop

新增或刪除容器的核心功能。詳細資訊在前面容器章節有講解，此處不再贅述。

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

1.24 cgroup_parent

指定一個容器的父級cgroup。

cgroup_parent: m-executor-abcd

1.25 devices

裝置對映列表。與Docker client的–device引數類似。

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

1.26 extends

這個標籤可以擴充套件另一個服務，擴充套件內容可以是來自在當前檔案，也可以是來自其他檔案，相同服務的情況下，後來者會有選擇地覆蓋原有配置。

extends:
  file: common.yml
  service: webapp

使用者可以在任何地方使用這個標籤，只要標籤內容包含file和service兩個值就可以了。file的值可以是相對或者絕對路徑，如果不指定file的值，那麼Compose會讀取當前YML檔案的資訊。

2. networks

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

可以指定使用服務或者容器的網路。

2.28 networks

加入指定網路，格式如下：

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

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

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

在不同的網路，相同的服務可以有不同的別名。

3. 其它

還有這些標籤：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