1. 程式人生 > >YAML 檔案語法

YAML 檔案語法

YAML 模板檔案語法

預設的模板檔案是 docker-compose.yml,其中定義的每個服務都必須通過 image 指令指定映象或 build 指令(需要 Dockerfile)來自動構建。
其它大部分指令都跟 docker run 中的類似。
如果使用 build 指令,在 Dockerfile 中設定的選項(例如:CMD, EXPOSE, VOLUME, ENV 等) 將會自動被獲取,無需在 docker-compose.yml 中再次設定。
image
指定為映象名稱或映象 ID。如果映象在本地不存在,Compose 將會嘗試拉去這個映象。
例如:

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

build

指定 Dockerfile 所在資料夾的路徑。 Compose 將會利用它自動構建這個映象,然後使用這個映象。
build: /path/to/build/dir

command

覆蓋容器啟動後預設執行的命令。

command: bundle exec thin -p 3000

連結到其它服務中的容器。使用服務名稱(同時作為別名)或服務名稱:服務別名 (SERVICE:ALIAS) 格式都可以。
links:
- db
- db:database
- redis
使用的別名將會自動在服務容器中的 /etc/hosts 裡建立。例如:
172.17.2.186 db
相應的環境變數也將被建立。

連結到 docker-compose.yml 外部的容器,甚至 並非 Compose 管理的容器。引數格式跟 links 類似。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql

ports

暴露埠資訊。
使用宿主:容器 (HOST:CONTAINER)格式或者僅僅指定容器的埠(宿主將會隨機選擇埠)都可以。
- “3000”
- “8000:8000”
- “127.0.0.1:8001:8001”
注:當使用 HOST:CONTAINER 格式來對映埠時,如果你使用的容器埠小於 60 你可能會得到錯誤得結果,因為 YAML 將會解析 xx:yy 這種數字格式為 60 進位制。所以建議採用字串格式。

expose

暴露埠,但不對映到宿主機,只被連線的服務訪問。
僅可以指定內部埠為引數
expose:
- “3000”
- “8000”

volumes

卷掛載路徑設定。可以設定宿主機路徑 (HOST:CONTAINER) 或加上訪問模式 (HOST:CONTAINER:ro)。

volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro

volumes_from

從另一個服務或容器掛載它的所有卷。
volumes_from:
- service_name
- container_name

environment

設定環境變數。你可以使用陣列或字典兩種格式。
只給定名稱的變數會自動獲取它在 Compose 主機上的值,可以用來防止洩露不必要的資料。
environment:
- RACK_ENV=development
- SESSION_SECRET

env_file

從檔案中獲取環境變數,可以為單獨的檔案路徑或列表。
如果通過 docker-compose -f FILE 指定了模板檔案,則 env_file 中路徑會基於模板檔案路徑。
如果有變數名稱與 environment 指令衝突,則以後者為準。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
環境變數檔案中每一行必須符合格式,支援 # 開頭的註釋行。
#common.env: Set Rails/Rack environment
RACK_ENV=development

extends

基於已有的服務進行擴充套件。例如我們已經有了一個 webapp 服務,模板檔案為 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: postgres

後者會自動繼承 common.yml 中的 webapp 服務及相關環節變數。

net

設定網路模式。使用和 docker client 的 –net 引數一樣的值。

net: "bridge"
net: "none"
net: "container:[name or id]"
net: "host"

pid

跟主機系統共享程序名稱空間。開啟該選項的容器可以相互通過程序 ID 來訪問和操作。
pid: “host

dns

配置 DNS 伺服器。可以是一個值,也可以是一個列表。

dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9

cap_add, cap_drop

新增或放棄容器的 Linux 能力(Capabiliity)。
cap_add:
- ALL
cap_drop:
- NET_ADMIN
- SYS_ADMIN

dns_search

配置 DNS 搜尋域。可以是一個值,也可以是一個列表。

dns_search: example.com
dns_search:
- domain1.example.com
 - domain2.example.com
working_dir, entrypoint, user, hostname, domainname, mem_limit, privileged, restart, stdin_open, tty, cpu_shares
這些都是和 docker run 支援的選項類似。
cpu_shares: 73
working_dir: /code
entrypoint: /code/entrypoint.sh
user: postgresql
hostname: foo
domainname: foo.com
mem_limit: 1000000000
privileged: true
restart: always
stdin_open: true
tty: true