什么是 Docker Compose

Docker Compose 是 Docker 官方編排（Orchestration）項(xiàng)目之一，負(fù)責(zé)快速的部署分布式應(yīng)用。

概述

Compose 項(xiàng)目是 Docker 官方的開(kāi)源項(xiàng)目，負(fù)責(zé)實(shí)現(xiàn)對(duì) Docker 容器集群的快速編排。從功能上看，跟 OpenStack 中的 Heat 十分類似。

其代碼目前在 https://github.com/docker/compose 上開(kāi)源。

Compose 定位是 「定義和運(yùn)行多個(gè) Docker 容器的應(yīng)用（Defining and running multi-container Docker applications）」，其前身是開(kāi)源項(xiàng)目 Fig。

通過(guò)第一部分中的介紹，我們知道使用一個(gè) Dockerfile 模板文件，可以讓用戶很方便的定義一個(gè)單獨(dú)的應(yīng)用容器。然而，在日常工作中，經(jīng)常會(huì)碰到需要多個(gè)容器相互配合來(lái)完成某項(xiàng)任務(wù)的情況。例如要實(shí)現(xiàn)一個(gè) Web 項(xiàng)目，除了 Web 服務(wù)容器本身，往往還需要再加上后端的數(shù)據(jù)庫(kù)服務(wù)容器，甚至還包括負(fù)載均衡容器等。

Compose 恰好滿足了這樣的需求。它允許用戶通過(guò)一個(gè)單獨(dú)的 docker-compose.yml 模板文件（YAML 格式）來(lái)定義一組相關(guān)聯(lián)的應(yīng)用容器為一個(gè)項(xiàng)目（project）。

Compose 中有兩個(gè)重要的概念：

• 服務(wù) (service)：一個(gè)應(yīng)用的容器，實(shí)際上可以包括若干運(yùn)行相同鏡像的容器實(shí)例。
• 項(xiàng)目 (project)：由一組關(guān)聯(lián)的應(yīng)用容器組成的一個(gè)完整業(yè)務(wù)單元，在 docker-compose.yml 文件中定義。

Compose 的默認(rèn)管理對(duì)象是項(xiàng)目，通過(guò)子命令對(duì)項(xiàng)目中的一組容器進(jìn)行便捷地生命周期管理。

Compose 項(xiàng)目由 Python 編寫，實(shí)現(xiàn)上調(diào)用了 Docker 服務(wù)提供的 API 來(lái)對(duì)容器進(jìn)行管理。因此，只要所操作的平臺(tái)支持 Docker API，就可以在其上利用 Compose 來(lái)進(jìn)行編排管理。

Docker Compose 安裝與卸載

Compose 支持 Linux、macOS、Windows 10 三大平臺(tái)。

Compose 可以通過(guò) Python 的包管理工具 pip 進(jìn)行安裝，也可以直接下載編譯好的二進(jìn)制文件使用，甚至能夠直接在 Docker 容器中運(yùn)行。

前兩種方式是傳統(tǒng)方式，適合本地環(huán)境下安裝使用；最后一種方式則不破壞系統(tǒng)環(huán)境，更適合云計(jì)算場(chǎng)景。

Docker for Mac 、Docker for Windows 自帶 docker-compose 二進(jìn)制文件，安裝 Docker 之后可以直接使用。

$ docker-compose --version
docker-compose version 1.17.1, build 6d101fb

Linux 系統(tǒng)請(qǐng)使用以下介紹的方法安裝。

二進(jìn)制包

在 Linux 上的也安裝十分簡(jiǎn)單，從 官方 GitHub Release 處直接下載編譯好的二進(jìn)制文件即可。

例如，在 Linux 64 位系統(tǒng)上直接下載對(duì)應(yīng)的二進(jìn)制包。

$ sudo curl -L https://github.com/docker/compose/releases/download/1.17.1/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

PIP 安裝

注： x86_64 架構(gòu)的 Linux 建議按照上邊的方法下載二進(jìn)制包進(jìn)行安裝，如果您計(jì)算機(jī)的架構(gòu)是 ARM(例如，樹(shù)莓派)，再使用 pip 安裝。

