docker-compose
一,Docker-compose簡介
1,Docker-compose簡介
Docker-Compose項目是Docker官方的開源項目,負責實現對Docker容器集群的快速編排。
Docker-Compose將所管理的容器分為三層,分別是工程(project)
,服務(service)
以及容器(container)
。Docker-Compose運行目錄下的所有文件(docker-compose.yml,extends文件或環境變量文件等)組成一個工程,若無特殊指定工程名即為當前目錄名。一個工程當中可包含多個服務,每個服務中定義了容器運行的鏡像,參數,依賴。一個服務當中可包括多個容器實例,Docker-Compose並沒有解決負載均衡的問題,因此需要借助其它工具實現服務負載均衡。
Docker-Compose的工程配置文件默認為docker-compose.yml
,可通過環境變量COMPOSE_FILE或-f參數自定義配置文件,其定義了多個有依賴關系的服務及每個服務運行的容器。
使用一個Dockerfile模板文件,可以讓用戶很方便的定義一個單獨的應用容器。在工作中,經常會碰到需要多個容器相互配合來完成某項任務的情況。例如要實現一個Web項目,除了Web服務容器本身,往往還需要再加上后端的數據庫服務容器,甚至還包括負載均衡容器等。
Compose允許用戶通過一個單獨的docker-compose.yml模板文件(YAML 格式)來定義一組相關聯的應用容器為一個項目(project)。
Docker-Compose項目由Python編寫,調用Docker服務提供的API來對容器進行管理。因此,只要所操作的平台支持Docker API,就可以在其上利用Compose來進行編排管理。
2,Docker-compose的安裝
安裝環境查看
安裝-用pip安裝
pip install docker-compose
PS:centos使用命令yum -y install python-pip
安裝pip
查看安裝的版本:docker-compose --version
安裝-gitlab安裝
Linux 上我們可以從 Github 上下載它的二進制包來使用,最新發行的版本地址:https://github.com/docker/compose/releases
。
運行以下命令以下載 Docker Compose 的當前穩定版本:
$ sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
要安裝其他版本的 Compose,請替換 1.24.1
。
將可執行權限應用於二進制文件:
$ sudo chmod +x /usr/local/bin/docker-compose
創建軟鏈:
$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
測試是否安裝成功:
$ docker-compose --version
3.Docker-compose的使用步驟
-
3.1 用Dockerfile定義應用程序的環境,以便可以在任何地方復制。
-
3.2 在docker-compose.yml/yaml 中定義組成應用程序的服務,所以它們可以在一個孤立的環境中運行
-
3.3 運行 docker-compose up 和Compose啟動並運行整個應用程序。
4,Docker-compose卸載
pip uninstall 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 指定項目名稱,默認使用當前所在目錄為項目名
--verbose 輸出更多調試信息
-v,-version 打印版本並退出
--log-level LEVEL 定義日志等級(DEBUG, INFO, WARNING, ERROR, CRITICAL)
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文件中定義的容器
3,docker-compose ps
list containers
docker-compose ps [options] [SERVICE...]
列出項目中所有的容器
4,docker-compose stop
stop running containers without rm them
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
-f, --follow 跟蹤日志輸出
-t, --timestamps 顯示時間戳
--tail="all" 容器日志末尾顯示行數
8,docker-compose bulid
構建(重新構建)項目中的服務容器
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
拉取在compose文件中的服務鏡像,但不啟動容器
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...]
-d 后台運行
--name 指定name
--entrypoint CMD Override the entrypoint of the image.
-e KEY=VAL Set an environment variable (can be used multiple times)
-u, --user="" Run as specified username or uid
--no-deps Don't start linked services.
--rm Remove container after run. Ignored in detached mode.
-p, --publish=[] Publish a container's port(s) to the host
--service-ports Run command with the service's ports enabled and mapped
to the host.
-v, --volume=[] Bind mount a volume (default [])
-T Disable pseudo-tty allocation. By default `docker-compose run`
allocates a TTY.
-w, --workdir="" Working directory inside the container
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
通過發送SIGKILL信號來強制停止服務容器
docker-compose kill [options] [SERVICE...]
支持通過-s參數來指定發送的信號,例如通過如下指令發送SIGINT信號:
docker-compose kill -s SIGINT
17,docker-compose config
驗證並查看compose文件配置
docker-compose config [options]
選項包括:
–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 uppause
恢復處於暫停狀態中的服務
docker-compose unpause [SERVICE...]
三,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
兩個部分。
舉例
docker-compose.yaml
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
6,command
使用command
可以覆蓋容器啟動后默認執行的命令。
command: bash
上面是執行單個命令,有時需要執行多個命令:
/bin/bash -c 字符串方式
# command: cmd1 && cmd2 && cmd3 ...
command: /bin/bash -c sleep 1 && python /path/hello.py
/bin/bash -c 配置文件方式
# 串行執行
command:
- sh
- -c
- |
cmd1
cmd2
cmd3
# 並行執行
command:
- sh
- -c
- |
cmd1 &
cmd2 &
cmd3
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,expose
暴露端口,但不映射到宿主機,只允許能被連接的服務訪問。僅可以指定內部端口為參數,如下所示:
expose:
- "3000"
- "8000"
16,links
鏈接到其它服務中的容器。使用服務名稱(同時作為別名),或者“服務名稱:服務別名”
(如 SERVICE:ALIAS
),例如:
links:
- db
- db:database
- redis
17,net
設置網絡模式。
net: "bridge"
net: "none"
net: "host"
四,Docker-compose模板文件示例
1,Docker-compose模板文件編寫
docker-compose.yml
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
docker-compose.yml文件指定了3個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
五、yaml示例擴展
version: "3.6"
services:
xxxserver:
image: xxx/xxxserver-ubuntu16.04:1.0
hostname: xxxserver-hello
container_name: xxxserver-hello
# depends_on:
# redis:
# condition: service_started
# zodiac:
# condition: service_started
volumes:
- /opt/mypro/xxxserver/:/opt/mypro/xxxserver/
- /var/log/xxx/xxxserver/:/opt/log/xxx/xxxserver/
networks:
app_net:
ipv4_address: 172.238.238.6
restart: always
# command: /usr/local/bin/uwsgi -d --ini /opt/mypro/xxxserver/xxxapi_uwsgi.ini && /bin/bash
command: /bin/bash
tty: true
stdin_open: true
ports:
- "9443:9443"
logging:
options:
max-size: "200M"
max-file: "5"
networks:
app_net:
driver: bridge
ipam:
driver: default
config:
- subnet: 172.238.238.0/24