docker-compose命令說明

前言

docker-compose術語：

• 服務（service）：一個應用容器，實際上能夠運行多個相同鏡像的實例。
• 項目（project）：由一組關聯的應用容器組成的一個完整業務單元。
• 一個項目能夠由多個服務（容器）關聯而成，Compose面向項目進行管理。

---

博文大綱：

• 1、docker-compose命令對象與格式
• 2、命令選項
• 3、命令使用說明
  • build——構建（從新構建）項目中的服務容器
  • config——檢測compose文件的錯誤
  • up——啓動服務
  • down——中止容器
  • images——列出項目中所包含的鏡像
  • logs——查看服務容器的日誌
  • kill——發送 SIGKILL 信號來強制中止服務容器
  • port——查看某個容器端口所映射的公共端口
  • ps——列出項目中目前的全部容器
  • restart——重啓項目中的服務
  • rm——刪除全部中止狀態的服務容器
  • run——在指定服務上運行一個命令
  • scale——設置指定服務運行的容器個數
  • stop——中止處於運行狀態的容器
  • start——啓動被stop的服務容器
  • top——查看各個服務容器內運行的進程
  • pause——暫停一個服務容器
  • unpause——恢復處於暫停狀態中的服務

1、命令對象與格式

對於Compose來講，大部分命令的對象既能夠是項目自己，也能夠指定爲項目中的服務或者容器。若是沒有特別的說明，命令對象將是項目，這意味着項目中全部的服務都會受到命令影響。

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

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

2、命令選項

• -f：指定使用的compose模板文件，默認爲當前目錄下的docker-compose.yaml文件，能夠屢次指定。
• -p：指定項目的名稱，默認將使用所在目錄名稱做爲項目名。
• --verbose：輸出更多調試信息。
• -v：打印版本信息並退出。

3、命令使用說明

一、build——構建（從新構建）項目中的服務容器

命令格式爲：docker-compose build [options] [SERVICE...]。

服務容器一旦構建後，將會帶上一個標記名，例如對於web項目中的一個db容器，多是web_db。

能夠隨時在項目目錄下運行docker-compose build 來從新構建服務。

上述命令選項包括：

• --force-rm：刪除構建過程當中的臨時容器。
• --no-cache：構建鏡像過程當中不使用cache（這會加長構建過程）。
• --pull：始終嘗試經過pull來獲取更新版本的鏡像。

二、config——檢測compose文件的錯誤

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

命令格式以下：

$ docker-compose config

三、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：中止容器時候的超時（默認爲 10 秒）。

三、down——中止容器

此命令將會中止up命令所啓動的容器，並移除網絡。

四、images——列出項目中所包含的鏡像

$ docker-compose images    # 列出項目中所包含的鏡像
$ docker-compose -p tt images      # 若不是默認的項目名稱，則須要指定項目名稱

五、logs——查看服務容器的日誌

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

默認狀況下，docker-compose 將對不一樣的服務輸出使用不一樣的顏色來區分。能夠經過 --no-color 來關閉顏色。

該命令在調試問題的時候十分有用。

$ cat docker-compose.yml           # compose文件以下
version: '3'
services:
  web:
    build: .
    ports:
      - "5001:5000"
  redis:
    image: "redis:alpine"

$ docker-compose logs        #不加服務名稱則會顯示項目中全部服務的日誌，不一樣服務之間的日誌以不一樣的顏色區分
$ docker-compose logs web      #也能夠指定項目中的服務名稱，查看指定服務的日誌
$ docker-compose logs redis     #同上

六、kill——發送 SIGKILL 信號來強制中止服務容器

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

支持經過 -s 參數來指定發送的信號，例如經過以下指令發送 SIGINT 信號。

$ docker-compose  kill -s SIGINT web     #  kill掉指定的服務
$ docker-compose -p tt kill -s SIGINT web   #若不是默認的項目名稱，則須要-p指定項目名稱

