docker-compose.yml

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

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

可以將Compose文件命名為任何所需內(nèi)容，以使其在邏輯上具有意義；docker-compose.yml僅為標(biāo)準(zhǔn)名稱。我們可以簡單地將此文件命名為docker-stack.yml或更特定于項目的內(nèi)容

version: "3"

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

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

在docker stack下，build指令不能使用，只能用image

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

請注意，將Compose文件設(shè)置為version:"3"。本質(zhì)上，這會使其兼容swarm mode。我們可以使用deploy key（僅可用于 Compose 文件格式版本 3.x 及更高版本）及其子選項對每項服務(wù)（例如，web）進行負(fù)載均衡和優(yōu)化性能。我們可以使用docker stack deploy命令（僅在 Compose 文件版本 3.x 及更高版本上受支持）運行此文件。您可以使用docker-compose up運行具有非 swarm 配置的版本3文件。

build

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

也可以使用context指令指定Dockerfile所在文件夾的路徑。

使用dockerfile指令指定Dockerfile文件名。

使用arg指令指定構(gòu)建鏡像時的變量。

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

version: '3'
services:
  web:
    build: ./dir

version: "3"
services:
    web:
        build:
            context: ./dir
            dockerfile: Dockerfile-node
            args:
                buildno: 1
            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"

config

僅用于 Swarm mode

cgroup_parent

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

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

cgroup_parent: cgroups_1

container_name

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

container_name: docker-web-container

指定容器名稱后，該服務(wù)將無法進行擴展（scale），因為 Docker 不允許多個容器具有相同的名稱。

deploy

僅用于 Swarm mode

devices

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

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

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: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

dns_search

配置 DNS 搜索域。可以是一個值，也可以是一個列表。

dns_search: example.com

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

tmpfs

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

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

env_file

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

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

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

env_file: .env

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

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

# common.env: Set development environment
PROG_ENV=development

environment

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

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

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

如果變量名稱或者值中用到true|false，yes|no等表達布爾含義的詞匯，最好放到引號里，避免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

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

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

expose:
 - "3000"
 - "8000"

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

通過命令檢查容器是否健康運行。

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

配置日志選項。

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

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

pid: "host"

ports

暴露端口信息。

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

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

當(dāng)使用HOST:CONTAINER格式來映射端口時，如果你使用的容器端口小于60并且沒放到引號里，可能會得到錯誤結(jié)果，因為YAML會自動解析xx:yy這種數(shù)字格式為60進制。為避免出現(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）機制的默認(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 限制值。

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

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

volumes

數(shù)據(jù)卷所掛載路徑設(shè)置。可以設(shè)置宿主機路徑（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īng)用的用戶名。

user:nginx

指定容器中工作目錄。

working_dir: /code

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

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

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

privileged: true

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

restart: always

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

read_only: true

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

stdin_open: true

模擬一個偽終端。

tty: true

讀取變量

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

例如，下面的Compose文件將從運行它的環(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 命令時將從該文件中讀取變量。

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

# 支持 # 號注釋
MONGO_VERSION=3.6

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