模板文件是使用compose的核心,涉及到的關鍵指令也比較多。大多數的指令都和docker run相關參數的含義類似。
默認的模板文件名稱“docker-compose.yml” ,格式爲YAML格式。
version: "3"
services:
webapp:
image: examples/web
ports:
- "80:80"
volumes:
- "/data"
注意:每個服務都必須通過image指令指定鏡像或者build指令(需要dockerfile)等來自動構建生成需要的鏡像。
如果用build指令,在Dockerfile中設置的選項(例如:CMD,EXPOSE,VOLUME,ENV等)將會自動被獲取,不需要再compose.yml中重複設置。
指令含義及用法
build
指定Dockerfile所在的文件目錄路徑(可以是絕對路徑或相對路徑) 需要在docker-compose.yml的路徑。
compose 將會利用它自動構建這個鏡像,然後使用該鏡像。
version: '3'
services:
webapp:
build: ./dir
你也可以使用 context 指令指定 Dockerfile 所在文件夾的路徑。
使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定構建鏡像時的變量。
version: '3'
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1
使用 cache_from 指定構建鏡像的緩存
build:
context: .
cache_from:
- alpine:latest
- corp/web_app:3.14
cap_add, cap_drop
指定容器的內核能力(capacity)分配。
例如,讓容器擁有所有能力可以指定爲:
cap_add:
- ALL
去掉 NET_ADMIN 能力可以指定爲:
cap_drop:
- NET_ADMIN
command
覆蓋容器啓動後默認執行的命令。
command: echo "hello world"
configs
僅用於 swarm mode
cgroup_parent
指定父 cgroup組,意味着將繼承該組的資源限制。
例如,創建了一個 cgroup 組名稱爲 cgroups_1。
cgroup_parent: cgroups_1
container_name
指定容器名稱。默認將會使用 項目名稱_服務名稱_序號 這樣的格式。
container_name: docker-web-container
注意: 指定容器名稱後,該服務將無法進行擴展(scale),因爲 Docker 不允許多個容器具有相同的名稱。
deploy
僅用於 Swarm mode
devices
指定設備映射關係。
devices:
- "/dev/ttyUSB1:/dev/ttyUSB0"
depends_on
解決容器的依賴、啓動先後的問題。以下例子中會先啓動 redis db 再啓動 web
version: '3'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
注意:web 服務不會等待 redis db 「完全啓動」之後才啓動。
dns
自定義 DNS 服務器。可以是一個值,也可以是一個列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 114.114.114.114
dns_search
配置 DNS 搜索域。可以是一個值,也可以是一個列表。
dns_search: example.com
dns_search:
- domain1.example.com
- domain2.example.com
tmpfs
掛載一個 tmpfs 文件系統到容器。
tmpfs: /run
tmpfs:
- /run
- /tmp
env_file
從文件中獲取環境變量,可以爲單獨的文件路徑或列表。
如果通過 docker-compose -f FILE 方式來指定 Compose 模板文件,則 env_file 中變量的路徑會基於模板文件路徑。
如果有變量名稱與 environment 指令衝突,則按照慣例,以後者爲準。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
環境變量文件中每一行必須符合格式,支持 # 開頭的註釋行。
# common.env: Set development environment
PROG_ENV=development
environment
設置環境變量。你可以使用數組或字典兩種格式。
只給定名稱的變量會自動獲取運行 Compose 主機上對應變量的值,可以用來防止泄露不必要的數據。
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET
如果變量名稱或者值中用到 true|false,yes|no 等表達 布爾 含義的詞彙,最好放到引號裏,避免 YAML 自動解析某些內容爲對應的布爾語義。這些特定詞彙,包括
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"
external_links
注意:不建議使用該指令。
鏈接到 docker-compose.yml 外部的容器,甚至並非 Compose 管理的外部容器。
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
healthcheck
通過命令檢查容器是否健康運行。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3
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
logging
配置日誌選項。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
目前支持三種日誌驅動類型。
driver: "json-file"
driver: "syslog"
driver: "none"
options 配置日誌驅動的相關參數。
options:
max-size: "200k"
max-file: "10"
例如:
nginx:
image: nginx:1.12.1
restart: always
logging:
driver: "json-file"
options:
max-size: "5g"
或者命令行啓動時添加:
docker run -d --log-opt max-size=1g nginx
或修改docker的daemon文件:
{
"log-opts": {
"max-size": "1G"
}
}
network_mode
設置網絡模式。使用和 docker run 的 --network 參數一樣的值。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
networks
配置容器連接的網絡。
version: "3"
services:
some-service:
networks:
- some-network
- other-network
networks:
some-network:
other-network:
例如:
version: '3'
services:
nginx:
image: nginx:v1
container_name: mynginx
command: ip addr
networks:
app_web: # 調用 networks 定義的 app_we 網絡
ipv4_address: 172.18.0.4 # IP V4 格式
networks:
app_web:
driver: bridge # 指定日誌記錄驅動程序
ipam: # 自定義 IPAM 配置. 這是一個具有多個屬性的對象, 每個屬性都是可選的
driver: default # IPAM 驅動程序, bridge 或者 default
config: # 配置項
- subnet: 172.18.0.0/24 #子網,網段
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 進制。爲避免出現這種問題,建議數字串都採用引號包括起來的字符串格式。
secrets
存儲敏感數據,例如 mysql 服務密碼。
version: "3.1"
services:
mysql:
image: mysql
environment:
MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
secrets:
- db_root_password
- my_other_secret
secrets:
my_secret:
file: ./my_secret.txt
my_other_secret:
external: true
security_opt
指定容器模板標籤(label)機制的默認屬性(用戶、角色、類型、級別等)。例如配置標籤的用戶名和角色名。
security_opt:
- label:user:USER
- label:role:ROLE
stop_signal
設置另一個信號來停止容器。在默認情況下使用的是 SIGTERM 停止容器。
stop_signal: SIGUSR1
sysctls
配置容器內核參數。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
ulimits
指定容器的 ulimits 限制值。
例如,指定最大進程數爲 65535,指定文件句柄數爲 20000(軟限制,應用可以隨時修改,不能超過硬限制) 和 40000(系統硬限制,只能 root 用戶提高)。
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000
volumes
數據卷所掛載路徑設置。可以設置爲宿主機路徑(HOST:CONTAINER)或者數據卷名稱(VOLUME:CONTAINER),並且可以設置訪問模式 (HOST:CONTAINER:ro)。
該指令中路徑支持相對路徑。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro
如果路徑爲數據卷名稱,必須在文件中配置數據卷。
version: "3"
services:
my_src:
image: mysql:8.0
volumes:
- mysql_data:/var/lib/mysql
volumes:
mysql_data:
其它指令
此外,還有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令,基本跟 docker run 中對應參數的功能一致。
指定服務容器啓動後執行的入口文件。
其實就是dockerfile裏面ENTRYPOINT與CMD。
entrypoint: /code/entrypoint.sh
指定容器中運行應用的用戶名。
user: nginx
指定容器中工作目錄。
working_dir: /code
指定容器中搜索域名、主機名、mac 地址等。
domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A
允許容器中運行一些特權命令。
privileged: true
指定容器退出後的重啓策略爲始終重啓。該命令對保持服務始終運行十分有效,在生產環境中推薦配置爲 always 或者 unless-stopped。
restart: always
以只讀模式掛載容器的 root 文件系統,意味着不能對容器內容進行修改。
read_only: true
打開標準輸入,可以接受外部輸入。
stdin_open: true
模擬一個僞終端。
tty: true
讀取變量
Compose 模板文件支持動態讀取主機的系統環境變量和當前目錄下的 .env 文件中的變量。
例如,下面的 Compose 文件將從運行它的環境中讀取變量 ${MONGO_VERSION} 的值,並寫入執行的指令中。
如果執行 MONGO_VERSION=3.2 docker-compose up 則會啓動一個 mongo:3.2 鏡像的容器;如果執行 MONGO_VERSION=2.8 docker-compose up 則會啓動一個 mongo:2.8 鏡像的容器。
若當前目錄存在 .env 文件,執行 docker-compose 命令時將從該文件中讀取變量。
在當前目錄新建 .env 文件並寫入以下內容。
# 支持 # 號註釋
MONGO_VERSION=3.6
執行 docker-compose up 則會啓動一個 mongo:3.6 鏡像的容器。
這裏只介紹一些常用的選項,有關係其他的還需要各位查閱官方文檔得知用法。
幫助文檔:
https://yeasy.gitbooks.io/docker_practice/compose/compose_file.html