這種方式是將 Compose 當(dāng)作一個(gè) Python 應(yīng)用來(lái)從 pip 源中安裝。
執(zhí)行安裝命令：

$ sudo pip install -U docker-compose

可以看到類似如下輸出，說(shuō)明安裝成功。

Collecting docker-compose
  Downloading docker-compose-1.17.1.tar.gz (149kB): 149kB downloaded
...
Successfully installed docker-compose cached-property requests texttable websocket-client docker-py dockerpty six enum34 backports.ssl-match-hostname ipaddress

容器中執(zhí)行

Compose 既然是一個(gè) Python 應(yīng)用，自然也可以直接用容器來(lái)執(zhí)行它。

$ curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$ chmod +x /usr/local/bin/docker-compose

實(shí)際上，查看下載的 run.sh 腳本內(nèi)容，如下

set -e

VERSION="1.8.0"
IMAGE="docker/compose:$VERSION"

# Setup options for connecting to docker host
if [ -z "$DOCKER_HOST" ]; then
    DOCKER_HOST="/var/run/docker.sock"
fi
if [ -S "$DOCKER_HOST" ]; then
    DOCKER_ADDR="-v $DOCKER_HOST:$DOCKER_HOST -e DOCKER_HOST"
else
    DOCKER_ADDR="-e DOCKER_HOST -e DOCKER_TLS_VERIFY -e DOCKER_CERT_PATH"
fi

# Setup volume mounts for compose config and context
if [ "$(pwd)" != '/' ]; then
    VOLUMES="-v $(pwd):$(pwd)"
fi
if [ -n "$COMPOSE_FILE" ]; then
    compose_dir=$(dirname $COMPOSE_FILE)
fi
# TODO: also check --file argument
if [ -n "$compose_dir" ]; then
    VOLUMES="$VOLUMES -v $compose_dir:$compose_dir"
fi
if [ -n "$HOME" ]; then
    VOLUMES="$VOLUMES -v $HOME:$HOME -v $HOME:/root" # mount $HOME in /root to share docker.config
fi

# Only allocate tty if we detect one
if [ -t 1 ]; then
    DOCKER_RUN_OPTIONS="-t"
fi
if [ -t 0 ]; then
    DOCKER_RUN_OPTIONS="$DOCKER_RUN_OPTIONS -i"
fi

exec docker run --rm $DOCKER_RUN_OPTIONS $DOCKER_ADDR $COMPOSE_OPTIONS $VOLUMES -w "$(pwd)" $IMAGE "$@"

可以看到，它其實(shí)是下載了 docker/compose 鏡像并運(yùn)行。

卸載

如果是二進(jìn)制包方式安裝的，刪除二進(jìn)制文件即可。

$ sudo rm /usr/local/bin/docker-compose

如果是通過(guò) pip 安裝的，則執(zhí)行如下命令即可刪除。

$ sudo pip uninstall docker-compose

Docker Compose 使用

術(shù)語(yǔ)

首先介紹幾個(gè)術(shù)語(yǔ)。

• 服務(wù) (service)：一個(gè)應(yīng)用容器，實(shí)際上可以運(yùn)行多個(gè)相同鏡像的實(shí)例。
• 項(xiàng)目 (project)：由一組關(guān)聯(lián)的應(yīng)用容器組成的一個(gè)完整業(yè)務(wù)單元。

可見(jiàn)，一個(gè)項(xiàng)目可以由多個(gè)服務(wù)（容器）關(guān)聯(lián)而成，Compose 面向項(xiàng)目進(jìn)行管理。

場(chǎng)景

最常見(jiàn)的項(xiàng)目是 web 網(wǎng)站，該項(xiàng)目應(yīng)該包含 web 應(yīng)用和緩存。

下面我們用 Python 來(lái)建立一個(gè)能夠記錄頁(yè)面訪問(wèn)次數(shù)的 web 網(wǎng)站。

web 應(yīng)用

新建文件夾，在該目錄中編寫 app.py 文件

from flask import Flask
from redis import Redis

app = Flask(__name__)
redis = Redis(host='redis', port=6379)

