Docker學習—Compose

前言

　前面《Docker學習—DockerFile》文中介紹了dockerfile相關的語法，及使用方式；接下來了解docker三劍客之一的 Compose；接下來詳細學習。

一、docker-compose介紹

　Docker-Compose專案是Docker官方的開源專案，主要使用Python編寫；用於定義和執行多容器Docker應用程式的工具。使用Compose，可以使用YAML檔案來配置應用程式的服務。然後使用一個命令，從配置建立並啟動所有服務。

　Compose是一個定位“定義和執行多個Docker容器應用的工具”，其前身是Fig，目前使用的Compose仍然相容Fig格式的模板檔案。

　Compose中包含兩個重要概念：

• 服務（Service）：一個應用的容器，實際可以包含若干個執行相同映象的容器例項
• 專案（Project）：一組相關聯的應用容器組成的完整業務單元，在docker-compose.yml檔案中定義　

　Compose的預設管理物件是專案，通過子命令對專案中的一組容器進行便捷地生命週期管理。

二、docker-compose安裝

　Compose目前已經完全支援Linux、Mac OS和Windows，在安裝Compose之前，需要先安裝Docker；（本篇主要在window中使用）

• Mac安裝：Install Docker for Mac
• Windows安裝：Install Docker for Windows
  
• Linux安裝：Install Docker for Centos

　安裝成功後命令列中輸入：docker compose -h  

　

三、docker-compose 命令

　安裝成功後來看下compose主要包含的命令：

  build              #生成或重建服務
  bundle             #從Compose檔案生成Docker bundle
  config             #驗證並檢視撰寫檔案
  create             #建立服務
  down               #停止並刪除容器、網路、映象和卷
  events             #從容器接收實時事件
  exec               #在正在執行的容器中執行命令
  help               #獲取命令幫助
  images             #顯示映象列表
  kill               #殺死容器
  logs               #檢視容器的輸出
  pause              #暫停服務
  port               #列印埠繫結的公共埠
  ps                 #顯示容器列表
  pull               #拉取服務映象
  push               #推送服務映象
  restart            #重新啟動服務
  rm                 #移除停止的容器
  run                #執行一次性命令
  scale              #設定服務的容器數
  start              #啟動服務
  stop               #暫停服務
  top                #顯示正在執行的程式
  unpause            #取消暫停服務
  up                 #建立並啟動容器
  version            #顯示Docker-Compose版本資訊

　對命令有大概印象後，接下來就需要對重點內容(docker-compose.yml)瞭解；每個命令具體的使用引數在使用是具體介紹

三、docker-compose.yml編寫

　docker-compose.yml已有多個版本:如下

 　首先我們先來看一個官方示例docker-compose.yml內容：

version: "3.8"
services:

  redis:
    image: redis:alpine
    ports:
      - "6379"
    networks:
      - frontend
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  db:
    image: postgres:9.4
    volumes:
      - db-data:/var/lib/postgresql/data
    networks:
      - backend
    deploy:
      placement:
        max_replicas_per_node: 1
        constraints:
          - "node.role==manager"

  vote:
    image: dockersamples/examplevotingapp_vote:before
    ports:
      - "5000:80"
    networks:
      - frontend
    depends_on:
      - redis
    deploy:
      replicas: 2
      update_config:
        parallelism: 2
      restart_policy:
        condition: on-failure

  result:
    image: dockersamples/examplevotingapp_result:before
    ports:
      - "5001:80"
    networks:
      - backend
    depends_on:
      - db
    deploy:
      replicas: 1
      update_config:
        parallelism: 2
        delay: 10s
      restart_policy:
        condition: on-failure

  worker:
    image: dockersamples/examplevotingapp_worker
    networks:
      - frontend
      - backend
    deploy:
      mode: replicated
      replicas: 1
      labels: [APP=VOTING]
      restart_policy:
        condition: on-failure
        delay: 10s
        max_attempts: 3
        window: 120s
      placement:
        constraints:
          - "node.role==manager"

networks:
  frontend:
  backend:

volumes:
  db-data:

 

　根據以上示例格式可以看出docker-compose.yml中主要包含以下內容：

