Docker-Compose 常用命令
Docker-Compose常用命令
1、Docker-Compose命令格式
docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
命令選項如下:
-f,–file FILE指定Compose模板檔案,預設為docker-compose.yml,可以多次指定。
-p,–project-name NAME指定專案名稱,預設將使用所在目錄名稱作為專案名。
-x-network-driver 使用Docker的可拔插網路後端特性(需要Docker 1.9+版本)
-x-network-driver DRIVER指定網路後端的驅動,預設為bridge(需要Docker 1.9+版本)
-verbose輸出更多除錯資訊
-v,–version列印版本並退出
2、docker-compose up
docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
選項包括:
-d 在後臺執行服務容器
–no-color 不使用顏色來區分不同的服務的控制輸出
–no-deps 不啟動服務所連結的容器
–force-recreate 強制重新建立容器,不能與–no-recreate同時使用
–no-recreate 如果容器已經存在,則不重新建立,不能與–force-recreate同時使用
–no-build 不自動構建缺失的服務映象
–build 在啟動容器前構建服務映象
–abort-on-container-exit 停止所有容器,如果任何一個容器被停止,不能與-d同時使用
-t, –timeout TIMEOUT 停止容器時候的超時(預設為10秒)
–remove-orphans 刪除服務中沒有在compose檔案中定義的容器
–scale SERVICE=NUM 設定服務執行容器的個數,將覆蓋在compose中通過scale指定的引數docker-compose up
啟動所有服務
docker-compose up -d
在後臺所有啟動服務
-f 指定使用的Compose模板檔案,預設為docker-compose.yml,可以多次指定。
docker-compose -f docker-compose.yml up -d
3、docker-compose ps
docker-compose ps [options] [SERVICE...]
docker-compose ps
列出專案中目前的所有容器
4、docker-compose stop
docker-compose stop [options] [SERVICE...]
選項包括:
-t, –timeout TIMEOUT 停止容器時候的超時(預設為10秒)docker-compose stop
停止正在執行的容器,可以通過docker-compose start 再次啟動
5、docker-compose -h
docker-compose -h
檢視幫助
6、docker-compose down
docker-compose down [options]
停止和刪除容器、網路、卷、映象。
選項包括:
–rmi type,刪除映象,型別必須是:all,刪除compose檔案中定義的所有映象;local,刪除映象名為空的映象
-v, –volumes,刪除已經在compose檔案中定義的和匿名的附在容器上的資料卷
–remove-orphans,刪除服務中沒有在compose中定義的容器docker-compose down
停用移除所有容器以及網路相關
7、docker-compose logs
docker-compose logs [options] [SERVICE...]
檢視服務容器的輸出。預設情況下,docker-compose將對不同的服務輸出使用不同的顏色來區分。可以通過–no-color來關閉顏色。docker-compose logs
檢視服務容器的輸出
8、docker-compose build
docker-compose build [options] [--build-arg key=val...] [SERVICE...]
構建(重新構建)專案中的服務容器。
選項包括:
–compress 通過gzip壓縮構建上下環境
–force-rm 刪除構建過程中的臨時容器
–no-cache 構建映象過程中不使用快取
–pull 始終嘗試通過拉取操作來獲取更新版本的映象
-m, –memory MEM為構建的容器設定記憶體大小
–build-arg key=val為服務設定build-time變數
服務容器一旦構建後,將會帶上一個標記名。可以隨時在專案目錄下執行docker-compose build來重新構建服務
9、docker-compose pull
docker-compose pull [options] [SERVICE...]
拉取服務依賴的映象。
選項包括:
–ignore-pull-failures,忽略拉取映象過程中的錯誤
–parallel,多個映象同時拉取
–quiet,拉取映象過程中不列印進度資訊docker-compose pull
拉取服務依賴的映象
10、docker-compose restart
docker-compose restart [options] [SERVICE...]
重啟專案中的服務。
選項包括:
-t, –timeout TIMEOUT,指定重啟前停止容器的超時(預設為10秒)docker-compose restart
重啟專案中的服務
11、docker-compose rm
docker-compose rm [options] [SERVICE...]
刪除所有(停止狀態的)服務容器。
選項包括:
–f, –force,強制直接刪除,包括非停止狀態的容器
-v,刪除容器所掛載的資料卷docker-compose rm
刪除所有(停止狀態的)服務容器。推薦先執行docker-compose stop命令來停止容器。
12、docker-compose start
docker-compose start [SERVICE...]
docker-compose start
啟動已經存在的服務容器。
13、docker-compose run
docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服務上執行一個命令。docker-compose run ubuntu ping www.baidu.com
在指定容器上執行一個ping命令。
14、docker-compose scale
docker-compose scale web=3 db=2
設定指定服務執行的容器個數。通過service=num的引數來設定數量
15、docker-compose pause
docker-compose pause [SERVICE...]
暫停一個服務容器
16、docker-compose kill
docker-compose kill [options] [SERVICE...]
通過傳送SIGKILL訊號來強制停止服務容器。
支援通過-s引數來指定傳送的訊號,例如通過如下指令傳送SIGINT訊號:docker-compose kill -s SIGINT
17、dokcer-compose config
docker-compose config [options]
驗證並檢視compose檔案配置。
選項包括:
–resolve-image-digests 將映象標籤標記為摘要
-q, –quiet 只驗證配置,不輸出。 當配置正確時,不輸出任何內容,當檔案配置錯誤,輸出錯誤資訊
–services 列印服務名,一行一個
–volumes 列印資料卷名,一行一個
18、docker-compose create
docker-compose create [options] [SERVICE...]
為服務建立容器。
選項包括:
–force-recreate:重新建立容器,即使配置和映象沒有改變,不相容–no-recreate引數
–no-recreate:如果容器已經存在,不需要重新建立,不相容–force-recreate引數
–no-build:不建立映象,即使缺失
–build:建立容器前,生成映象
19、docker-compose exec
docker-compose exec [options] SERVICE COMMAND [ARGS...]
選項包括:
-d 分離模式,後臺執行命令。
–privileged 獲取特權。
–user USER 指定執行的使用者。
-T 禁用分配TTY,預設docker-compose exec分配TTY。
–index=index,當一個服務擁有多個容器時,可通過該引數登陸到該服務下的任何服務,例如:docker-compose exec –index=1 web /bin/bash ,web服務中包含多個容器
20、docker-compose port
docker-compose port [options] SERVICE PRIVATE_PORT
顯示某個容器埠所對映的公共埠。
選項包括:
–protocol=proto,指定埠協議,TCP(預設值)或者UDP
–index=index,如果同意服務存在多個容器,指定命令物件容器的序號(預設為1)
21、docker-compose push
docker-compose push [options] [SERVICE...]
推送服務依的映象。
選項包括:
–ignore-push-failures 忽略推送映象過程中的錯誤
22、docker-compose stop
docker-compose stop [options] [SERVICE...]
顯示各個容器執行的程序情況。
23、docker-compose unpause
docker-compose unpause [SERVICE...]
恢復處於暫停狀態中的服務。
24、docker-compose version
docker-compose version
列印版本資訊。
三、Docker-Compose模板檔案
1、Docker-Compose模板檔案簡介
Compose允許使用者通過一個docker-compose.yml模板檔案(YAML 格式)來定義一組相關聯的應用容器為一個專案(project)。
Compose模板檔案是一個定義服務、網路和卷的YAML檔案。Compose模板檔案預設路徑是當前目錄下的docker-compose.yml,可以使用.yml或.yaml作為副檔名。
Docker-Compose標準模板檔案應該包含version、services、networks 三大部分,最關鍵的是services和networks兩個部分。
version: '2'
services:
web:
image: dockercloud/hello-world
ports:
- 8080
networks:
- front-tier
- back-tier
redis:
image: redis
links:
- web
networks:
- back-tier
lb:
image: dockercloud/haproxy
ports:
- 80:80
links:
- web
networks:
- front-tier
- back-tier
volumes:
- /var/run/docker.sock:/var/run/docker.sock
networks:
front-tier:
driver: bridge
back-tier:
driver: bridge
Compose目前有三個版本分別為Version 1,Version 2,Version 3,Compose區分Version 1和Version 2(Compose 1.6.0+,Docker Engine 1.10.0+)。Version 2支援更多的指令。Version 1將來會被棄用。
2、image
image是指定服務的映象名稱或映象ID。如果映象在本地不存在,Compose將會嘗試拉取映象。
services:
web:
image: hello-world
3、build
服務除了可以基於指定的映象,還可以基於一份Dockerfile,在使用up啟動時執行構建任務,構建標籤是build,可以指定Dockerfile所在資料夾的路徑。Compose將會利用Dockerfile自動構建映象,然後使用映象啟動服務容器。build: /path/to/build/dir
也可以是相對路徑,只要上下文確定就可以讀取到Dockerfile。build: ./dir
設定上下文根目錄,然後以該目錄為準指定Dockerfile。
build:
context: ../
dockerfile: path/of/Dockerfile
build都是一個目錄,如果要指定Dockerfile檔案需要在build標籤的子級標籤中使用dockerfile標籤指定。
如果同時指定image和build兩個標籤,那麼Compose會構建映象並且把映象命名為image值指定的名字。
4、context
context選項可以是Dockerfile的檔案路徑,也可以是到連結到git倉庫的url,當提供的值是相對路徑時,被解析為相對於撰寫檔案的路徑,此目錄也是傳送到Docker守護程序的context
build:
context: ./dir
5、dockerfile
使用dockerfile檔案來構建,必須指定構建路徑
build:
context: .
dockerfile: Dockerfile-alternate
dockerfile指令不能跟image同時使用,否則Compose將不確定根據哪個指令來生成最終的服務映象。
6、command
使用command可以覆蓋容器啟動後預設執行的命令。command: bundle exec thin -p 3000
7、container_name
Compose的容器名稱格式是:<專案名稱><服務名稱><序號>
可以自定義專案名稱、服務名稱,但如果想完全控制容器的命名,可以使用標籤指定:container_name: app
8、depends_on
在使用Compose時,最大的好處就是少打啟動命令,但一般專案容器啟動的順序是有要求的,如果直接從上到下啟動容器,必然會因為容器依賴問題而啟動失敗。例如在沒啟動資料庫容器的時候啟動應用容器,應用容器會因為找不到資料庫而退出。depends_on標籤用於解決容器的依賴、啟動先後的問題。
version: '2'
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
上述YAML檔案定義的容器會先啟動redis和db兩個服務,最後才啟動web 服務。
9、pid
pid: "host"
將PID模式設定為主機PID模式,跟主機系統共享程序名稱空間。容器使用pid標籤將能夠訪問和操縱其他容器和宿主機的名稱空間。
10、ports
ports用於對映埠的標籤。
使用HOST:CONTAINER格式或者只是指定容器的埠,宿主機會隨機對映埠。
ports:
- "3000"
- "8000:8000"
- "49100:22"
- "127.0.0.1:8001:8001"
當使用HOST:CONTAINER格式來對映埠時,如果使用的容器埠小於60可能會得到錯誤得結果,因為YAML將會解析xx:yy這種數字格式為60進位制。所以建議採用字串格式。
11、extra_hosts
新增主機名的標籤,會在/etc/hosts檔案中新增一些記錄。
extra_hosts:
- "somehost:162.242.195.82"
- "otherhost:50.31.209.229"
啟動後檢視容器內部hosts:
162.242.195.82 somehost
50.31.209.229 otherhost
12、volumes
掛載一個目錄或者一個已存在的資料卷容器,可以直接使用 [HOST:CONTAINER]格式,或者使用[HOST:CONTAINER:ro]格式,後者對於容器來說,資料卷是隻讀的,可以有效保護宿主機的檔案系統。
Compose的資料卷指定路徑可以是相對路徑,使用 . 或者 .. 來指定相對目錄。
資料卷的格式可以是下面多種形式:
volumes:
// 只是指定一個路徑,Docker 會自動在建立一個數據卷(這個路徑是容器內部的)。
- /var/lib/mysql
// 使用絕對路徑掛載資料卷
- /opt/data:/var/lib/mysql
// 以 Compose 配置檔案為中心的相對路徑作為資料卷掛載到容器。
- ./cache:/tmp/cache
// 使用使用者的相對路徑(~/ 表示的目錄是 /home/<使用者目錄>/ 或者 /root/)。
- ~/configs:/etc/configs/:ro
// 已經存在的命名的資料卷。
- datavolume:/var/lib/mysql
如果不使用宿主機的路徑,可以指定一個volume_driver。volume_driver: mydriver
13、volumes_from
從另一個服務或容器掛載其資料卷:
volumes_from:
- service_name
- container_name
14、dns
自定義DNS伺服器。可以是一個值,也可以是一個列表。
dns:8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
15、dns_search
配置DNS搜尋域。可以是一個值,也可以是一個列表。
dns_search:example.com
dns_search:
- domain1.example.com
- domain2.example.com
16、entrypoint
在Dockerfile中有一個指令叫做ENTRYPOINT指令,用於指定接入點。
在docker-compose.yml中可以定義接入點,覆蓋Dockerfile中的定義:entrypoint: /code/entrypoint.sh
17、env_file
在docker-compose.yml中可以定義一個專門存放變數的檔案。
如果通過docker-compose -f FILE指定配置檔案,則env_file中路徑會使用配置檔案路徑。
如果有變數名稱與environment指令衝突,則以後者為準。格式如下:env_file: .env
或者根據docker-compose.yml設定多個:
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
如果在配置檔案中有build操作,變數並不會進入構建過程中。
18、cap_add
增加指定容器的核心能力(capacity)。
讓容器具有所有能力可以指定:
cap_add:
- ALL
19、cap_drop
去掉指定容器的核心能力(capacity)。
去掉NET_ADMIN能力可以指定:
cap_drop:
- NET_ADMIN
20、cgroup_parent
建立了一個cgroup組名稱為cgroups_1:cgroup_parent: cgroups_1
21、devices
指定裝置對映關係,例如:
devices:
- "/dev/ttyUSB1:/dev/ttyUSB0"
22、expose
暴露埠,但不對映到宿主機,只允許能被連線的服務訪問。僅可以指定內部埠為引數,如下所示:
expose:
- "3000"
- "8000"
23、extends
基於其它模板檔案進行擴充套件。例如,對於webapp服務定義了一個基礎模板檔案為common.yml:
# common.yml
webapp:
build: ./webapp
environment:
- DEBUG=false
- SEND_EMAILS=false
再編寫一個新的development.yml檔案,使用common.yml中的webapp服務進行擴充套件:
# development.yml
web:
extends:
file: common.yml
service: webapp
ports:
- "8000:8000"
links:
- db
environment:
- DEBUG=true
db:
image: mysql
後者會自動繼承common.yml中的webapp服務及環境變數定義。
extends限制如下:
A、要避免出現迴圈依賴
B、extends不會繼承links和volumes_from中定義的容器和資料卷資源
推薦在基礎模板中只定義一些可以共享的映象和環境變數,在擴充套件模板中具體指定應用變數、連結、資料卷等資訊
24、external_links
連結到docker-compose.yml外部的容器,可以是非Compose管理的外部容器。
external_links:
- redis_1
- project_db_1:mysql
- project_db_1:postgresql
25、labels
為容器新增Docker元資料(metadata)資訊。例如,可以為容器新增輔助說明資訊:
labels:
com.startupteam.description: "webapp for a strtup team"
26、links
連結到其它服務中的容器。使用服務名稱(同時作為別名),或者“服務名稱:服務別名”(如 SERVICE:ALIAS),例如:
links:
- db
- db:database
- redis
使用別名將會自動在服務容器中的/etc/hosts裡建立。例如:
172.17.2.186 db
172.17.2.186 database
172.17.2.187 redis
27、log_driver
指定日誌驅動型別。目前支援三種日誌驅動型別:
log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"
28、log_opt
日誌驅動的相關引數。例如:
log_driver: "syslog"log_opt:
syslog-address: "tcp://192.168.0.42:123"
29、net
設定網路模式。
net: "bridge"
net: "none"
net: "host"
30、security_opt
指定容器模板標籤(label)機制的預設屬性(使用者、角色、型別、級別等)。例如,配置標籤的使用者名稱和角色名:
security_opt:
- label:user:USER
- label:role:ROLE
31、環境變數
環境變數可以用來配置Docker-Compose的行為。
COMPOSE_PROJECT_NAME
設定通過Compose啟動的每一個容器前新增的專案名稱,預設是當前工作目錄的名字。
COMPOSE_FILE
設定docker-compose.yml模板檔案的路徑。預設路徑是當前工作目錄。
DOCKER_HOST
設定Docker daemon的地址。預設使用unix:///var/run/docker.sock。 DOCKER_TLS_VERIFY
如果設定不為空,則與Docker daemon互動通過TLS進行。
DOCKER_CERT_PATH
配置TLS通訊所需要的驗證(ca.pem、cert.pem 和 key.pem)檔案的路徑,預設是~/.docker。
四、Docker-Compose模板檔案示例
1、docker-compose模板檔案編寫
docker-compose.yaml檔案如下:
version: '2'
services:
web1:
image: nginx
ports:
- "6061:80"
container_name: "web1"
networks:
- dev
web2:
image: nginx
ports:
- "6062:80"
container_name: "web2"
networks:
- dev
- pro
web3:
image: nginx
ports:
- "6063:80"
container_name: "web3"
networks:
- pro
networks:
dev:
driver: bridge
pro:
driver: bridge
#volumes:
docker-compose.yaml檔案指定了三個web服務。
2、啟動應用
建立一個webapp目錄,將docker-compose.yaml檔案拷貝到webapp目錄下,使用docker-compose啟動應用。docker-compose up -d
3、服務訪問
通過瀏覽器訪問web1,web2,web3服務:
http://127.0.0.1:6061
http://127.0.0.1:6062
http://127.0.0.1:6063