八、port——查看某個容器端口所映射的公共端口

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

選項：

• --protocol=proto 指定端口協議，tcp（默認值）或者 udp。
• --index=index 若是同一服務存在多個容器，指定命令對象容器的序號（默認爲 1）。

[root@node02 test]# docker-compose port web 5000
0.0.0.0:5001
#上面的結果表示將web服務的5000端口映射到了宿主機的5001端口

九、ps——列出項目中目前的全部容器

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

$ docker-compose ps -q web    #查看某一個服務的ID
$ docker-compose ps       #查看項目中全部服務的容器信息

選項：

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

十、restart——重啓項目中的服務

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

選項：

• -t, --timeout TIMEOUT 指定重啓前中止容器的超時（默認爲 10 秒）。

舉個栗子：

$ docker-compose restart        #重啓當前項目中的全部服務
$ docker-compose restart web     #重啓當前項目中的web服務

十一、rm——刪除全部中止狀態的服務容器

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

選項：

• -f：不要求確認移除。
• -s：在刪除前中止項目中的全部容器。
• -v：刪除任何附加到容器的匿名卷。

十二、run——在指定服務上運行一個命令

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

例如：

$ docker-compose run web ping www.baidu.com

上面的指令將啓動項目中的web服務容器，並執行ping www.baidu.com 命令。

默認狀況下，若是存在關聯，則全部關聯的服務將會自動被啓動，除非這些服務已經在運行中。

若是不但願自動啓動關聯的容器，可使用 --no-deps 選項，例如

$ docker-compose run --no-deps web ping www.baidu.com

選項：

• -d：後臺運行容器。
• --name：爲容器指定一個名字。
• --entrypoint ：覆蓋默認的容器啓動指令。
• -e KEY=VAL ：設置環境變量值，可屢次使用選項來設置多個環境變量。
• -u：指定運行容器的用戶名或者 uid。
• --no-deps ：不自動啓動關聯的服務容器。
• --rm：運行命令後自動刪除容器，d 模式下將忽略。
• -p：映射容器端口到本地主機。
• --service-ports：配置服務端口並映射到本地主機。
• -T：不分配僞 tty，意味着依賴 tty 的指令將沒法運行。

1三、scale——設置指定服務運行的容器個數

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

經過 service=num 的參數來設置數量。例如：

$ docker-compose scale web=3 redis=2

將啓動 3 個容器運行 web 服務，2 個容器運行redis服務，可是須要注意的是，docker-compose中定義ports字段時，就不能夠指定映射到宿主機的端口了，不然只能夠啓動一個。

通常的，當指定數目多於該服務當前實際運行容器，將新建立並啓動容器；反之，將中止容器。

選項：
-t：中止容器時候的超時（默認爲 10 秒）。

1四、stop——中止處於運行狀態的容器

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

中止已經處於運行狀態的容器，但不刪除它。經過 docker-compose start 能夠再次啓動這些容器。

栗子：

$ docker-compose stop web     #中止當前項目中的web服務
$ docker-compose stop         #中止當前項目中全部服務

選項：

• -t：中止容器時候的超時（默認爲10秒）

1五、start——啓動被stop的服務容器

格式爲：docker-compose start [SERVICE...]。

栗子：

$ docker-compose start

1六、top——查看各個服務容器內運行的進程

$ docker-compose top    #查看項目中全部服務的進程
$ docker-compose top web   #查看項目中web服務的進程

1七、pause——暫停一個服務容器

格式爲：docker-compose pause [SERVICE...]。

暫停一個服務容器。

以下：

$ docker-compose -p tt pause redis    # -p選項是指定項目名稱
#如果默認的項目名稱，則能夠忽略-p選項
$ docker-compose pause        #暫停項目中的全部服務

1八、unpause——恢復處於暫停狀態中的服務

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

栗子：

$ docker-compose unpause

———————— 本文至此結束，感謝閱讀 ————————