docker-compose指令詳解上(二)

compose文件格式

定義配置文件中的部分(如構(gòu)建，部署，依賴，網(wǎng)絡(luò)等)的頂級鍵與支持它們作為子主題的選項一起列出。這映射到Compose文件的<key>：<option>：<value>縮進結(jié)構(gòu)

成都創(chuàng)新互聯(lián)-專業(yè)網(wǎng)站定制、快速模板網(wǎng)站建設(shè)、高性價比鹿城網(wǎng)站開發(fā)、企業(yè)建站全套包干低至880元,成熟完善的模板庫,直接使用。一站式鹿城網(wǎng)站制作公司更省心,省錢,快速模板網(wǎng)站建設(shè)找我們，業(yè)務(wù)覆蓋鹿城地區(qū)。費用合理售后完善，十余年實體公司更值得信賴。

服務(wù)配置參考

Compose文件是定義services,networks和volumes的YAML文件。 Compose文件的默認路徑是./docker-compose.yml。

服務(wù)定義包含應(yīng)用于為該服務(wù)啟動的每個容器的配置. 類似:

docker container create
docker network create 
docker volume create

build

在構(gòu)建時應(yīng)用的配置選項. 可以指定為包含構(gòu)建上下文路徑的字符串.

version: "3.7"    #版本
services:         #服務(wù)
  nginx:          #服務(wù)名稱
    build: ./dir  #指定構(gòu)建目錄
    image: nginx:tag  #指定基礎(chǔ)鏡像

context

包含Dockerfile的目錄的路徑，或者是git存儲庫的url。
當提供的值是相對路徑時，它被解釋為相對于Compose文件的位置。此目錄也是發(fā)送到Docker守護程序的構(gòu)建上下文。

build:
  context: ./dir

dockerfile

Compose使用備用文件來構(gòu)建。還必須指定構(gòu)建路徑。

build:
  context: .
  dockerfile: Dockerfile-alternate

ARGS

添加構(gòu)建參數(shù).在dockerfile中定義:

ARG buildno
ARG gitcommithash

指定參數(shù)在build指令下構(gòu)建

build:
  context: .
  args:
    buildno: 1

注意: 在Dockerfile中，如果在FROM指令之前指定ARG，則在FROM下的構(gòu)建指令中不能使用ARG。
YAML布爾值（true，false，yes，no，on，off）必須用引號括起來，以便解析器將它們解釋為字符串。

CACHE_FROM

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

LABELS

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

build:
  context: .
  labels:
    com.example.description: "Accounting webapp"

SHM_SIZE

為此構(gòu)建的容器設(shè)置/dev/shm分區(qū)的大小

build:
  context: .
  shm_size: '2gb'

TARGET

在內(nèi)部定義構(gòu)建指定的階段dockerfile
多階段構(gòu)建文檔鏈接: https://docs.docker.com/engine/userguide/eng-image/multistage-build/

build:
  context: .
  target: prod

cap_add和cap_drop

添加或刪除容器功能

cap_add:
  - ALL

cap_drop:
  - NET_ADMIN
  - SYS_ADMIN

cgroup_parent

為容器指定可選的父cgroup

cgroup_parent: m-executor-abcd

command

覆蓋默認命令,和dockerfile指令相似.

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

configs

短語法變體僅指定配置名稱。這將授予容器對配置的訪問權(quán)限，并將其安裝在容器中的/ <config_name>中。源名稱和目標安裝點都設(shè)置為配置名稱. 支持3.3版本以上.
以下示例使用短語法授予對my_config和my_other_config配置的redis服務(wù)訪問權(quán)限。 my_config的值設(shè)置為./my_config.txt文件的內(nèi)容，my_other_config被定義為外部資源，這意味著它已經(jīng)在Docker中定義，通過運行docker config create命令或另一個堆棧部署。如果外部配置不存在，則堆棧部署將失敗并顯示config not found錯誤

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

LONG SYNTAX