@app.route('/')
def hello():
    count = redis.incr('hits')
    return 'Hello World! 該頁(yè)面已被訪問(wèn) {} 次。\n'.format(count)

if __name__ == "__main__":
    app.run(host="0.0.0.0", debug=True)

Dockerfile

編寫 Dockerfile 文件，內(nèi)容為

FROM python:3.6-alpine
ADD . /code
WORKDIR /code
RUN pip install redis flask
CMD ["python", "app.py"]

docker-compose.yml

編寫 docker-compose.yml 文件，這個(gè)是 Compose 使用的主模板文件。

version: '3'
services:
  web:
    build: .
    ports:
     - "5000:5000"

  redis:
    image: "redis:alpine"

運(yùn)行 compose 項(xiàng)目

$ docker-compose up

此時(shí)訪問(wèn)本地 5000 端口，每次刷新頁(yè)面，計(jì)數(shù)就會(huì)加 1。

Docker Compose 命令說(shuō)明

命令對(duì)象與格式

對(duì)于 Compose 來(lái)說(shuō)，大部分命令的對(duì)象既可以是項(xiàng)目本身，也可以指定為項(xiàng)目中的服務(wù)或者容器。如果沒(méi)有特別的說(shuō)明，命令對(duì)象將是項(xiàng)目，這意味著項(xiàng)目中所有的服務(wù)都會(huì)受到命令影響。

執(zhí)行 docker-compose [COMMAND] --help 或者 docker-compose help [COMMAND] 可以查看具體某個(gè)命令的使用格式。

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-networking 使用 Docker 的可拔插網(wǎng)絡(luò)后端特性
• --x-network-driver DRIVER 指定網(wǎng)絡(luò)后端的驅(qū)動(dòng)，默認(rèn)為 bridge
• --verbose 輸出更多調(diào)試信息。
• -v, --version 打印版本并退出。

build

格式為 docker-compose build [options] [SERVICE...]。

構(gòu)建（重新構(gòu)建）項(xiàng)目中的服務(wù)容器。

服務(wù)容器一旦構(gòu)建后，將會(huì)帶上一個(gè)標(biāo)記名，例如對(duì)于 web 項(xiàng)目中的一個(gè) db 容器，可能是 web_db。

可以隨時(shí)在項(xiàng)目目錄下運(yùn)行 docker-compose build 來(lái)重新構(gòu)建服務(wù)。

選項(xiàng)包括：

• --force-rm 刪除構(gòu)建過(guò)程中的臨時(shí)容器。
• --no-cache 構(gòu)建鏡像過(guò)程中不使用 cache（這將加長(zhǎng)構(gòu)建過(guò)程）。
• --pull 始終嘗試通過(guò) pull 來(lái)獲取更新版本的鏡像。

config

驗(yàn)證 Compose 文件格式是否正確，若正確則顯示配置，若格式錯(cuò)誤顯示錯(cuò)誤原因。

down

此命令將會(huì)停止 up 命令所啟動(dòng)的容器，并移除網(wǎng)絡(luò)

exec

進(jìn)入指定的容器。

help

獲得一個(gè)命令的幫助。

images

列出 Compose 文件中包含的鏡像。

kill

格式為 docker-compose kill [options] [SERVICE...]。

通過(guò)發(fā)送 SIGKILL 信號(hào)來(lái)強(qiáng)制停止服務(wù)容器。

支持通過(guò) -s 參數(shù)來(lái)指定發(fā)送的信號(hào)，例如通過(guò)如下指令發(fā)送 SIGINT 信號(hào)。

$ docker-compose kill -s SIGINT

logs

格式為 docker-compose logs [options] [SERVICE...]。

查看服務(wù)容器的輸出。默認(rèn)情況下，docker-compose 將對(duì)不同的服務(wù)輸出使用不同的顏色來(lái)區(qū)分?？梢酝ㄟ^(guò) --no-color 來(lái)關(guān)閉顏色。

該命令在調(diào)試問(wèn)題的時(shí)候十分有用。

pause

格式為 docker-compose pause [SERVICE...]。

暫停一個(gè)服務(wù)容器。

