轉自https://cloud.tencent.com/developer/article/1499032

一轰豆、Docker-Compose簡介

1、Docker-Compose簡介

Docker-Compose項目是Docker官方的開源項目敷扫，負責實現對Docker容器集群的快速編排埋酬。 Docker-Compose將所管理的容器分為三層伞插，分別是工程（project）粗梭，服務（service）以及容器（container）拼坎。Docker-Compose運行目錄下的所有文件（docker-compose.yml浮毯，extends文件或環(huán)境變量文件等）組成一個工程，若無特殊指定工程名即為當前目錄名演痒。一個工程當中可包含多個服務亲轨，每個服務中定義了容器運行的鏡像，參數鸟顺，依賴惦蚊。一個服務當中可包括多個容器實例器虾，Docker-Compose并沒有解決負載均衡的問題，因此需要借助其它工具實現服務發(fā)現及負載均衡蹦锋。
Docker-Compose的工程配置文件默認為docker-compose.yml兆沙，可通過環(huán)境變量COMPOSE_FILE或-f參數自定義配置文件，其定義了多個有依賴關系的服務及每個服務運行的容器莉掂。 使用一個Dockerfile模板文件葛圃，可以讓用戶很方便的定義一個單獨的應用容器。在工作中憎妙，經常會碰到需要多個容器相互配合來完成某項任務的情況库正。例如要實現一個Web項目，除了Web服務容器本身厘唾，往往還需要再加上后端的數據庫服務容器褥符，甚至還包括負載均衡容器等。 Compose允許用戶通過一個單獨的docker-compose.yml模板文件（YAML 格式）來定義一組相關聯的應用容器為一個項目（project）抚垃。 Docker-Compose項目由Python編寫喷楣，調用Docker服務提供的API來對容器進行管理。因此鹤树，只要所操作的平臺支持Docker API铣焊，就可以在其上利用Compose來進行編排管理。

2罕伯、Docker-Compose安裝

安裝方法： 安裝pip

yum -y install epel-release
yum -y install python-pip
pip --version
pip install --upgrade pip
pip install docker-compose
docker-compose version

3曲伊、Docker-Compose卸載

如果是二進制包方式安裝的，刪除二進制文件即可： sudo rm /usr/local/bin/docker-compose
如果通過Python pip工具安裝的捣炬，則執(zhí)行如下命令刪除： sudo pip uninstall docker-compose

二熊昌、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 up

這個命令一定要記住扩所，每次啟動都要用到，只要學會使用的人記住這個就好了

docker-compose up [options] [--scale SERVICE=NUM...] [SERVICE...]

選項包括：

• -d 在后臺運行服務容器
• –no-color 不使用顏色來區(qū)分不同的服務的控制輸出
• –no-deps 不啟動服務所鏈接的容器
• –force-recreate 強制重新創(chuàng)建容器朴乖，不能與–no-recreate同時使用
• –no-recreate 如果容器已經存在祖屏，則不重新創(chuàng)建助赞，不能與–force-recreate同時使用
• –no-build 不自動構建缺失的服務鏡像
• –build 在啟動容器前構建服務鏡像
• –abort-on-container-exit 停止所有容器，如果任何一個容器被停止袁勺，不能與-d同時使用
• -t, –timeout TIMEOUT 停止容器時候的超時（默認為10秒）
• –remove-orphans 刪除服務中沒有在compose文件中定義的容器
• –scale SERVICE=NUM 設置服務運行容器的個數雹食，將覆蓋在compose中通過scale指定的參數
• -f 指定使用的Compose模板文件，默認為docker-compose.yml期丰，可以多次指定群叶。
  啟動所有服務

docker-compose up  

在后臺啟動所有服務

docker-compose up -d

在后臺所有啟動服務,指定編排文件

docker-compose -f docker-compose.yml up -d

3、docker-compose ps

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

4钝荡、docker-compose stop

docker-compose stop 停止正在運行的容器街立，可以通過docker-compose start 再次啟動

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

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

5、docker-compose -h

