一文了解 Docker Compose 模板文件
模板文件是使用 Compose 的核心,涉及到的指令關(guān)鍵字也比較多。但大家不用擔(dān)心,這里面大部分指令跟 docker run 相關(guān)參數(shù)的含義都是類似的。
默認(rèn)的模板文件名稱為 docker-compose.yml,格式為 YAML 格式。
version: "3"
services:
webapp:
image: examples/web
ports:
- "80:80"
volumes:
- "/data"注意每個服務(wù)都必須通過 image 指令指定鏡像或 build 指令(需要 Dockerfile)等來自動構(gòu)建生成鏡像。
如果使用 build 指令,在 Dockerfile 中設(shè)置的選項(例如:CMD, EXPOSE, VOLUME, ENV 等) 將會自動被獲取,無需在 docker-compose.yml 中再次設(shè)置。
下面分別介紹各個指令的用法。
build
指定 Dockerfile 所在文件夾的路徑(可以是絕對路徑,或者相對 docker-compose.yml 文件的路徑)。Compose 將會利用它自動構(gòu)建這個鏡像,然后使用這個鏡像。
version: '3'
services:
webapp:
build: ./dir你也可以使用 context 指令指定 Dockerfile 所在文件夾的路徑。
使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定構(gòu)建鏡像時的變量。
version: '3'
services:
webapp:
build:
context: ./dir
dockerfile: Dockerfile-alternate
args:
buildno: 1使用 cache_from 指定構(gòu)建鏡像的緩存
build:
context: .
cache_from:
- alpine:latest
- corp/web_app:3.14cap_add, cap_drop
指定容器的內(nèi)核能力(capacity)分配。
例如,讓容器擁有所有能力可以指定為:
cap_add:
- ALL去掉 NET_ADMIN 能力可以指定為:
cap_drop:
- NET_ADMINcommand
覆蓋容器啟動后默認(rèn)執(zhí)行的命令。
command: echo "hello world"configs
僅用于 Swarm mode,詳細內(nèi)容請查看 Swarm mode 一節(jié)。
cgroup_parent
指定父 cgroup 組,意味著將繼承該組的資源限制。
例如,創(chuàng)建了一個 cgroup 組名稱為 cgroups_1。
cgroup_parent: cgroups_1container_name
指定容器名稱。默認(rèn)將會使用 項目名稱_服務(wù)名稱_序號 這樣的格式。
container_name: docker-web-container注意: 指定容器名稱后,該服務(wù)將無法進行擴展(scale),因為 Docker 不允許多個容器具有相同的名稱。
deploy
僅用于 Swarm mode,詳細內(nèi)容請查看 Swarm mode 一節(jié)
devices
指定設(shè)備映射關(guān)系。
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 服務(wù)不會等待 redis db 「完全啟動」之后才啟動。
dns
自定義 DNS 服務(wù)器。可以是一個值,也可以是一個列表。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 114.114.114.114dns_search
配置 DNS 搜索域。可以是一個值,也可以是一個列表。
dns_search: example.com
dns_search:
- domain1.example.com
- domain2.example.comtmpfs
掛載一個 tmpfs 文件系統(tǒng)到容器。
tmpfs: /run
tmpfs:
- /run
- /tmpenv_file
從文件中獲取環(huán)境變量,可以為單獨的文件路徑或列表。
如果通過 docker-compose -f FILE 方式來指定 Compose 模板文件,則 env_file 中變量的路徑會基于模板文件路徑。
如果有變量名稱與 environment 指令沖突,則按照慣例,以后者為準(zhǔn)。
env_file: .env
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env環(huán)境變量文件中每一行必須符合格式,支持 # 開頭的注釋行。
# common.env: Set development environment
PROG_ENV=developmentenvironment
設(shè)置環(huán)境變量。你可以使用數(shù)組或字典兩種格式。
只給定名稱的變量會自動獲取運行 Compose 主機上對應(yīng)變量的值,可以用來防止泄露不必要的數(shù)據(jù)。
environment:
RACK_ENV: development
SESSION_SECRET:
environment:
- RACK_ENV=development
- SESSION_SECRET如果變量名稱或者值中用到 true|false,yes|no 等表達 布爾 含義的詞匯,最好放到引號里,避免 YAML 自動解析某些內(nèi)容為對應(yīng)的布爾語義。這些特定詞匯,包括
y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFFexpose
暴露端口,但不映射到宿主機,只被連接的服務(wù)訪問。
僅可以指定內(nèi)部端口為參數(shù)
expose:
- "3000"
- "8000"external_links
注意:不建議使用該指令。
鏈接到 docker-compose.yml 外部的容器,甚至并非 Compose 管理的外部容器。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresqlextra_hosts
類似 Docker 中的 --add-host 參數(shù),指定額外的 host 名稱映射信息。
extra_hosts:
- "googledns:8.8.8.8"
- "dockerhub:52.1.157.61"會在啟動后的服務(wù)容器中 /etc/hosts 文件中添加如下兩條條目。
8.8.8.8 googledns
52.1.157.61 dockerhubhealthcheck
通過命令檢查容器是否健康運行。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"]
interval: 1m30s
timeout: 10s
retries: 3image
指定為鏡像名稱或鏡像 ID。如果鏡像在本地不存在,Compose 將會嘗試?yán)∵@個鏡像。
image: ubuntu
image: orchardup/postgresql
image: a4bc65fdlabels
為容器添加 Docker 元數(shù)據(jù)(metadata)信息。例如可以為容器添加輔助說明信息。
labels:
com.startupteam.description: "webapp for a startup team"
com.startupteam.department: "devops department"
com.startupteam.release: "rc3 for v1.0"links
注意:不推薦使用該指令。
logging
配置日志選項。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"目前支持三種日志驅(qū)動類型。
driver: "json-file"
driver: "syslog"
driver: "none"options 配置日志驅(qū)動的相關(guān)參數(shù)。
options:
max-size: "200k"
max-file: "10"network_mode
設(shè)置網(wǎng)絡(luò)模式。使用和 docker run 的 --network 參數(shù)一樣的值。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"networks
配置容器連接的網(wǎng)絡(luò)。
version: "3"
services:
some-service:
networks:
- some-network
- other-network
networks:
some-network:
other-network:pid
跟主機系統(tǒng)共享進程命名空間。打開該選項的容器之間,以及容器和宿主機系統(tǒng)之間可以通過進程 ID 來相互訪問和操作。
pid: "host"ports
暴露端口信息。
使用宿主端口:容器端口 (HOST:CONTAINER) 格式,或者僅僅指定容器的端口(宿主將會隨機選擇端口)都可以。
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"注意:當(dāng)使用 HOST:CONTAINER 格式來映射端口時,如果你使用的容器端口小于 60 并且沒放到引號里,可能會得到錯誤結(jié)果,因為 YAML 會自動解析 xx:yy 這種數(shù)字格式為 60 進制。為避免出現(xiàn)這種問題,建議數(shù)字串都采用引號包括起來的字符串格式。
secrets
存儲敏感數(shù)據(jù),例如 mysql 服務(wù)密碼。
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: truesecurity_opt
指定容器模板標(biāo)簽(label)機制的默認(rèn)屬性(用戶、角色、類型、級別等)。例如配置標(biāo)簽的用戶名和角色名。
security_opt:
- label:user:USER
- label:role:ROLEstop_signal
設(shè)置另一個信號來停止容器。在默認(rèn)情況下使用的是 SIGTERM 停止容器。
stop_signal: SIGUSR1sysctls
配置容器內(nèi)核參數(shù)。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0ulimits
指定容器的 ulimits 限制值。
例如,指定最大進程數(shù)為 65535,指定文件句柄數(shù)為 20000(軟限制,應(yīng)用可以隨時修改,不能超過硬限制) 和 40000(系統(tǒng)硬限制,只能 root 用戶提高)。
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000volumes
數(shù)據(jù)卷所掛載路徑設(shè)置。可以設(shè)置宿主機路徑 (HOST:CONTAINER) 或加上訪問模式 (HOST:CONTAINER:ro)。
該指令中路徑支持相對路徑。
volumes:
- /var/lib/mysql
- cache/:/tmp/cache
- ~/configs:/etc/configs/:ro其它指令
此外,還有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令,基本跟 docker run 中對應(yīng)參數(shù)的功能一致。
指定服務(wù)容器啟動后執(zhí)行的入口文件。
entrypoint: /code/entrypoint.sh指定容器中運行應(yīng)用的用戶名。
user: nginx指定容器中工作目錄。
working_dir: /code指定容器中搜索域名、主機名、mac 地址等。
domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A允許容器中運行一些特權(quán)命令。
privileged: true指定容器退出后的重啟策略為始終重啟。該命令對保持服務(wù)始終運行十分有效,在生產(chǎn)環(huán)境中推薦配置為 always 或者 unless-stopped。
restart: always以只讀模式掛載容器的 root 文件系統(tǒng),意味著不能對容器內(nèi)容進行修改。
read_only: true打開標(biāo)準(zhǔn)輸入,可以接受外部輸入。
stdin_open: true模擬一個偽終端。
tty: true讀取變量
Compose 模板文件支持動態(tài)讀取主機的系統(tǒng)環(huán)境變量和當(dāng)前目錄下的 .env 文件中的變量。
例如,下面的 Compose 文件將從運行它的環(huán)境中讀取變量 ${MONGO_VERSION} 的值,并寫入執(zhí)行的指令中。
version: "3"
services:
db:
image: "mongo:${MONGO_VERSION}"如果執(zhí)行 MONGO_VERSION=3.2 docker-compose up 則會啟動一個 mongo:3.2 鏡像的容器;如果執(zhí)行 MONGO_VERSION=2.8 docker-compose up 則會啟動一個 mongo:2.8 鏡像的容器。
若當(dāng)前目錄存在 .env 文件,執(zhí)行 docker-compose 命令時將從該文件中讀取變量。
在當(dāng)前目錄新建 .env 文件并寫入以下內(nèi)容。
# 支持 # 號注釋
MONGO_VERSION=3.6執(zhí)行 docker-compose up 則會啟動一個 mongo:3.6 鏡像的容器。
souece:https://www.yuque.com/grasilife/docker/compose-compose-file

喜歡,在看
