Docker Compose 命令說明
命令對象與格式
對于 Compose 來說,大部分命令的對象既可以是項目本身屡江,也可以指定為項目中的服務或者容器剪芍。如果沒有特別的說明敢朱,命令對象將是項目唉窃,這意味著項目中所有的服務都會受到命令影響。
執(zhí)行 docker-compose [COMMAND] --help
或者 docker-compose help [COMMAND]
可以查看具體某個命令的使用格式纹笼。docker-compose
命令的基本的使用格式是
docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]
命令選項
-
-f, --file FILE
指定使用的 Compose 模板文件纹份,默認為docker-compose.yml
,可以多次指定廷痘。 -
-p, --project-name NAME
指定項目名稱蔓涧,默認將使用所在目錄名稱作為項目名。 -
--x-networking
使用 Docker 的可拔插網(wǎng)絡后端特性 -
--x-network-driver DRIVER
指定網(wǎng)絡后端的驅動笋额,默認為bridge
-
--verbose
輸出更多調試信息元暴。 -
-v, --version
打印版本并退出。
build
格式為 docker-compose build [options] [SERVICE...]
兄猩。
構建(重新構建)項目中的服務容器茉盏。
服務容器一旦構建后鉴未,將會帶上一個標記名,例如對于 web 項目中的一個 db 容器鸠姨,可能是 web_db铜秆。
可以隨時在項目目錄下運行 docker-compose build
來重新構建服務。
選項包括:
-
--force-rm
刪除構建過程中的臨時容器讶迁。 -
--no-cache
構建鏡像過程中不使用 cache(這將加長構建過程)连茧。 -
--pull
始終嘗試通過 pull 來獲取更新版本的鏡像。
config
驗證 Compose 文件格式是否正確巍糯,若正確則顯示配置啸驯,若格式錯誤顯示錯誤原因。
down
此命令將會停止 up
命令所啟動的容器祟峦,并移除網(wǎng)絡
exec
進入指定的容器罚斗。
help
獲得一個命令的幫助。
images
列出 Compose 文件中包含的鏡像搀愧。
kill
格式為 docker-compose kill [options] [SERVICE...]
惰聂。
通過發(fā)送 SIGKILL
信號來強制停止服務容器。
支持通過 -s
參數(shù)來指定發(fā)送的信號咱筛,例如通過如下指令發(fā)送 SIGINT
信號搓幌。
docker-compose kill -s SIGINT
logs
格式為 docker-compose logs [options] [SERVICE...]
。
查看服務容器的輸出迅箩。默認情況下溉愁,docker-compose 將對不同的服務輸出使用不同的顏色來區(qū)分∷乔鳎可以通過 --no-color
來關閉顏色拐揭。
該命令在調試問題的時候十分有用。
pause
格式為 docker-compose pause [SERVICE...]
奕塑。
暫停一個服務容器堂污。
port
格式為 docker-compose port [options] SERVICE PRIVATE_PORT
。
打印某個容器端口所映射的公共端口龄砰。
選項:
-
--protocol=proto
指定端口協(xié)議盟猖,tcp(默認值)或者 udp。 -
--index=index
如果同一服務存在多個容器换棚,指定命令對象容器的序號(默認為 1)式镐。
ps
格式為 docker-compose ps [options] [SERVICE...]
。
列出項目中目前的所有容器固蚤。
選項:
-
-q
只打印容器的 ID 信息娘汞。
pull
格式為 docker-compose pull [options] [SERVICE...]
。
拉取服務依賴的鏡像夕玩。
選項:
-
--ignore-pull-failures
忽略拉取鏡像過程中的錯誤你弦。
push
推送服務依賴的鏡像到 Docker 鏡像倉庫惊豺。
restart
格式為 docker-compose restart [options] [SERVICE...]
。
重啟項目中的服務鳖目。
選項:
-
-t, --timeout TIMEOUT
指定重啟前停止容器的超時(默認為 10 秒)扮叨。
rm
格式為 docker-compose rm [options] [SERVICE...]
。
刪除所有(停止狀態(tài)的)服務容器领迈。推薦先執(zhí)行 docker-compose stop
命令來停止容器彻磁。
選項:
-
-f, --force
強制直接刪除,包括非停止狀態(tài)的容器狸捅。一般盡量不要使用該選項衷蜓。 -
-v
刪除容器所掛載的數(shù)據(jù)卷。
run
格式為 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
尘喝。
在指定服務上執(zhí)行一個命令磁浇。
例如:
docker-compose run ubuntu ping docker.com
將會啟動一個 ubuntu 服務容器,并執(zhí)行 ping docker.com
命令朽褪。
默認情況下置吓,如果存在關聯(lián),則所有關聯(lián)的服務將會自動被啟動缔赠,除非這些服務已經在運行中衍锚。
該命令類似啟動容器后運行指定的命令,相關卷嗤堰、鏈接等等都將會按照配置自動創(chuàng)建戴质。
兩個不同點:
- 給定命令將會覆蓋原有的自動運行命令;
- 不會自動創(chuàng)建端口踢匣,以避免沖突告匠。
如果不希望自動啟動關聯(lián)的容器,可以使用 --no-deps
選項离唬,例如
docker-compose run --no-deps web python manage.py shell
將不會啟動 web 容器所關聯(lián)的其它容器后专。
選項:
-
-d
后臺運行容器。 -
--name NAME
為容器指定一個名字输莺。 -
--entrypoint CMD
覆蓋默認的容器啟動指令戚哎。 -
-e KEY=VAL
設置環(huán)境變量值,可多次使用選項來設置多個環(huán)境變量模闲。 -
-u, --user=""
指定運行容器的用戶名或者 uid。 -
--no-deps
不自動啟動關聯(lián)的服務容器崭捍。 -
--rm
運行命令后自動刪除容器尸折,d
模式下將忽略。 -
-p, --publish=[]
映射容器端口到本地主機殷蛇。 -
--service-ports
配置服務端口并映射到本地主機实夹。 -
-T
不分配偽 tty橄浓,意味著依賴 tty 的指令將無法運行。
scale
格式為 docker-compose scale [options] [SERVICE=NUM...]
亮航。
設置指定服務運行的容器個數(shù)荸实。
通過 service=num
的參數(shù)來設置數(shù)量。例如:
docker-compose scale web=3 db=2
將啟動 3 個容器運行 web 服務缴淋,2 個容器運行 db 服務准给。
一般的,當指定數(shù)目多于該服務當前實際運行容器重抖,將新創(chuàng)建并啟動容器露氮;反之,將停止容器钟沛。
選項:
-
-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)畔规。
start
格式為 docker-compose start [SERVICE...]
。
啟動已經存在的服務容器恨统。
stop
格式為 docker-compose stop [options] [SERVICE...]
叁扫。
停止已經處于運行狀態(tài)的容器,但不刪除它畜埋。通過 docker-compose start
可以再次啟動這些容器莫绣。
選項:
-
-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)。
top
查看各個服務容器內運行的進程由捎。
unpause
格式為 docker-compose unpause [SERVICE...]
兔综。
恢復處于暫停狀態(tài)中的服務。
up
格式為 docker-compose up [options] [SERVICE...]
狞玛。
該命令十分強大软驰,它將嘗試自動完成包括構建鏡像,(重新)創(chuàng)建服務心肪,啟動服務锭亏,并關聯(lián)服務相關容器的一系列操作。
鏈接的服務都將會被自動啟動硬鞍,除非已經處于運行狀態(tài)慧瘤。
可以說,大部分時候都可以直接通過該命令來啟動一個項目固该。
默認情況锅减,docker-compose up
啟動的容器都在前臺,控制臺將會同時打印所有容器的輸出信息伐坏,可以很方便進行調試怔匣。
當通過 Ctrl-C
停止命令時,所有容器將會停止桦沉。
如果使用 docker-compose up -d
每瞒,將會在后臺啟動并運行所有的容器金闽。一般推薦生產環(huán)境下使用該選項。
默認情況剿骨,如果服務容器已經存在代芜,docker-compose up
將會嘗試停止容器,然后重新創(chuàng)建(保持使用 volumes-from
掛載的卷)浓利,以保證新啟動的服務匹配 docker-compose.yml
文件的最新內容挤庇。如果用戶不希望容器被停止并重新創(chuàng)建,可以使用 docker-compose up --no-recreate
荞膘。這樣將只會啟動處于停止狀態(tài)的容器罚随,而忽略已經運行的服務。如果用戶只想重新部署某個服務羽资,可以使用 docker-compose up --no-deps -d <SERVICE_NAME>
來重新創(chuàng)建服務并后臺停止舊服務淘菩,啟動新服務,并不會影響到其所依賴的服務屠升。
選項:
-
-d
在后臺運行服務容器潮改。 -
--no-color
不使用顏色來區(qū)分不同的服務的控制臺輸出。 -
--no-deps
不啟動服務所鏈接的容器腹暖。 -
--force-recreate
強制重新創(chuàng)建容器汇在,不能與--no-recreate
同時使用。 -
--no-recreate
如果容器已經存在了脏答,則不重新創(chuàng)建糕殉,不能與--force-recreate
同時使用。 -
--no-build
不自動構建缺失的服務鏡像殖告。 -
-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)阿蝶。
version
格式為 docker-compose version
。
打印版本信息黄绩。