Docker - Compose 使用說明、詳解docker-compose

Compose 模板文件

前些天發現了一個巨牛的人工智能學習網站，通俗易懂，風趣幽默，忍不住分享一下給大家。點擊跳轉到教程。

模板文件是使用 Compose 的核心，涉及到的指令關鍵字也比較多。但大家不用擔心，這里面大部分指令跟?docker run?相關參數的含義都是類似的。

默認的模板文件名稱為?docker-compose.yml，格式為 YAML 格式。

在舊版本（版本 1）中，其中每個頂級元素為服務名稱，次級元素為服務容器的配置信息，例如

webapp:image: examples/webports:- "80:80"volumes:- "/data"

版本 2 擴展了 Compose 的語法，同時盡量保持跟版本 1 的兼容，除了可以聲明網絡和存儲信息外，最大的不同一是添加了版本信息，另一個是需要將所有的服務放到?services?根下面。

例如，上面例子改寫為版本 2，內容為

version: "2"
services:webapp:image: examples/webports:- "80:80"volumes:- "/data"

注意每個服務都必須通過?image?指令指定鏡像或?build?指令（需要 Dockerfile）等來自動構建生成鏡像。

如果使用?build?指令，在?Dockerfile?中設置的選項(例如：CMD,?EXPOSE,?VOLUME,?ENV?等) 將會自動被獲取，無需在?docker-compose.yml?中再次設置。

下面分別介紹各個指令的用法。

`build`

指定?Dockerfile?所在文件夾的路徑（可以是絕對路徑，或者相對 docker-compose.yml 文件的路徑）。?Compose?將會利用它自動構建這個鏡像，然后使用這個鏡像。

build: /path/to/build/dir

`cap_add, cap_drop`

指定容器的內核能力（capacity）分配。

例如，讓容器擁有所有能力可以指定為：

cap_add:- ALL

去掉 NET_ADMIN 能力可以指定為：

cap_drop:- NET_ADMIN

`command`

覆蓋容器啟動后默認執行的命令。

command: echo "hello world"

`cgroup_parent`

指定父 cgroup 組，意味著將繼承該組的資源限制。

例如，創建了一個 cgroup 組名稱為?cgroups_1。

cgroup_parent: cgroups_1

`container_name`

指定容器名稱。默認將會使用?項目名稱_服務名稱_序號?這樣的格式。

例如：

container_name: docker-web-container

需要注意，指定容器名稱后，該服務將無法進行擴展（scale），因為 Docker 不允許多個容器具有相同的名稱。

`devices`

指定設備映射關系。

例如：

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

`dns`

自定義 DNS 服務器。可以是一個值，也可以是一個列表。

dns: 8.8.8.8
dns:- 8.8.8.8- 9.9.9.9

`dns_search`

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

dns_search: example.com
dns_search:- domain1.example.com- domain2.example.com

`dockerfile`

如果需要指定額外的編譯鏡像的 Dockefile 文件，可以通過該指令來指定。

例如

dockerfile: Dockerfile-alternate

注意，該指令不能跟?image?同時使用，否則 Compose 將不知道根據哪個指令來生成最終的服務鏡像。

`env_file`

從文件中獲取環境變量，可以為單獨的文件路徑或列表。

如果通過?docker-compose -f FILE?方式來指定 Compose 模板文件，則?env_file?中變量的路徑會基于模板文件路徑。

如果有變量名稱與?environment?指令沖突，則按照慣例，以后者為準。

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

環境變量文件中每一行必須符合格式，支持?#?開頭的注釋行。

# common.env: Set development environment
PROG_ENV=development

`environment`

設置環境變量。你可以使用數組或字典兩種格式。

只給定名稱的變量會自動獲取運行 Compose 主機上對應變量的值，可以用來防止泄露不必要的數據。

例如

environment:RACK_ENV: developmentSESSION_SECRET:

或者

environment:- RACK_ENV=development- SESSION_SECRET

注意，如果變量名稱或者值中用到?true|false，yes|no?等表達布爾含義的詞匯，最好放到引號里，避免 YAML 自動解析某些內容為對應的布爾語義。

http://yaml.org/type/bool.html?中給出了這些特定詞匯，包括

 y|Y|yes|Yes|YES|n|N|no|No|NO
|true|True|TRUE|false|False|FALSE
|on|On|ON|off|Off|OFF

`expose`

暴露端口，但不映射到宿主機，只被連接的服務訪問。

僅可以指定內部端口為參數

expose:- "3000"- "8000"

`extends`

基于其它模板文件進行擴展。

例如我們已經有了一個 webapp 服務，定義一個基礎模板文件為?common.yml。

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

再編寫一個新的?development.yml?文件，使用?common.yml?中的 webapp 服務進行擴展。

# development.yml
web:extends:file: common.ymlservice: webappports:- "8000:8000"links:- dbenvironment:- DEBUG=true
db:image: postgres

后者會自動繼承 common.yml 中的 webapp 服務及環境變量定義。

使用 extends 需要注意：

要避免出現循環依賴，例如?A 依賴 B，B 依賴 C，C 反過來依賴 A?的情況。
extends 不會繼承 links 和 volumes_from 中定義的容器和數據卷資源。

一般的，推薦在基礎模板中只定義一些可以共享的鏡像和環境變量，在擴展模板中具體指定應用變量、鏈接、數據卷等信息。

