docker-compose 詳細指令

默認的模版文件名

docker-compose.yml

version: '3'

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

build

指定Dockerfile所在文件夾的路徑, Compose將會利用它自動構建這個鏡像，而後使用這個鏡像
context     指定Dockerfile所在文件夾的路徑
dockerfile  指定Dockerfile文件名
arg         指定構建鏡像時的變量
cache_from  指定構建鏡像的緩存

version: '3'
services:

    webapp:
        build:
            context: ./dir
            cache_from:
                - alpine:latest
                - corp/web_app:3.14
            dockerfile: Dockerfile-alternate
            args:
                buildno: 1

cap_add, cap_drop

指定容器的內核能力(capacity)分配

cap_add:
    - ALL #用於全部能力

cap_drop:
    - NET_ADMIN #去掉NET_ADMIN能力

command

覆蓋容器啓動後默認執行的命令

command: echo 'hello world'

configs

僅用於Swarm mode

cgroup_parent

指定父cgroup組 繼承改組的資源限制

cgroup_parent: cgroups_1  #建立了一個cgroup組名稱爲cgroups_1

container_name

指定容器名稱 默認使用 項目名稱_服務名稱_序號 

container_name: docker-web-container # 指定名稱後沒法使用擴展(scale)

deploy

僅用於Swarm mode

devices

指定設備映射關係

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服務不會等待redis db 徹底啓動以後才啓動

dns

自定義DNS服務器。

dns: 8.8.8.8

dns:
    - 8.8.8.8
    - 114.114.114.114

dns_search

配置DNS搜索域

dns_search: examples.com

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

tmpfs

掛載一個tmpfs文件系統到容器

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

env_file

從文件中獲取環境變量，能夠爲單獨的文件路徑或列表

env_file: .env

env_file:
    - ./common.env
    - ./apps/web.env
    - /opt/secrets.env
    
環境變量文件每一行必須符合格式，支持 # 開頭的註釋行

# common.env: Set development environment
PROG_ENV=development

environment

設置環境變量 可使用數組和字典兩種格式

environment:
    PACK_ENV: development
    SESSION_SECRET:
    
environment:
    - RACK_ENV=development
    - SESSION_SECRET

expose

暴露端口，但不映射到宿主機，只被鏈接的服務訪問。

expose:
    - "3000"
    - "8000"

external_links[不建議使用]

連接到外部容器，甚至到非Compose管理的外部容器

extra_hosts

相似Docker中的 --add-host，指定額外的host名稱映射信息
extra_hosts:
    - "googledns:8.8.8.8"
    - "dockerhub:52.1.157.61"
    
會在啓動後的服務容器中/etc/hosts文件中添加以下兩條

8.8.8.8 googledns
52.1.157.61 dockerhub

healthcheck

檢查容器是否健康運行

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

image

指定爲鏡像名稱或鏡像ID，不存在則會去拉取

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

labels

爲容器添加Docker元數據(metadata)信息

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

links [不推薦使用]

logging

配置日誌選項
logging:
    driver: syslog
    options:
        syslog-address: "tcp://192.168.0.42:123"
        
目前支持三種日誌驅動類型
driver: "json-file"
driver: "syslog"
driver: "none"

options配置日誌驅動的相關參數
options:
    max-size: "200k"
    max-file: "10"

network_mode

設置網絡模式。使用和docker run 的 --network參數同樣的值

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

networks

配置容器鏈接的網絡

version: '3'
services:
    
    some-service:
        networks:
            - some-network
            - other-network
            
networks:
    some-network:
    other-network:

pid

跟主機系統共享進程命名空間。容器之間能夠經過進程ID來相互訪問和操做。

pid: "host"

ports

暴露端口信息。使用宿主端口:容器端口格式，或者僅僅指定容器端口(宿主機將隨機端口)

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

secrets

存儲敏感數據，例如mysql服務密碼

version: "3"
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

指定容器模版標籤(label)機制的默認屬性(用戶，角色，類型， 級別)

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

stop_signal

設置另外一個信號來中止容器

stop_signal: SIGUSER1

sysctls

配置容器內核參數

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

指定容器的ulimits限制值

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

volumes

數據卷所掛載路徑設置，能夠設置宿主機路徑或加上訪問模式，支持相對路徑

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

其餘指令

entrypoint: /code/entrypoint.sh   # 指定服務容器啓動後執行的入口文件
user: nginx                       # 指定容器中運行應用的用戶名
working_dir: /code                # 指定容器中的工做目錄
domainname: your_website.com      # 指定容器中搜索域名
hostname: test                    # 主機名
mac_address: 08-00-27-00-0C-0A    # MAC地址
privileged: true                  # 容許容器中運行一些特權命令
restart: always                   # 指定容器退出後的重啓策略爲始終重啓
read_only: true                   # 以只讀模式掛載容器的root文件系統，意味着不能對容器內容修改
stdin_open: true                  # 打開標準輸入，能夠接受外部輸入
tty: true                         # 模擬一個僞終端

讀取變量

Compose模版文件支持動態讀取主機的系統環境變量和當前目錄下.env文件中的變量
eg: 從運行它的環境變量中讀取變量${MONGO_VERSION}的值，並寫入執行的指令中。
version: '3'
services:

db:
    image: "mongo:${MONGO_VERSION}" 
    
當前目錄若存在.env文件，執行docker-compose則將從該文件中讀取變量

# 支持 # 號註釋
MONGO_VERSION=3.6