018-docker-docker-compose定義和運行多容器 Docker 應用程序的工具

一、概述

Compose 是用於定義和運行多容器 Docker 應用程序的工具。通過 Compose，您可以使用 YML 文件來配置應用程序需要的所有服務。然后，使用一個命令，就可以從 YML 文件配置中創建並啟動所有服務。

Compose 使用的三個步驟：

• 使用 Dockerfile 定義應用程序的環境。

• 使用 docker-compose.yml 定義構成應用程序的服務，這樣它們可以在隔離環境中一起運行。

• 最后，執行 docker-compose up 命令來啟動並運行整個應用程序。

負責實現對Docker容器集群的快速編排。

Docker-Compose將所管理的容器分為三層，分別是工程（project），服務（service）以及容器（container）。

Docker-Compose運行目錄下的所有文件（docker-compose.yml，extends文件或環境變量文件等）組成一個工程，若無特殊指定工程名即為當前目錄名。一個工程當中可包含多個服務，每個服務中定義了容器運行的鏡像，參數，依賴。一個服務當中可包括多個容器實例，Docker-Compose並沒有解決負載均衡的問題，因此需要借助其它工具實現服務發現及負載均衡。

Docker-Compose的工程配置文件默認為docker-compose.yml，可通過環境變量COMPOSE_FILE或-f參數自定義配置文件，其定義了多個有依賴關系的服務及每個服務運行的容器。

使用一個Dockerfile模板文件，可以讓用戶很方便的定義一個單獨的應用容器。在工作中，經常會碰到需要多個容器相互配合來完成某項任務的情況。例如要實現一個Web項目，除了Web服務容器本身，往往還需要再加上后端的數據庫服務容器，甚至還包括負載均衡容器等。
Compose允許用戶通過一個單獨的docker-compose.yml模板文件（YAML 格式）來定義一組相關聯的應用容器為一個項目（project）。

Docker-Compose項目由Python編寫，調用Docker服務提供的API來對容器進行管理。因此，只要所操作的平台支持Docker API，就可以在其上利用Compose來進行編排管理。

二、Docker-compose模板文件

Compose允許用戶通過一個docker-compose.yml模板文件（YAML 格式）來定義一組相關聯的應用容器為一個項目（project）。

Compose模板文件是一個定義服務、網絡和卷的YAML文件。Compose模板文件默認路徑是當前目錄下的docker-compose.yml，可以使用.yml或.yaml作為文件擴展名。

Docker-Compose標准模板文件應該包含version、services、networks 三大部分，最關鍵的是services和networks兩個部分。

version: '2'
services:
  web:
    image: dockercloud/hello-world
    ports:
      - 8080
    networks:
      - front-tier
      - back-tier
 
  redis:
    image: redis
    links:
      - web
    networks:
      - back-tier
 
  lb:
    image: dockercloud/haproxy
    ports:
      - 80:80
    links:
      - web
    networks:
      - front-tier
      - back-tier
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
 
networks:
  front-tier:
    driver: bridge
  back-tier:
    driver: bridge

2.1、version版本

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

Compose目前有三個版本分別為Version 1，Version 2，Version 3，Compose區分Version 1和Version 2（Compose 1.6.0+，Docker Engine 1.10.0+）。Version 2支持更多的指令。Version 1將來會被棄用。  

2.2、services配置

一般是 service: → 類型名 ：→ 以下的配置

2.2.1、鏡像

2.2.1.1、image倉庫鏡像

services:
  nginx-1:
    image: nginx_scan:v0.0.1

是指定服務的鏡像名稱或鏡像ID。

如果鏡像在本地不存在，Compose將會嘗試拉取鏡像。

2.2.1.2、build基於Dockerfile構建

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

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

services:
  webapp:
    build: ./dir

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

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的文件路徑，也可以是到鏈接到git倉庫的url，當提供的值是相對路徑時，被解析為相對於撰寫文件的路徑，此目錄也是發送到Docker守護進程的context
• dockerfile：指定構建鏡像的 Dockerfile 文件名。
• args：添加構建參數，這是只能在構建過程中訪問的環境變量。
• labels：設置構建鏡像的標簽。
• target：多層構建，可以指定構建哪一層。

2.2.2、container_name

Compose的容器名稱格式是：<項目名稱><服務名稱><序號>

2.2.3、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 之前停止。

services:
  web:
    build: .
    depends_on:
      - db
      - redis
  redis:
    image: redis
  db:
    image: postgres

 

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

2.2.4、command

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

三、Docker-compose常用命令

命令格式：docker-compose [-f <arg>...] [options] [COMMAND] [ARGS...]

可選參數

-f --file FILE指定Compose模板文件，默認為docker-compose.yml
-p --project-name NAME 指定項目名稱，默認使用當前所在目錄為項目名
--verbose  輸出更多調試信息
-v，-version 打印版本並退出
--log-level LEVEL 定義日志等級(DEBUG, INFO, WARNING, ERROR, CRITICAL)

3.1、command參數

3.1.1、docker-compose up 啟動

docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]
選項包括：
-d 在后台運行服務容器
-no-color 不是有顏色來區分不同的服務的控制輸出
-no-deps 不啟動服務所鏈接的容器
--force-recreate 強制重新創建容器，不能與-no-recreate同時使用
–no-recreate 如果容器已經存在，則不重新創建，不能與–force-recreate同時使用
–no-build 不自動構建缺失的服務鏡像
–build 在啟動容器前構建服務鏡像
–abort-on-container-exit 停止所有容器，如果任何一個容器被停止，不能與-d同時使用
-t, –timeout TIMEOUT 停止容器時候的超時（默認為10秒）
–remove-orphans 刪除服務中沒有在compose文件中定義的容器