`external_links`

鏈接到 docker-compose.yml 外部的容器，甚至并非?Compose?管理的外部容器。參數格式跟?links?類似。

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

`extra_hosts`

類似 Docker 中的?--add-host?參數，指定額外的 host 名稱映射信息。

例如：

extra_hosts:- "googledns:8.8.8.8"- "dockerhub:52.1.157.61"

會在啟動后的服務容器中?/etc/hosts?文件中添加如下兩條條目。

8.8.8.8 googledns
52.1.157.61 dockerhub

`image`

指定為鏡像名稱或鏡像 ID。如果鏡像在本地不存在，Compose?將會嘗試拉去這個鏡像。

例如：

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

`labels`

為容器添加 Docker 元數據（metadata）信息。例如可以為容器添加輔助說明信息。

labels:com.startupteam.description: "webapp for a startup team"com.startupteam.department: "devops department"com.startupteam.release: "rc3 for v1.0"

`links`

鏈接到其它服務中的容器。使用服務名稱（同時作為別名）或服務名稱：服務別名?（SERVICE:ALIAS）?格式都可以。

links:- db- db:database- redis

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

172.17.2.186  db
172.17.2.186  database
172.17.2.187  redis

被鏈接容器中相應的環境變量也將被創建。

`log_driver`

類似 Docker 中的?--log-driver?參數，指定日志驅動類型。

目前支持三種日志驅動類型。

log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

`log_opt`

日志驅動的相關參數。

例如

log_driver: "syslog"
log_opt:syslog-address: "tcp://192.168.0.42:123"

`net`

設置網絡模式。使用和?docker client?的?--net?參數一樣的值。

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

`pid`

跟主機系統共享進程命名空間。打開該選項的容器之間，以及容器和宿主機系統之間可以通過進程 ID 來相互訪問和操作。

pid: "host"

`ports`

暴露端口信息。

使用宿主：容器?（HOST:CONTAINER）格式，或者僅僅指定容器的端口（宿主將會隨機選擇端口）都可以。

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

注意：當使用?HOST:CONTAINER?格式來映射端口時，如果你使用的容器端口小于 60 并且沒放到引號里，可能會得到錯誤結果，因為?YAML?會自動解析?xx:yy?這種數字格式為 60 進制。為避免出現這種問題，建議數字串都采用引號包括起來的字符串格式。

`security_opt`

指定容器模板標簽（label）機制的默認屬性（用戶、角色、類型、級別等）。

例如配置標簽的用戶名和角色名。

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

`ulimits`

指定容器的 ulimits 限制值。

例如，指定最大進程數為 65535，指定文件句柄數為 20000（軟限制，應用可以隨時修改，不能超過硬限制）和 40000（系統硬限制，只能 root 用戶提高）。

  ulimits:nproc: 65535nofile:soft: 20000hard: 40000

`volumes`

數據卷所掛載路徑設置。可以設置宿主機路徑（HOST:CONTAINER）或加上訪問模式（HOST:CONTAINER:ro）。

該指令中路徑支持相對路徑。例如

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

`volumes_driver`

較新版本的 Docker 支持數據卷的插件驅動。

用戶可以先使用第三方驅動創建一個數據卷，然后使用名稱來訪問它。

此時，可以通過?volumes_driver?來指定驅動。

volume_driver: mydriver

`volumes_from`

從另一個服務或容器掛載它的數據卷。

volumes_from:- service_name- container_name

其它指令

此外，還有包括?cpu_shares, cpuset, domainname, entrypoint, hostname, ipc, mac_address, mem_limit, memswap_limit, privileged, read_only, restart, stdin_open, tty, user, working_dir?等指令，基本跟 docker-run 中對應參數的功能一致。

例如，指定使用 cpu 核 0 和核 1，只用 50% 的 CPU 資源：

cpu_shares: 73
cpuset: 0,1

指定服務容器啟動后執行的命令。

entrypoint: /code/entrypoint.sh

指定容器中運行應用的用戶名。

user: nginx

指定容器中工作目錄。

working_dir: /code

指定容器中搜索域名、主機名、mac 地址等。

domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A

指定容器中

ipc: host

指定容器中內存和內存交換區限制都為 1G。

mem_limit: 1g
memswap_limit: 1g

允許容器中運行一些特權命令。

privileged: true

指定容器退出后的重啟策略為始終重啟。該命令對保持服務始終運行十分有效，在生產環境中推薦配置為?always?或者?unless-stopped。

restart: always

以只讀模式掛載容器的 root 文件系統，意味著不能對容器內容進行修改。

read_only: true

打開標準輸入，可以接受外部輸入。

stdin_open: true

模擬一個假的遠程控制臺。

tty: true

讀取環境變量

從 1.5.0 版本開始，Compose 模板文件支持動態讀取主機的系統環境變量。

例如，下面的 Compose 文件將從運行它的環境中讀取變量 ${MONGO_VERSION} 的值，并寫入執行的指令中。

db:image: "mongo:${MONGO_VERSION}"

如果執行?MONGO_VERSION=3.0 docker-compose up?則會啟動一個?mongo:3.2?鏡像的容器；如果執行?MONGO_VERSION=2.8 docker-compose up?則會啟動一個?mongo:2.8?鏡像的容器。

轉自：https://bingohuang.gitbooks.io/docker_practice/content/compose/yaml_file.html