docker-compose 模板文件指令

1、bulid
  • 服務(wù)除了可以基于指定的鏡像,還可以基于一份 Dockerfile,在使用 up 啟動之時執(zhí)行構(gòu)建任務(wù),這個構(gòu)建標簽就是 build,它可以指定 Dockerfile 所在文件夾的路徑。Compose 將會利用它自動構(gòu)建這個鏡像,然后使用這個鏡像啟動服務(wù)容器
build: /path/to/build/dir

也可以是相對路徑

build: ./dir

設(shè)定上下文根目錄,然后以該目錄為準指定 Dockerfile

build:
  context: ../
  dockerfile: path/of/Dockerfile

例子:

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

如果 context 中有指定的路徑,并且可以選定 Dockerfile 和 args。那么 arg 這個標簽,就像 Dockerfile 中的 ARG 指令,它可以在構(gòu)建過程中指定環(huán)境變量,但是在構(gòu)建成功后取消,在 docker-compose.yml 文件中也支持這樣的寫法:

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

與 ENV 不同的是,ARG 可以為空值

args:
  - buildno
  - password

如果要指定 image 以及 build ,選項格式為

build: ./dir
image: webapp:tag

這會在 ./dir 目錄生成一個名為 webaapp 和標記為 tag 的鏡像

Note:當用(Version 3) Compose 文件在群集模式下部署堆棧時,該選項被忽略。因為 docker stack 命令只接受預(yù)先構(gòu)建的鏡像

2、 context

context 選項可以是 Dockerfile 的文件路徑,也可以是到鏈接到 git 倉庫的 url

當提供的值是相對路徑時,它被解析為相對于撰寫文件的路徑,此目錄也是發(fā)送到 Docker 守護進程的 context

build:
  context: ./dir
3、 dockerfile

使用此 dockerfile 文件來構(gòu)建,必須指定構(gòu)建路徑

build:
  context: .
  dockerfile: Dockerfile-alternate
4、args

添加構(gòu)建參數(shù),這些參數(shù)是僅在構(gòu)建過程中可訪問的環(huán)境變量

首先, 在Dockerfile中指定參數(shù):

ARG buildno
ARG password

RUN echo "Build number: $buildno"
RUN script-requiring-password.sh "$password"

然后指定 build 下的參數(shù),可以傳遞映射或列表

build:
  context: .
  args:
    buildno: 1
    password: secret

build:
  context: .
  args:
    - buildno=1
    - password=secret

指定構(gòu)建參數(shù)時可以省略該值,在這種情況下,構(gòu)建時的值默認構(gòu)成運行環(huán)境中的值

args:
  - buildno
  - password

Note: YAML 布爾值(true,false,yes,no,on,off)必須使用引號括起來,以為了能夠正常被解析為字符串

5、cache_from

編寫緩存解析鏡像列表

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14
6、labels

使用 Docker標簽 將元數(shù)據(jù)添加到生成的鏡像中,可以使用數(shù)組或字典。

建議使用反向 DNS 標記來防止簽名與其他軟件所使用的簽名沖突

build:
  context: .
  labels:
    com.example.description: "Accounting webapp"
    com.example.department: "Finance"
    com.example.label-with-empty-value: ""

build:
  context: .
  labels:
    - "com.example.description=Accounting webapp"
    - "com.example.department=Finance"
    - "com.example.label-with-empty-value"
7、shm_size

設(shè)置容器 /dev/shm 分區(qū)的大小,值為表示字節(jié)的整數(shù)值或表示字符的字符串

build:
  context: .
  shm_size: '2gb'

build:
  context: .
  shm_size: 10000000

8、target
根據(jù)對應(yīng)的 Dockerfile 構(gòu)建指定 Stage

build:
    context: .
    target: prod
9、cap_add、cap_drop

添加或刪除容器功能,可查看 man 7 capabilities

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

Note:當用(Version 3) Compose 文件在群集模式下部署堆棧時,該選項被忽略。因為 docker stack 命令只接受預(yù)先構(gòu)建的鏡像

10、command

覆蓋容器啟動后默認執(zhí)行的命令

command: bundle exec thin -p 3000

該命令也可以是一個列表,方法類似于 dockerfile:

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

使用服務(wù) configs 配置為每個服務(wù)賦予相應(yīng)的訪問權(quán)限,支持兩種不同的語法。

