Docker-Compose 是什么？

Docker-Compose 項目是 Docker 官方的開源項目，負責實現對 Docker 容器集群的快速編排。Docker-Compose 的工程配置文件名是默認為 docker-compose.yml 的，在整個文件中，我們可以通過環境變量 COMPOSE_FILE 或者 -f參數來對配置進行定義。我們可以看一個很簡單的 docker-compose.yml 的配置文件：

couchdb:
    container_name: couchdb
    image: hyperledger/fabric-couchdb
    # Populate the COUCHDB_USER and COUCHDB_PASSWORD to set an admin user and password
    # for CouchDB.  This will prevent CouchDB from operating in an "Admin Party" mode.
    environment:
      - COUCHDB_USER=
      - COUCHDB_PASSWORD=
    # Comment/Uncomment the port mapping if you want to hide/expose the CouchDB service,
    # for example map it to utilize Fauxton User Interface in dev environments.
    ports:
      - "5984:5984"

這就是一個通過 docker-compose.yml 配置實現 CouchDB 在 Docker 中運行的配置實例。

Docker-Compose 是用 Python 來編寫的，我們可以通過 pip 命令進行對 Docker-Compose 的安裝，之后就調用Docker服務提供的API來對容器進行管理。因此，只要所操作的平臺支持Docker API，就可以在其上利用Compose來進行編排管理。

Docker-Compose 怎么用？

具體的安裝過程，因為種類繁多，而且可以很容易的找到，因此在這里不過多說明。但是在 Windows 中使用時，一定要保證 Windows 是可以安裝 Docker 的。我們具體要說的是關于 Docker-Compose 的一些常用的命令。

1、Docker-Compose 命令格式

docker-compose [-f<arg>...] [options] [COMMAND] [ARGS...]

選項包括：

-f，–file FILE 指定 Compose 模板文件，默認為 docker-compose.yml，可以多次指定。
-p，–project-name NAME 指定項目名稱，默認將使用所在目錄名稱作為項目名。
-x-network-driver 使用 Docker 的可拔插網絡后端特性（需要Docker 1.9+版本）
-x-network-driver DRIVER 指定網絡后端的驅動，默認為 bridge（需要Docker 1.9+版本）
-verbose 輸出更多調試信息
-v，–version 打印版本并退出

2、Docker-Compose 啟動格式

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文件中定義的容器
–scale SERVICE=NUM 設置服務運行容器的個數，將覆蓋在compose中通過scale指定的參數
docker-compose up
啟動所有服務--這是我們最常用的命令格式
docker-compose up -d
在后臺所有啟動服務--需要在后臺使用時可以通過添加 -d 來后臺啟動
-f 指定使用的 Compose 模板文件，默認為docker-compose.yml，可以多次指定。

3、Docker-Compose 查看格式

docker-compose ps [options] [SERVICE...]

這條命令與 Docker 中查看容器的命令基本功能和方法是一樣的。一般我們使用的是 docker-compose ps。

4、Docker-Compose 終止格式

docker-compose stop [options] [SERVICE...]

選項包括：

-t, –timeout TIMEOUT 停止容器時候的超時（默認為10秒）

我們在執行 stop 命令之后，是需要通過 docker-compose start 來啟動的，而不是剛才我們所講的 up 命令。

5、Docker-Compose 停止格式

docker-compose down [options]

選項包括：

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

6、Docker-Compose 日志格式

docker-compose logs [options][SERVICE...]

默認情況下使用 docker-compose logs來查看服務容器的輸出，或者我們可以通過指定 --no-color來關閉顏色。

7、Docker-Compose build

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來重新構建服務。

8、Docker-Compose pull

docker-compose pull [options] [SERVICE...]

選項包括：

–ignore-pull-failures，忽略拉取鏡像過程中的錯誤
–parallel，多個鏡像同時拉取
–quiet，拉取鏡像過程中不打印進度信息
docker-compose pull
拉取服務依賴的鏡像。

9、Docker-Compose restart

docker-compose restart [options] [SERVICE...]

選項包括：

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

10、Docker-Compose start

docker-compose start [SERVICE...]

啟動已經存在的服務容器。

11、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命令。

12、Docker-Compose scale

docker-compose scale web=3 db=2

設置指定服務運行的容器個數。通過service=num的參數來設置數量。

13、Docker-Compose pause

docker-compose pause [SERVICE...]

暫停一個服務容器。

14、Docker-Compose rm

docker-compose rm [options] [SERVICE...]

選項包括：

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

15、Docker-Compose kill

docker-compose kill [options] [SERVICE...]

支持通過 -s 參數來指定發送的信號，例如通過如下指令發送 SIGINT 信號：
docker-compose kill -s SIGINT

16、Docker-Compose config

docker-compose [options]

驗證并查看 compose 配置文件。

選項包括：

–resolve-image-digests 將鏡像標簽標記為摘要
-q, –quiet 只驗證配置，不輸出。 當配置正確時，不輸出任何內容，當文件配置錯誤，輸出錯誤信息
–services 打印服務名，一行一個
–volumes 打印數據卷名，一行一個

17、Docker-Compose create

docker-compose create [options] [SERVICE...]

選項包括：

–force-recreate：重新創建容器，即使配置和鏡像沒有改變，不兼容–no-recreate參數
–no-recreate：如果容器已經存在，不需要重新創建，不兼容–force-recreate參數
–no-build：不創建鏡像，即使缺失
–build：創建容器前，生成鏡像

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 服務中包含多個容器

19、Docker-Compose port

docker-compose port [options] SERVICE PRIVATE_PORT

選項包括：

–protocol=proto，指定端口協議，TCP（默認值）或者UDP
–index=index，如果同意服務存在多個容器，指定命令對象容器的序號（默認為1）

