Docker-Compose 是什么?
Docker-Compose 項(xiàng)目是 Docker 官方的開源項(xiàng)目,負(fù)責(zé)實(shí)現(xiàn)對(duì) Docker 容器集群的快速編排。Docker-Compose 的工程配置文件名是默認(rèn)為 docker-compose.yml 的,在整個(gè)文件中,我們可以通過環(huán)境變量 COMPOSE_FILE 或者 -f參數(shù)來對(duì)配置進(jìn)行定義。我們可以看一個(gè)很簡單的 docker-compose.yml 的配置文件:
couchdb:
container_name: couchdb
image: hyperledger/fabric-couchdb
# Populate the COUCHDB_USER and COUCHDB_PASSWORD to set an admin user and password
# for CouchDB. This will prevent CouchDB from operating in an "Admin Party" mode.
environment:
- COUCHDB_USER=
- COUCHDB_PASSWORD=
# Comment/Uncomment the port mapping if you want to hide/expose the CouchDB service,
# for example map it to utilize Fauxton User Interface in dev environments.
ports:
- "5984:5984"
這就是一個(gè)通過 docker-compose.yml 配置實(shí)現(xiàn) CouchDB 在 Docker 中運(yùn)行的配置實(shí)例。
Docker-Compose 是用 Python 來編寫的,我們可以通過 pip 命令進(jìn)行對(duì) Docker-Compose 的安裝,之后就調(diào)用Docker服務(wù)提供的API來對(duì)容器進(jìn)行管理。因此,只要所操作的平臺(tái)支持Docker API,就可以在其上利用Compose來進(jìn)行編排管理。
Docker-Compose 怎么用?
具體的安裝過程,因?yàn)榉N類繁多,而且可以很容易的找到,因此在這里不過多說明。但是在 Windows 中使用時(shí),一定要保證 Windows 是可以安裝 Docker 的。我們具體要說的是關(guān)于 Docker-Compose 的一些常用的命令。
1、Docker-Compose 命令格式
docker-compose [-f<arg>...] [options] [COMMAND] [ARGS...]
選項(xiàng)包括:
-f,–file FILE 指定 Compose 模板文件,默認(rèn)為 docker-compose.yml,可以多次指定。
-p,–project-name NAME 指定項(xiàng)目名稱,默認(rèn)將使用所在目錄名稱作為項(xiàng)目名。
-x-network-driver 使用 Docker 的可拔插網(wǎng)絡(luò)后端特性(需要Docker 1.9+版本)
-x-network-driver DRIVER 指定網(wǎng)絡(luò)后端的驅(qū)動(dòng),默認(rèn)為 bridge(需要Docker 1.9+版本)
-verbose 輸出更多調(diào)試信息
-v,–version 打印版本并退出
2、Docker-Compose 啟動(dòng)格式
docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
選項(xiàng)包括:
-d 在后臺(tái)運(yùn)行服務(wù)容器
–no-color 不使用顏色來區(qū)分不同的服務(wù)的控制輸出
–no-deps 不啟動(dòng)服務(wù)所鏈接的容器
–force-recreate 強(qiáng)制重新創(chuàng)建容器,不能與–no-recreate同時(shí)使用
–no-recreate 如果容器已經(jīng)存在,則不重新創(chuàng)建,不能與–force-recreate同時(shí)使用
–no-build 不自動(dòng)構(gòu)建缺失的服務(wù)鏡像
–build 在啟動(dòng)容器前構(gòu)建服務(wù)鏡像
–abort-on-container-exit 停止所有容器,如果任何一個(gè)容器被停止,不能與-d同時(shí)使用
-t, –timeout TIMEOUT 停止容器時(shí)候的超時(shí)(默認(rèn)為10秒)
–remove-orphans 刪除服務(wù)中沒有在compose文件中定義的容器
–scale SERVICE=NUM 設(shè)置服務(wù)運(yùn)行容器的個(gè)數(shù),將覆蓋在compose中通過scale指定的參數(shù)
docker-compose up
啟動(dòng)所有服務(wù)--這是我們最常用的命令格式
docker-compose up -d
在后臺(tái)所有啟動(dòng)服務(wù)--需要在后臺(tái)使用時(shí)可以通過添加 -d 來后臺(tái)啟動(dòng)
-f 指定使用的 Compose 模板文件,默認(rèn)為docker-compose.yml,可以多次指定。
3、Docker-Compose 查看格式
docker-compose ps [options] [SERVICE...]
這條命令與 Docker 中查看容器的命令基本功能和方法是一樣的。一般我們使用的是 docker-compose ps。
4、Docker-Compose 終止格式
docker-compose stop [options] [SERVICE...]
選項(xiàng)包括:
-t, –timeout TIMEOUT 停止容器時(shí)候的超時(shí)(默認(rèn)為10秒)
我們?cè)趫?zhí)行 stop 命令之后,是需要通過 docker-compose start 來啟動(dòng)的,而不是剛才我們所講的 up 命令。
5、Docker-Compose 停止格式
docker-compose down [options]
選項(xiàng)包括:
–rmi type,刪除鏡像,類型必須是:all,刪除compose文件中定義的所有鏡像;local,刪除鏡像名為空的鏡像
-v, –volumes,刪除已經(jīng)在compose文件中定義的和匿名的附在容器上的數(shù)據(jù)卷
–remove-orphans,刪除服務(wù)中沒有在compose中定義的容器
docker-compose down
停用移除所有容器以及網(wǎng)絡(luò)相關(guān)--最常用的格式
6、Docker-Compose 日志格式
docker-compose logs [options][SERVICE...]
默認(rèn)情況下使用 docker-compose logs來查看服務(wù)容器的輸出,或者我們可以通過指定 --no-color來關(guān)閉顏色。
7、Docker-Compose build
docker-compose build [options] [--build-arg key=val...] [SERVICE...]
選項(xiàng)包括:
–compress 通過gzip壓縮構(gòu)建上下環(huán)境
–force-rm 刪除構(gòu)建過程中的臨時(shí)容器
–no-cache 構(gòu)建鏡像過程中不使用緩存
–pull 始終嘗試通過拉取操作來獲取更新版本的鏡像
-m, –memory MEM 為構(gòu)建的容器設(shè)置內(nèi)存大小
–build-arg key=val 為服務(wù)設(shè)置build-time變量
服務(wù)容器一旦構(gòu)建后,將會(huì)帶上一個(gè)標(biāo)記名??梢噪S時(shí)在項(xiàng)目目錄下運(yùn)行docker-compose build來重新構(gòu)建服務(wù)。
8、Docker-Compose pull
docker-compose pull [options] [SERVICE...]
選項(xiàng)包括:
–ignore-pull-failures,忽略拉取鏡像過程中的錯(cuò)誤
–parallel,多個(gè)鏡像同時(shí)拉取
–quiet,拉取鏡像過程中不打印進(jìn)度信息
docker-compose pull
拉取服務(wù)依賴的鏡像。
9、Docker-Compose restart
docker-compose restart [options] [SERVICE...]
選項(xiàng)包括:
–f, –force,強(qiáng)制直接刪除,包括非停止?fàn)顟B(tài)的容器
-v,刪除容器所掛載的數(shù)據(jù)卷
docker-compose rm
刪除所有(停止?fàn)顟B(tài)的)服務(wù)容器。推薦先執(zhí)行docker-compose stop命令來停止容器。
10、Docker-Compose start
docker-compose start [SERVICE...]
啟動(dòng)已經(jīng)存在的服務(wù)容器。
11、Docker-Compose run
docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
docker-compose run ubuntu ping www.baidu.com
在指定容器上執(zhí)行一個(gè)ping命令。
12、Docker-Compose scale
docker-compose scale web=3 db=2
設(shè)置指定服務(wù)運(yùn)行的容器個(gè)數(shù)。通過service=num的參數(shù)來設(shè)置數(shù)量。
13、Docker-Compose pause
docker-compose pause [SERVICE...]
暫停一個(gè)服務(wù)容器。
14、Docker-Compose rm
docker-compose rm [options] [SERVICE...]
選項(xiàng)包括:
–f, –force,強(qiáng)制直接刪除,包括非停止?fàn)顟B(tài)的容器
-v,刪除容器所掛載的數(shù)據(jù)卷
docker-compose rm
刪除所有(停止?fàn)顟B(tài)的)服務(wù)容器。推薦先執(zhí)行docker-compose stop命令來停止容器。
15、Docker-Compose kill
docker-compose kill [options] [SERVICE...]
支持通過 -s 參數(shù)來指定發(fā)送的信號(hào),例如通過如下指令發(fā)送 SIGINT 信號(hào):
docker-compose kill -s SIGINT
16、Docker-Compose config
docker-compose [options]
驗(yàn)證并查看 compose 配置文件。
選項(xiàng)包括:
–resolve-image-digests 將鏡像標(biāo)簽標(biāo)記為摘要
-q, –quiet 只驗(yàn)證配置,不輸出。 當(dāng)配置正確時(shí),不輸出任何內(nèi)容,當(dāng)文件配置錯(cuò)誤,輸出錯(cuò)誤信息
–services 打印服務(wù)名,一行一個(gè)
–volumes 打印數(shù)據(jù)卷名,一行一個(gè)
17、Docker-Compose create
docker-compose create [options] [SERVICE...]
選項(xiàng)包括:
–force-recreate:重新創(chuàng)建容器,即使配置和鏡像沒有改變,不兼容–no-recreate參數(shù)
–no-recreate:如果容器已經(jīng)存在,不需要重新創(chuàng)建,不兼容–force-recreate參數(shù)
–no-build:不創(chuàng)建鏡像,即使缺失
–build:創(chuàng)建容器前,生成鏡像
18、Docker-Compose exec
docker-compose exec [options] SERVICE COMMAND [ARGS...]
選項(xiàng)包括:
-d 分離模式,后臺(tái)運(yùn)行命令。
–privileged 獲取特權(quán)。
–user USER 指定運(yùn)行的用戶。
-T 禁用分配TTY,默認(rèn) docker-compose exec 分配 TTY。
–index=index,當(dāng)一個(gè)服務(wù)擁有多個(gè)容器時(shí),可通過該參數(shù)登陸到該服務(wù)下的任何服務(wù)。
例如:docker-compose exec –index=1 web /bin/bash ,web 服務(wù)中包含多個(gè)容器
19、Docker-Compose port
docker-compose port [options] SERVICE PRIVATE_PORT
選項(xiàng)包括:
–protocol=proto,指定端口協(xié)議,TCP(默認(rèn)值)或者UDP
–index=index,如果同意服務(wù)存在多個(gè)容器,指定命令對(duì)象容器的序號(hào)(默認(rèn)為1)
20、Docker-Compose push
docker-compose push [options] [SERVICE...]
選項(xiàng)包括:
–ignore-push-failures 忽略推送鏡像過程中的錯(cuò)誤
21、Docker-Compose unpause
docker-compose unpause [SERVICE...]
恢復(fù)處于暫停狀態(tài)中的服務(wù)。
22、Docker-Compose version
docker-compose version
用于打印版本信息。
Docker-Compose 怎么寫?
Docker-Compose標(biāo)準(zhǔn)模板文件應(yīng)該包含version、services、networks 三大部分,最關(guān)鍵的是services和networks兩個(gè)部分。我們想要實(shí)現(xiàn)對(duì)其的配置,就要通過 docker-compose.yml 來實(shí)現(xiàn)。
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
Compose目前有三個(gè)版本分別為Version 1,Version 2,Version 3,Compose區(qū)分Version 1和Version 2(Compose 1.6.0+,Docker Engine 1.10.0+)。Version 2支持更多的指令。Version 1將來會(huì)被棄用。
image
image是指定服務(wù)的鏡像名稱或鏡像ID。如果鏡像在本地不存在,Compose將會(huì)嘗試?yán)$R像。
image: dockercloud/hello-world
build
服務(wù)除了可以基于指定的鏡像,還可以基于一份Dockerfile,在使用up啟動(dòng)時(shí)執(zhí)行構(gòu)建任務(wù),構(gòu)建標(biāo)簽是build,可以指定Dockerfile所在文件夾的路徑。Compose將會(huì)利用Dockerfile自動(dòng)構(gòu)建鏡像,然后使用鏡像啟動(dòng)服務(wù)容器。
build: /path/to/build/dir
也可以是相對(duì)路徑,只要上下文確定就可以讀取到Dockerfile。
build: ./dir
設(shè)定上下文根目錄,然后以該目錄為準(zhǔn)指定Dockerfile。
context
context 選項(xiàng)可以是 Dockerfile 的文件路徑,也可以是到鏈接到 git 倉庫的 url,當(dāng)提供的值是相對(duì)路徑時(shí),被解析為相對(duì)于撰寫文件的路徑,此目錄也是發(fā)送到 Docker 守護(hù)進(jìn)程的 context
build:
context: ./dir
dockerfile
使用dockerfile文件來構(gòu)建,必須指定構(gòu)建路徑
build:
context: ./dir
dockerfile: Dokcerfile-alternate
command
使用command可以覆蓋容器啟動(dòng)后默認(rèn)執(zhí)行的命令
command:
bundle exec thin -p 3000
container_name
Compose的容器名稱格式是:<項(xiàng)目名稱><服務(wù)名稱><序號(hào)>
可以自定義項(xiàng)目名稱、服務(wù)名稱,但如果想完全控制容器的命名,可以使用標(biāo)簽指定:
container_name:
app
depends_on
depends_on:
- couchdb
- redis
這里就是代替啟動(dòng)命令的執(zhí)行內(nèi)容,一般按照順序來執(zhí)行。例如上面這個(gè)語句,執(zhí)行的就是 couchdb 和 redis 兩個(gè)服務(wù)。
ports
ports用于映射端口的標(biāo)簽。
ports:
- "3000:3000"
extra_hosts
添加主機(jī)名的標(biāo)簽,會(huì)在/etc/hosts文件中添加一些記錄。
extra_hosts:
- "somehost:162.242.195.82"
- "otherhost:50.31.209.229"
volumes
掛載一個(gè)目錄或者一個(gè)已存在的數(shù)據(jù)卷容器
volumes:
// 只是指定一個(gè)路徑,Docker 會(huì)自動(dòng)在創(chuàng)建一個(gè)數(shù)據(jù)卷(這個(gè)路徑是容器內(nèi)部的)。
- /var/lib/mysql
// 使用絕對(duì)路徑掛載數(shù)據(jù)卷
- /opt/data:/var/lib/mysql
// 以 Compose 配置文件為中心的相對(duì)路徑作為數(shù)據(jù)卷掛載到容器。
- ./cache:/tmp/cache
// 使用用戶的相對(duì)路徑(~/ 表示的目錄是 /home/<用戶目錄>/ 或者 /root/)。
- ~/configs:/etc/configs/:ro
// 已經(jīng)存在的命名的數(shù)據(jù)卷。
- datavolume:/var/lib/mysql
如果不使用宿主機(jī)的路徑,可以指定一個(gè)volume_driver。
volume_driver: mydriver
dns
dns: 8.8.8.8
dns:
- 8.8.8.8
自定義一個(gè) dns 服務(wù)器。
dns_search
dns_search: example.com
dns_search:
- domin1.example.com
- domin2.example.com
配置DNS搜索域??梢允且粋€(gè)值,也可以是一個(gè)列表。
entrypoint
定義接入點(diǎn),覆蓋 Dockerfile 中的定義:
entrypoint: /code/entrypoint.sh
env_file
定義一個(gè)專門存放變量的文件:
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
如果有變量名稱與 environment 指令沖突,則以后者為準(zhǔn)。
cap_add
增加指定容器的內(nèi)核能力(capacity):
cap_add:
- ALL
cap_drop
與上面一條命令相反,去掉指定容器的內(nèi)核能力(capacity):
cap_drop:
- NET_ADMIN
cgroup_parent
創(chuàng)建一個(gè) cgroup 組:
cgroup_parent: cgroups_1
devices
指定設(shè)備映射關(guān)系:
devices:
- "/dev/ttyUSB1:/DEV/ttyUSB0"
expose
暴露端口,但不映射到宿主機(jī),只允許能被連接的服務(wù)訪問。僅可以指定內(nèi)部端口為參數(shù):
expose:
- "3000"
- "8000"
extends
基于其他模板文件進(jìn)行擴(kuò)展:
webapp:
build: ./webapp
environment:
- DEBUG=false
- SEND_EMAILS=false
再編寫一個(gè)新的 development.yml文件,使用 common.yml中的webapp服務(wù)進(jìn)行擴(kuò)展:
# development.yml
web:
extends:
file: common.yml
service: webapp
ports:
- "8000:8000"
links:
- db
environment:
- DEBUG=true
db:
image: mysql
后者會(huì)自動(dòng)繼承 common.yml 中的 webapp服務(wù)及環(huán)境變量定義。
external_links
鏈接到docker-compose.yml外部的容器,可以是非Compose管理的外部容器。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
label
為容器添加元數(shù)據(jù)信息:
labels:
com.startupteam.description: "webapp for a startup team"
links
鏈接到其它服務(wù)中的容器:
links:
- db
- db:database
- redis
log_driver
指定日志驅(qū)動(dòng)類型。目前支持三種日志驅(qū)動(dòng)類型:
log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"
log_opt
日志驅(qū)動(dòng)的相關(guān)參數(shù):
log_driver: "syslog"
log_opt:
syslog-address: "tcp://192.168.0.42:8080"
net
設(shè)置網(wǎng)絡(luò)格式:
net: "bridge"
net: "none"
net: "host"
security_opt
指定容器模板標(biāo)簽(label)機(jī)制的默認(rèn)屬性(用戶、角色、類型、級(jí)別等)。例如,配置標(biāo)簽的用戶名和角色名:
security_opt:
- label:user:USER
- label:role:ROLE