Note: 配置必須存在或在 configs 此堆棧文件的頂層中定義,否則堆棧部署失效

(1).SHORT 語法
SHORT 語法只能指定配置名稱,這允許容器訪問配置并將其安裝在 /<config_name> 容器內(nèi),源名稱和目標裝入點都設(shè)為配置名稱。

version: "3.3"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - my_config
      - my_other_config
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

以上實例使用 SHORT 語法將 redis 服務(wù)訪問授予 my_config 和 my_other_config ,并被 my_other_config 定義為外部資源,這意味著它已經(jīng)在 Docker 中定義。可以通過 docker config create 命令或通過另一個堆棧部署。如果外部部署配置都不存在,則堆棧部署會失敗并出現(xiàn) config not found 錯誤。

Note: config 定義僅在 3.3 版本或在更高版本的撰寫文件格式中受支持,YAML 的布爾值(true, false, yes, no, on, off)必須要使用引號引起來(單引號、雙引號均可),否則會當成字符串解析。

(2). LONG 語法
LONG 語法提供了創(chuàng)建服務(wù)配置的更加詳細的信息

source:Docker 中存在的配置的名稱
target:要在服務(wù)的任務(wù)中裝載的文件的路徑或名稱。如果未指定則默認為 /<source>
uid 和 gid:在服務(wù)的任務(wù)容器中擁有安裝的配置文件的數(shù)字 UID 或 GID。如果未指定,則默認為在Linux上。Windows不支持。
mode:在服務(wù)的任務(wù)容器中安裝的文件的權(quán)限,以八進制表示法。例如,0444 代表文件可讀的。默認是 0444。如果配置文件無法寫入,是因為它們安裝在臨時文件系統(tǒng)中,所以如果設(shè)置了可寫位,它將被忽略??蓤?zhí)行位可以設(shè)置。如果您不熟悉 UNIX 文件權(quán)限模式,Unix Permissions Calculator
下面示例在容器中將 my_config 名稱設(shè)置為 redis_config,將模式設(shè)置為 0440(group-readable)并將用戶和組設(shè)置為 103。該?。鄏edis 服務(wù)無法訪問 my_other_config 配置。

version: "3.3"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    configs:
      - source: my_config
        target: /redis_config
        uid: '103'
        gid: '103'
        mode: 0440
configs:
  my_config:
    file: ./my_config.txt
  my_other_config:
    external: true

可以同時授予多個配置的服務(wù)相應(yīng)的訪問權(quán)限,也可以混合使用 LONG 和 SHORT 語法。定義配置并不意味著授予服務(wù)訪問權(quán)限。

12、cgroup_parent

可以為容器選擇一個可選的父 cgroup

cgroup_parent: m-executor-abcd

注意:當 使用(Version 3)Compose 文件在群集模式下部署堆棧時,忽略此選項

13、 container_name

為自定義的容器指定一個名稱,而不是使用默認的名稱

container_name: my-web-container

因為 docker 容器名稱必須是唯一的,所以如果指定了一個自定義的名稱,不能擴展一個服務(wù)超過 1 個容器

14、 credential_spec

為托管服務(wù)賬戶配置憑據(jù)規(guī)范,此選項僅適用于 Windows 容器服務(wù)

在 credential_spec 上的配置列表格式為 file://<filename> 或 registry://<value-name>

使用 file: 應(yīng)該注意引用的文件必須存在于 CredentialSpecs,docker 數(shù)據(jù)目錄的子目錄中。在 Windows 上,該目錄默認為 C:\ProgramData\Docker\。以下示例從名為C:\ProgramData\Docker\CredentialSpecs\my-credential-spec.json 的文件加載憑證規(guī)范 :

credential_spec:
  file: my-credential-spec.json

使用 registry: 將從守護進程主機上的 Windows 注冊表中讀取憑據(jù)規(guī)范。其注冊表值必須位于:

HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Virtualization\Containers\CredentialSpecs

下面的示例通過 my-credential-spec 注冊表中指定的值加載憑證規(guī)范:

credential_spec:
  registry: my-credential-spec
15、deploy

指定與部署和運行服務(wù)相關(guān)的配置