20、Docker-Compose push

docker-compose push [options] [SERVICE...]

選項包括：

–ignore-push-failures 忽略推送鏡像過程中的錯誤

21、Docker-Compose unpause

docker-compose unpause [SERVICE...]

恢復處于暫停狀態中的服務。

22、Docker-Compose version

docker-compose version

用于打印版本信息。

Docker-Compose 怎么寫？

Docker-Compose標準模板文件應該包含version、services、networks 三大部分，最關鍵的是services和networks兩個部分。我們想要實現對其的配置，就要通過 docker-compose.yml 來實現。

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

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將來會被棄用。

image

image是指定服務的鏡像名稱或鏡像ID。如果鏡像在本地不存在，Compose將會嘗試拉取鏡像。

image: dockercloud/hello-world

build

服務除了可以基于指定的鏡像，還可以基于一份Dockerfile，在使用up啟動時執行構建任務，構建標簽是build，可以指定Dockerfile所在文件夾的路徑。Compose將會利用Dockerfile自動構建鏡像，然后使用鏡像啟動服務容器。

build: /path/to/build/dir
也可以是相對路徑，只要上下文確定就可以讀取到Dockerfile。
build: ./dir
設定上下文根目錄，然后以該目錄為準指定Dockerfile。

context

context 選項可以是 Dockerfile 的文件路徑，也可以是到鏈接到 git 倉庫的 url，當提供的值是相對路徑時，被解析為相對于撰寫文件的路徑，此目錄也是發送到 Docker 守護進程的 context

build:
 context: ./dir

dockerfile

使用dockerfile文件來構建，必須指定構建路徑

build:
 context: ./dir
 dockerfile: Dokcerfile-alternate

command

使用command可以覆蓋容器啟動后默認執行的命令

command:
 bundle exec thin -p 3000

container_name

Compose的容器名稱格式是：<項目名稱><服務名稱><序號>
可以自定義項目名稱、服務名稱，但如果想完全控制容器的命名，可以使用標簽指定：

container_name:
 app

depends_on

depends_on:
 - couchdb
 - redis

這里就是代替啟動命令的執行內容，一般按照順序來執行。例如上面這個語句，執行的就是 couchdb 和 redis 兩個服務。

ports

ports用于映射端口的標簽。

ports:
 - "3000:3000"

extra_hosts

添加主機名的標簽，會在/etc/hosts文件中添加一些記錄。

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

volumes

掛載一個目錄或者一個已存在的數據卷容器

volumes:
  // 只是指定一個路徑，Docker 會自動在創建一個數據卷（這個路徑是容器內部的）。
  - /var/lib/mysql
  // 使用絕對路徑掛載數據卷
  - /opt/data:/var/lib/mysql
  // 以 Compose 配置文件為中心的相對路徑作為數據卷掛載到容器。
  - ./cache:/tmp/cache
  // 使用用戶的相對路徑（~/ 表示的目錄是 /home/<用戶目錄>/ 或者 /root/）。
  - ~/configs:/etc/configs/:ro
  // 已經存在的命名的數據卷。
  - datavolume:/var/lib/mysql

如果不使用宿主機的路徑，可以指定一個volume_driver。
volume_driver: mydriver

dns

dns: 8.8.8.8
dns:
 - 8.8.8.8

自定義一個 dns 服務器。

dns_search

dns_search: example.com
dns_search:
 - domin1.example.com
 - domin2.example.com

配置DNS搜索域。可以是一個值，也可以是一個列表。

entrypoint

定義接入點，覆蓋 Dockerfile 中的定義：

entrypoint: /code/entrypoint.sh

env_file

定義一個專門存放變量的文件：

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

如果有變量名稱與 environment 指令沖突，則以后者為準。

cap_add

增加指定容器的內核能力（capacity）：

cap_add:
 - ALL

cap_drop

與上面一條命令相反，去掉指定容器的內核能力（capacity）：

cap_drop:
 - NET_ADMIN

cgroup_parent

創建一個 cgroup 組：

cgroup_parent: cgroups_1

devices

指定設備映射關系：

devices:
 - "/dev/ttyUSB1:/DEV/ttyUSB0"

expose

暴露端口，但不映射到宿主機，只允許能被連接的服務訪問。僅可以指定內部端口為參數：

expose:
 - "3000"
 - "8000"

extends

基于其他模板文件進行擴展：

webapp:
 build: ./webapp
 environment:
  - DEBUG=false
  - SEND_EMAILS=false

再編寫一個新的 development.yml文件，使用 common.yml中的webapp服務進行擴展：

# development.yml
web:
 extends:
  file: common.yml
  service: webapp
 ports:
  - "8000:8000"
 links:
  - db
 environment:
  - DEBUG=true
db:
 image: mysql

后者會自動繼承 common.yml 中的 webapp服務及環境變量定義。

external_links

鏈接到docker-compose.yml外部的容器，可以是非Compose管理的外部容器。

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

label

為容器添加元數據信息：

labels:
 com.startupteam.description: "webapp for a startup team"

links

鏈接到其它服務中的容器：

links:
 - db
 - db:database
 - redis

log_driver

指定日志驅動類型。目前支持三種日志驅動類型：

log_driver: "json-file"
log_driver: "syslog"
log_driver: "none"

log_opt

日志驅動的相關參數：

log_driver: "syslog"
log_opt: 
 syslog-address: "tcp://192.168.0.42:8080"

net

設置網絡格式：

net: "bridge"
net: "none"
net: "host"

security_opt

指定容器模板標簽（label）機制的默認屬性（用戶、角色、類型、級別等）。例如，配置標簽的用戶名和角色名：

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

參考：https://blog.51cto.com/9291927/2310444