source: Docker中存在的配置名稱
target: 要在服務(wù)的任務(wù)容器中裝入的文件的路徑和名稱。默認為:/<source>
uid和gid: 在服務(wù)的任務(wù)容器中擁有已裝入的配置文件的數(shù)字UID或GID.默認為0.
mode: 以八進制表示法在服務(wù)的任務(wù)容器中裝入的文件的權(quán)限。默認值為0444.配置無法寫入，因為它們安裝在臨時文件系統(tǒng)中，因此如果設(shè)置了可寫位，則會將其忽略?？梢栽O(shè)置可執(zhí)行位。
以下示例將my_config的名稱設(shè)置為容器中的redis_config，將模式設(shè)置為0440（組可讀）并將用戶和組設(shè)置為103. redis服務(wù)無權(quán)訪問my_other_config配置。

version: "3.7"
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ù)訪問權(quán)限.

container_name

指定自定義容器的名稱.

container_name: nginx-test

Docker容器名稱必須是唯一的,如果指定了自定義名稱，則無法將服務(wù)擴展到多個容器.

EXAMPLE GMSA CONFIGURATION

為服務(wù)配置gMSA憑據(jù)規(guī)范時，只需指定憑據(jù)規(guī)范.

version: "3.8"
services:
  myservice:
    image: myimage:latest
    credential_spec:
      config: my_credential_spec

configs:
  my_credentials_spec:
    file: ./my-credential-spec.json|

depends_on

服務(wù)依賴關(guān)系之間的Express依賴關(guān)系會導(dǎo)致以下行為：
- docker-compose up: 以依賴順序啟動服務(wù).
- docker-compose up SERVICE: 自動包含SERVICE的依賴項.
- docker-compose stop: 按依賴順序停止服務(wù).

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

deploy

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

version: "3.7"
services:
  redis:
    image: redis:alpine
    deploy:
      replicas: 6
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

ENDPOINT_MODE

為連接到群集的外部客戶端指定服務(wù)發(fā)現(xiàn)方法。
endpoint_mode: vip: Docker為服務(wù)分配虛擬IP(VIP),作為客戶端到達網(wǎng)絡(luò)服務(wù)的前端。 Docker在客戶端和服務(wù)的可用工作節(jié)點之間路由請求，而無需客戶端知道有多少節(jié)點參與服務(wù)或其IP地址或端口。
endpoint_mode: DNSrr: DNS循環(huán)（DNSRR）服務(wù)發(fā)現(xiàn)不使用單個虛擬IP。 Docker為服務(wù)設(shè)置DNS條目，以便服務(wù)名稱的DNS查詢返回IP地址列表，客戶端直接連接到其中一個。

version: "3.7"

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:

LABELS

指定服務(wù)的標簽。這些標簽僅在服務(wù)上設(shè)置，而不在服務(wù)的任何容器上設(shè)置。

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

要在容器上設(shè)置標簽,可以把labels鍵放在和image鍵同級.

MODE

全局或復(fù)制(副本容器)

version: "3.7"
services:
  worker:
    image: dockersamples/examplevotingapp_worker
    deploy:
      mode: global

PLACEMENT

指定約束和首選項的位置

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

REPLICAS

如果復(fù)制了服務(wù)，請指定在任何給定時間應(yīng)運行的容器數(shù)。

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

RESOURCES

配置資源限制.
在這個示例中，redis服務(wù)被限制為使用不超過50M的內(nèi)存和0.50（單核的50％）的可用處理時間（CPU），并且具有20M的內(nèi)存和0.25個CPU時間保留(始終可用).

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

Out Of Memory Exceptions (OOME)

如果您的服務(wù)或容器嘗試使用的內(nèi)存超過系統(tǒng)可用的內(nèi)存，則可能會遇到內(nèi)存不足異常（OOME），并且內(nèi)核OOM殺手可能會殺死容器或Docker守護程序。要防止這種情況發(fā)生，請確保您的應(yīng)用程序在具有足夠內(nèi)存的主機上運行.

RESTART_POLICY

配置是否以及如何在容器退出時重新啟動容器.
- condition: none,on-failure,any
- delay: 重啟嘗試之間等待多長時間,默認0.
- max_attempts: 在放棄之前嘗試重啟容器的次數(shù).例如，如果max_attempts設(shè)置為“2”，并且第一次嘗試時重新啟動失敗，則可能會嘗試重新啟動兩次以上。
- window: 在決定重啟是否成功之前等待多長時間.

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

ROLLBACK_CONFIG