version: '3'
services:
  redis:
    image: redis:alpine
    deploy:
      replicas: 6
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure
  • 這里有幾個子選項:
    (1). endpoint_mode
    指定連接到群組外部客戶端服務(wù)發(fā)現(xiàn)方法

endpoint_mode:vip :Docker 為該服務(wù)分配了一個虛擬 IP(VIP),作為客戶端的 “前端“ 部位用于訪問網(wǎng)絡(luò)上的服務(wù)。
endpoint_mode: dnsrr : DNS輪詢(DNSRR)服務(wù)發(fā)現(xiàn)不使用單個虛擬 IP。Docker為服務(wù)設(shè)置 DNS 條目,使得服務(wù)名稱的 DNS 查詢返回一個 IP 地址列表,并且客戶端直接連接到其中的一個。如果想使用自己的負載平衡器,或者混合 Windows 和 Linux 應(yīng)用程序,則 DNS 輪詢調(diào)度(round-robin)功能就非常實用。

version: "3.3"

services:
  wordpress:
    image: wordpress
    ports:
      - 8080:80
    networks:
      - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: vip

  mysql:
    image: mysql
    volumes:
       - db-data:/var/lib/mysql/data
    networks:
       - overlay
    deploy:
      mode: replicated
      replicas: 2
      endpoint_mode: dnsrr

volumes:
  db-data:

networks:
  overlay:

相關(guān)信息:Swarm 模式 CLI 命令 、Configure 服務(wù)發(fā)現(xiàn)

(2).labels
指定服務(wù)的標簽,這些標簽僅在服務(wù)上設(shè)置。

version: "3"
services:
  web:
    image: web
    deploy:
      labels:
        com.example.description: "This label will appear on the web service"

通過將 deploy 外面的 labels 標簽來設(shè)置容器上的 labels

version: "3"
services:
  web:
    image: web
    labels:
      com.example.description: "This label will appear on all containers for the web service"

(3).mode

global:每個集節(jié)點只有一個容器
replicated:指定容器數(shù)量(默認)

version: '3'
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    deploy:
      mode: global

(4). placement
指定 constraints 和 preferences

version: '3'
services:
  db:
    image: postgres
    deploy:
      placement:
        constraints:
          - node.role == manager
          - engine.labels.operatingsystem == ubuntu 14.04
        preferences:
          - spread: node.labels.zone

(5).replicas
如果服務(wù)是 replicated(默認),需要指定運行的容器數(shù)量

version: '3'
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 6

(6). resources
配置資源限制

version: '3'
services:
  redis:
    image: redis:alpine
    deploy:
      resources:
        limits:
          cpus: '0.50'
          memory: 50M
        reservations:
          cpus: '0.25'
          memory: 20M

此例子中,redis 服務(wù)限制使用不超過 50M 的內(nèi)存和 0.50(50%)可用處理時間(CPU),并且 保留 20M 了內(nèi)存和 0.25 CPU時間

(7). restart_policy
配置容器的重新啟動,代替 restart

condition:值可以為 none 、on-failure 以及 any(默認)
delay: 嘗試重啟的等待時間,默認為 0
max_attempts:在放棄之前嘗試重新啟動容器次數(shù)(默認:從不放棄)。如果重新啟動在配置中沒有成功 window,則此嘗試不計入配置max_attempts 值。例如,如果 max_attempts 值為 2,并且第一次嘗試重新啟動失敗,則可能會嘗試重新啟動兩次以上。
windows:在決定重新啟動是否成功之前的等時間,指定為持續(xù)時間(默認值:立即決定)。

version: "3"
services:
  redis:
    image: redis:alpine
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s
        max_attempts: 3
        window: 120s

(8). update_config
配置更新服務(wù),用于無縫更新應(yīng)用(rolling update)

parallelism:一次性更新的容器數(shù)量
delay:更新一組容器之間的等待時間。
failure_action:如果更新失敗,可以執(zhí)行的的是 continue、rollback 或 pause (默認)
monitor:每次任務(wù)更新后監(jiān)視失敗的時間(ns|us|ms|s|m|h)(默認為0)
max_failure_ratio:在更新期間能接受的失敗率
order:更新次序設(shè)置,top-first(舊的任務(wù)在開始新任務(wù)之前停止)、start-first(新的任務(wù)首先啟動,并且正在運行的任務(wù)短暫重疊)(默認 stop-first)