port

格式為 docker-compose port [options] SERVICE PRIVATE_PORT。

打印某個(gè)容器端口所映射的公共端口。

選項(xiàng)：

• --protocol=proto 指定端口協(xié)議，tcp（默認(rèn)值）或者 udp。
• --index=index 如果同一服務(wù)存在多個(gè)容器，指定命令對(duì)象容器的序號(hào)（默認(rèn)為 1）。

ps

格式為 docker-compose ps [options] [SERVICE...]。

列出項(xiàng)目中目前的所有容器。

選項(xiàng)：

• -q 只打印容器的 ID 信息。

pull

格式為 docker-compose pull [options] [SERVICE...]。

拉取服務(wù)依賴的鏡像。

選項(xiàng)：

• --ignore-pull-failures 忽略拉取鏡像過(guò)程中的錯(cuò)誤。

push

推送服務(wù)依賴的鏡像到 Docker 鏡像倉(cāng)庫(kù)。

restart

格式為 docker-compose restart [options] [SERVICE...]。

重啟項(xiàng)目中的服務(wù)。

選項(xiàng)：

• -t, --timeout TIMEOUT 指定重啟前停止容器的超時(shí)（默認(rèn)為 10 秒）。

rm

格式為 docker-compose rm [options] [SERVICE...]。

刪除所有（停止?fàn)顟B(tài)的）服務(wù)容器。推薦先執(zhí)行 docker-compose stop 命令來(lái)停止容器。

選項(xiàng)：

• -f, --force 強(qiáng)制直接刪除，包括非停止?fàn)顟B(tài)的容器。一般盡量不要使用該選項(xiàng)。
• -v 刪除容器所掛載的數(shù)據(jù)卷。

run

格式為 docker-compose run [options] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]。

在指定服務(wù)上執(zhí)行一個(gè)命令。

例如：

$ docker-compose run ubuntu ping docker.com

將會(huì)啟動(dòng)一個(gè) ubuntu 服務(wù)容器，并執(zhí)行 ping docker.com 命令。

默認(rèn)情況下，如果存在關(guān)聯(lián)，則所有關(guān)聯(lián)的服務(wù)將會(huì)自動(dòng)被啟動(dòng)，除非這些服務(wù)已經(jīng)在運(yùn)行中。

該命令類似啟動(dòng)容器后運(yùn)行指定的命令，相關(guān)卷、鏈接等等都將會(huì)按照配置自動(dòng)創(chuàng)建。

兩個(gè)不同點(diǎn)：

• 給定命令將會(huì)覆蓋原有的自動(dòng)運(yùn)行命令；
• 不會(huì)自動(dòng)創(chuàng)建端口，以避免沖突。

如果不希望自動(dòng)啟動(dòng)關(guān)聯(lián)的容器，可以使用 --no-deps 選項(xiàng)，例如

$ docker-compose run --no-deps web python manage.py shell

將不會(huì)啟動(dòng) web 容器所關(guān)聯(lián)的其它容器。

選項(xiàng)：

• -d 后臺(tái)運(yùn)行容器。
• --name NAME 為容器指定一個(gè)名字。
• --entrypoint CMD 覆蓋默認(rèn)的容器啟動(dòng)指令。
• -e KEY=VAL 設(shè)置環(huán)境變量值，可多次使用選項(xiàng)來(lái)設(shè)置多個(gè)環(huán)境變量。
• -u, --user="" 指定運(yùn)行容器的用戶名或者 uid。
• --no-deps 不自動(dòng)啟動(dòng)關(guān)聯(lián)的服務(wù)容器。
• --rm 運(yùn)行命令后自動(dòng)刪除容器，d 模式下將忽略。
• -p, --publish=[] 映射容器端口到本地主機(jī)。
• --service-ports 配置服務(wù)端口并映射到本地主機(jī)。
• -T 不分配偽 tty，意味著依賴 tty 的指令將無(wú)法運(yùn)行。

scale

格式為 docker-compose scale [options] [SERVICE=NUM...]。

設(shè)置指定服務(wù)運(yùn)行的容器個(gè)數(shù)。