配置在更新失敗的情況下應(yīng)如何回滾服務(wù).
- `parallelism: 一次回滾的容器數(shù). 0為同時回滾.
- delay: 每個容器組的回滾之間等待的時間.
- failure_action: 如果回滾失敗該怎么辦。選擇continue或者pause
- monitor: 每次更新任務(wù)后的持續(xù)時間.ns|us|ms|s|m|h
- max_failure_ratio: 回滾期間容忍的失敗率.
- order: 回滾期間的操作順序。停止優(yōu)先（舊任務(wù)在啟動新任務(wù)之前停止）或啟動優(yōu)先（新任務(wù)首先啟動，運行任務(wù)暫時重疊）（默認停止優(yōu)先）

UPDATE_CONFIG

配置服務(wù)應(yīng)如何更新。用于配置滾動更新.
- parallelism:一次更新的容器數(shù)
- delay: 更新一組容器之間的等待時間.
- failure_action: 如果更新失敗該怎么辦。選擇continue,rollback,pause.默認pause.
- monitor: 每次更新任務(wù)后的持續(xù)時間.(ns|us|ms|s|m|h)
- max_failure_ratio: 更新期間容忍的失敗率。
- order : 更新期間的操作順序。 stop-first之一（舊任務(wù)在啟動新任務(wù)之前停止）或start-first（首先啟動新任務(wù)，并且運行任務(wù)暫時重疊）（默認stop-first）

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

dns

自定義dns服務(wù)

dns:
  - 8.8.8.8
  - 9.9.9.9

dns_search

自定義DNS搜索域

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

entrypoint

覆蓋默認entrypoint

entrypoint: /code/entrypoint.sh

env_file

從文件添加環(huán)境變量

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

Compose期望env文件中的每一行都是VAR = VAL格式。以＃開頭的行被視為注釋并被忽略。空行也被忽略。

environment

添加環(huán)境變量。您可以使用數(shù)組或字典。任何布爾值; true，false，yes no，需要用引號括起來

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

expose

暴露端口而不將它們發(fā)布到主機 - 它們只能被鏈接服務(wù)訪問。只能指定內(nèi)部端口

expose:
 - "3000"
 - "8000"

external_links

鏈接到此docker-compose.yml之外或甚至在Compose之外的容器。指定容器名稱和鏈接別名.

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

extra_hosts

添加主機名映射

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

在該服務(wù)的容器內(nèi)的/ etc / hosts中創(chuàng)建具有ip地址和主機名的條目.

162.242.195.82  somehost
50.31.209.229   otherhost

healthcheck

配置運行的檢查以確定此服務(wù)的容器是否“健康”.

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

test: ["CMD", "curl", "-f", "http://localhost"]
test: ["CMD-SHELL", "curl -f http://localhost || exit 1"]
test: curl -f https://localhost || exit 1

禁用運行狀況檢查

healthcheck:
  disable: true

init

在容器內(nèi)運行init，轉(zhuǎn)發(fā)信號并重新獲得進程.

version: "3.7"
services:
  web:
    image: alpine:latest
    init: true

links

鏈接到另一個服務(wù)中的容器。指定服務(wù)名稱和鏈接別名.

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

鏈接服務(wù)的容器可以在與別名相同的主機名上訪問，如果未指定別名，則可以訪問服務(wù)名稱。
鏈接還以與depends_on相同的方式表達服務(wù)之間的依賴關(guān)系.

當前文章：docker-compose指令詳解上(二)
文章起源：http://m.jiaotiyi.com/article/gggohi.html

網(wǎng)站建設(shè)知識

docker-compose指令詳解上(二)

compose文件格式

服務(wù)配置參考

build

context

dockerfile

ARGS

CACHE_FROM

LABELS

SHM_SIZE

TARGET

cap_add和cap_drop

cgroup_parent

command

configs

LONG SYNTAX

container_name

EXAMPLE GMSA CONFIGURATION

depends_on

deploy

ENDPOINT_MODE

LABELS

MODE

PLACEMENT

REPLICAS

RESOURCES

Out Of Memory Exceptions (OOME)

RESTART_POLICY

ROLLBACK_CONFIG

UPDATE_CONFIG

dns

dns_search

entrypoint

env_file

environment

expose

external_links

extra_hosts

healthcheck

禁用運行狀況檢查

init

links

其他資訊