version: '3.4'
services:
  vote:
    image: dockersamples/examplevotingapp_vote:before
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
        order: stop-first

不支持 Docker stack desploy 的幾個子選項
build、cgroup_parent、container_name、devices、tmpfs、external_links、inks、network_mode、restart、security_opt、stop_signal、sysctls、userns_mode

16、devices

設(shè)置映射列表,與 Docker 客戶端的 --device 參數(shù)類似 :

devices:
  - "/dev/ttyUSB0:/dev/ttyUSB0"
17、depends_on

此選項解決了啟動順序的問題

在使用 Compose 時,最大的好處就是少打啟動命令,但是一般項目容器啟動的順序是有要求的,如果直接從上到下啟動容器,必然會因為容器依賴問題而啟動失敗。例如在沒啟動數(shù)據(jù)庫容器的時候啟動了應(yīng)用容器,這時候應(yīng)用容器會因為找不到數(shù)據(jù)庫而退出,為了避免這種情況我們需要加入一個標簽,就是 depends_on,這個標簽解決了容器的依賴、啟動先后的問題。

指定服務(wù)之間的依賴關(guān)系,有兩種效果

docker-compose up 以依賴順序啟動服務(wù),下面例子中 redis 和 db 服務(wù)在 web 啟動前啟動
docker-compose up SERVICE 自動包含 SERVICE 的依賴性,下面例子中,例如下面容器會先啟動 redis 和 db
兩個服務(wù),最后才啟動 web 服務(wù):

version: '3'
services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

注意的是,默認情況下使用 docker-compose up web 這樣的方式啟動 web 服務(wù)時,也會啟動 redis 和 db 兩個服務(wù),因為在配置文件中定義了依賴關(guān)系

18、dns

自定義 DNS 服務(wù)器,與 --dns 具有一樣的用途,可以是單個值或列表

dns: 8.8.8.8
dns:
  - 8.8.8.8
  - 9.9.9.9
19、dns_search

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

dns_search: example.com
dns_search:
  - dc1.example.com
  - dc2.example.com
20、 tmpfs

掛載臨時文件目錄到容器內(nèi)部,與 run 的參數(shù)一樣效果,可以是單個值或列表

tmpfs: /run
tmpfs:
- /run
- /tmp
21、entrypoint

在 Dockerfile 中有一個指令叫做 ENTRYPOINT 指令,用于指定接入點。在 docker-compose.yml 中可以定義接入點,覆蓋 Dockerfile 中的定義:

entrypoint: /code/entrypoint.sh

entrypoint 也可以是一個列表,方法類似于 dockerfile

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

從文件中添加環(huán)境變量??梢允菃蝹€值或是列表
如果已經(jīng)用 docker-compose -f FILE 指定了 Compose 文件,那么 env_file 路徑值為相對于該文件所在的目錄

但 environment 環(huán)境中的設(shè)置的變量會會覆蓋這些值,無論這些值未定義還是為 None

env_file: .env

或者根據(jù) docker-compose.yml 設(shè)置多個:

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

環(huán)境配置文件 env_file 中的聲明每行都是以 VAR=VAL 格式,其中以 # 開頭的被解析為注釋而被忽略

注意環(huán)境變量配置列表的順序*,例如下面例子

docker_compose.yml

services:
  some-service:
    env_file:
      - a.env
      - b.env

a.env 文件

# a.env
VAR=1

b.env文件

對于在文件a.env 中指定的相同變量但在文件 b.env 中分配了不同的值,如果 b.env 像下面列在 a.env 之后,則剛在 a.env 設(shè)置的值被 b.env 相同變量的值覆蓋,此時 $VAR 值為 hello。此外,這里所說的環(huán)境變量是對宿主機的 Compose 而言的,如果在配置文件中有 build 操作,這些變量并不會進入構(gòu)建過程中,如果要在構(gòu)建中使用變量還是首選 arg 標簽

22、environment

添加環(huán)境變量,可以使用數(shù)組或字典。與上面的 env_file 選項完全不同,反而和 arg 有幾分類似,這個標簽的作用是設(shè)置鏡像變量,它可以保存變量到鏡像里面,也就是說啟動的容器也會包含這些變量設(shè)置,這是與 arg 最大的不同。
一般 arg 標簽的變量僅用在構(gòu)建過程中。而 environment 和 Dockerfile 中的 ENV 指令一樣會把變量一直保存在鏡像、容器中,類似 docker run -e 的效果

