Docker-Compose項(xiàng)目是Docker官方的開源項(xiàng)目,負(fù)責(zé)實(shí)現(xiàn)對Docker容器集群的快速編排。
Docker-Compose將所管理的容器分為三層,分別是工程(project),服務(wù)(service)以及容器(container)。Docker-Compose運(yùn)行目錄下的所有文件(docker-compose.yml,extends文件或環(huán)境變量文件等)組成一個工程,若無特殊指定工程名即為當(dāng)前目錄名。一個工程當(dāng)中可包含多個服務(wù),每個服務(wù)中定義了容器運(yùn)行的鏡像,參數(shù),依賴。一個服務(wù)當(dāng)中可包括多個容器實(shí)例,Docker-Compose并沒有解決負(fù)載均衡的問題,因此需要借助其它工具實(shí)現(xiàn)服務(wù)發(fā)現(xiàn)及負(fù)載均衡。
Docker-Compose的工程配置文件默認(rèn)為docker-compose.yml,可通過環(huán)境變量COMPOSE_FILE或-f參數(shù)自定義配置文件,其定義了多個有依賴關(guān)系的服務(wù)及每個服務(wù)運(yùn)行的容器。
使用一個Dockerfile模板文件,可以讓用戶很方便的定義一個單獨(dú)的應(yīng)用容器。在工作中,經(jīng)常會碰到需要多個容器相互配合來完成某項(xiàng)任務(wù)的情況。例如要實(shí)現(xiàn)一個Web項(xiàng)目,除了Web服務(wù)容器本身,往往還需要再加上后端的數(shù)據(jù)庫服務(wù)容器,甚至還包括負(fù)載均衡容器等。
Compose允許用戶通過一個單獨(dú)的docker-compose.yml模板文件(YAML 格式)來定義一組相關(guān)聯(lián)的應(yīng)用容器為一個項(xiàng)目(project)。
Docker-Compose項(xiàng)目由Python編寫,調(diào)用Docker服務(wù)提供的API來對容器進(jìn)行管理。因此,只要所操作的平臺支持Docker API,就可以在其上利用Compose來進(jìn)行編排管理。
安裝方法一:
下載Docker-Compose:
sudo curl -L https://github.com/docker/compose/releases/download/1.23.0-rc3/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
安裝Docker-Compose:sudo chmod +x /usr/local/bin/docker-compose
查看版本 :docker-compose version
安裝方法二:
安裝pip
yum -y install epel-releaseyum -y install python-pip
確認(rèn)版本pip --version
更新pippip install --upgrade pip
安裝docker-composepip install docker-compose
查看版本docker-compose version
安裝補(bǔ)全工具:
為了方便輸入命令,也可以安裝Docker的補(bǔ)全提示工具幫忙快速輸入命令:
安裝yum install bash-completion
下載docker-compose腳本
curl -L https://raw.githubusercontent.com/docker/compose/$(docker-compose version --short)/contrib/completion/bash/docker-compose > /etc/bash_completion.d/docker-compose
如果是二進(jìn)制包方式安裝的,刪除二進(jìn)制文件即可:sudo rm /usr/local/bin/docker-compose
如果通過Python pip工具安裝的,則執(zhí)行如下命令刪除:sudo pip uninstall docker-compose
docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]
命令選項(xiàng)如下:
-f,–file FILE指定Compose模板文件,默認(rèn)為docker-compose.yml,可以多次指定。
-p,–project-name NAME指定項(xiàng)目名稱,默認(rèn)將使用所在目錄名稱作為項(xiàng)目名。
-x-network-driver 使用Docker的可拔插網(wǎng)絡(luò)后端特性(需要Docker 1.9+版本)
-x-network-driver DRIVER指定網(wǎng)絡(luò)后端的驅(qū)動,默認(rèn)為bridge(需要Docker 1.9+版本)
-verbose輸出更多調(diào)試信息
-v,–version打印版本并退出
docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
選項(xiàng)包括:
-d 在后臺運(yùn)行服務(wù)容器
–no-color 不使用顏色來區(qū)分不同的服務(wù)的控制輸出
–no-deps 不啟動服務(wù)所鏈接的容器
–force-recreate 強(qiáng)制重新創(chuàng)建容器,不能與–no-recreate同時使用
–no-recreate 如果容器已經(jīng)存在,則不重新創(chuàng)建,不能與–force-recreate同時使用
–no-build 不自動構(gòu)建缺失的服務(wù)鏡像
–build 在啟動容器前構(gòu)建服務(wù)鏡像
–abort-on-container-exit 停止所有容器,如果任何一個容器被停止,不能與-d同時使用
-t, –timeout TIMEOUT 停止容器時候的超時(默認(rèn)為10秒)
–remove-orphans 刪除服務(wù)中沒有在compose文件中定義的容器
–scale SERVICE=NUM 設(shè)置服務(wù)運(yùn)行容器的個數(shù),將覆蓋在compose中通過scale指定的參數(shù)docker-compose up
啟動所有服務(wù)docker-compose up -d
在后臺所有啟動服務(wù)
-f 指定使用的Compose模板文件,默認(rèn)為docker-compose.yml,可以多次指定。docker-compose -f docker-compose.yml up -d
docker-compose ps [options] [SERVICE...]
docker-compose ps
列出項(xiàng)目中目前的所有容器
docker-compose stop [options] [SERVICE...]
選項(xiàng)包括:
-t, –timeout TIMEOUT 停止容器時候的超時(默認(rèn)為10秒)docker-compose stop
停止正在運(yùn)行的容器,可以通過docker-compose start 再次啟動
docker-compose -h
查看幫助
docker-compose down [options]
停止和刪除容器、網(wǎng)絡(luò)、卷、鏡像。
選項(xiàng)包括:
–rmi type,刪除鏡像,類型必須是:all,刪除compose文件中定義的所有鏡像;local,刪除鏡像名為空的鏡像
-v, –volumes,刪除已經(jīng)在compose文件中定義的和匿名的附在容器上的數(shù)據(jù)卷
–remove-orphans,刪除服務(wù)中沒有在compose中定義的容器docker-compose down
停用移除所有容器以及網(wǎng)絡(luò)相關(guān)
docker-compose logs [options] [SERVICE...]
查看服務(wù)容器的輸出。默認(rèn)情況下,docker-compose將對不同的服務(wù)輸出使用不同的顏色來區(qū)分??梢酝ㄟ^–no-color來關(guān)閉顏色。docker-compose logs
查看服務(wù)容器的輸出
docker-compose build [options] [--build-arg key=val...] [SERVICE...]
構(gòu)建(重新構(gòu)建)項(xiàng)目中的服務(wù)容器。
選項(xiàng)包括:
–compress 通過gzip壓縮構(gòu)建上下環(huán)境
–force-rm 刪除構(gòu)建過程中的臨時容器
–no-cache 構(gòu)建鏡像過程中不使用緩存
–pull 始終嘗試通過拉取操作來獲取更新版本的鏡像
-m, –memory MEM為構(gòu)建的容器設(shè)置內(nèi)存大小
–build-arg key=val為服務(wù)設(shè)置build-time變量
服務(wù)容器一旦構(gòu)建后,將會帶上一個標(biāo)記名??梢噪S時在項(xiàng)目目錄下運(yùn)行docker-compose build來重新構(gòu)建服務(wù)
docker-compose pull [options] [SERVICE...]
拉取服務(wù)依賴的鏡像。
選項(xiàng)包括:
–ignore-pull-failures,忽略拉取鏡像過程中的錯誤
–parallel,多個鏡像同時拉取
–quiet,拉取鏡像過程中不打印進(jìn)度信息docker-compose pull
拉取服務(wù)依賴的鏡像
docker-compose restart [options] [SERVICE...]
重啟項(xiàng)目中的服務(wù)。
選項(xiàng)包括:
-t, –timeout TIMEOUT,指定重啟前停止容器的超時(默認(rèn)為10秒)docker-compose restart
重啟項(xiàng)目中的服務(wù)
docker-compose rm [options] [SERVICE...]
刪除所有(停止?fàn)顟B(tài)的)服務(wù)容器。
選項(xiàng)包括:
–f, –force,強(qiáng)制直接刪除,包括非停止?fàn)顟B(tài)的容器
-v,刪除容器所掛載的數(shù)據(jù)卷docker-compose rm
刪除所有(停止?fàn)顟B(tài)的)服務(wù)容器。推薦先執(zhí)行docker-compose stop命令來停止容器。
docker-compose start [SERVICE...]
docker-compose start
啟動已經(jīng)存在的服務(wù)容器。
docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服務(wù)上執(zhí)行一個命令。docker-compose run ubuntu ping www.baidu.com
在指定容器上執(zhí)行一個ping命令。
docker-compose scale web=3 db=2
設(shè)置指定服務(wù)運(yùn)行的容器個數(shù)。通過service=num的參數(shù)來設(shè)置數(shù)量
docker-compose pause [SERVICE...]
暫停一個服務(wù)容器
docker-compose kill [options] [SERVICE...]
通過發(fā)送SIGKILL信號來強(qiáng)制停止服務(wù)容器。
支持通過-s參數(shù)來指定發(fā)送的信號,例如通過如下指令發(fā)送SIGINT信號:docker-compose kill -s SIGINT
docker-compose config [options]
驗(yàn)證并查看compose文件配置。
選項(xiàng)包括:
–resolve-image-digests 將鏡像標(biāo)簽標(biāo)記為摘要
-q, –quiet 只驗(yàn)證配置,不輸出。 當(dāng)配置正確時,不輸出任何內(nèi)容,當(dāng)文件配置錯誤,輸出錯誤信息
–services 打印服務(wù)名,一行一個
–volumes 打印數(shù)據(jù)卷名,一行一個
docker-compose create [options] [SERVICE...]
為服務(wù)創(chuàng)建容器。
選項(xiàng)包括:
–force-recreate:重新創(chuàng)建容器,即使配置和鏡像沒有改變,不兼容–no-recreate參數(shù)
–no-recreate:如果容器已經(jīng)存在,不需要重新創(chuàng)建,不兼容–force-recreate參數(shù)
–no-build:不創(chuàng)建鏡像,即使缺失
–build:創(chuàng)建容器前,生成鏡像
docker-compose exec [options] SERVICE COMMAND [ARGS...]
選項(xiàng)包括:
-d 分離模式,后臺運(yùn)行命令。
–privileged 獲取特權(quán)。
–user USER 指定運(yùn)行的用戶。
-T 禁用分配TTY,默認(rèn)docker-compose exec分配TTY。
–index=index,當(dāng)一個服務(wù)擁有多個容器時,可通過該參數(shù)登陸到該服務(wù)下的任何服務(wù),例如:docker-compose exec –index=1 web /bin/bash ,web服務(wù)中包含多個容器
docker-compose port [options] SERVICE PRIVATE_PORT
顯示某個容器端口所映射的公共端口。
選項(xiàng)包括:
–protocol=proto,指定端口協(xié)議,TCP(默認(rèn)值)或者UDP
–index=index,如果同意服務(wù)存在多個容器,指定命令對象容器的序號(默認(rèn)為1)
docker-compose push [options] [SERVICE...]
推送服務(wù)依的鏡像。
選項(xiàng)包括:
–ignore-push-failures 忽略推送鏡像過程中的錯誤
docker-compose stop [options] [SERVICE...]
顯示各個容器運(yùn)行的進(jìn)程情況。
docker-compose unpause [SERVICE...]
恢復(fù)處于暫停狀態(tài)中的服務(wù)。
docker-compose version
打印版本信息。
Compose允許用戶通過一個docker-compose.yml模板文件(YAML 格式)來定義一組相關(guān)聯(lián)的應(yīng)用容器為一個項(xiàng)目(project)。
Compose模板文件是一個定義服務(wù)、網(wǎng)絡(luò)和卷的YAML文件。Compose模板文件默認(rèn)路徑是當(dāng)前目錄下的docker-compose.yml,可以使用.yml或.yaml作為文件擴(kuò)展名。
Docker-Compose標(biāo)準(zhǔn)模板文件應(yīng)該包含version、services、networks 三大部分,最關(guān)鍵的是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區(qū)分Version 1和Version 2(Compose 1.6.0+,Docker Engine 1.10.0+)。Version 2支持更多的指令。Version 1將來會被棄用。
image是指定服務(wù)的鏡像名稱或鏡像ID。如果鏡像在本地不存在,Compose將會嘗試?yán)$R像。
services: web: image: hello-world
服務(wù)除了可以基于指定的鏡像,還可以基于一份Dockerfile,在使用up啟動時執(zhí)行構(gòu)建任務(wù),構(gòu)建標(biāo)簽是build,可以指定Dockerfile所在文件夾的路徑。Compose將會利用Dockerfile自動構(gòu)建鏡像,然后使用鏡像啟動服務(wù)容器。build: /path/to/build/dir
也可以是相對路徑,只要上下文確定就可以讀取到Dockerfile。build: ./dir
設(shè)定上下文根目錄,然后以該目錄為準(zhǔn)指定Dockerfile。
build: context: ../ dockerfile: path/of/Dockerfile
build都是一個目錄,如果要指定Dockerfile文件需要在build標(biāo)簽的子級標(biāo)簽中使用dockerfile標(biāo)簽指定。
如果同時指定image和build兩個標(biāo)簽,那么Compose會構(gòu)建鏡像并且把鏡像命名為image值指定的名字。
context選項(xiàng)可以是Dockerfile的文件路徑,也可以是到鏈接到git倉庫的url,當(dāng)提供的值是相對路徑時,被解析為相對于撰寫文件的路徑,此目錄也是發(fā)送到Docker守護(hù)進(jìn)程的context
build: context: ./dir
使用dockerfile文件來構(gòu)建,必須指定構(gòu)建路徑
build: context: . dockerfile: Dockerfile-alternate
dockerfile指令不能跟image同時使用,否則Compose將不確定根據(jù)哪個指令來生成最終的服務(wù)鏡像。
使用command可以覆蓋容器啟動后默認(rèn)執(zhí)行的命令。command: bundle exec thin -p 3000
Compose的容器名稱格式是:<項(xiàng)目名稱><服務(wù)名稱><序號>
可以自定義項(xiàng)目名稱、服務(wù)名稱,但如果想完全控制容器的命名,可以使用標(biāo)簽指定:container_name: app
在使用Compose時,最大的好處就是少打啟動命令,但一般項(xiàng)目容器啟動的順序是有要求的,如果直接從上到下啟動容器,必然會因?yàn)槿萜饕蕾噯栴}而啟動失敗。例如在沒啟動數(shù)據(jù)庫容器的時候啟動應(yīng)用容器,應(yīng)用容器會因?yàn)檎也坏綌?shù)據(jù)庫而退出。depends_on標(biāo)簽用于解決容器的依賴、啟動先后的問題。
version: '2'services: web: build: . depends_on: - db - redis redis: image: redis db: image: postgres
上述YAML文件定義的容器會先啟動redis和db兩個服務(wù),最后才啟動web 服務(wù)。
pid: "host"
將PID模式設(shè)置為主機(jī)PID模式,跟主機(jī)系統(tǒng)共享進(jìn)程命名空間。容器使用pid標(biāo)簽將能夠訪問和操縱其他容器和宿主機(jī)的名稱空間。
ports用于映射端口的標(biāo)簽。
使用HOST:CONTAINER格式或者只是指定容器的端口,宿主機(jī)會隨機(jī)映射端口。
ports: - "3000" - "8000:8000" - "49100:22" - "127.0.0.1:8001:8001"
當(dāng)使用HOST:CONTAINER格式來映射端口時,如果使用的容器端口小于60可能會得到錯誤得結(jié)果,因?yàn)閅AML將會解析xx:yy這種數(shù)字格式為60進(jìn)制。所以建議采用字符串格式。
添加主機(jī)名的標(biāo)簽,會在/etc/hosts文件中添加一些記錄。
extra_hosts: - "somehost:162.242.195.82" - "otherhost:50.31.209.229"
啟動后查看容器內(nèi)部hosts:
162.242.195.82 somehost50.31.209.229 otherhost
掛載一個目錄或者一個已存在的數(shù)據(jù)卷容器,可以直接使用 [HOST:CONTAINER]格式,或者使用[HOST:CONTAINER:ro]格式,后者對于容器來說,數(shù)據(jù)卷是只讀的,可以有效保護(hù)宿主機(jī)的文件系統(tǒng)。
Compose的數(shù)據(jù)卷指定路徑可以是相對路徑,使用 . 或者 .. 來指定相對目錄。
數(shù)據(jù)卷的格式可以是下面多種形式:
volumes: // 只是指定一個路徑,Docker 會自動在創(chuàng)建一個數(shù)據(jù)卷(這個路徑是容器內(nèi)部的)。 - /var/lib/mysql // 使用絕對路徑掛載數(shù)據(jù)卷 - /opt/data:/var/lib/mysql // 以 Compose 配置文件為中心的相對路徑作為數(shù)據(jù)卷掛載到容器。 - ./cache:/tmp/cache // 使用用戶的相對路徑(~/ 表示的目錄是 /home/<用戶目錄>/ 或者 /root/)。 - ~/configs:/etc/configs/:ro // 已經(jīng)存在的命名的數(shù)據(jù)卷。 - datavolume:/var/lib/mysql
如果不使用宿主機(jī)的路徑,可以指定一個volume_driver。volume_driver: mydriver
從另一個服務(wù)或容器掛載其數(shù)據(jù)卷:
volumes_from: - service_name - container_name
自定義DNS服務(wù)器??梢允且粋€值,也可以是一個列表。
dns:8.8.8.8dns: - 8.8.8.8 - 9.9.9.9
配置DNS搜索域??梢允且粋€值,也可以是一個列表。
dns_search:example.comdns_search: - domain1.example.com - domain2.example.com
在Dockerfile中有一個指令叫做ENTRYPOINT指令,用于指定接入點(diǎn)。
在docker-compose.yml中可以定義接入點(diǎn),覆蓋Dockerfile中的定義:entrypoint: /code/entrypoint.sh
在docker-compose.yml中可以定義一個專門存放變量的文件。
如果通過docker-compose -f FILE指定配置文件,則env_file中路徑會使用配置文件路徑。
如果有變量名稱與environment指令沖突,則以后者為準(zhǔn)。格式如下:env_file: .env
或者根據(jù)docker-compose.yml設(shè)置多個:
env_file: - ./common.env - ./apps/web.env - /opt/secrets.env
如果在配置文件中有build操作,變量并不會進(jìn)入構(gòu)建過程中。
增加指定容器的內(nèi)核能力(capacity)。
讓容器具有所有能力可以指定:
cap_add: - ALL
去掉指定容器的內(nèi)核能力(capacity)。
去掉NET_ADMIN能力可以指定:
cap_drop: - NET_ADMIN
創(chuàng)建了一個cgroup組名稱為cgroups_1:cgroup_parent: cgroups_1
指定設(shè)備映射關(guān)系,例如:
devices: - "/dev/ttyUSB1:/dev/ttyUSB0"
暴露端口,但不映射到宿主機(jī),只允許能被連接的服務(wù)訪問。僅可以指定內(nèi)部端口為參數(shù),如下所示:
expose: - "3000" - "8000"
基于其它模板文件進(jìn)行擴(kuò)展。例如,對于webapp服務(wù)定義了一個基礎(chǔ)模板文件為common.yml:
# common.ymlwebapp: build: ./webapp environment: - DEBUG=false - SEND_EMAILS=false
再編寫一個新的development.yml文件,使用common.yml中的webapp服務(wù)進(jìn)行擴(kuò)展:
# development.ymlweb: extends: file: common.yml service: webapp ports: - "8000:8000" links: - db environment: - DEBUG=truedb: image: mysql
后者會自動繼承common.yml中的webapp服務(wù)及環(huán)境變量定義。
extends限制如下:
A、要避免出現(xiàn)循環(huán)依賴
B、extends不會繼承l(wèi)inks和volumes_from中定義的容器和數(shù)據(jù)卷資源
推薦在基礎(chǔ)模板中只定義一些可以共享的鏡像和環(huán)境變量,在擴(kuò)展模板中具體指定應(yīng)用變量、鏈接、數(shù)據(jù)卷等信息
鏈接到docker-compose.yml外部的容器,可以是非Compose管理的外部容器。
external_links: - redis_1 - project_db_1:mysql - project_db_1:postgresql
為容器添加Docker元數(shù)據(jù)(metadata)信息。例如,可以為容器添加輔助說明信息:
labels: com.startupteam.description: "webapp for a strtup team"
鏈接到其它服務(wù)中的容器。使用服務(wù)名稱(同時作為別名),或者“服務(wù)名稱:服務(wù)別名”(如 SERVICE:ALIAS),例如:
links: - db - db:database - redis
使用別名將會自動在服務(wù)容器中的/etc/hosts里創(chuàng)建。例如:
172.17.2.186 db172.17.2.186 database172.17.2.187 redis
指定日志驅(qū)動類型。目前支持三種日志驅(qū)動類型:
log_driver: "json-file"log_driver: "syslog"log_driver: "none"
日志驅(qū)動的相關(guān)參數(shù)。例如:
log_driver: "syslog"log_opt: syslog-address: "tcp://192.168.0.42:123"
設(shè)置網(wǎng)絡(luò)模式。
net: "bridge"net: "none"net: "host"
指定容器模板標(biāo)簽(label)機(jī)制的默認(rèn)屬性(用戶、角色、類型、級別等)。例如,配置標(biāo)簽的用戶名和角色名:
security_opt: - label:user:USER - label:role:ROLE
環(huán)境變量可以用來配置Docker-Compose的行為。
COMPOSE_PROJECT_NAME
設(shè)置通過Compose啟動的每一個容器前添加的項(xiàng)目名稱,默認(rèn)是當(dāng)前工作目錄的名字。
COMPOSE_FILE
設(shè)置docker-compose.yml模板文件的路徑。默認(rèn)路徑是當(dāng)前工作目錄。
DOCKER_HOST
設(shè)置Docker daemon的地址。默認(rèn)使用unix:///var/run/docker.sock。 DOCKER_TLS_VERIFY
如果設(shè)置不為空,則與Docker daemon交互通過TLS進(jìn)行。
DOCKER_CERT_PATH
配置TLS通信所需要的驗(yàn)證(ca.pem、cert.pem 和 key.pem)文件的路徑,默認(rèn)是 ~/.docker 。
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: - pronetworks: dev: driver: bridge pro: driver: bridge#volumes:
docker-compose.yaml文件指定了三個web服務(wù)。
創(chuàng)建一個webapp目錄,將docker-compose.yaml文件拷貝到webapp目錄下,使用docker-compose啟動應(yīng)用。docker-compose up -d
通過瀏覽器訪問web1,web2,web3服務(wù):
http://127.0.0.1:6061
http://127.0.0.1:6062
http://127.0.0.1:6063