Docker Compose
Compose 簡介
Compose 是用于定義和運行多容器 Docker 應(yīng)用程序的工具。通過 Compose,您可以使用 YML 文件來配置應(yīng)用程序需要的所有服務(wù)。然后,使用一個命令,就可以從 YML 文件配置中創(chuàng)建并啟動所有服務(wù)。
如果你還不了解 YML 文件配置,可以先閱讀?YAML 入門教程。
Compose 使用的三個步驟:
- 使用 Dockerfile 定義應(yīng)用程序的環(huán)境。
- 使用 docker-compose.yml 定義構(gòu)成應(yīng)用程序的服務(wù),這樣它們可以在隔離環(huán)境中一起運行。
- 最后,執(zhí)行 docker-compose up 命令來啟動并運行整個應(yīng)用程序。
docker-compose.yml 的配置案例如下(配置參數(shù)參考下文):
實例
version:?'3'
services:
web:
build:?.
ports:
-?"5000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image:?redis
volumes:
logvolume01:?{}
Compose 安裝
Linux
Linux 上我們可以從 Github 上下載它的二進(jìn)制包來使用,最新發(fā)行的版本地址:https://github.com/docker/compose/releases。
運行以下命令以下載 Docker Compose 的當(dāng)前穩(wěn)定版本:
$ 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,請?zhí)鎿Q 1.24.1。
將可執(zhí)行權(quán)限應(yīng)用于二進(jìn)制文件:
$ sudo chmod +x /usr/local/bin/docker-compose
創(chuàng)建軟鏈:
$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
測試是否安裝成功:
$ docker-compose --version cker-compose version 1.24.1, build 4667896b
注意: 對于 alpine,需要以下依賴包: py-pip,python-dev,libffi-dev,openssl-dev,gcc,libc-dev,和 make。
macOS
Mac 的 Docker 桌面版和 Docker Toolbox 已經(jīng)包括 Compose 和其他 Docker 應(yīng)用程序,因此 Mac 用戶不需要單獨安裝 Compose。Docker 安裝說明可以參閱?MacOS Docker 安裝。
windows PC
Windows 的 Docker 桌面版和 Docker Toolbox 已經(jīng)包括 Compose 和其他 Docker 應(yīng)用程序,因此 Windows 用戶不需要單獨安裝 Compose。Docker 安裝說明可以參閱?Windows Docker 安裝。
使用
1、準(zhǔn)備
創(chuàng)建一個測試目錄:
$ mkdir composetest
$ cd composetest
在測試目錄中創(chuàng)建一個名為 app.py 的文件,并復(fù)制粘貼以下內(nèi)容:
composetest/app.py 文件代碼
import?time
import?redis
from?flask?import?Flask
app?=?Flask(__name__)
cache?=?redis.Redis(host='redis',?port=6379)
def?get_hit_count():
retries?=?5
while?True:
try:
return?cache.incr('hits')
except?redis.exceptions.ConnectionError?as?exc:
if?retries?==?0:
raise?exc
retries -=?1
time.sleep(0.5)
@app.route('/')
def?hello():
count?=?get_hit_count()
return?'Hello World! I have been seen {} times.n'.format(count)
在此示例中,redis 是應(yīng)用程序網(wǎng)絡(luò)上的 redis 容器的主機名,該主機使用的端口為 6379。
在 composetest 目錄中創(chuàng)建另一個名為 requirements.txt 的文件,內(nèi)容如下:
flask
redis
2、創(chuàng)建 Dockerfile 文件
在 composetest 目錄中,創(chuàng)建一個名為的文件 Dockerfile,內(nèi)容如下:
FROM python:3.7-alpine WORKDIR /code ENV FLASK_APP app.py ENV FLASK_RUN_HOST 0.0.0.0 RUN apk add --no-cache gcc musl-dev linux-headers COPY requirements.txt requirements.txt RUN pip install -r requirements.txt COPY . . CMD ["flask", "run"]
Dockerfile 內(nèi)容解釋:
- FROM python:3.7-alpine: 從 Python 3.7 映像開始構(gòu)建鏡像。
- WORKDIR /code: 將工作目錄設(shè)置為 /code。
-
ENV FLASK_APP app.py ENV FLASK_RUN_HOST 0.0.0.0
設(shè)置 flask 命令使用的環(huán)境變量。
- RUN apk add --no-cache gcc musl-dev linux-headers: 安裝 gcc,以便諸如 MarkupSafe 和 SQLAlchemy 之類的 Python 包可以編譯加速。
COPY requirements.txt requirements.txtRUN pip install -r requirements.txt
復(fù)制 requirements.txt 并安裝 Python 依賴項。
- COPY . .: 將 . 項目中的當(dāng)前目錄復(fù)制到 . 鏡像中的工作目錄。
- CMD ["flask", "run"]: 容器提供默認(rèn)的執(zhí)行命令為:flask run。
3、創(chuàng)建 docker-compose.yml
在測試目錄中創(chuàng)建一個名為 docker-compose.yml 的文件,然后粘貼以下內(nèi)容:
docker-compose.yml 配置文件
version:?'3'
services:
web:
build:?.
ports:
-?"5000:5000"
redis:
image:?"redis:alpine"
該 Compose 文件定義了兩個服務(wù):web 和 redis。
- web:該 web 服務(wù)使用從 Dockerfile 當(dāng)前目錄中構(gòu)建的鏡像。然后,它將容器和主機綁定到暴露的端口 5000。此示例服務(wù)使用 Flask Web 服務(wù)器的默認(rèn)端口 5000 。
- redis:該 redis 服務(wù)使用 Docker Hub 的公共 Redis 映像。
4、使用 Compose 命令構(gòu)建和運行您的應(yīng)用
在測試目錄中,執(zhí)行以下命令來啟動應(yīng)用程序:
docker-compose up
如果你想在后臺執(zhí)行該服務(wù)可以加上?-d?參數(shù):
docker-compose up -d
yml 配置指令參考
version
指定本 yml 依從的 compose 哪個版本制定的。
build
指定為構(gòu)建鏡像上下文路徑:
例如 webapp 服務(wù),指定為從上下文路徑 ./dir/Dockerfile 所構(gòu)建的鏡像:
version: "3.7" services: webapp: build: ./dir
或者,作為具有在上下文指定的路徑的對象,以及可選的 Dockerfile 和 args:
version: "3.7" services: webapp: build: context: ./dir dockerfile: Dockerfile-alternate args: buildno: 1 labels: - "com.example.description=Accounting webapp" - "com.example.department=Finance" - "com.example.label-with-empty-value" target: prod
- context:上下文路徑。
- dockerfile:指定構(gòu)建鏡像的 Dockerfile 文件名。
- args:添加構(gòu)建參數(shù),這是只能在構(gòu)建過程中訪問的環(huán)境變量。
- labels:設(shè)置構(gòu)建鏡像的標(biāo)簽。
- target:多層構(gòu)建,可以指定構(gòu)建哪一層。
cap_add,cap_drop
添加或刪除容器擁有的宿主機的內(nèi)核功能。
cap_add: - ALL # 開啟全部權(quán)限 cap_drop: - SYS_PTRACE # 關(guān)閉 ptrace權(quán)限
cgroup_parent
為容器指定父 cgroup 組,意味著將繼承該組的資源限制。
cgroup_parent: m-executor-abcd
command
覆蓋容器啟動的默認(rèn)命令。
command: ["bundle", "exec", "thin", "-p", "3000"]
container_name
指定自定義容器名稱,而不是生成的默認(rèn)名稱。
container_name: my-web-container
depends_on
設(shè)置依賴關(guān)系。
- docker-compose up :以依賴性順序啟動服務(wù)。在以下示例中,先啟動 db 和 redis ,才會啟動 web。
- docker-compose up SERVICE :自動包含 SERVICE 的依賴項。在以下示例中,docker-compose up web 還將創(chuàng)建并啟動 db 和 redis。
- docker-compose stop :按依賴關(guān)系順序停止服務(wù)。在以下示例中,web 在 db 和 redis 之前停止。
version: "3.7" services: web: build: . depends_on: - db - redis redis: image: redis db: image: postgres
注意:web 服務(wù)不會等待 redis db 完全啟動 之后才啟動。
deploy
指定與服務(wù)的部署和運行有關(guān)的配置。只在 swarm 模式下才會有用。
version: "3.7" services: redis: image: redis:alpine deploy: mode:replicated replicas: 6 endpoint_mode: dnsrr labels: description: "This redis service label" resources: limits: cpus: '0.50' memory: 50M reservations: cpus: '0.25' memory: 20M restart_policy: condition: on-failure delay: 5s max_attempts: 3 window: 120s
可以選參數(shù):
endpoint_mode:訪問集群服務(wù)的方式。
endpoint_mode: vip # Docker 集群服務(wù)一個對外的虛擬 ip。所有的請求都會通過這個虛擬 ip 到達(dá)集群服務(wù)內(nèi)部的機器。 endpoint_mode: dnsrr # DNS 輪詢(DNSRR)。所有的請求會自動輪詢獲取到集群 ip 列表中的一個 ip 地址。
labels:在服務(wù)上設(shè)置標(biāo)簽。可以用容器上的 labels(跟 deploy 同級的配置) 覆蓋 deploy 下的 labels。
mode:指定服務(wù)提供的模式。
- replicated:復(fù)制服務(wù),復(fù)制指定服務(wù)到集群的機器上。
- global:全局服務(wù),服務(wù)將部署至集群的每個節(jié)點。
- 圖解:下圖中黃色的方塊是 replicated 模式的運行情況,灰色方塊是 global 模式的運行情況。
replicas:mode?為 replicated 時,需要使用此參數(shù)配置具體運行的節(jié)點數(shù)量。
resources:配置服務(wù)器資源使用的限制,例如上例子,配置 redis 集群運行需要的 cpu 的百分比 和 內(nèi)存的占用。避免占用資源過高出現(xiàn)異常。
restart_policy:配置如何在退出容器時重新啟動容器。
- condition:可選 none,on-failure 或者 any(默認(rèn)值:any)。
- delay:設(shè)置多久之后重啟(默認(rèn)值:0)。
- max_attempts:嘗試重新啟動容器的次數(shù),超出次數(shù),則不再嘗試(默認(rèn)值:一直重試)。
- window:設(shè)置容器重啟超時時間(默認(rèn)值:0)。
rollback_config:配置在更新失敗的情況下應(yīng)如何回滾服務(wù)。
- parallelism:一次要回滾的容器數(shù)。如果設(shè)置為0,則所有容器將同時回滾。
- delay:每個容器組回滾之間等待的時間(默認(rèn)為0s)。
- failure_action:如果回滾失敗,該怎么辦。其中一個 continue 或者 pause(默認(rèn)pause)。
- monitor:每個容器更新后,持續(xù)觀察是否失敗了的時間 (ns|us|ms|s|m|h)(默認(rèn)為0s)。
- max_failure_ratio:在回滾期間可以容忍的故障率(默認(rèn)為0)。
- order:回滾期間的操作順序。其中一個 stop-first(串行回滾),或者 start-first(并行回滾)(默認(rèn) stop-first )。
update_config:配置應(yīng)如何更新服務(wù),對于配置滾動更新很有用。
- parallelism:一次更新的容器數(shù)。
- delay:在更新一組容器之間等待的時間。
- failure_action:如果更新失敗,該怎么辦。其中一個 continue,rollback 或者pause (默認(rèn):pause)。
- monitor:每個容器更新后,持續(xù)觀察是否失敗了的時間 (ns|us|ms|s|m|h)(默認(rèn)為0s)。
- max_failure_ratio:在更新過程中可以容忍的故障率。
- order:回滾期間的操作順序。其中一個 stop-first(串行回滾),或者 start-first(并行回滾)(默認(rèn)stop-first)。
注:僅支持 V3.4 及更高版本。
devices
指定設(shè)備映射列表。
devices: - "/dev/ttyUSB0:/dev/ttyUSB0"
dns
自定義 DNS 服務(wù)器,可以是單個值或列表的多個值。
dns: 8.8.8.8 dns: - 8.8.8.8 - 9.9.9.9
dns_search
自定義 DNS 搜索域。可以是單個值或列表。
dns_search: example.com dns_search: - dc1.example.com - dc2.example.com
entrypoint
覆蓋容器默認(rèn)的 entrypoint。
entrypoint: /code/.sh
也可以是以下格式:
entrypoint: - php - -d - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so - -d - memory_limit=-1 - vendor/bin/phpunit
env_file
從文件添加環(huán)境變量。可以是單個值或列表的多個值。
env_file: .env
也可以是列表格式:
env_file: - ./common.env - ./apps/web.env - /opt/secrets.env
environment
添加環(huán)境變量。您可以使用數(shù)組或字典、任何布爾值,布爾值需要用引號引起來,以確保 YML 解析器不會將其轉(zhuǎn)換為 True 或 False。
environment: RACK_ENV: development SHOW: 'true'
expose
暴露端口,但不映射到宿主機,只被連接的服務(wù)訪問。
僅可以指定內(nèi)部端口為參數(shù):
expose: - "3000" - "8000"
extra_hosts
添加主機名映射。類似 docker client --add-host。
extra_hosts: - "somehost:162.242.195.82" - "otherhost:50.31.209.229"
以上會在此服務(wù)的內(nèi)部容器中 /etc/hosts 創(chuàng)建一個具有 ip 地址和主機名的映射關(guān)系:
162.242.195.82 somehost 50.31.209.229 otherhost
healthcheck
用于檢測 docker 服務(wù)是否健康運行。
healthcheck: test: ["CMD", "curl", "-f", "http://localhost"] # 設(shè)置檢測程序 interval: 1m30s # 設(shè)置檢測間隔 timeout: 10s # 設(shè)置檢測超時時間 retries: 3 # 設(shè)置重試次數(shù) start_period: 40s # 啟動后,多少秒開始啟動檢測程序
image
指定容器運行的鏡像。以下格式都可以:
image: redis image: ubuntu:14.04 image: tutum/influxdb image: example-registry.com:4000/postgresql image: a4bc65fd # 鏡像id
logging
服務(wù)的日志記錄配置。
driver:指定服務(wù)容器的日志記錄驅(qū)動程序,默認(rèn)值為json-file。有以下三個選項
driver: "json-file" driver: "syslog" driver: "none"
僅在 json-file 驅(qū)動程序下,可以使用以下參數(shù),限制日志得數(shù)量和大小。
logging: driver: json-file options: max-size: "200k" # 單個文件大小為200k max-file: "10" # 最多10個文件
當(dāng)達(dá)到文件限制上限,會自動刪除舊得文件。
syslog 驅(qū)動程序下,可以使用 syslog-address 指定日志接收地址。
logging: driver: syslog options: syslog-address: "tcp://192.168.0.42:123"
network_mode
設(shè)置網(wǎng)絡(luò)模式。
network_mode: "bridge" network_mode: "host" network_mode: "none" network_mode: "service:[service name]" network_mode: "container:[container name/id]"
networks
配置容器連接的網(wǎng)絡(luò),引用頂級 networks 下的條目 。
services: some-service: networks: some-network: aliases: - alias1 other-network: aliases: - alias2 networks: some-network: # Use a custom driver driver: custom-driver-1 other-network: # Use a custom driver which takes special options driver: custom-driver-2
aliases?:同一網(wǎng)絡(luò)上的其他容器可以使用服務(wù)名稱或此別名來連接到對應(yīng)容器的服務(wù)。
restart
- no:是默認(rèn)的重啟策略,在任何情況下都不會重啟容器。
- always:容器總是重新啟動。
- on-failure:在容器非正常退出時(退出狀態(tài)非0),才會重啟容器。
- unless-stopped:在容器退出時總是重啟容器,但是不考慮在Docker守護(hù)進(jìn)程啟動時就已經(jīng)停止了的容器
restart: "no" restart: always restart: on-failure restart: unless-stopped
注:swarm 集群模式,請改用 restart_policy。
secrets
存儲敏感數(shù)據(jù),例如密碼:
version: "3.1" services: mysql: image: mysql environment: MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret secrets: - my_secret secrets: my_secret: file: ./my_secret.txt
security_opt
修改容器默認(rèn)的 schema 標(biāo)簽。
security-opt: - label:user:USER # 設(shè)置容器的用戶標(biāo)簽 - label:role:ROLE # 設(shè)置容器的角色標(biāo)簽 - label:type:TYPE # 設(shè)置容器的安全策略標(biāo)簽 - label:level:LEVEL # 設(shè)置容器的安全等級標(biāo)簽
stop_grace_period
指定在容器無法處理 SIGTERM (或者任何 stop_signal 的信號),等待多久后發(fā)送 SIGKILL 信號關(guān)閉容器。
stop_grace_period: 1s # 等待 1 秒 stop_grace_period: 1m30s # 等待 1 分 30 秒
默認(rèn)的等待時間是 10 秒。
stop_signal
設(shè)置停止容器的替代信號。默認(rèn)情況下使用 SIGTERM 。
以下示例,使用 SIGUSR1 替代信號 SIGTERM 來停止容器。
stop_signal: SIGUSR1
sysctls
設(shè)置容器中的內(nèi)核參數(shù),可以使用數(shù)組或字典格式。
sysctls: net.core.somaxconn: 1024 net.ipv4.tcp_syncookies: 0 sysctls: - net.core.somaxconn=1024 - net.ipv4.tcp_syncookies=0
tmpfs
在容器內(nèi)安裝一個臨時文件系統(tǒng)。可以是單個值或列表的多個值。
tmpfs: /run tmpfs: - /run - /tmp
ulimits
覆蓋容器默認(rèn)的 ulimit。
ulimits: nproc: 65535 nofile: soft: 20000 hard: 40000
volumes
將主機的數(shù)據(jù)卷或著文件掛載到容器里。
version: "3.7" services: db: image: postgres:latest volumes: - "/localhost/postgres.sock:/var/run/postgres/postgres.sock" - "/localhost/data:/var/lib/postgresql/data" 文章來源于網(wǎng)絡(luò),侵刪!