environment:
  RACK_ENV: development
  SHOW: 'true'
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SHOW=true
  - SESSION_SECRET
23、 expose

暴露端口,但不映射到宿主機,只被連接的服務(wù)訪問。這個標簽與 Dockerfile 中的 EXPOSE 指令一樣,用于指定暴露的端口,但是只是作為一種參考,實際上 docker-compose.yml 的端口映射還得 ports 這樣的標簽

expose:
 - "3000"
 - "8000"
24、external_links

鏈接到 docker-compose.yml 外部的容器,甚至 并非 Compose 項目文件管理的容器。參數(shù)格式跟 links 類似

在使用Docker過程中,會有許多單獨使用 docker run 啟動的容器的情況,為了使 Compose 能夠連接這些不在docker-compose.yml 配置文件中定義的容器,那么就需要一個特殊的標簽,就是 external_links,它可以讓Compose 項目里面的容器連接到那些項目配置外部的容器(前提是外部容器中必須至少有一個容器是連接到與項目內(nèi)的服務(wù)的同一個網(wǎng)絡(luò)里面)。

格式如下

external_links:
 - redis_1
 - project_db_1:mysql
 - project_db_1:postgresql
25、extra_hosts

添加主機名的標簽,就是往 /etc/hosts 文件中添加一些記錄,與 Docker 客戶端 中的 --add-host 類似:

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

具有 IP 地址和主機名的條目在 /etc/hosts 內(nèi)部容器中創(chuàng)建。啟動之后查看容器內(nèi)部 hosts ,例如:

162.242.195.82  somehost
50.31.209.229   otherhost
26、healthcheck

用于檢查測試服務(wù)使用的容器是否正常

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

interval,timeout 以及 start_period 都定為持續(xù)時間

test 必須是字符串或列表,如果它是一個列表,第一項必須是 NONE,CMD 或 CMD-SHELL ;如果它是一個字符串,則相當于指定CMD-SHELL 后跟該字符串。

# Hit the local web app
test: ["CMD", "curl", "-f", "http://localhost"]

# As above, but wrapped in /bin/sh. Both forms below are equivalent.
test: ["CMD-SHELL", "curl -f http://localhost || exit 1"]
test: curl -f https://localhost || exit 1

如果需要禁用鏡像的所有檢查項目,可以使用 disable:true,相當于 test:["NONE"]

healthcheck:
  disable: true
27、image

從指定的鏡像中啟動容器,可以是存儲倉庫、標簽以及鏡像 ID

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

如果鏡像不存在,Compose 會自動拉去鏡像

28、 isolation

Linux 上僅僅支持 default 值

29、labels

使用 Docker 標簽將元數(shù)據(jù)添加到容器,可以使用數(shù)組或字典。與 Dockerfile 中的 LABELS 類似:

labels:
  com.example.description: "Accounting webapp"
  com.example.department: "Finance"
  com.example.label-with-empty-value: ""

labels:
  - "com.example.description=Accounting webapp"
  - "com.example.department=Finance"
  - "com.example.label-with-empty-value"
30、links

鏈接到其它服務(wù)的中的容器,可以指定服務(wù)名稱也可以指定鏈接別名(SERVICE:ALIAS),與 Docker 客戶端的 --link 有一樣效果,會連接到其它服務(wù)中的容器

web:
  links:
   - db
   - db:database
   - redis

使用的別名將會自動在服務(wù)容器中的 /etc/hosts 里創(chuàng)建。例如:

172.12.2.186  db
172.12.2.186  database
172.12.2.187  redis

相應(yīng)的環(huán)境變量也將被創(chuàng)建

31、 logging

配置日志服務(wù)

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

該 driver值是指定服務(wù)器的日志記錄驅(qū)動程序,默認值為 json-file,與 --log-diver 選項一樣

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

注意:只有驅(qū)動程序 json-file 和 journald 驅(qū)動程序可以直接從 docker-compose up 和 docker-compose logs 獲取日志。使用任何其他方式不會顯示任何日志。

對于可選值,可以使用 options 指定日志記錄中的日志記錄選項

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