通過(guò) service=num 的參數(shù)來(lái)設(shè)置數(shù)量。例如：

$ docker-compose scale web=3 db=2

將啟動(dòng) 3 個(gè)容器運(yùn)行 web 服務(wù)，2 個(gè)容器運(yùn)行 db 服務(wù)。

一般的，當(dāng)指定數(shù)目多于該服務(wù)當(dāng)前實(shí)際運(yùn)行容器，將新創(chuàng)建并啟動(dòng)容器；反之，將停止容器。

選項(xiàng)：

• -t, --timeout TIMEOUT 停止容器時(shí)候的超時(shí)（默認(rèn)為 10 秒）。

start

格式為 docker-compose start [SERVICE...]。

啟動(dòng)已經(jīng)存在的服務(wù)容器。

stop

格式為 docker-compose stop [options] [SERVICE...]。

停止已經(jīng)處于運(yùn)行狀態(tài)的容器，但不刪除它。通過(guò) docker-compose start 可以再次啟動(dòng)這些容器。

選項(xiàng)：

• -t, --timeout TIMEOUT 停止容器時(shí)候的超時(shí)（默認(rèn)為 10 秒）。

top

查看各個(gè)服務(wù)容器內(nèi)運(yùn)行的進(jìn)程。

unpause

格式為 docker-compose unpause [SERVICE...]。

恢復(fù)處于暫停狀態(tài)中的服務(wù)。

up

格式為 docker-compose up [options] [SERVICE...]。

該命令十分強(qiáng)大，它將嘗試自動(dòng)完成包括構(gòu)建鏡像，（重新）創(chuàng)建服務(wù)，啟動(dòng)服務(wù)，并關(guān)聯(lián)服務(wù)相關(guān)容器的一系列操作。

鏈接的服務(wù)都將會(huì)被自動(dòng)啟動(dòng)，除非已經(jīng)處于運(yùn)行狀態(tài)。

可以說(shuō)，大部分時(shí)候都可以直接通過(guò)該命令來(lái)啟動(dòng)一個(gè)項(xiàng)目。

默認(rèn)情況，docker-compose up 啟動(dòng)的容器都在前臺(tái)，控制臺(tái)將會(huì)同時(shí)打印所有容器的輸出信息，可以很方便進(jìn)行調(diào)試。

當(dāng)通過(guò) Ctrl-C 停止命令時(shí)，所有容器將會(huì)停止。

如果使用 docker-compose up -d，將會(huì)在后臺(tái)啟動(dòng)并運(yùn)行所有的容器。一般推薦生產(chǎn)環(huán)境下使用該選項(xiàng)。

默認(rèn)情況，如果服務(wù)容器已經(jīng)存在，docker-compose up 將會(huì)嘗試停止容器，然后重新創(chuàng)建（保持使用 volumes-from 掛載的卷），以保證新啟動(dòng)的服務(wù)匹配 docker-compose.yml 文件的最新內(nèi)容。如果用戶不希望容器被停止并重新創(chuàng)建，可以使用 docker-compose up --no-recreate。這樣將只會(huì)啟動(dòng)處于停止?fàn)顟B(tài)的容器，而忽略已經(jīng)運(yùn)行的服務(wù)。如果用戶只想重新部署某個(gè)服務(wù)，可以使用 docker-compose up --no-deps -d <SERVICE_NAME> 來(lái)重新創(chuàng)建服務(wù)并后臺(tái)停止舊服務(wù)，啟動(dòng)新服務(wù)，并不會(huì)影響到其所依賴的服務(wù)。

選項(xiàng)：

• -d 在后臺(tái)運(yùn)行服務(wù)容器。
• --no-color 不使用顏色來(lái)區(qū)分不同的服務(wù)的控制臺(tái)輸出。
• --no-deps 不啟動(dòng)服務(wù)所鏈接的容器。
• --force-recreate 強(qiáng)制重新創(chuàng)建容器，不能與 --no-recreate 同時(shí)使用。
• --no-recreate 如果容器已經(jīng)存在了，則不重新創(chuàng)建，不能與 --force-recreate 同時(shí)使用。
• --no-build 不自動(dòng)構(gòu)建缺失的服務(wù)鏡像。
• -t, --timeout TIMEOUT 停止容器時(shí)候的超時(shí)（默認(rèn)為 10 秒）。

