學(xué)習(xí)完整課程請移步 互聯(lián)網(wǎng) Java 全棧工程師

命令對象與格式

對于 Compose 來說，大部分命令的對象既可以是項目本身，也可以指定為項目中的服務(wù)或者容器。如果沒有特別的說明，命令對象將是項目，這意味著項目中所有的服務(wù)都會受到命令影響。

執(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)絡(luò)后端特性
• --x-network-driver DRIVER 指定網(wǎng)絡(luò)后端的驅(qū)動，默認為 bridge
• --verbose 輸出更多調(diào)試信息。
• -v, --version 打印版本并退出。

build

格式為 docker-compose build [options] [SERVICE...]。

構(gòu)建（重新構(gòu)建）項目中的服務(wù)容器。

服務(wù)容器一旦構(gòu)建后，將會帶上一個標記名，例如對于 web 項目中的一個 db 容器，可能是 web_db。

可以隨時在項目目錄下運行 docker-compose build 來重新構(gòu)建服務(wù)。

選項包括：

• --force-rm 刪除構(gòu)建過程中的臨時容器。
• --no-cache 構(gòu)建鏡像過程中不使用 cache（這將加長構(gòu)建過程）。
• --pull 始終嘗試通過 pull 來獲取更新版本的鏡像。

config

驗證 Compose 文件格式是否正確，若正確則顯示配置，若格式錯誤顯示錯誤原因。

down

此命令將會停止 up 命令所啟動的容器，并移除網(wǎng)絡(luò)

exec

進入指定的容器。

help

獲得一個命令的幫助。

images

列出 Compose 文件中包含的鏡像。

kill

格式為 docker-compose kill [options] [SERVICE...]。

通過發(fā)送 SIGKILL 信號來強制停止服務(wù)容器。

支持通過 -s 參數(shù)來指定發(fā)送的信號，例如通過如下指令發(fā)送 SIGINT 信號。

$ docker-compose kill -s SIGINT

logs

格式為 docker-compose logs [options] [SERVICE...]。

查看服務(wù)容器的輸出。默認情況下，docker-compose 將對不同的服務(wù)輸出使用不同的顏色來區(qū)分?？梢酝ㄟ^ --no-color 來關(guān)閉顏色。

該命令在調(diào)試問題的時候十分有用。

pause

格式為 docker-compose pause [SERVICE...]。

暫停一個服務(wù)容器。

port

格式為 docker-compose port [options] SERVICE PRIVATE_PORT。

打印某個容器端口所映射的公共端口。

選項：

• --protocol=proto 指定端口協(xié)議，tcp（默認值）或者 udp。
• --index=index 如果同一服務(wù)存在多個容器，指定命令對象容器的序號（默認為 1）。

ps

格式為 docker-compose ps [options] [SERVICE...]。

列出項目中目前的所有容器。

選項：

• -q 只打印容器的 ID 信息。

pull

格式為 docker-compose pull [options] [SERVICE...]。

拉取服務(wù)依賴的鏡像。

選項：

• --ignore-pull-failures 忽略拉取鏡像過程中的錯誤。

push

推送服務(wù)依賴的鏡像到 Docker 鏡像倉庫。

restart

格式為 docker-compose restart [options] [SERVICE...]。

重啟項目中的服務(wù)。

選項：

• -t, --timeout TIMEOUT 指定重啟前停止容器的超時（默認為 10 秒）。

rm

格式為 docker-compose rm [options] [SERVICE...]。

刪除所有（停止狀態(tài)的）服務(wù)容器。推薦先執(zhí)行 docker-compose stop 命令來停止容器。

選項：

• -f, --force 強制直接刪除，包括非停止狀態(tài)的容器。一般盡量不要使用該選項。
• -v 刪除容器所掛載的數(shù)據(jù)卷。

run

格式為 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]。

在指定服務(wù)上執(zhí)行一個命令。

例如：

$ docker-compose run ubuntu ping docker.com

將會啟動一個 ubuntu 服務(wù)容器，并執(zhí)行 ping docker.com 命令。

默認情況下，如果存在關(guān)聯(lián)，則所有關(guān)聯(lián)的服務(wù)將會自動被啟動，除非這些服務(wù)已經(jīng)在運行中。

該命令類似啟動容器后運行指定的命令，相關(guān)卷、鏈接等等都將會按照配置自動創(chuàng)建。

兩個不同點：

• 給定命令將會覆蓋原有的自動運行命令；
• 不會自動創(chuàng)建端口，以避免沖突。