默認驅(qū)動程序 json-file 具有限制存儲日志量的選項,所以,使用鍵值對來獲得最大存儲大小以及最小存儲數(shù)量

options:
  max-size: "200k"
  max-file: "10"

上面實例將存儲日志文件,直到它們達到max-size:200kB,存儲的單個日志文件的數(shù)量由該 max-file 值指定。隨著日志增長超出最大限制,舊日志文件將被刪除以存儲新日志

docker-compose.yml 限制日志存儲的示例

services:
  some-service:
    image: some-service
    logging:
      driver: "json-file"
      options:
        max-size: "200k"
        max-file: "10"
32、network_mode

網(wǎng)絡(luò)模式,用法類似于 Docke 客戶端的 --net 選項,格式為:service:[service name]

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

可以指定使用服務(wù)或者容器的網(wǎng)絡(luò)

33、networks

加入指定網(wǎng)絡(luò)

services:
  some-service:
    networks:
     - some-network
     - other-network
34、 aliases

同一網(wǎng)絡(luò)上的其他容器可以使用服務(wù)器名稱或別名來連接到其他服務(wù)的容器

services:
  some-service:
    networks:
      some-network:
        aliases:
         - alias1
         - alias3
      other-network:
        aliases:
         - alias2

下面實例中,提供 web 、worker以及db 服務(wù),伴隨著兩個網(wǎng)絡(luò) new 和 legacy 。

version: '2'

services:
  web:
    build: ./web
    networks:
      - new

  worker:
    build: ./worker
    networks:
      - legacy

  db:
    image: mysql
    networks:
      new:
        aliases:
          - database
      legacy:
        aliases:
          - mysql

networks:
  new:
  legacy:

相同的服務(wù)可以在不同的網(wǎng)絡(luò)有不同的別名

35、ipv4_address、ipv6_address

為服務(wù)的容器指定一個靜態(tài) IP 地址

version: '2.1'

services:
  app:
    image: busybox
    command: ifconfig
    networks:
      app_net:
        ipv4_address: 172.16.238.10
        ipv6_address: 2001:3984:3989::10

networks:
  app_net:
    driver: bridge
    enable_ipv6: true
    ipam:
      driver: default
      config:
      -
        subnet: 172.16.238.0/24
      -
        subnet: 2001:3984:3989::/64
36、PID
pid: "host"

將 PID 模式設(shè)置為主機 PID 模式,可以打開容器與主機操作系統(tǒng)之間的共享 PID 地址空間。使用此標志啟動的容器可以訪問和操作宿主機的其他容器,反之亦然。

37、ports

映射端口

(1). SHORT 語法
可以使用 HOST:CONTAINER 的方式指定端口,也可以指定容器端口(選擇臨時主機端口),宿主機會隨機映射端口

ports:
 - "3000"
 - "3000-3005"
 - "8000:8000"
 - "9090-9091:8080-8081"
 - "49100:22"
 - "127.0.0.1:8001:8001"
 - "127.0.0.1:5000-5010:5000-5010"
 - "6060:6060/udp"

注意:當使用 HOST:CONTAINER 格式來映射端口時,如果使用的容器端口小于 60 可能會得到錯誤得結(jié)果,因為YAML 將會解析 xx:yy 這種數(shù)字格式為 60 進制,所以建議采用字符串格式。

(2). LONG 語法
LONG 語法支持 SHORT 語法不支持的附加字段

target:容器內(nèi)的端口
published:公開的端口
protocol: 端口協(xié)議(tcp 或 udp)
mode:通過host 用在每個節(jié)點還是哪個發(fā)布的主機端口或使用 ingress 用于集群模式端口進行平衡負載,

ports:
  - target: 80
    published: 8080
    protocol: tcp
    mode: host
38、secrets

通過 secrets為每個服務(wù)授予相應(yīng)的訪問權(quán)限

(1). SHORT 語法

version: "3.1"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    secrets:
      - my_secret
      - my_other_secret
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true

(2). LONG 語法
LONG 語法可以添加其他選項

source:secret 名稱
target:在服務(wù)任務(wù)容器中需要裝載在 /run/secrets/ 中的文件名稱,如果 source 未定義,那么默認為此值
uid&gid:在服務(wù)的任務(wù)容器中擁有該文件的 UID 或 GID 。如果未指定,兩者都默認為 0。
mode:以八進制表示法將文件裝載到服務(wù)的任務(wù)容器中 /run/secrets/ 的權(quán)限。例如,0444 代表可讀。

