Docker Compose - yml 配置指令參考

yml 配置指令參考

version

指定本 yml 依從的 compose 哪個版本制定的

build

指定為構建鏡像上下文路徑

例如 webapp 服務，指定為從上下文路徑 ./dir/Dockerfile 所構建的鏡像：

version: "3.7"
services:
  webapp:
    build: ./dir

或者，作為具有在上下文指定的路徑的對象，以及可選的 Dockerfile 和 args：

version: "3.7"
services:
  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1
      labels:
        - "com.example.description=Accounting webapp"
        - "com.example.department=Finance"
        - "com.example.label-with-empty-value"
      target: prod

• context：上下文路徑。
• dockerfile：指定構建鏡像的 Dockerfile 文件名。
• args：添加構建參數，這是只能在構建過程中訪問的環境變量。
• labels：設置構建鏡像的標簽。
• target：多層構建，可以指定構建哪一層。

cap_add，cap_drop

添加或刪除容器擁有的宿主機的內核功能。

cap_add:
  - ALL # 開啟全部權限

cap_drop:
  - SYS_PTRACE # 關閉 ptrace權限

cgroup_parent

為容器指定父 cgroup 組，意味着將繼承該組的資源限制。

cgroup_parent: m-executor-abcd

command

覆蓋容器啟動的默認命令。

command: ["bundle", "exec", "thin", "-p", "3000"]

container_name

指定自定義容器名稱，而不是生成的默認名稱。

container_name: my-web-container

depends_on

設置依賴關系

• docker-compose up ：以依賴性順序啟動服務。在以下示例中，先啟動 db 和 redis ，才會啟動 web。
• docker-compose up SERVICE ：自動包含 SERVICE 的依賴項。在以下示例中，docker-compose up web 還將創建並啟動 db 和 redis。
• docker-compose stop ：按依賴關系順序停止服務。在以下示例中，web 在 db 和 redis 之前停止。

version: "3.7"
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

注意：web 服務不會等待 redis db 完全啟動 之后才啟動。

deploy

指定與服務的部署和運行有關的配置。只在 swarm（集群）模式下才會有用

version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      mode：replicated
      replicas: 6
      endpoint_mode: dnsrr
      labels: 
        description: "This redis service label"
      resources:
        limits:
          cpus: '0.50'
          memory: 50M
        reservations:
          cpus: '0.25'
          memory: 20M
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s

可以選參數：

endpoint_mode：訪問集群服務的方式。

endpoint_mode: vip
# Docker 集群服務一個對外的虛擬 ip。所有的請求都會通過這個虛擬 ip 到達集群服務內部的機器。
endpoint_mode: dnsrr
# DNS 輪詢（DNSRR）。所有的請求會自動輪詢獲取到集群 ip 列表中的一個 ip 地址。

labels：在服務上設置標簽。可以用容器上的 labels（跟 deploy 同級的配置） 覆蓋 deploy 下的 labels。

mode：指定服務提供的模式。

• replicated：復制服務，復制指定服務到集群的機器上。

• global：全局服務，服務將部署至集群的每個節點。

• 圖解：下圖中黃色的方塊是 replicated 模式的運行情況，灰色方塊是 global 模式的運行情況。

  

replicas：mode 為 replicated 時，需要使用此參數配置具體運行的節點數量。

resources：配置服務器資源使用的限制，例如上例子，配置 redis 集群運行需要的 cpu 的百分比 和 內存的占用。避免占用資源過高出現異常。

restart_policy：配置如何在退出容器時重新啟動容器。

• condition：可選 none，on-failure 或者 any（默認值：any）。
• delay：設置多久之后重啟（默認值：0）。
• max_attempts：嘗試重新啟動容器的次數，超出次數，則不再嘗試（默認值：一直重試）。
• window：設置容器重啟超時時間（默認值：0）。

rollback_config：配置在更新失敗的情況下應如何回滾服務。

• parallelism：一次要回滾的容器數。如果設置為0，則所有容器將同時回滾。
• delay：每個容器組回滾之間等待的時間（默認為0s）。
• failure_action：如果回滾失敗，該怎么辦。其中一個 continue 或者 pause（默認pause）。
• monitor：每個容器更新后，持續觀察是否失敗了的時間 (ns|us|ms|s|m|h)（默認為0s）。
• max_failure_ratio：在回滾期間可以容忍的故障率（默認為0）。
• order：回滾期間的操作順序。其中一個 stop-first（串行回滾），或者 start-first（並行回滾）（默認 stop-first ）。

update_config：配置應如何更新服務，對於配置滾動更新很有用。

• parallelism：一次更新的容器數。
• delay：在更新一組容器之間等待的時間。
• failure_action：如果更新失敗，該怎么辦。其中一個 continue，rollback 或者pause （默認：pause）。
• monitor：每個容器更新后，持續觀察是否失敗了的時間 (ns|us|ms|s|m|h)（默認為0s）。
• max_failure_ratio：在更新過程中可以容忍的故障率。
• order：回滾期間的操作順序。其中一個 stop-first（串行回滾），或者 start-first（並行回滾）（默認stop-first）。