查看幫助
docker-compose -h

6埠通、docker-compose down

停止和刪除容器几晤、網絡、卷植阴、鏡像

docker-compose down [options]

選項包括：

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

7灸拍、docker-compose logs

查看服務容器的輸出

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

默認情況下做祝，docker-compose將對不同的服務輸出使用不同的顏色來區(qū)分〖Ω冢可以通過–no-color來關閉顏色混槐。

8、docker-compose build

構建（重新構建）項目中的服務容器

docker-compose build [options] [--build-arg key=val...] [SERVICE...]

選項包括：

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

9、docker-compose pull

拉取服務依賴的鏡像

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

選項包括：

• –ignore-pull-failures揣苏，忽略拉取鏡像過程中的錯誤
• –parallel悯嗓，多個鏡像同時拉取
• –quiet，拉取鏡像過程中不打印進度信息

10卸察、docker-compose restart

docker-compose restart 重啟項目中的服務

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

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

11脯厨、docker-compose rm

刪除所有（停止狀態(tài)的）服務容器

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

選項包括：

• –f, –force，強制直接刪除坑质，包括非停止狀態(tài)的容器
• -v合武，刪除容器所掛載的數據卷
  docker-compose rm 刪除所有（停止狀態(tài)的）服務容器临梗。推薦先執(zhí)行docker-compose stop命令來停止容器。

12眯杏、docker-compose start

docker-compose start 啟動已經存在的服務容器夜焦。

13、docker-compose run

在指定服務上執(zhí)行一個命令

docker-compose run [options] [-v VOLUME...] [-p PORT...] [-e KEY=VAL...] SERVICE [COMMAND] [ARGS...]
示例：
`docker-compose run ubuntu ping www.baidu.com` 在指定容器上執(zhí)行一個ping命令岂贩。

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

### 15萎津、docker-compose pause

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

