Docker Compose 命令說明
#命令對象與格式
對於 Compose 來說,大部分命令的對象既可以是項目本身,也可以指定為項目中的服務或者容器。如果沒有特別的說明,命令對象將是項目,這意味着項目中所有的服務都會受到命令影響。
執行 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 的可拔插網絡后端特性--x-network-driver DRIVER
指定網絡后端的驅動,默認為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
命令所啟動的容器,並移除網絡
#exec
進入指定的容器。
#help
獲得一個命令的幫助。
#images
列出 Compose 文件中包含的鏡像。
#kill
格式為 docker-compose kill [options] [SERVICE...]
。
通過發送 SIGKILL
信號來強制停止服務容器。
支持通過 -s
參數來指定發送的信號,例如通過如下指令發送 SIGINT
信號。
$ docker-compose kill -s SIGINT
#logs
格式為 docker-compose logs [options] [SERVICE...]
。
查看服務容器的輸出。默認情況下,docker-compose 將對不同的服務輸出使用不同的顏色來區分。可以通過 --no-color
來關閉顏色。
該命令在調試問題的時候十分有用。
#pause
格式為 docker-compose pause [SERVICE...]
。
暫停一個服務容器。
#port
格式為 docker-compose port [options] SERVICE PRIVATE_PORT
。
打印某個容器端口所映射的公共端口。
選項:
--protocol=proto
指定端口協議,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...]
。
刪除所有(停止狀態的)服務容器。推薦先執行 docker-compose stop
命令來停止容器。
選項:
-f, --force
強制直接刪除,包括非停止狀態的容器。一般盡量不要使用該選項。-v
刪除容器所掛載的數據卷。
#run
格式為 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
。
在指定服務上執行一個命令。
例如:
$ docker-compose run ubuntu ping docker.com
將會啟動一個 ubuntu 服務容器,並執行 ping docker.com
命令。
默認情況下,如果存在關聯,則所有關聯的服務將會自動被啟動,除非這些服務已經在運行中。
該命令類似啟動容器后運行指定的命令,相關卷、鏈接等等都將會按照配置自動創建。
兩個不同點:
- 給定命令將會覆蓋原有的自動運行命令;
- 不會自動創建端口,以避免沖突。
如果不希望自動啟動關聯的容器,可以使用 --no-deps
選項,例如
$ docker-compose run --no-deps web python manage.py shell
將不會啟動 web 容器所關聯的其它容器。
選項:
-d
后台運行容器。--name NAME
為容器指定一個名字。--entrypoint CMD
覆蓋默認的容器啟動指令。-e KEY=VAL
設置環境變量值,可多次使用選項來設置多個環境變量。-u, --user=""
指定運行容器的用戶名或者 uid。--no-deps
不自動啟動關聯的服務容器。--rm
運行命令后自動刪除容器,d
模式下將忽略。-p, --publish=[]
映射容器端口到本地主機。--service-ports
配置服務端口並映射到本地主機。-T
不分配偽 tty,意味着依賴 tty 的指令將無法運行。
#scale
格式為 docker-compose scale [options] [SERVICE=NUM...]
。
設置指定服務運行的容器個數。
通過 service=num
的參數來設置數量。例如:
$ docker-compose scale web=3 db=2
將啟動 3 個容器運行 web 服務,2 個容器運行 db 服務。
一般的,當指定數目多於該服務當前實際運行容器,將新創建並啟動容器;反之,將停止容器。
選項:
-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)。
#start
格式為 docker-compose start [SERVICE...]
。
啟動已經存在的服務容器。
#stop
格式為 docker-compose stop [options] [SERVICE...]
。
停止已經處於運行狀態的容器,但不刪除它。通過 docker-compose start
可以再次啟動這些容器。
選項:
-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)。
#top
查看各個服務容器內運行的進程。
#unpause
格式為 docker-compose unpause [SERVICE...]
。
恢復處於暫停狀態中的服務。
#up
格式為 docker-compose up [options] [SERVICE...]
。
該命令十分強大,它將嘗試自動完成包括構建鏡像,(重新)創建服務,啟動服務,並關聯服務相關容器的一系列操作。
鏈接的服務都將會被自動啟動,除非已經處於運行狀態。
可以說,大部分時候都可以直接通過該命令來啟動一個項目。
默認情況,docker-compose up
啟動的容器都在前台,控制台將會同時打印所有容器的輸出信息,可以很方便進行調試。
當通過 Ctrl-C
停止命令時,所有容器將會停止。
如果使用 docker-compose up -d
,將會在后台啟動並運行所有的容器。一般推薦生產環境下使用該選項。
默認情況,如果服務容器已經存在,docker-compose up
將會嘗試停止容器,然后重新創建(保持使用 volumes-from
掛載的卷),以保證新啟動的服務匹配 docker-compose.yml
文件的最新內容。如果用戶不希望容器被停止並重新創建,可以使用 docker-compose up --no-recreate
。這樣將只會啟動處於停止狀態的容器,而忽略已經運行的服務。如果用戶只想重新部署某個服務,可以使用 docker-compose up --no-deps -d <SERVICE_NAME>
來重新創建服務並后台停止舊服務,啟動新服務,並不會影響到其所依賴的服務。
選項:
-d
在后台運行服務容器。--no-color
不使用顏色來區分不同的服務的控制台輸出。--no-deps
不啟動服務所鏈接的容器。--force-recreate
強制重新創建容器,不能與--no-recreate
同時使用。--no-recreate
如果容器已經存在了,則不重新創建,不能與--force-recreate
同時使用。--no-build
不自動構建缺失的服務鏡像。-t, --timeout TIMEOUT
停止容器時候的超時(默認為 10 秒)。