• version: 指定當前docker-compose.yml的版本，版本與Docker Engine版本存在對應關係，如：v3.8對應 Docker Engine 19.03.0+
• services：服務，可以定義業務需要的一些服務，每個服務可包含服務名稱、使用映象、掛載資料卷、使用的網路、依賴服務等資訊
• networks：應用的網路，可以定義網路名稱、使用的網路型別等
• volumes：資料卷，可以定義資料卷，然後掛載到不同的服務下使用

　接著就來看下相關命令的語法及具體含義

　　

docker-compose.yml命令

序號	所屬	命令	說明
1	services	build	基於Dockerfile，指定Dockerfile所在路徑,Compose會利用它自動構建映象，然後啟動服務容器
2		cap_add，cap_drop	新增或刪除容器功能
3		command	覆蓋容器啟動後預設執行的命令
4		config	使用“每服務配置”配置在每個服務的基礎上授予對配置的訪問許可權。存在兩種語法方式：短語法、長語法
5		cgroup_parent	為容器指定一個可選的父cgroup
6		container_name	容器名稱
7		depends_on	容器依賴，用於指定服務依賴的其他服務
8		depoly	指定與服務的部署和執行相關的配置。這隻在使用docker stack deploy部署到一個群時生效，docker compose up和docker compose run將忽略此項。
9		devices	裝置對映列表。
10		dns	自定義DNS伺服器。可以是單個值或列表。
11		dns_search	自定義DNS搜尋域。可以是單個值或列表。
12		entrypoint	覆蓋預設入口點
13		env_file	從檔案新增環境變數。可以是單個值或列表
14		environment	新增環境變數。可以使用陣列或字典。任何布林值（true、false、yes、no）都需要用引號括起來，以確保它們不會被YML解析器轉換為true或false。
15		expose	暴露埠而不將它們釋出到主機-它們只能被連結的服務訪問。只能指定內部埠。
16		external_links	連結到在此範圍之外docker-compose.yml甚至在Compose之外開始的容器，尤其是對於提供共享或公共服務的容器。 同時指定容器名稱和連結別名（）時，請external_links遵循與legacy選項相似的語義。
17		extra_hosts	新增主機名對映。使用與docker客戶端相同的值
18		healthcheck	配置執行的檢查以確定該服務的容器是否“健康”
19		image	指定要從中啟動容器的映象。可以是儲存庫/標籤或映象ID
20		init	在容器內執行一個初始化程式，以轉發訊號並獲取程式。設定此選項可以true為服務啟用此功能。
21		isolation	指定容器的隔離技術。在Linux上，唯一支援的值是default。在Windows中，可接受的值是default，process和 hyperv。
22		labels	使用Docker標籤將後設資料新增到容器中。您可以使用陣列或字典。
23		links	連結到另一個服務中的容器。指定服務名稱和連結別名（"SERVICE:ALIAS"），或者僅指定服務名稱。
24		logging	服務的日誌記錄配置
25		network_mode	網路模式。使用與客戶端服務相同的網路名稱和服務-引數docker相同。
26		networks	要加入的網路，引用頂級網路鍵下的條目。
27		pid	將PID模式設定為主機PID模式。這將開啟容器和主機作業系統之間的PID地址空間共享。
28		ports	暴露埠
29		restart	no是預設的重啟策略，在任何情況下都不會重啟容器。當always指定時，容器總是重新啟動。該 on-failure如果退出程式碼指示的故障錯誤政策重啟的容器。unless-stopped總是重新啟動容器，除非容器停止（手動或其他方式）。
30		secrets	使用按服務secrets 配置，按服務授予對機密的訪問許可權。
31		security_opt	覆蓋每個容器的預設標籤方案。
32		stop_grace_period	指定在傳送SIGKILL之前，如果容器不處理SIGTERM（或用stop_nusignal指定的任何停止訊號），嘗試停止該容器時要等待多長時間。預設10s
33		stop_signal	設定停止容器的替代訊號。預設情況下，stop使用SIGTERM。使用stop_signal設定替代訊號會導致stop傳送該訊號。
34		sysctls	要在容器中設定的核心引數。可以使用陣列或字典。
35		tmpfs	在容器內安裝一個臨時檔案系統。可以是單個值或列表。
36		ulimits	覆蓋容器的預設ulimit。您可以將單個限制指定為整數，也可以將軟/硬限制指定為對映。
37		userns_mode	如果Docker守護程式配置了使用者名稱稱空間，則禁用此服務的使用者名稱稱空間。
38		volumes	掛載主機路徑或命名卷，指定為服務的子選項。可以將主機路徑安裝為單個服務的定義的一部分，而無需在頂級volumes中進行定義。 但是，如果要在多個服務之間重用卷，請在頂級volumes金鑰中定義一個命名卷。 將命名卷與服務，群集和堆疊檔案一起使用。
39		domainname, hostname, ipc, mac_address, privileged, read_only, shm_size, stdin_open, tty, user, working_dir	其中每個都是一個值，類似於其 docker run對應項。
40	Volumes	dirver	指定該卷應使用哪個卷驅動程式。預設為Docker Engine配置為使用的任何驅動程式，大多數情況下為 local。
41		dirver_opts	指定選項列表作為鍵值對，以傳遞給該卷的驅動程式。
42		external	如果設定為true，則指定此卷是在Compose之外建立的。docker-compose up不會嘗試建立它，如果不存在則引發錯誤。
43		labels	使用Docker標籤向容器新增後設資料。可以使用陣列或字典。
44		name	為此卷設定一個自定義名稱。名稱欄位可用於引用包含特殊字元的卷。
45	Networks	dirver	指定該網路應使用哪個驅動程式。
46		dirver_opts	指定選項列表作為要傳遞給此網路的驅動程式的鍵值對
47		attachable	僅當驅動程式設定為覆蓋時使用。
48		enable_ipv6	在此網路上啟用IPv6網路。
49		ipam	指定自定義IPAM配置
50		internal	預設情況下，Docker還會連線一個網橋網路來提供外部連線。如果要建立外部隔離的覆蓋網路，可以將此選項設定為true。
51		labels	使用Docker標籤將後設資料新增到容器中 。您可以使用陣列或字典。
52		external	如果設定為true，則指定此網路是在Compose之外建立的。docker-compose up不會嘗試建立它，如果不存在則引發錯誤。
53		name	為此網路設定一個自定義名稱。名稱欄位可用於引用包含特殊字元的網路。

 　　通過以上內容發現，services中相關命令是docker相關配置項關聯；接下來就來驗證通過docker-compose.yml執行應用 