version: "3.1"
services:
  redis:
    image: redis:latest
    deploy:
      replicas: 1
    secrets:
      - source: my_secret
        target: redis_secret
        uid: '103'
        gid: '103'
        mode: 0440
secrets:
  my_secret:
    file: ./my_secret.txt
  my_other_secret:
    external: true
39、security_opt

為每個容器覆蓋默認的標簽。簡單說來就是管理全部服務(wù)的標簽,比如設(shè)置全部服務(wù)的 user 標簽值為 USER

security_opt:
  - label:user:USER
  - label:role:ROLE
40、 stop_grace_period

在發(fā)送 SIGKILL 之前指定 stop_signal ,如果試圖停止容器(如果它沒有處理 SIGTERM(或指定的任何停止信號)),則需要等待的時間

stop_grace_period: 1s
stop_grace_period: 1m30s

默認情況下,stop 在發(fā)送SIGKILL之前等待10秒鐘容器退出

41、stop_signal

設(shè)置另一個信號來停止容器。在默認情況下使用的 SIGTERM 來停止容器。設(shè)置另一個信號可以使用 stop_signal 標簽:

stop_signal: SIGUSR1
42、 sysctls

在容器中設(shè)置的內(nèi)核參數(shù),可以為數(shù)組或字典

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

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

覆蓋容器的默認限制,可以單一地將限制值設(shè)為一個整數(shù),也可以將soft/hard 限制指定為映射

ulimits:
  nproc: 65535
  nofile:
    soft: 20000
    hard: 40000
44、 userns_mode
userns_mode: "host"
45、 volumes

掛載一個目錄或者一個已存在的數(shù)據(jù)卷容器,可以直接使用 HOST:CONTAINER 這樣的格式,或者使用 HOST:CONTAINER:ro 這樣的格式,后者對于容器來說,數(shù)據(jù)卷是只讀的,這樣可以有效保護宿主機的文件系統(tǒng)

version: "3.2"
services:
  web:
    image: nginx:alpine
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static

  db:
    image: postgres:latest
    volumes:
      - "/var/run/postgres/postgres.sock:/var/run/postgres/postgres.sock"
      - "dbdata:/var/lib/postgresql/data"

volumes:
  mydata:
  dbdata:

Compose 的數(shù)據(jù)卷指定路徑可以是相對路徑,使用 . 或者 .. 來指定相對目錄。

數(shù)據(jù)卷的格式可以是下面多種形式:

volumes:
  # 只是指定一個路徑,Docker 會自動在創(chuàng)建一個數(shù)據(jù)卷(這個路徑是容器內(nèi)部的)。
  - /var/lib/mysql

  # 使用絕對路徑掛載數(shù)據(jù)卷
  - /opt/data:/var/lib/mysql

  # 以 Compose 配置文件為中心的相對路徑作為數(shù)據(jù)卷掛載到容器。
  - ./cache:/tmp/cache

  # 使用用戶的相對路徑(~/ 表示的目錄是 /home/<用戶目錄>/ 或者 /root/)。
  - ~/configs:/etc/configs/:ro

  # 已經(jīng)存在的命名的數(shù)據(jù)卷。
  - datavolume:/var/lib/mysql

如果你不使用宿主機的路徑,可以指定一個 volume_driver

volume_driver: mydriver

(1). SHORT 語法
可以選擇在主機(HOST:CONTAINER)或訪問模式(HOST:CONTAINER:ro)上指定路徑。

可以在主機上掛載相對路徑,該路徑相對于正在使用的 Compose 配置文件的目錄進行擴展。相對路徑應(yīng)始終以 . 或 .. 開頭

volumes:
  # Just specify a path and let the Engine create a volume
  - /var/lib/mysql

  # Specify an absolute path mapping
  - /opt/data:/var/lib/mysql

  # Path on the host, relative to the Compose file
  - ./cache:/tmp/cache

  # User-relative path
  - ~/configs:/etc/configs/:ro

  # Named volume
  - datavolume:/var/lib/mysql

(2). LONG 語法
LONG 語法有些附加字段

