Compose 是用於定義和執行多容器 Docker 應用程式的工具。通過 Compose,您可以使用 YML 檔案來設定應用程式需要的所有服務。然後,使用一個命令,就可以從 YML 檔案設定中建立並啟動所有服務。
Compose 使用的三個步驟:
使用 Dockerfile 定義應用程式的環境。
使用 docker-compose.yml 定義構成應用程式的服務,這樣它們可以在隔離環境中一起執行。
最後,執行 docker-compose up 命令來啟動並執行整個應用程式。
docker-compose.yml 的設定案例如下(設定引數參考下文):
# yaml 設定範例
version: '3'
services:
web:
build: .
ports:
- "5000:5000"
volumes:
- .:/code
- logvolume01:/var/log
links:
- redis
redis:
image: redis
volumes:
logvolume01: {}
建立一個測試目錄:
mkdir composetest
cd composetest
在測試目錄中建立一個名為 app.py 的檔案,並複製貼上以下內容:
touch app.py
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 是應用程式網路上的 redis 容器的主機名,該主機使用的埠為 6379。
在 composetest 目錄中建立另一個名為 requirements.txt 的檔案,內容如下:
flask
redis
在 composetest 目錄中,建立一個名為的檔案 Dockerfile,內容如下:
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 內容解釋:
FROM python:3.7-alpine: 從 Python 3.7 映像開始構建映象。
WORKDIR /code: 將工作目錄設定為 /code。
ENV FLASK_APP app.py
ENV FLASK_RUN_HOST 0.0.0.0
設定 flask 命令使用的環境變數。
RUN apk add --no-cache gcc musl-dev linux-headers: 安裝 gcc,以便諸如 MarkupSafe 和 SQLAlchemy 之類的 Python 包可以編譯加速。
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
複製 requirements.txt 並安裝 Python 依賴項。
COPY . .: 將 . 專案中的當前目錄複製到 . 映象中的工作目錄。
CMD ["flask", "run"]: 容器提供預設的執行命令為:flask run。
在測試目錄中建立一個名為 docker-compose.yml 的檔案,然後貼上以下內容:
docker-compose.yml 組態檔
# yaml 設定
version: '3'
services:
web:
build: .
ports:
- "5000:5000"
redis:
image: "redis:alpine"
該 Compose 檔案定義了兩個服務:web 和 redis。
web:該 web 服務使用從 Dockerfile 當前目錄中構建的映象。然後,它將容器和主機繫結到暴露的埠 5000。此範例服務使用 Flask Web 伺服器的預設埠 5000 。
redis:該 redis 服務使用 Docker Hub 的公共 Redis 映像。
在測試目錄中,執行以下命令來啟動應用程式:
docker-compose up
如果你想在後臺執行該服務可以加上 -d 引數:
docker-compose up -d
指定本 yml 依從的 compose 哪個版本制定的。
指定為構建映象上下文路徑:
例如 webapp 服務,指定為從上下文路徑 ./dir/Dockerfile 所構建的映象:
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:指定構建映象的 Dockerfile 檔名。
args:新增構建引數,這是隻能在構建過程中存取的環境變數。
labels:設定構建映象的標籤。
target:多層構建,可以指定構建哪一層。
新增或刪除容器擁有的宿主機的核心功能。
cap_add:
- ALL # 開啟全部許可權
cap_drop:
- SYS_PTRACE # 關閉 ptrace許可權
為容器指定父 cgroup 組,意味著將繼承該組的資源限制。
cgroup_parent: m-executor-abcd
覆蓋容器啟動的預設命令。
command: ["bundle", "exec", "thin", "-p", "3000"]
指定自定義容器名稱,而不是生成的預設名稱。
container_name: my-web-container
設定依賴關係。
docker-compose up :以依賴性順序啟動服務。在以下範例中,先啟動 db 和 redis ,才會啟動 web。
docker-compose up SERVICE :自動包含 SERVICE 的依賴項。在以下範例中,docker-compose up web 還將建立並啟動 db 和 redis。
docker-compose stop :按依賴關係順序停止服務。在以下範例中,web 在 db 和 redis 之前停止。
version: "3.7"
services:
web:
build: .
depends_on:
- db
- redis
redis:
image: redis
db:
image: postgres
注意:web 服務不會等待 redis db 完全啟動 之後才啟動。
指定與服務的部署和執行有關的設定。只在 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
可以選引數:
endpoint_mode:存取叢集服務的方式。
endpoint_mode: vip
# Docker 叢集服務一個對外的虛擬 ip。所有的請求都會通過這個虛擬 ip 到達叢集服務內部的機器。
endpoint_mode: dnsrr
# DNS 輪詢(DNSRR)。所有的請求會自動輪詢獲取到叢集 ip 列表中的一個 ip 地址。
labels:在服務上設定標籤。可以用容器上的 labels(跟 deploy 同級的設定) 覆蓋 deploy 下的 labels。
mode:指定服務提供的模式。
replicated:複製服務,複製指定服務到叢集的機器上。
global:全域性服務,服務將部署至叢集的每個節點。
圖解:下圖中黃色的方塊是 replicated 模式的執行情況,灰色方塊是 global 模式的執行情況。
replicas:mode 為 replicated 時,需要使用此引數設定具體執行的節點數量。
resources:設定伺服器資源使用的限制,例如上例子,設定 redis 叢集執行需要的 cpu 的百分比 和 記憶體的佔用。避免佔用資源過高出現異常。
restart_policy:設定如何在退出容器時重新啟動容器。
condition:可選 none,on-failure 或者 any(預設值:any)。
delay:設定多久之後重新啟動(預設值:0)。
max_attempts:嘗試重新啟動容器的次數,超出次數,則不再嘗試(預設值:一直重試)。
window:設定容器重新啟動超時時間(預設值:0)。
rollback_config:設定在更新失敗的情況下應如何回滾服務。
parallelism:一次要回滾的容器數。如果設定為0,則所有容器將同時回滾。
delay:每個容器組回滾之間等待的時間(預設為0s)。
failure_action:如果回滾失敗,該怎麼辦。其中一個 continue 或者 pause(預設pause)。
monitor:每個容器更新後,持續觀察是否失敗了的時間 (ns|us|ms|s|m|h)(預設為0s)。
max_failure_ratio:在回滾期間可以容忍的故障率(預設為0)。
order:回滾期間的操作順序。其中一個 stop-first(序列回滾),或者 start-first(並行回滾)(預設 stop-first )。
update_config:設定應如何更新服務,對於設定捲動更新很有用。
parallelism:一次更新的容器數。
delay:在更新一組容器之間等待的時間。
failure_action:如果更新失敗,該怎麼辦。其中一個 continue,rollback 或者pause (預設:pause)。
monitor:每個容器更新後,持續觀察是否失敗了的時間 (ns|us|ms|s|m|h)(預設為0s)。
max_failure_ratio:在更新過程中可以容忍的故障率。
order:回滾期間的操作順序。其中一個 stop-first(序列回滾),或者 start-first(並行回滾)(預設stop-first)。
注:僅支援 V3.4 及更高版本。
指定裝置對映列表。
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
自定義 DNS 伺服器,可以是單個值或列表的多個值。
dns: 8.8.8.8
dns:
- 8.8.8.8
- 9.9.9.9
自定義 DNS 搜尋域。可以是單個值或列表。
dns_search: example.com
dns_search:
- dc1.example.com
- dc2.example.com
覆蓋容器預設的 entrypoint。
entrypoint: /code/entrypoint.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: .env
也可以是列表格式:
env_file:
- ./common.env
- ./apps/web.env
- /opt/secrets.env
新增環境變數。您可以使用陣列或字典、任何布林值,布林值需要用引號引起來,以確保 YML 解析器不會將其轉換為 True 或 False。
environment:
RACK_ENV: development
SHOW: 'true'
暴露埠,但不對映到宿主機,只被連線的服務存取。
僅可以指定內部埠為引數:
expose:
- "3000"
- "8000"
新增主機名對映。類似 docker client --add-host。
extra_hosts:
- "somehost:162.242.195.82"
- "otherhost:50.31.209.229"
以上會在此服務的內部容器中 /etc/hosts 建立一個具有 ip 地址和主機名的對映關係:
162.242.195.82 somehost
50.31.209.229 otherhost
用於檢測 docker 服務是否健康執行。
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost"] # 設定檢測程式
interval: 1m30s # 設定檢測間隔
timeout: 10s # 設定檢測超時時間
retries: 3 # 設定重試次數
start_period: 40s # 啟動後,多少秒開始啟動檢測程式
指定容器執行的映象。以下格式都可以:
image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd # 映象id
服務的紀錄檔記錄設定。
driver:指定服務容器的紀錄檔記錄驅動程式,預設值為json-file。有以下三個選項
driver: "json-file"
driver: "syslog"
driver: "none"
僅在 json-file 驅動程式下,可以使用以下引數,限制紀錄檔得數量和大小。
logging:
driver: json-file
options:
max-size: "200k" # 單個檔案大小為200k
max-file: "10" # 最多10個檔案
當達到檔案限制上限,會自動刪除舊得檔案。
syslog 驅動程式下,可以使用 syslog-address 指定紀錄檔接收地址。
logging:
driver: syslog
options:
syslog-address: "tcp://192.168.0.42:123"
設定網路模式。
network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
設定容器連線的網路,參照頂級 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 :同一網路上的其他容器可以使用服務名稱或此別名來連線到對應容器的服務。
no:是預設的重新啟動策略,在任何情況下都不會重新啟動容器。
always:容器總是重新啟動。
on-failure:在容器非正常退出時(退出狀態非0),才會重新啟動容器。
unless-stopped:在容器退出時總是重新啟動容器,但是不考慮在Docker守護行程啟動時就已經停止了的容器
restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
注:swarm 叢集模式,請改用 restart_policy。
儲存敏感資料,例如密碼:
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
修改容器預設的 schema 標籤。
security-opt:
- label:user:USER # 設定容器的使用者標籤
- label:role:ROLE # 設定容器的角色標籤
- label:type:TYPE # 設定容器的安全策略標籤
- label:level:LEVEL # 設定容器的安全等級標籤
指定在容器無法處理 SIGTERM (或者任何 stop_signal 的訊號),等待多久後傳送 SIGKILL 訊號關閉容器。
stop_grace_period: 1s # 等待 1 秒
stop_grace_period: 1m30s # 等待 1 分 30 秒
預設的等待時間是 10 秒。
設定停止容器的替代訊號。預設情況下使用 SIGTERM 。
以下範例,使用 SIGUSR1 替代訊號 SIGTERM 來停止容器。
stop_signal: SIGUSR1
設定容器中的核心引數,可以使用陣列或字典格式。
sysctls:
net.core.somaxconn: 1024
net.ipv4.tcp_syncookies: 0
sysctls:
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
在容器內安裝一個臨時檔案系統。可以是單個值或列表的多個值。
tmpfs: /run
tmpfs:
- /run
- /tmp
覆蓋容器預設的 ulimit。
ulimits:
nproc: 65535
nofile:
soft: 20000
hard: 40000
將主機的資料卷或著檔案掛載到容器裡。
version: "3.7"
services:
db:
image: postgres:latest
volumes:
- "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
- "/localhost/data:/var/lib/postgresql/data"