1、Docker-compose簡介
1.1、ocker-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來進行編排管理。
1.2、Docker-compose 安裝
安裝
# ubuntu 命令
apt install python-pip
pip install docker-compose# centos使用下面的命令安裝pip
yum -y install python-pip
查看安裝的版本
# docker-compose --version
docker-compose version 1.24.0, build 0aa5906
1.3、Docker-compose卸載
pip uninstall docker-compose
2、Docker-compose常用命令
2.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.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文件中定義的容器
2.3、docker-compose ps
列出項目中所有的容器
docker-compose ps [options] [SERVICE...]
2.4、docker-compose stop
停止容器
docker-compose stop [options] [SERVICE...]選項包括-t, –timeout TIMEOUT 停止容器時候的超時(默認為10秒)docker-compose stop
# 停止正在運行的容器,可以通過docker-compose start 再次啟動
2.5、docker-compose -h
查看幫助
docker-compose -h
2.6、docker-compose down
停止和刪除容器、網絡、卷、鏡像。
docker-compose down [options]選項包括:–rmi type,刪除鏡像,類型必須是:all,刪除compose文件中定義的所有鏡像;local,刪除鏡像名為空的鏡像-v, –volumes,刪除已經在compose文件中定義的和匿名的附在容器上的數據卷–remove-orphans,刪除服務中沒有在compose中定義的容器docker-compose down
# 停用移除所有容器以及網絡相關
2.7、docker-compose logs
docker-compose logs [options] [SERVICE...]
# 查看服務容器的輸出。默認情況下,docker-compose將對不同的服務輸出使用不同的顏色來區分。可以通過–no-color來關閉顏色。docker-compose logs
# 查看服務容器的輸出 -f 跟蹤日志輸出
2.8、docker-compose bulid
構建(重新構建)項目中的服務容器。
服務容器一旦構建后,將會帶上一個標記名。可以隨時在項目目錄下運行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變量
2.9、docker-compose pull
拉取服務依賴的鏡像。
docker-compose pull [options] [SERVICE...]選項包括:–ignore-pull-failures,忽略拉取鏡像過程中的錯誤–parallel,多個鏡像同時拉取–quiet,拉取鏡像過程中不打印進度信息docker-compose pull
# 拉取服務依賴的鏡像
2.10、docker-compose restart
重啟項目中的服務。
docker-compose restart [options] [SERVICE...]選項包括:-t, –timeout TIMEOUT,指定重啟前停止容器的超時(默認為10秒)docker-compose restart
# 重啟項目中的服務
2.11、docker-compose rm
刪除所有(停止狀態的)服務容器。
docker-compose rm [options] [SERVICE...]選項包括:–f, –force,強制直接刪除,包括非停止狀態的容器-v,刪除容器所掛載的數據卷docker-compose rm
# 刪除所有(停止狀態的)服務容器。推薦先執行docker-compose stop命令來停止容器。
2.12、docker-compose start
啟動已經存在的服務容器。
docker-compose start [SERVICE...]
2.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命令。
2.14、docker-compose scale
設置指定服務運行的容器個數。通過service=num的參數來設置數量
docker-compose scale web=3 db=2
2.15、docker-compose pause
暫停一個服務容器
docker-compose pause [SERVICE...]
2.16、docker-compose kill
通過發送SIGKILL信號來強制停止服務容器。
docker-compose kill [options] [SERVICE...]# 支持通過-s參數來指定發送的信號,例如通過如下指令發送SIGINT信號:
docker-compose kill -s SIGINT
2.17、docker-compose config
驗證并查看compose文件配置。
docker-compose config [options]選項包括:–resolve-image-digests 將鏡像標簽標記為摘要-q, –quiet 只驗證配置,不輸出。 當配置正確時,不輸出任何內容,當文件配置錯誤,輸出錯誤信息–services 打印服務名,一行一個–volumes 打印數據卷名,一行一個
2.18、docker-compose create
為服務創建容器。
docker-compose create [options] [SERVICE...]選項包括:–force-recreate:重新創建容器,即使配置和鏡像沒有改變,不兼容–no-recreate參數–no-recreate:如果容器已經存在,不需要重新創建,不兼容–force-recreate參數–no-build:不創建鏡像,即使缺失–build:創建容器前 ,生成鏡像
2.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服務中包含多個容器
2.20、docker-compose port
顯示某個容器端口所映射的公共端口。
docker-compose port [options] SERVICE PRIVATE_PORT選項包括:–protocol=proto,指定端口協議,TCP(默認值)或者UDP–index=index,如果同意服務存在多個容器,指定命令對象容器的序號(默認為1)
2.21、docker-compose push
推送服務依的鏡像。
docker-compose push [options] [SERVICE...]選項包括:–ignore-push-failures 忽略推送鏡像過程中的錯誤
2.22、docker-compose uppause
恢復處于暫停狀態中的服務。
docker-compose unpause [SERVICE...]
3、Docker-compose模板文件
3.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-worldports:- 8080networks:- front-tier- back-tierredis:image: redislinks:- webnetworks:- back-tierlb:image: dockercloud/haproxyports:- 80:80links:- webnetworks:- front-tier- back-tiervolumes:- /var/run/docker.sock:/var/run/docker.sock networks:front-tier:driver: bridgeback-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將來會被棄用。
3.2、image
image是指定服務的鏡像名稱或鏡像ID。如果鏡像在本地不存在,Compose將會嘗試拉取鏡像。
services: web: image: hello-world
3.3、build
服務除了可以基于指定的鏡像,還可以基于一份Dockerfile,在使用up啟動時執行構建任務,構建標簽是build,可以指定Dockerfile所在文件夾的路徑。Compose將會利用Dockerfile自動構建鏡像,然后使用鏡像啟動服務容器。
services:web:build: /path/to/build/dir
也可以是相對路徑,只要上下文確定就可以讀取到Dockerfile。
services:web:build: ./dir
設定上下文根目錄,然后以該目錄為準指定Dockerfile。
services:web:build:context: ../dockerfile: path/of/Dockerfile
build都是一個目錄,如果要指定Dockerfile文件需要在build標簽的子級標簽中使用dockerfile標簽指定。
如果同時指定image和build兩個標簽,那么Compose會構建鏡像并且把鏡像命名為image值指定的名字。
3.4、context
context選項可以是Dockerfile的文件路徑,也可以是到鏈接到git倉庫的url,當提供的值是相對路徑時,被解析為相對于撰寫文件的路徑,此目錄也是發送到Docker守護進程的context
services:web:build:context: ./dir
3.5、dockerfile
使用dockerfile文件來構建,必須指定構建路徑
services:web:build:context: .dockerfile: Dockerfile-alternate
3.6、commond
使用command可以覆蓋容器啟動后默認執行的命令。
services:web:build:context: .dockerfile: Dockerfile-alternatecommand: bundle exec thin -p 3000
3.7、container_name
Compose的容器名稱格式是:<項目名稱><服務名稱><序號>
可以自定義項目名稱、服務名稱,但如果想完全控制容器的命名,可以使用標簽指定:
container_name: app
3.8、depends_on 依賴
在使用Compose時,最大的好處就是少打啟動命令,但一般項目容器啟動的順序是有要求的,如果直接從上到下啟動容器,必然會因為容器依賴問題而啟動失敗。例如在沒啟動數據庫容器的時候啟動應用容器,應用容器會因為找不到數據庫而退出。depends_on標簽用于解決容器的依賴、啟動先后的問題
version: '2'
services:web:build: .depends_on:- db- redisredis:image: redisdb:image: postgres
上述YAML文件定義的容器會先啟動redis和db兩個服務,最后才啟動web 服務。
3.9、PID
將PID模式設置為主機PID模式,跟主機系統共享進程命名空間。容器使用pid標簽將能夠訪問和操縱其他容器和宿主機的名稱空間。
services:web:pid: "host"
3.10、ports
ports用于映射端口的標簽。
使用HOST:CONTAINER格式或者只是指定容器的端口,宿主機會隨機映射端口。
services:web:ports:- "3000"- "8000:8000"- "49100:22"- "127.0.0.1:8001:8001"
當使用HOST:CONTAINER格式來映射端口時,如果使用的容器端口小于60可能會得到錯誤得結果,因為YAML將會解析xx:yy這種數字格式為60進制。所以建議采用字符串格式。
3.11、extra_hosts
添加主機名的標簽,會在/etc/hosts文件中添加一些記錄。
services:web:extra_hosts:- "somehost:162.242.195.82"- "otherhost:50.31.209.229"
啟動后查看容器內部hosts:
162.242.195.82 somehost
50.31.209.229 otherhost
3.12、volumes
掛載一個目錄或者一個已存在的數據卷容器,可以直接使用 [HOST:CONTAINER]格式,或者使用[HOST:CONTAINER:ro]格式,后者對于容器來說,數據卷是只讀的,可以有效保護宿主機的文件系統。
Compose的數據卷指定路徑可以是相對路徑,使用 . 或者 … 來指定相對目錄。
數據卷的格式可以是下面多種形式
services:web: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
3.13、volumes_from
從另一個服務或容器掛載其數據卷:
services:web:volumes_from:- service_name - container_name
3.14、dns
自定義DNS服務器。可以是一個值,也可以是一個列表。
services:web:dns:8.8.8.8dns:- 8.8.8.8 - 9.9.9.9
3.15、expose
暴露端口,但不映射到宿主機,只允許能被連接的服務訪問。僅可以指定內部端口為參數,如下所示:
services:web:expose:- "3000"- "8000"
3.16、links
鏈接到其它服務中的容器。使用服務名稱(同時作為別名),或者“服務名稱:服務別名”(如 SERVICE:ALIAS),例如:
services:web:links:- db- db:database- redis
3.17、net
設置網絡模式。
services:web:net: "bridge"net: "none"net: "host"
3.18、deploy
部署相關參數。
services:web:deploy:resources:limits:memory: 12288mreservations:memory: 8192mrestart_policy:condition: on-failure
3.19、environment
environment。
services:web:environment:- API_BASE_URL=http://localhost:8081
4、dependency-track 示例
4.1、Docker-compose 模板
docker-compose.yml
version: '3.7'#####################################################
# This Docker Compose file contains two services
# Dependency-Track API Server
# Dependency-Track FrontEnd
#####################################################volumes:dependency-track:services:dtrack-apiserver:image: dependencytrack/apiserver# environment:# The Dependency-Track container can be configured using any of the# available configuration properties defined in:# https://docs.dependencytrack.org/getting-started/configuration/# All properties are upper case with periods replaced by underscores.## Database Properties# - ALPINE_DATABASE_MODE=external# - ALPINE_DATABASE_URL=jdbc:postgresql://postgres10:5432/dtrack# - ALPINE_DATABASE_DRIVER=org.postgresql.Driver# - ALPINE_DATABASE_USERNAME=dtrack# - ALPINE_DATABASE_PASSWORD=changeme# - ALPINE_DATABASE_POOL_ENABLED=true# - ALPINE_DATABASE_POOL_MAX_SIZE=10# - ALPINE_DATABASE_POOL_IDLE_TIMEOUT=600000# - ALPINE_DATABASE_POOL_MAX_LIFETIME=600000## Optional LDAP Properties# - ALPINE_LDAP_ENABLED=true# - ALPINE_LDAP_SERVER_URL=ldap://ldap.example.com:389# - ALPINE_LDAP_BASEDN=dc=example,dc=com# - ALPINE_LDAP_SECURITY_AUTH=simple# - ALPINE_LDAP_BIND_USERNAME=# - ALPINE_LDAP_BIND_PASSWORD=# - ALPINE_LDAP_AUTH_USERNAME_FORMAT=%s@example.com# - ALPINE_LDAP_ATTRIBUTE_NAME=userPrincipalName# - ALPINE_LDAP_ATTRIBUTE_MAIL=mail# - ALPINE_LDAP_GROUPS_FILTER=(&(objectClass=group)(objectCategory=Group))# - ALPINE_LDAP_USER_GROUPS_FILTER=(member:1.2.840.113556.1.4.1941:={USER_DN})# - ALPINE_LDAP_GROUPS_SEARCH_FILTER=(&(objectClass=group)(objectCategory=Group)(cn=*{SEARCH_TERM}*))# - ALPINE_LDAP_USERS_SEARCH_FILTER=(&(objectClass=user)(objectCategory=Person)(cn=*{SEARCH_TERM}*))# - ALPINE_LDAP_USER_PROVISIONING=false# - ALPINE_LDAP_TEAM_SYNCHRONIZATION=false## Optional OpenID Connect (OIDC) Properties# - ALPINE_OIDC_ENABLED=true# - ALPINE_OIDC_ISSUER=https://auth.example.com/auth/realms/example# - ALPINE_OIDC_USERNAME_CLAIM=preferred_username# - ALPINE_OIDC_TEAMS_CLAIM=groups# - ALPINE_OIDC_USER_PROVISIONING=true# - ALPINE_OIDC_TEAM_SYNCHRONIZATION=true## Optional HTTP Proxy Settings# - ALPINE_HTTP_PROXY_ADDRESS=proxy.example.com# - ALPINE_HTTP_PROXY_PORT=8888# - ALPINE_HTTP_PROXY_USERNAME=# - ALPINE_HTTP_PROXY_PASSWORD=# - ALPINE_NO_PROXY=## Optional Cross-Origin Resource Sharing (CORS) Headers# - ALPINE_CORS_ENABLED=true# - ALPINE_CORS_ALLOW_ORIGIN=*# - ALPINE_CORS_ALLOW_METHODS=GET POST PUT DELETE OPTIONS# - ALPINE_CORS_ALLOW_HEADERS=Origin, Content-Type, Authorization, X-Requested-With, Content-Length, Accept, Origin, X-Api-Key, X-Total-Count, *# - ALPINE_CORS_EXPOSE_HEADERS=Origin, Content-Type, Authorization, X-Requested-With, Content-Length, Accept, Origin, X-Api-Key, X-Total-Count# - ALPINE_CORS_ALLOW_CREDENTIALS=true# - ALPINE_CORS_MAX_AGE=3600deploy:resources:limits:memory: 12288mreservations:memory: 8192mrestart_policy:condition: on-failureports:- '8081:8080'volumes:- 'dependency-track:/data'restart: unless-stoppeddtrack-frontend:image: dependencytrack/frontenddepends_on:- dtrack-apiserverenvironment:- API_BASE_URL=http://localhost:8081# - "OIDC_ISSUER="# - "OIDC_CLIENT_ID="# - "OIDC_SCOPE="# - "OIDC_FLOW="# volumes:# - "/host/path/to/config.json:/app/static/config.json"ports:- "8080:80"restart: unless-stopped
docker-compose.yml文件指定了3個web服務
4.2、啟動應用
創建一個webapp目錄,將docker-compose.yaml文件拷貝到webapp目錄下,使用docker-compose啟動應用。
docker-compose up -d
4.3、服務訪問
通過瀏覽器訪問