注：僅支持 V3.4 及更高版本。

devices

指定設備映射列表。

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

dns

自定義 DNS 服務器，可以是單個值或列表的多個值。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search

自定義 DNS 搜索域。可以是單個值或列表。

dns_search: example.com

dns_search:
  - dc1.example.com
  - dc2.example.com

entrypoint

覆蓋容器默認的 entrypoint。

entrypoint: /code/entrypoint.sh

也可以是以下格式：

entrypoint:
    - php
    - -d
    - zend_extension=/usr/local/lib/php/extensions/no-debug-non-zts-20100525/xdebug.so
    - -d
    - memory_limit=-1
    - vendor/bin/phpunit

env_file

從文件添加環境變量。可以是單個值或列表的多個值。

env_file: .env

也可以是列表格式：

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

environment

添加環境變量。您可以使用數組或字典、任何布爾值，布爾值需要用引號引起來，以確保 YML 解析器不會將其轉換為 True 或 False。

environment:
  RACK_ENV: development
  SHOW: 'true'

expose

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

僅可以指定內部端口為參數：

expose:
 - "3000"
 - "8000"

extra_hosts

添加主機名映射。類似 docker client --add-host。

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"

以上會在此服務的內部容器中 /etc/hosts 創建一個具有 ip 地址和主機名的映射關系：

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

用於檢測 docker 服務是否健康運行。

healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost"] # 設置檢測程序
  interval: 1m30s # 設置檢測間隔
  timeout: 10s # 設置檢測超時時間
  retries: 3 # 設置重試次數
  start_period: 40s # 啟動后，多少秒開始啟動檢測程序

image

指定容器運行的鏡像。以下格式都可以：

image: redis
image: ubuntu:14.04
image: tutum/influxdb
image: example-registry.com:4000/postgresql
image: a4bc65fd # 鏡像id

logging

服務的日志記錄配置。

driver：指定服務容器的日志記錄驅動程序，默認值為json-file。有以下三個選項

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

僅在 json-file 驅動程序下，可以使用以下參數，限制日志得數量和大小。

logging:
  driver: json-file
  options:
    max-size: "200k" # 單個文件大小為200k
    max-file: "10" # 最多10個文件

當達到文件限制上限，會自動刪除舊得文件。

syslog 驅動程序下，可以使用 syslog-address 指定日志接收地址。

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

network_mode

設置網絡模式。

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

networks

配置容器連接的網絡，引用頂級 networks 下的條目 。

services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
      other-network:
        aliases:
         - alias2
networks:
  some-network:
    # Use a custom driver
    driver: custom-driver-1
  other-network:
    # Use a custom driver which takes special options
    driver: custom-driver-2

aliases ：同一網絡上的其他容器可以使用服務名稱或此別名來連接到對應容器的服務。

restart

• no：是默認的重啟策略，在任何情況下都不會重啟容器。
• always：容器總是重新啟動。
• on-failure：在容器非正常退出時（退出狀態非0），才會重啟容器。
• unless-stopped：在容器退出時總是重啟容器，但是不考慮在Docker守護進程啟動時就已經停止了的容器

restart: "no"
restart: always
restart: on-failure
restart: unless-stopped

注：swarm 集群模式，請改用 restart_policy。

secrets

存儲敏感數據，例如密碼：

version: "3.1"
services:

mysql:
  image: mysql
  environment:
    MYSQL_ROOT_PASSWORD_FILE: /run/secrets/my_secret
  secrets:
    - my_secret

secrets:
  my_secret:
    file: ./my_secret.txt

security_opt

修改容器默認的 schema 標簽。

security-opt：
  - label:user:USER   # 設置容器的用戶標簽
  - label:role:ROLE   # 設置容器的角色標簽
  - label:type:TYPE   # 設置容器的安全策略標簽
  - label:level:LEVEL  # 設置容器的安全等級標簽

stop_grace_period

指定在容器無法處理 SIGTERM (或者任何 stop_signal 的信號)，等待多久后發送 SIGKILL 信號關閉容器。

stop_grace_period: 1s # 等待 1 秒
stop_grace_period: 1m30s # 等待 1 分 30 秒 

默認的等待時間是 10 秒。

stop_signal

設置停止容器的替代信號。默認情況下使用 SIGTERM 。

以下示例，使用 SIGUSR1 替代信號 SIGTERM 來停止容器。

stop_signal: SIGUSR1

sysctls

設置容器中的內核參數，可以使用數組或字典格式。

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

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

tmpfs

在容器內安裝一個臨時文件系統。可以是單個值或列表的多個值。

tmpfs: /run

tmpfs:
  - /run
  - /tmp

ulimits

覆蓋容器默認的 ulimit。

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

volumes

將主機的數據卷或着文件掛載到容器里。

version: "3.7"
services:
  db:
    image: postgres:latest
    volumes:
      - "/localhost/postgres.sock:/var/run/postgres/postgres.sock"
      - "/localhost/data:/var/lib/postgresql/data"