1. 程式人生 > >Docker-compose 模板

Docker-compose 模板

一個可以使用顯示卡的mnist compose模板

version: "2.3"

#mnist
services:
  mnist:
    build:
      context: ./mnist
      dockerfile: Dockerfile

    container_name: mnist
    image: myapp:mnist
    runtime: "nvidia"
    environment:
      NVIDIA_VISIBLE_DEVICES: all
      NVIDIA_DRIVER_CAPABILITIES: compute,utility
      NVIDIA_REQUIRE_CUDA: "cuda>=9.0"
    restart: always
    network_mode: "host"
    ports:
      - "8081:8081"
    volumes:
      - logs_mnist:/DATA/code/mnist

build: 指定 Dockerfile 所在資料夾的路徑(可以是絕對路徑,或者相對 docker-compose.yml 檔案的路徑) 。 Compose 將會利用它自動構建這個映象,然後使用這個映象。

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

也可以使用 context 指令指定 Dockerfile 所在資料夾的路徑。使用 dockerfile 指令指定 Dockerfile 檔名。使用 arg 指令指定構建映象時的變數。

version: '3'
services:
  webapp:
    build:
    context: ./dir
    dockerfile: Dockerfile-alternate
    args:
      buildno: 1 

cap_add, cap_drop: 指定容器的核心能力(capacity) 分配。 例如,讓容器擁有所有能力可以指定為:

cap_add:
  - ALL

去掉 NET_ADMIN 能力可以指定為:

cap_drop:
  - NET_ADMIN 

command: 覆蓋容器啟動後預設執行的命令。

command: echo "hello world"

configs: 僅用於 Swarm mode

cgroup_parent: 指定父 cgroup 組,意味著將繼承該組的資源限制。 例如,建立了一個 cgroup 組名稱為 cgroups_1 。

cgroup_parent: cgroups_1 

container_name: 指定容器名稱。預設將會使用 專案名稱_服務名稱_序號 這樣的格式。 container_name: docker-web-container 注意: 指定容器名稱後,該服務將無法進行擴充套件(scale) ,因為 Docker 不允許多個容器具有相同的名稱。

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: example.com
dns_search:
  - domain1.example.com
  - domain2.example.com 

tmpfs: 掛載一個 tmpfs 檔案系統到容器。

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

env_file: 從檔案中獲取環境變數,可以為單獨的檔案路徑或列表。 如果通過 docker-compose -f FILE 方式來指定 Compose 模板檔案,則 env_file 中變數的路徑會基於模板檔案路徑。 如果有變數名稱與 environment 指令衝突,則按照慣例,以後者為準。

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

環境變數檔案中每一行必須符合格式,支援 # 開頭的註釋行。

# common.env: Set development environment
PROG_ENV=development

environment: 設定環境變數。你可以使用陣列或字典兩種格式。 只給定名稱的變數會自動獲取執行 Compose 主機上對應變數的值,可以用來防止洩露不必要的資料。

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

如果變數名稱或者值中用到 true|false,yes|no 等表達 布林 含義的詞彙,最好放到引號裡,避免 YAML 自動解析某些內容為對應的布林語義。這些特定詞彙,包括

y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF 

expose: 暴露埠,但不對映到宿主機,只被連線的服務訪問。僅可以指定內部埠為引數

expose:
  - "3000"
  - "8000" 

external_links: 注意:不建議使用該指令。 連結到 docker-compose.yml 外部的容器,甚至並非 Compose 管理的外部容器。

external_links:
  - redis_1
  - project_db_1:mysql
  - project_db_1:postgresql 

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
  timeout: 10s
  retries: 3 

image: 指定為映象名稱或映象 ID。如果映象在本地不存在, Compose 將會嘗試拉取這個映象。

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: 暴露埠資訊。

使用宿主埠:容器埠 (HOST:CONTAINER) 格式,或者僅僅指定容器的埠(宿主將會隨機選擇埠) 都可以。

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

注意:當使用 HOST:CONTAINER 格式來對映埠時,如果你使用的容器埠小於 60 並且沒放 到引號裡,可能會得到錯誤結果,因為 YAML 會自動解析 xx:yy 這種數字格式為 60 進位制。 為避免出現這種問題,建議數字串都採用引號包括起來的字串格式。

secrets: 儲存敏感資料,例如 mysql 服務密碼。

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: 指定容器模板標籤(label) 機制的預設屬性(使用者、角色、型別、級別等) 。例如配置標籤的使用者名稱和角色名。

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

stop_signal :

設定另一個訊號來停止容器。在預設情況下使用的是 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 

ulimits: 指定容器的 ulimits 限制值。 例如,指定最大程序數為 65535,指定檔案控制代碼數為 20000(軟限制,應用可以隨時修改,不能超過硬限制) 和 40000(系統硬限制,只能 root 使用者提高) 。

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

volumes: 資料卷所掛載路徑設定。可以設定宿主機路徑 (HOST:CONTAINER ) 或加上訪問模式(HOST:CONTAINER:ro ) 。該指令中路徑支援相對路徑。

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

entrypoint :

指定服務容器啟動後執行的入口檔案。

entrypoint: /code/entrypoint.sh 

user :

指定容器中執行應用的使用者名稱。

user: nginx 

working_dir:

指定容器中工作目錄。

working_dir: /code 

domainname :

指定容器中搜索域名

domainname: your_website.com 

hostname:

指定容器中搜索主機名

hostname: test 

mac_address :

指定容器中搜索mac 地址

mac_address: 08-00-27-00-0C-0A 

privileged :

允許容器中執行一些特權命令。

privileged: true

restart :

指定容器退出後的重啟策略為始終重啟。該命令對保持服務始終執行十分有效,在生產環境中推薦配置為 always 或者 unless-stopped 。

restart: always 

read_only :

以只讀模式掛載容器的 root 檔案系統,意味著不能對容器內容進行修改。

read_only: true 

stdin_open:

開啟標準輸入,可以接受外部輸入。

stdin_open: true

tty :

模擬一個偽終端。

tty: true 

讀取變數:

Compose 模板檔案支援動態讀取主機的系統環境變數和當前目錄下的 .env 檔案中的變數。 例如,下面的 Compose 檔案將從執行它的環境中讀取變數 ${MONGO_VERSION} 的值,並寫入 執行的指令中。

version: "3"
services:
db:
  image: "mongo:${MONGO_VERSION}"

如果執行 MONGO_VERSION=3.2 docker-compose up 則會啟動一個 mongo:3.2 映象的容器;如果 執行 MONGO_VERSION=2.8 docker-compose up 則會啟動一個 mongo:2.8 映象的容器。 若當前目錄存在 .env 檔案,執行 docker-compose 命令時將從該檔案中讀取變數。 在當前目錄新建 .env 檔案並寫入以下內容。

# 支援 # 號註釋
MONGO_VERSION=3.6

執行 docker-compose up 則會啟動一個 mongo:3.6 映象的容器。