docker-compose 詳細(xì)指令

ztyzz 發(fā)布于2019-06-28 16:40 / 2549人閱讀

摘要：使用和的參數(shù)一樣的值配置容器連接的網(wǎng)絡(luò)跟主機(jī)系統(tǒng)共享進(jìn)程命名空間。容器之間可以通過(guò)進(jìn)程來(lái)相互訪問(wèn)和操作。當(dāng)前目錄若存在文件，執(zhí)行則將從該文件中讀取變量支持號(hào)注釋

默認(rèn)的模版文件名

docker-compose.yml

version: "3"

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

build

指定Dockerfile所在文件夾的路徑, Compose將會(huì)利用它自動(dòng)構(gòu)建這個(gè)鏡像，然后使用這個(gè)鏡像
context     指定Dockerfile所在文件夾的路徑
dockerfile  指定Dockerfile文件名
arg         指定構(gòu)建鏡像時(shí)的變量
cache_from  指定構(gòu)建鏡像的緩存

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

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

cap_add:
    - ALL #用于所有能力

cap_drop:
    - NET_ADMIN #去掉NET_ADMIN能力

command

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

command: echo "hello world"

configs

僅用于Swarm mode

cgroup_parent

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

cgroup_parent: cgroups_1  #創(chuàng)建了一個(gè)cgroup組名稱為cgroups_1

container_name

指定容器名稱 默認(rèn)使用 項(xiàng)目名稱_服務(wù)名稱_序號(hào) 

container_name: docker-web-container # 指定名稱后無(wú)法使用擴(kuò)展(scale)

deploy

僅用于Swarm mode

devices

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

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

depends_on

解決容器的依賴、啟動(dòng)先后的問(wèn)題(下例中先啟動(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ù)器。

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

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

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

env_file

從文件中獲取環(huá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ù)組和字典兩種格式

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

expose

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

expose:
    - "3000"
    - "8000"

external_links[不建議使用]

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

extra_hosts

類似Docker中的 --add-host，指定額外的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

檢查容器是否健康運(yùn)行

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

image

指定為鏡像名稱或鏡像ID，不存在則會(huì)去拉取

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"

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:

pid

跟主機(jī)系統(tǒng)共享進(jìn)程命名空間。容器之間可以通過(guò)進(jìn)程ID來(lái)相互訪問(wèn)和操作。

pid: "host"

ports

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

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

secrets

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

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

指定容器模版標(biāo)簽(label)機(jī)制的默認(rèn)屬性(用戶，角色，類型， 級(jí)別)

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

stop_signal

設(shè)置另一個(gè)信號(hào)來(lái)停止容器

stop_signal: SIGUSER1

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:
    nproc: 65535
    nofile:
        soft:20000
        hard:40000

volumes

數(shù)據(jù)卷所掛載路徑設(shè)置，可以設(shè)置宿主機(jī)路徑或加上訪問(wèn)模式，支持相對(duì)路徑

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

其他指令

entrypoint: /code/entrypoint.sh   # 指定服務(wù)容器啟動(dòng)后執(zhí)行的入口文件
user: nginx                       # 指定容器中運(yùn)行應(yīng)用的用戶名
working_dir: /code                # 指定容器中的工作目錄
domainname: your_website.com      # 指定容器中搜索域名
hostname: test                    # 主機(jī)名
mac_address: 08-00-27-00-0C-0A    # MAC地址
privileged: true                  # 允許容器中運(yùn)行一些特權(quán)命令
restart: always                   # 指定容器退出后的重啟策略為始終重啟
read_only: true                   # 以只讀模式掛載容器的root文件系統(tǒng)，意味著不能對(duì)容器內(nèi)容修改
stdin_open: true                  # 打開標(biāo)準(zhǔn)輸入，可以接受外部輸入
tty: true                         # 模擬一個(gè)偽終端

讀取變量

Compose模版文件支持動(dòng)態(tài)讀取主機(jī)的系統(tǒng)環(huán)境變量和當(dāng)前目錄下.env文件中的變量
eg: 從運(yùn)行它的環(huán)境變量中讀取變量${MONGO_VERSION}的值，并寫入執(zhí)行的指令中。
version: "3"
services:

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

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