version

格式為 docker-compose version。

打印版本信息。

Docker Compose 模板文件

模板文件是使用 Compose 的核心，涉及到的指令關(guān)鍵字也比較多。但大家不用擔(dān)心，這里面大部分指令跟 docker run 相關(guān)參數(shù)的含義都是類似的。

默認(rèn)的模板文件名稱為 docker-compose.yml，格式為 YAML 格式。

version: "3"

services:
  webapp:
    image: examples/web
    ports:
      - "80:80"
    volumes:
      - "/data"

注意每個(gè)服務(wù)都必須通過(guò) image 指令指定鏡像或 build 指令（需要 Dockerfile）等來(lái)自動(dòng)構(gòu)建生成鏡像。

如果使用 build 指令，在 Dockerfile 中設(shè)置的選項(xiàng)(例如：CMD, EXPOSE, VOLUME, ENV 等) 將會(huì)自動(dòng)被獲取，無(wú)需在 docker-compose.yml 中再次設(shè)置。

下面分別介紹各個(gè)指令的用法。

build

指定 Dockerfile 所在文件夾的路徑（可以是絕對(duì)路徑，或者相對(duì) docker-compose.yml 文件的路徑）。 Compose 將會(huì)利用它自動(dòng)構(gòu)建這個(gè)鏡像，然后使用這個(gè)鏡像。

version: '3'
services:

  webapp:
    build: ./dir

你也可以使用 context 指令指定 Dockerfile 所在文件夾的路徑。
使用 dockerfile 指令指定 Dockerfile 文件名。
使用 arg 指令指定構(gòu)建鏡像時(shí)的變量。

version: '3'
services:

  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

使用 cache_from 指定構(gòu)建鏡像的緩存

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

cap_add, cap_drop

指定容器的內(nèi)核能力（capacity）分配。

例如，讓容器擁有所有能力可以指定為：

cap_add:
  - ALL

去掉 NET_ADMIN 能力可以指定為：

cap_drop:
  - NET_ADMIN

command

覆蓋容器啟動(dòng)后默認(rèn)執(zhí)行的命令。

command: echo "hello world"

configs

僅用于 Swarm mode

cgroup_parent

指定父 cgroup 組，意味著將繼承該組的資源限制。

例如，創(chuàng)建了一個(gè) cgroup 組名稱為 cgroups_1。

cgroup_parent: cgroups_1

container_name

指定容器名稱。默認(rèn)將會(huì)使用 項(xiàng)目名稱_服務(wù)名稱_序號(hào) 這樣的格式。

container_name: docker-web-container

注意: 指定容器名稱后，該服務(wù)將無(wú)法進(jìn)行擴(kuò)展（scale），因?yàn)?Docker 不允許多個(gè)容器具有相同的名稱。

deploy

僅用于 Swarm mode

devices

指定設(shè)備映射關(guān)系。

devices:
  - "/dev/ttyUSB1:/dev/ttyUSB0"

depends_on

解決容器的依賴、啟動(dòng)先后的問(wèn)題。以下例子中會(huì)先啟動(dòng) redis db 再啟動(dòng) web

version: '3'

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis
  db:
    image: postgres

注意：web 服務(wù)不會(huì)等待 redis db 「完全啟動(dòng)」之后才啟動(dòng)。

dns

自定義 DNS 服務(wù)器?？梢允且粋€(gè)值，也可以是一個(gè)列表。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

dns_search

配置 DNS 搜索域?？梢允且粋€(gè)值，也可以是一個(gè)列表。

dns_search: example.com

dns_search:
  - domain1.example.com
  - domain2.example.com

tmpfs

掛載一個(gè) tmpfs 文件系統(tǒng)到容器。

tmpfs: /run
tmpfs:
  - /run
  - /tmp

env_file

從文件中獲取環(huán)境變量，可以為單獨(dú)的文件路徑或列表。