四、應用案例

　實現效果：基於身份認證時，相關示例程式碼實現，通過docker-compose啟動相關所有服務容器，執行程式。

　A、在解決方案目錄下新增docker-compose.yml檔案：

　新增方式：

　1、手動新增檔案

　2、通過vs自動新增：選中需要新增專案右鍵，如圖

　新增後如下：

 

 

　B、修改內容如下：(該docker-compose.yml比較簡單)

version: '3.4'

services:
  cz.identityserver:
    image: ${DOCKER_REGISTRY-}czidentityserver
    build:
      context: .
      dockerfile: cz.IdentityServer/Dockerfile

  cz.api.order:
    image: ${DOCKER_REGISTRY-}czapiorder
    build:
      context: .
      dockerfile: cz.Api.Order/Dockerfile


  cz.api.goods:
    image: ${DOCKER_REGISTRY-}czapigoods
    build:
      context: .
      dockerfile: cz.Api.Goods/Dockerfile


  cz.mvcclient:
    image: ${DOCKER_REGISTRY-}czmvcclient
    build:
      context: .
      dockerfile: cz.MVCClient/Dockerfile

 

　C、執行命令docker-compose up命令：執行完成看到以下輸出，則編譯啟動完成。

　　

 　D、在docker管理頁面中檢視如下：

　　

後續：

　本篇內容先對docker-compose內容進行了相關介紹，下面將對Swarm、Machine、K8S 進行應用學習。

參考：

　　https://docs.docker.com/compose/

　　https://docs.docker.com/compose/compose-file/