1. 程式人生 > 實用技巧 >Docker Compose 命令說明

Docker Compose 命令說明

1、命令物件與格式

對於 Compose 來說,大部分命令的物件既可以是專案本身,也可以指定為專案中的服務或者容器。如果沒有特別的說明,命令物件將是專案,這意味著專案中所有的服務都會受到命令影響。

執行docker-compose [COMMAND] --help或者docker-compose help [COMMAND]可以檢視具體某個命令的使用格式。

docker-compose命令的基本的使用格式是

    docker-compose [-f=<arg>...] [options] [COMMAND] [ARGS...]

2、命令選項

  • -f, --file FILE
    指定使用的 Compose 模板檔案,預設為docker-compose.yml,可以多次指定。
  • -p, --project-name NAME指定專案名稱,預設將使用所在目錄名稱作為專案名。
  • --x-networking使用 Docker 的可拔插網路後端特性
  • --x-network-driver DRIVER指定網路後端的驅動,預設為bridge
  • --verbose輸出更多除錯資訊。
  • -v, --version列印版本並退出。

3、build

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

構建(重新構建)專案中的服務容器。

服務容器一旦構建後,將會帶上一個標記名,例如對於 web 專案中的一個 db 容器,可能是 web_db。

可以隨時在專案目錄下執行docker-compose build來重新構建服務。

選項包括:

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

4、config

驗證 Compose 檔案格式是否正確,若正確則顯示配置,若格式錯誤顯示錯誤原因。

5、down

此命令將會停止up命令所啟動的容器,並移除網路

6、exec

進入指定的容器。

7、help

獲得一個命令的幫助。

8、images

列出 Compose 檔案中包含的映象。

9、kill

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

通過傳送SIGKILL訊號來強制停止服務容器。

支援通過-s引數來指定傳送的訊號,例如通過如下指令傳送SIGINT訊號。

    $ docker-compose kill -s SIGINT

10、logs

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

檢視服務容器的輸出。預設情況下,docker-compose 將對不同的服務輸出使用不同的顏色來區分。可以通過--no-color來關閉顏色。

該命令在除錯問題的時候十分有用。

11、pause

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

暫停一個服務容器。

12、port

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

列印某個容器埠所對映的公共埠。

選項:

  • --protocol=proto指定埠協議,tcp(預設值)或者 udp。
  • --index=index如果同一服務存在多個容器,指定命令物件容器的序號(預設為 1)。

13、ps

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

列出專案中目前的所有容器。

選項:

  • -q只打印容器的 ID 資訊。

14、pull

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

拉取服務依賴的映象。

選項:

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

15、push

推送服務依賴的映象到 Docker 映象倉庫。

16、restart

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

重啟專案中的服務。

選項:

  • -t, --timeout TIMEOUT指定重啟前停止容器的超時(預設為 10 秒)。

17、rm

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

刪除所有(停止狀態的)服務容器。推薦先執行docker-compose stop命令來停止容器。

選項:

  • -f, --force強制直接刪除,包括非停止狀態的容器。一般儘量不要使用該選項。
  • -v刪除容器所掛載的資料卷。

18、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 的指令將無法執行。

19、scale

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

設定指定服務執行的容器個數。

通過service=num的引數來設定數量。例如:

    $ docker-compose scale web=3 db=2

將啟動 3 個容器執行 web 服務,2 個容器執行 db 服務。

一般的,當指定數目多於該服務當前實際執行容器,將新建立並啟動容器;反之,將停止容器。

選項:

  • -t, --timeout TIMEOUT停止容器時候的超時(預設為 10 秒)。

20、start

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

啟動已經存在的服務容器。

21、stop

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

停止已經處於執行狀態的容器,但不刪除它。通過docker-compose start可以再次啟動這些容器。

選項:

  • -t, --timeout TIMEOUT停止容器時候的超時(預設為 10 秒)。

22、top

檢視各個服務容器內執行的程序。

23、unpause

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

恢復處於暫停狀態中的服務。

24、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 秒)。

25、version

格式為docker-compose version

列印版本資訊。

轉自:有夢想的鹹魚