如果通過(guò) docker-compose -f FILE 方式來(lái)指定 Compose 模板文件，則 env_file 中變量的路徑會(huì)基于模板文件路徑。

如果有變量名稱與 environment 指令沖突，則按照慣例，以后者為準(zhǔn)。

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

環(huán)境變量文件中每一行必須符合格式，支持 # 開(kāi)頭的注釋行。

# common.env: Set development environment
PROG_ENV=development

environment

設(shè)置環(huán)境變量。你可以使用數(shù)組或字典兩種格式。

只給定名稱的變量會(huì)自動(dòng)獲取運(yùn)行 Compose 主機(jī)上對(duì)應(yīng)變量的值，可以用來(lái)防止泄露不必要的數(shù)據(jù)。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

如果變量名稱或者值中用到 true|false，yes|no 等表達(dá) 布爾 含義的詞匯，最好放到引號(hào)里，避免 YAML 自動(dòng)解析某些內(nèi)容為對(duì)應(yīng)的布爾語(yǔ)義。這些特定詞匯，包括

y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF

expose

暴露端口，但不映射到宿主機(jī)，只被連接的服務(wù)訪問(wèn)。

僅可以指定內(nèi)部端口為參數(shù)

expose:
 - "3000"
 - "8000"

external_links

注意：不建議使用該指令。

鏈接到 docker-compose.yml 外部的容器，甚至并非 Compose 管理的外部容器。

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql

extra_hosts

類似 Docker 中的 --add-host 參數(shù)，指定額外的 host 名稱映射信息。

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

會(huì)在啟動(dòng)后的服務(wù)容器中 /etc/hosts 文件中添加如下兩條條目。

8.8.8.8 googledns
52.1.157.61 dockerhub

healthcheck

通過(guò)命令檢查容器是否健康運(yùn)行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"]
  interval: 1m30s
  timeout: 10s
  retries: 3

image

指定為鏡像名稱或鏡像 ID。如果鏡像在本地不存在，Compose 將會(huì)嘗試?yán)∵@個(gè)鏡像。

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

labels

為容器添加 Docker 元數(shù)據(jù)（metadata）信息。例如可以為容器添加輔助說(shuō)明信息。

labels:
  com.startupteam.description: "webapp for a startup team"
  com.startupteam.department: "devops department"
  com.startupteam.release: "rc3 for v1.0"

links

注意：不推薦使用該指令。

logging

配置日志選項(xiàng)。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

目前支持三種日志驅(qū)動(dòng)類型。

driver: "json-file"
driver: "syslog"
driver: "none"

options 配置日志驅(qū)動(dòng)的相關(guān)參數(shù)。

options:
  max-size: "200k"
  max-file: "10"

network_mode

設(shè)置網(wǎng)絡(luò)模式。使用和 docker run 的 --network 參數(shù)一樣的值。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

networks

配置容器連接的網(wǎng)絡(luò)。

version: "3"
services:

  some-service:
    networks:
     - some-network
     - other-network

networks:
  some-network:
  other-network:
  my_netx:            
    driver: bridge
      ipam:
        config:
        - subnet: 172.18.0.1/16

pid

跟主機(jī)系統(tǒng)共享進(jìn)程命名空間。打開(kāi)該選項(xiàng)的容器之間，以及容器和宿主機(jī)系統(tǒng)之間可以通過(guò)進(jìn)程 ID 來(lái)相互訪問(wèn)和操作。

pid: "host"

ports

暴露端口信息。

使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者僅僅指定容器的端口（宿主將會(huì)隨機(jī)選擇端口）都可以。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

注意：當(dāng)使用 HOST:CONTAINER 格式來(lái)映射端口時(shí)，如果你使用的容器端口小于 60 并且沒(méi)放到引號(hào)里，可能會(huì)得到錯(cuò)誤結(jié)果，因?yàn)?YAML 會(huì)自動(dòng)解析 xx:yy 這種數(shù)字格式為 60 進(jìn)制。為避免出現(xiàn)這種問(wèn)題，建議數(shù)字串都采用引號(hào)包括起來(lái)的字符串格式。

secrets