### 16卸伞、docker-compose kill
通過發(fā)送SIGKILL信號來強制停止服務容器
```shell
docker-compose kill [options] [SERVICE ...]

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

17锉屈、dokcer-compose config

驗證并查看compose文件配置

docker-compose config [options]

選項包括：

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

18、docker-compose create

為服務創(chuàng)建容器

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

選項包括： –force-recreate：重新創(chuàng)建容器绍豁，即使配置和鏡像沒有改變芯咧，不兼容–no-recreate參數 –no-recreate：如果容器已經存在，不需要重新創(chuàng)建竹揍，不兼容–force-recreate參數 –no-build：不創(chuàng)建鏡像敬飒，即使缺失 –build：創(chuàng)建容器前，生成鏡像

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

20、docker-compose port

docker-compose port [options] SERVICE PRIVATE_PORT

顯示某個容器端口所映射的公共端口哥牍。 選項包括： –protocol=proto毕泌，指定端口協(xié)議喝检，TCP（默認值）或者UDP –index=index，如果同意服務存在多個容器撼泛，指定命令對象容器的序號（默認為1）

21挠说、docker-compose push

推送服務依的鏡像

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

選項包括： –ignore-push-failures 忽略推送鏡像過程中的錯誤

22、docker-compose stop

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

23损俭、docker-compose unpause

docker-compose unpause [SERVICE...] 恢復處于暫停狀態(tài)中的服務。

24潘酗、docker-compose version

docker-compose version 打印版本信息杆兵。

三、Docker-Compose模板文件

1仔夺、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

Compose目前有三個版本分別為Version 1，Version 2路克，Version 3樟结，Compose區(qū)分Version 1和Version 2（Compose 1.6.0+，Docker Engine 1.10.0+）精算。Version 2支持更多的指令瓢宦。Version 1將來會被棄用。

2灰羽、image

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

services: 
    web: 
        image: hello-world 

3玫镐、build

服務除了可以基于指定的鏡像，還可以基于一份Dockerfile怠噪，在使用up啟動時執(zhí)行構建任務恐似，構建標簽是build，可以指定Dockerfile所在文件夾的路徑傍念。Compose將會利用Dockerfile自動構建鏡像矫夷，然后使用鏡像啟動服務容器葛闷。 build: /path/to/build/dir 也可以是相對路徑，只要上下文確定就可以讀取到Dockerfile双藕。 build: ./dir 設定上下文根目錄淑趾，然后以該目錄為準指定Dockerfile。

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

build都是一個目錄忧陪，如果要指定Dockerfile文件需要在build標簽的子級標簽中使用dockerfile標簽指定扣泊。 如果同時指定image和build兩個標簽，那么Compose會構建鏡像并且把鏡像命名為image值指定的名字赤嚼。

4旷赖、context

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

build:
  context: ./dir 

5蹂空、dockerfile

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

build:
  context: .
  dockerfile: Dockerfile-alternate 

dockerfile指令不能跟image同時使用，否則Compose將不確定根據哪個指令來生成最終的服務鏡像上枕。

6咐熙、command

使用command可以覆蓋容器啟動后默認執(zhí)行的命令。 command: bundle exec thin -p 3000

7辨萍、container_name

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

8爪飘、depends_on

在使用Compose時，最大的好處就是少打啟動命令拉背，但一般項目容器啟動的順序是有要求的师崎，如果直接從上到下啟動容器，必然會因為容器依賴問題而啟動失敗椅棺。例如在沒啟動數據庫容器的時候啟動應用容器犁罩，應用容器會因為找不到數據庫而退出。depends_on標簽用于解決容器的依賴两疚、啟動先后的問題床估。

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

上述YAML文件定義的容器會先啟動redis和db兩個服務，最后才啟動web 服務诱渤。

9顷窒、pid

pid: "host" 將PID模式設置為主機PID模式，跟主機系統(tǒng)共享進程命名空間。容器使用pid標簽將能夠訪問和操縱其他容器和宿主機的名稱空間鞋吉。

10鸦做、ports

ports用于映射端口的標簽。 使用HOST:CONTAINER格式或者只是指定容器的端口谓着，宿主機會隨機映射端口泼诱。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

當使用HOST:CONTAINER格式來映射端口時，如果使用的容器端口小于60可能會得到錯誤得結果赊锚，因為YAML將會解析xx:yy這種數字格式為60進制治筒。所以建議采用字符串格式。

11舷蒲、extra_hosts

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

extra_hosts:
 - "somehost:162.242.195.82"
 - "otherhost:50.31.209.229"</pre>

啟動后查看容器內部hosts：
162.242.195.82 somehost
50.31.209.229 otherhost

12牲平、volumes

掛載一個目錄或者一個已存在的數據卷容器堤框，可以直接使用 [HOST:CONTAINER]格式，或者使用[HOST:CONTAINER:ro]格式纵柿，后者對于容器來說蜈抓，數據卷是只讀的，可以有效保護宿主機的文件系統(tǒng)昂儒。 Compose的數據卷指定路徑可以是相對路徑沟使，使用 . 或者 .. 來指定相對目錄。 數據卷的格式可以是下面多種形式：

volumes:
  // 只是指定一個路徑渊跋，Docker 會自動在創(chuàng)建一個數據卷（這個路徑是容器內部的）腊嗡。
  - /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

13、volumes_from

從另一個服務或容器掛載其數據卷：

volumes_from:
   - service_name    
     - container_name 

14虎眨、dns

自定義DNS服務器蟋软。可以是一個值嗽桩，也可以是一個列表岳守。

dns：8.8.8.8
dns：
    - 8.8.8.8    
      - 9.9.9.9

15、dns_search

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

dns_search：example.com
dns_search：
    - domain1.example.com
    - domain2.example.com

16譬重、entrypoint

在Dockerfile中有一個指令叫做ENTRYPOINT指令拒逮，用于指定接入點。 在docker-compose.yml中可以定義接入點臀规，覆蓋Dockerfile中的定義： entrypoint: /code/entrypoint.sh

17滩援、env_file

在docker-compose.yml中可以定義一個專門存放變量的文件。 如果通過docker-compose -f FILE指定配置文件塔嬉，則env_file中路徑會使用配置文件路徑玩徊。 如果有變量名稱與environment指令沖突，則以后者為準谨究。格式如下： env_file: .env 或者根據docker-compose.yml設置多個：

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

如果在配置文件中有build操作恩袱，變量并不會進入構建過程中。

18胶哲、cap_add

增加指定容器的內核能力（capacity）畔塔。 讓容器具有所有能力可以指定：

cap_add:
    - ALL

19、cap_drop

去掉指定容器的內核能力（capacity）纪吮。 去掉NET_ADMIN能力可以指定：

cap_drop:
    - NET_ADMIN

20俩檬、cgroup_parent

創(chuàng)建了一個cgroup組名稱為cgroups_1: cgroup_parent: cgroups_1

21、devices

指定設備映射關系碾盟，例如：

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

22棚辽、expose

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

expose:
    - "3000"
    - "8000" 

23熙尉、extends

基于其它模板文件進行擴展联逻。例如，對于webapp服務定義了一個基礎模板文件為common.yml：

common.yml
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服務及環(huán)境變量定義包归。 extends限制如下： A、要避免出現循環(huán)依賴 B铅歼、extends不會繼承l(wèi)inks和volumes_from中定義的容器和數據卷資源 推薦在基礎模板中只定義一些可以共享的鏡像和環(huán)境變量公壤，在擴展模板中具體指定應用變量、鏈接椎椰、數據卷等信息

24厦幅、external_links

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

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

25确憨、labels

為容器添加Docker元數據（metadata）信息。例如，可以為容器添加輔助說明信息：

labels：
    com.startupteam.description: "webapp for a strtup team"

26休弃、links

鏈接到其它服務中的容器吞歼。使用服務名稱（同時作為別名），或者“服務名稱:服務別名”（如 SERVICE:ALIAS）玫芦，例如：

links:
    - db
    - db:database
    - redis

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

172.17.2.186  db
172.17.2.186  database
172.17.2.187  redis

27、log_driver

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

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

28医增、log_opt

日志驅動的相關參數。例如：

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

29老虫、net

設置網絡模式叶骨。

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

30、security_opt

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

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

31、環(huán)境變量

環(huán)境變量可以用來配置Docker-Compose的行為些阅。 COMPOSE_PROJECT_NAME 設置通過Compose啟動的每一個容器前添加的項目名稱伞剑，默認是當前工作目錄的名字。 COMPOSE_FILE 設置docker-compose.yml模板文件的路徑市埋。默認路徑是當前工作目錄黎泣。 DOCKER_HOST 設置Docker daemon的地址。默認使用unix:///var/run/docker.sock缤谎。 DOCKER_TLS_VERIFY 如果設置不為空抒倚，則與Docker daemon交互通過TLS進行。 DOCKER_CERT_PATH 配置TLS通信所需要的驗證(ca.pem坷澡、cert.pem 和 key.pem)文件的路徑托呕，默認是 ~/.docker 。

四频敛、Docker-Compose模板文件示例

1项郊、docker-compose模板文件編寫

docker-compose.yaml文件如下：

version: '2'
services:
  web1:
    image: nginx
    ports: 
      - "6061:80"
    container_name: "web1"
    networks:
      - dev
  web2:
    image: nginx
    ports: 
      - "6062:80"
    container_name: "web2"
    networks:
      - dev
      - pro
  web3:
    image: nginx
    ports: 
      - "6063:80"
    container_name: "web3"
    networks:
      - pro

networks:
  dev:
    driver: bridge
  pro:
    driver: bridge

#volumes:

docker-compose.yaml文件指定了三個web服務。

2姻政、啟動應用

創(chuàng)建一個webapp目錄，將docker-compose.yaml文件拷貝到webapp目錄下岂嗓，使用docker-compose啟動應用汁展。 docker-compose up -d

3、服務訪問

通過瀏覽器訪問web1: http://127.0.0.1:6061
web2服務: http://127.0.0.1:6062
web3服務: http://127.0.0.1:6063