3.1.2、docker-compose ps

docker-compose  ps [options] [SERVICE...]
列出項目中所有的容器

3.1.3、docker-compose stop

docker-compose stop [options] [SERVICE...]
選項包括
-t, –timeout TIMEOUT 停止容器時候的超時（默認為10秒）
docker-compose stop
停止正在運行的容器，可以通過docker-compose start 再次啟動

3.1.4、docker-compose -h 查看幫助

31.5、docker-compose down

docker-compose down [options]
停止和刪除容器、網絡、卷、鏡像。
選項包括：
–rmi type，刪除鏡像，類型必須是：all，刪除compose文件中定義的所有鏡像；local，刪除鏡像名為空的鏡像
-v, –volumes，刪除已經在compose文件中定義的和匿名的附在容器上的數據卷
–remove-orphans，刪除服務中沒有在compose中定義的容器
docker-compose down
停用移除所有容器以及網絡相關

3.1.6、docker-compose logs

docker-compose logs [options] [SERVICE...]
查看服務容器的輸出。默認情況下，docker-compose將對不同的服務輸出使用不同的顏色來區分。可以通過–no-color來關閉顏色。
docker-compose logs
查看服務容器的輸出
-f 跟蹤日志輸出

3.1.7、docker-compose bulid

docker-compose build [options] [--build-arg key=val...] [SERVICE...]
構建（重新構建）項目中的服務容器。
選項包括：
–compress 通過gzip壓縮構建上下環境
–force-rm 刪除構建過程中的臨時容器
–no-cache 構建鏡像過程中不使用緩存
–pull 始終嘗試通過拉取操作來獲取更新版本的鏡像
-m, –memory MEM為構建的容器設置內存大小
–build-arg key=val為服務設置build-time變量
服務容器一旦構建后，將會帶上一個標記名。可以隨時在項目目錄下運行docker-compose build來重新構建服務

3.1.8、docker-compose pull

docker-compose pull [options] [SERVICE...]
拉取服務依賴的鏡像。
選項包括：
–ignore-pull-failures，忽略拉取鏡像過程中的錯誤
–parallel，多個鏡像同時拉取
–quiet，拉取鏡像過程中不打印進度信息
docker-compose pull
拉取服務依賴的鏡像

3.1.9、docker-compose restart

docker-compose restart [options] [SERVICE...]
重啟項目中的服務。
選項包括：
-t, –timeout TIMEOUT，指定重啟前停止容器的超時（默認為10秒）
docker-compose restart
重啟項目中的服務

3.1.10、docker-compose rm

docker-compose rm [options] [SERVICE...]
刪除所有（停止狀態的）服務容器。
選項包括：
–f, –force，強制直接刪除，包括非停止狀態的容器
-v，刪除容器所掛載的數據卷
docker-compose rm
刪除所有（停止狀態的）服務容器。推薦先執行docker-compose stop命令來停止容器。

3.1.11、docker-compose start

docker-compose start [SERVICE...]
docker-compose start
啟動已經存在的服務容器。

3.1.12、docker-compose run

docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
在指定服務上執行一個命令。
docker-compose run ubuntu ping www.baidu.com
在指定容器上執行一個ping命令。

3.1.13、docker-compose scale

docker-compose scale web=3 db=2
設置指定服務運行的容器個數。通過service=num的參數來設置數量

3.1.14、docker-compose pause [SERVICE...]  暫停一個服務容器

3.1.15、docker-compose kill

docker-compose kill [options] [SERVICE...]
通過發送SIGKILL信號來強制停止服務容器。
支持通過-s參數來指定發送的信號，例如通過如下指令發送SIGINT信號：
docker-compose kill -s SIGINT

3.1.16、docker-compose config

docker-compose config [options]
驗證並查看compose文件配置。
選項包括：
–resolve-image-digests 將鏡像標簽標記為摘要
-q, –quiet 只驗證配置，不輸出。 當配置正確時，不輸出任何內容，當文件配置錯誤，輸出錯誤信息
–services 打印服務名，一行一個
–volumes 打印數據卷名，一行一個

3.1.17、docker-compose create

docker-compose create [options] [SERVICE...]
為服務創建容器。
選項包括：
–force-recreate：重新創建容器，即使配置和鏡像沒有改變，不兼容–no-recreate參數
–no-recreate：如果容器已經存在，不需要重新創建，不兼容–force-recreate參數
–no-build：不創建鏡像，即使缺失
–build：創建容器前　　，生成鏡像

3.1.18、docker-compose exec

docker-compose exec [options] SERVICE COMMAND [ARGS...]
選項包括：
-d 分離模式，后台運行命令。
–privileged 獲取特權。
–user USER 指定運行的用戶。
-T 禁用分配TTY，默認docker-compose exec分配TTY。
–index=index，當一個服務擁有多個容器時，可通過該參數登陸到該服務下的任何服務，例如：docker-compose exec –index=1 web /bin/bash ，web服務中包含多個容器

3.1.19、docker-compose port

docker-compose port [options] SERVICE PRIVATE_PORT
顯示某個容器端口所映射的公共端口。
選項包括：
–protocol=proto，指定端口協議，TCP（默認值）或者UDP
–index=index，如果同意服務存在多個容器，指定命令對象容器的序號（默認為1）

3.1.20、docker-compose push

docker-compose push [options] [SERVICE...]
推送服務依的鏡像。
選項包括：
–ignore-push-failures 忽略推送鏡像過程中的錯誤

3.1.21、docker-compose stop [options] [SERVICE...]  顯示各個容器運行的進程情況。

3.1.22、docker-compose uppause [SERVICE...] 恢復處於暫停狀態中的服務。