如果不希望自動啟動關(guān)聯(lián)的容器，可以使用 --no-deps 選項，例如

$ docker-compose run --no-deps web python manage.py shell

將不會啟動 web 容器所關(guān)聯(lián)的其它容器。

選項：

• -d 后臺運行容器。
• --name NAME 為容器指定一個名字。
• --entrypoint CMD 覆蓋默認的容器啟動指令。
• -e KEY=VAL 設(shè)置環(huán)境變量值，可多次使用選項來設(shè)置多個環(huán)境變量。
• -u, --user="" 指定運行容器的用戶名或者 uid。
• --no-deps 不自動啟動關(guān)聯(lián)的服務(wù)容器。
• --rm 運行命令后自動刪除容器，d 模式下將忽略。
• -p, --publish=[] 映射容器端口到本地主機。
• --service-ports 配置服務(wù)端口并映射到本地主機。
• -T 不分配偽 tty，意味著依賴 tty 的指令將無法運行。

scale

格式為 docker-compose scale [options] [SERVICE=NUM...]。

設(shè)置指定服務(wù)運行的容器個數(shù)。

通過 service=num 的參數(shù)來設(shè)置數(shù)量。例如：

$ docker-compose scale web=3 db=2

將啟動 3 個容器運行 web 服務(wù)，2 個容器運行 db 服務(wù)。

一般的，當(dāng)指定數(shù)目多于該服務(wù)當(dāng)前實際運行容器，將新創(chuàng)建并啟動容器；反之，將停止容器。

選項：

• -t, --timeout TIMEOUT 停止容器時候的超時（默認為 10 秒）。

start

格式為 docker-compose start [SERVICE...]。

啟動已經(jīng)存在的服務(wù)容器。

stop

格式為 docker-compose stop [options] [SERVICE...]。

停止已經(jīng)處于運行狀態(tài)的容器，但不刪除它。通過 docker-compose start 可以再次啟動這些容器。

選項：

• -t, --timeout TIMEOUT 停止容器時候的超時（默認為 10 秒）。

top

查看各個服務(wù)容器內(nèi)運行的進程。

unpause

格式為 docker-compose unpause [SERVICE...]。

恢復(fù)處于暫停狀態(tài)中的服務(wù)。

up

格式為 docker-compose up [options] [SERVICE...]。

該命令十分強大，它將嘗試自動完成包括構(gòu)建鏡像，（重新）創(chuàng)建服務(wù)，啟動服務(wù)，并關(guān)聯(lián)服務(wù)相關(guān)容器的一系列操作。

鏈接的服務(wù)都將會被自動啟動，除非已經(jīng)處于運行狀態(tài)。

可以說，大部分時候都可以直接通過該命令來啟動一個項目。

默認情況，docker-compose up 啟動的容器都在前臺，控制臺將會同時打印所有容器的輸出信息，可以很方便進行調(diào)試。

當(dāng)通過 Ctrl-C 停止命令時，所有容器將會停止。

如果使用 docker-compose up -d，將會在后臺啟動并運行所有的容器。一般推薦生產(chǎn)環(huán)境下使用該選項。

默認情況，如果服務(wù)容器已經(jīng)存在，docker-compose up 將會嘗試停止容器，然后重新創(chuàng)建（保持使用 volumes-from 掛載的卷），以保證新啟動的服務(wù)匹配 docker-compose.yml 文件的最新內(nèi)容。如果用戶不希望容器被停止并重新創(chuàng)建，可以使用 docker-compose up --no-recreate。這樣將只會啟動處于停止狀態(tài)的容器，而忽略已經(jīng)運行的服務(wù)。如果用戶只想重新部署某個服務(wù)，可以使用 docker-compose up --no-deps -d <SERVICE_NAME> 來重新創(chuàng)建服務(wù)并后臺停止舊服務(wù)，啟動新服務(wù)，并不會影響到其所依賴的服務(wù)。

選項：

• -d 在后臺運行服務(wù)容器。
• --no-color 不使用顏色來區(qū)分不同的服務(wù)的控制臺輸出。
• --no-deps 不啟動服務(wù)所鏈接的容器。
• --force-recreate 強制重新創(chuàng)建容器，不能與 --no-recreate 同時使用。
• --no-recreate 如果容器已經(jīng)存在了，則不重新創(chuàng)建，不能與 --force-recreate 同時使用。
• --no-build 不自動構(gòu)建缺失的服務(wù)鏡像。
• -t, --timeout TIMEOUT 停止容器時候的超時（默認為 10 秒）。

version

格式為 docker-compose version。

打印版本信息。