type:安裝類型,可以為 volume、bind 或 tmpfs
source:安裝源,主機上用于綁定安裝的路徑或定義在頂級 volumes密鑰中卷的名稱 ,不適用于 tmpfs 類型安裝。
target:卷安裝在容器中的路徑
read_only:標志將卷設(shè)置為只讀
bind:配置額外的綁定選項
propagation:用于綁定的傳播模式
volume:配置額外的音量選項
nocopy:創(chuàng)建卷時禁止從容器復(fù)制數(shù)據(jù)的標志
tmpfs:配置額外的 tmpfs 選項
size:tmpfs 的大小,以字節(jié)為單位

version: "3.2"
services:
  web:
    image: nginx:alpine
    ports:
      - "80:80"
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static

networks:
  webnet:

volumes:
  mydata:
46、 volumes_from

從其它容器或者服務(wù)掛載數(shù)據(jù)卷,可選的參數(shù)是 :ro 或 :rw,前者表示容器只讀,后者表示容器對數(shù)據(jù)卷是可讀可寫的(默認情況為可讀可寫的)。

volumes_from:
  - service_name
  - service_name:ro
  - container:container_name
  - container:container_name:rw
47、 用于服務(wù)、群集以及堆棧文件的卷

在使用服務(wù),群集和 docker-stack.yml 文件時,請記住支持服務(wù)的任務(wù)(容器)可以部署在群集中的任何節(jié)點上,并且每次更新服務(wù)時都可能是不同的節(jié)點。

在缺少指定源的命名卷的情況下,Docker 為支持服務(wù)的每個任務(wù)創(chuàng)建一個匿名卷。關(guān)聯(lián)的容器被移除后,匿名卷不會保留。

如果希望數(shù)據(jù)持久存在,請使用可識別多主機的命名卷和卷驅(qū)動程序,以便可以從任何節(jié)點訪問數(shù)據(jù)。或者,對該服務(wù)設(shè)置約束,以便將其任務(wù)部署在具有該卷的節(jié)點上。

下面一個例子,Docker Labs 中 votingapp 示例的 docker-stack.yml文件中定義了一個稱為 db 的服務(wù)。它被配置為一個命名卷來保存群體上的數(shù)據(jù), 并且僅限于在節(jié)點上運行。下面是來自該文件的部分內(nèi)容:db postgres manager

version: "3"
services:
  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        constraints: [node.role == manager]
48、 restart

默認值為 no ,即在任何情況下都不會重新啟動容器;當值為 always 時,容器總是重新啟動;當值為 on-failure 時,當出現(xiàn) on-failure 報錯容器退出時,容器重新啟動。

restart: "no"
restart: always
restart: on-failure
restart: unless-stopped
49、 其他選項

關(guān)于標簽:cpu_shares、cpu_quota、 cpuse、domainname、hostname、 ipc、 mac_address、privileged、 read_only、 shm_size、stdin_open、tty、 user、 working_dir

上面這些都是一個單值的標簽,類似于使用 docker run 的效果

cpu_shares: 73
cpu_quota: 50000
cpuset: 0,1

user: postgresql
working_dir: /code

domainname: foo.com
hostname: foo
ipc: host
mac_address: 02:42:ac:11:65:43

privileged: true


read_only: true
shm_size: 64M
stdin_open: true
tty: true
50、 持續(xù)時間

某些配置選項如 check 的子選項interval以及timeout 的設(shè)置格式

2.5s
10s
1m30s
2h32m
5h34m56s

支持的單位有 us、ms、s、m 以及 h

51、 指定字節(jié)值

某些選項如 bulid 的子選項 shm_size

2b
1024kb
2048k
300m
1gb

支持的單位是 b,k,m 以及 g,或 kb, mb 和 gb。目前不支持十進制值

52、 extends

這個標簽可以擴展另一個服務(wù),擴展內(nèi)容可以是來自在當前文件,也可以是來自其他文件,相同服務(wù)的情況下,后來者會有選擇地覆蓋原有配置

extends:
  file: common.yml
  service: webapp

用戶可以在任何地方使用這個標簽,只要標簽內(nèi)容包含 file 和 service 兩個值就可以了。file 的值可以是相對或者絕對路徑,如果不指定 file 的值,那么 Compose 會讀取當前 YML 文件的信息。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容