存儲(chǔ)敏感數(shù)據(jù)，例如 mysql 服務(wù)密碼。

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db_root_password
  secrets:
    - db_root_password
    - my_other_secret

secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

security_opt

指定容器模板標(biāo)簽（label）機(jī)制的默認(rèn)屬性（用戶、角色、類型、級(jí)別等）。例如配置標(biāo)簽的用戶名和角色名。

security_opt:
    - label:user:USER
    - label:role:ROLE

stop_signal

設(shè)置另一個(gè)信號(hào)來(lái)停止容器。在默認(rèn)情況下使用的是 SIGTERM 停止容器。

stop_signal: SIGUSR1

sysctls

配置容器內(nèi)核參數(shù)。

sysctls:
  net.core.somaxconn: 1024
  net.ipv4.tcp_syncookies: 0

sysctls:
  - net.core.somaxconn=1024
  - net.ipv4.tcp_syncookies=0

ulimits

指定容器的 ulimits 限制值。

例如，指定最大進(jìn)程數(shù)為 65535，指定文件句柄數(shù)為 20000（軟限制，應(yīng)用可以隨時(shí)修改，不能超過(guò)硬限制） 和 40000（系統(tǒng)硬限制，只能 root 用戶提高）。

  ulimits:
    nproc: 65535
    nofile:
      soft: 20000
      hard: 40000

volumes

數(shù)據(jù)卷所掛載路徑設(shè)置?？梢栽O(shè)置宿主機(jī)路徑 （HOST:CONTAINER） 或加上訪問(wèn)模式 （HOST:CONTAINER:ro）。

該指令中路徑支持相對(duì)路徑。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

其它指令

此外，還有包括 domainname, entrypoint, hostname, ipc, mac_address, privileged, read_only, shm_size, restart, stdin_open, tty, user, working_dir 等指令，基本跟 docker run 中對(duì)應(yīng)參數(shù)的功能一致。

指定服務(wù)容器啟動(dòng)后執(zhí)行的入口文件。

entrypoint: /code/entrypoint.sh

指定容器中運(yùn)行應(yīng)用的用戶名。

user: nginx

指定容器中工作目錄。

working_dir: /code

指定容器中搜索域名、主機(jī)名、mac 地址等。

domainname: your_website.com
hostname: test
mac_address: 08-00-27-00-0C-0A

允許容器中運(yùn)行一些特權(quán)命令。

privileged: true

指定容器退出后的重啟策略為始終重啟。該命令對(duì)保持服務(wù)始終運(yùn)行十分有效，在生產(chǎn)環(huán)境中推薦配置為 always 或者 unless-stopped。

restart: always

以只讀模式掛載容器的 root 文件系統(tǒng)，意味著不能對(duì)容器內(nèi)容進(jìn)行修改。

read_only: true

打開(kāi)標(biāo)準(zhǔn)輸入，可以接受外部輸入。

stdin_open: true

模擬一個(gè)偽終端。

tty: true

讀取變量

Compose 模板文件支持動(dòng)態(tài)讀取主機(jī)的系統(tǒng)環(huán)境變量和當(dāng)前目錄下的 .env 文件中的變量。

例如，下面的 Compose 文件將從運(yùn)行它的環(huán)境中讀取變量 ${MONGO_VERSION} 的值，并寫入執(zhí)行的指令中。

version: "3"
services:

db:
  image: "mongo:${MONGO_VERSION}"

如果執(zhí)行 MONGO_VERSION=3.2 docker-compose up 則會(huì)啟動(dòng)一個(gè) mongo:3.2 鏡像的容器；如果執(zhí)行 MONGO_VERSION=2.8 docker-compose up 則會(huì)啟動(dòng)一個(gè) mongo:2.8 鏡像的容器。

若當(dāng)前目錄存在 .env 文件，執(zhí)行 docker-compose 命令時(shí)將從該文件中讀取變量。

在當(dāng)前目錄新建 .env 文件并寫入以下內(nèi)容。

# 支持 # 號(hào)注釋
MONGO_VERSION=3.6

執(zhí)行 docker-compose up 則會(huì)啟動(dòng)一個(gè) mongo:3.6 鏡像的容器。