Compose 簡介

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

其代碼目前在 https://github.com/docker/compose 上開源氢烘。

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

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

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

Compose 中有兩個重要的概念：

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

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

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

Compose 命令

命令對象與格式

對于 Compose 來說，大部分命令的對象既可以是項(xiàng)目本身岩馍，也可以指定為項(xiàng)目中的服務(wù)或者容器碉咆。如果沒有特別的說明，命令對象將是項(xiàng)目蛀恩，這意味著項(xiàng)目中所有的服務(wù)都會受到命令影響疫铜。

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

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ū)動，默認(rèn)為 bridge
• --verbose 輸出更多調(diào)試信息趣避。
• -v, --version 打印版本并退出庞呕。

build

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

選項(xiàng)包括：

• --force-rm 刪除構(gòu)建過程中的臨時(shí)容器。

• --no-cache 構(gòu)建鏡像過程中不使用 cache（這將加長構(gòu)建過程）。

• --pull 始終嘗試通過 pull 來獲取更新版本的鏡像住练。

config

驗(yàn)證Compose文件格式是否正確

$ docker-compose config

down

停止up命令所啟動的容器地啰，并刪除網(wǎng)絡(luò)

exec

進(jìn)入容器

help

不解釋

images

列出Compose文件中包含的鏡像

kill

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

過發(fā)送 SIGKILL 信號來強(qiáng)制停止服務(wù)容器。

docker-compose kill -s SIGINT

logs

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

查看服務(wù)容器的輸出亏吝。默認(rèn)情況下，docker-compose 將對不同的服務(wù)輸出使用不同的顏色來區(qū)分盏混∥蹬福可以通過 --no-color 來關(guān)閉顏色。

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

pause

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

暫停一個服務(wù)容器止喷。

port

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

打印某個容器端口所映射的公共端口混聊。

選項(xiàng)：

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

$ docker-compose port api 80

PS

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

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

選項(xiàng)：

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

pull

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

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

選項(xiàng)：

• --ignore-pull-failures 忽略拉取鏡像過程中的錯誤。

push

推送服務(wù)依賴的鏡像到 Docker 鏡像倉庫展懈。

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 命令來停止容器金句。

選項(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í)行一個命令趁曼。

例如：

$ docker-compose run ubuntu ping docker.com

將會啟動一個 ubuntu 服務(wù)容器，并執(zhí)行 ping docker.com 命令棕洋。

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

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

兩個不同點(diǎn)：

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

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

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

將不會啟動 web 容器所關(guān)聯(lián)的其它容器管跺。

選項(xiàng)：

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

scale

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

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

通過 service=num 的參數(shù)來設(shè)置數(shù)量治力。例如：

$ docker-compose scale web=3 db=2

將啟動 3 個容器運(yùn)行 web 服務(wù)，2 個容器運(yùn)行 db 服務(wù)勃黍。

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

選項(xiàng)：

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

start

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

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

top

查看服務(wù)容器內(nèi)的進(jìn)程

$ docker-compose top web

unpause

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

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

up

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

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

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

可以說掌动，大部分時(shí)候都可以直接通過該命令來啟動一個項(xiàng)目四啰。

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

當(dāng)通過 Ctrl-C 停止命令時(shí)眷射，所有容器將會停止匙赞。

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

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

選項(xiàng)：

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

version

格式為 docker-compose version次洼。

打印版本信息。

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"

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

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

下面分別介紹各個指令的用法届吁。

build

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

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

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

command: echo "hello world"

cgroup_parent

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

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

cgroup_parent: cgroups_1

container_name

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

devices

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

depends_on

解決容器的依賴绵估、啟動先后的問題炎疆。以下例子中會先啟動 redis db 再啟動 web

version: '3'

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

  redis:
    image: redis

  db:
    image: postgres

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

dns

自定義 DNS 服務(wù)器国裳⌒稳耄可以是一個值，也可以是一個列表缝左。

dns_search

配置 DNS 搜索域亿遂∨ㄈ簦可以是一個值，也可以是一個列表蛇数。

tmpfs

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

env_file

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

如果通過 docker-compose -f FILE 方式來指定 Compose 模板文件碌上，則 env_file 中變量的路徑會基于模板文件路徑。

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

environment

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

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

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

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ù)訪問。

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

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"

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

8.8.8.8 googledns
52.1.157.61 dockerhub

healthcheck

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

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

image

指定為鏡像名稱或鏡像 ID居触。如果鏡像在本地不存在，Compose 將會嘗試?yán)∵@個鏡像老赤。

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

labels

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

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

logging

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

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

目前支持三種日志驅(qū)動類型弊予。

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

options 配置日志驅(qū)動的相關(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:

pid

跟主機(jī)系統(tǒng)共享進(jìn)程命名空間床未。打開該選項(xiàng)的容器之間竭翠，以及容器和宿主機(jī)系統(tǒng)之間可以通過進(jìn)程 ID 來相互訪問和操作。

pid: "host"

ports

暴露端口信息薇搁。

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

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

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

secrets

存儲敏感數(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)屬性（用戶、角色卖宠、類型巍杈、級別等）。例如配置標(biāo)簽的用戶名和角色名扛伍。

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

stop_signal

設(shè)置另一個信號來停止容器筷畦。在默認(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í)修改，不能超過硬限制） 和 40000（系統(tǒng)硬限制纸泡，只能 root 用戶提高）漂问。

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

volumes

數(shù)據(jù)卷所掛載路徑設(shè)置∨遥可以設(shè)置宿主機(jī)路徑 （HOST:CONTAINER） 或加上訪問模式 （HOST:CONTAINER:ro）蚤假。

該指令中路徑支持相對路徑。

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 中對應(yīng)參數(shù)的功能一致。

指定服務(wù)容器啟動后執(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

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

restart: always

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

read_only: true

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

stdin_open: true

模擬一個偽終端屁药。

tty: true

讀取變量

Compose 模板文件支持動態(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 則會啟動一個 mongo:3.2 鏡像的容器绢彤；如果執(zhí)行 MONGO_VERSION=2.8 docker-compose up 則會啟動一個 mongo:2.8 鏡像的容器七问。

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

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

# 支持 # 號注釋
MONGO_VERSION=3.6

執(zhí)行 docker-compose up 則會啟動一個 mongo:3.6 鏡像的容器。