[TOC]

docker compose的使用場(chǎng)景

我們開發(fā)的時(shí)候橱野，一個(gè)應(yīng)用往往依賴多個(gè)服務(wù)叫潦。采用傳統(tǒng)的docker run方式五续，要挨個(gè)啟動(dòng)多個(gè)服務(wù)弟断，甚至需要配置對(duì)應(yīng)的網(wǎng)絡(luò),過程比較繁瑣咏花，很不方便。 docker compose旨在通過將多服務(wù)的構(gòu)建和依賴關(guān)系都編寫在docker-compose.yml中，通過docker-compose命令昏翰，即可完成對(duì)整個(gè)服務(wù)集群的啟動(dòng)苍匆，關(guān)閉等操作。

一個(gè)基本的demo演示

demo的功能是一個(gè)簡(jiǎn)單的python程序棚菊，暴露一個(gè)web服務(wù)浸踩。該服務(wù)用于統(tǒng)計(jì)當(dāng)前服務(wù)被訪問的次數(shù)。次數(shù)的累加和存儲(chǔ)统求，都是基于redis進(jìn)行的检碗。也即該程序本身除了自己的服務(wù)，還要依賴一個(gè)redis服務(wù)码邻。以下是詳細(xì)步驟

找一個(gè)目錄折剃，在其中創(chuàng)建一個(gè)python文件app.py

import time

import redis
from flask import Flask

app = Flask(__name__)
cache = redis.Redis(host='redis', port=6379)

def get_hit_count():
    retries = 5
    while True:
        try:
            return cache.incr('hits')
        except redis.exceptions.ConnectionError as exc:
            if retries == 0:
                raise exc
            retries -= 1
            time.sleep(0.5)

@app.route('/')
def hello():
    count = get_hit_count()
    return 'Hello World! I have been seen {} times.\n'.format(count)

在相同的文件夾下，創(chuàng)建requirements.txt文件

requirements.txt文件用來聲明python程序需要使用到的依賴lib像屋，有點(diǎn)像java中的maven pom文件怕犁。上述代碼使用的組件有flask和redis。所以requirements.txt文件內(nèi)容為

flask
redis

在相同的文件夾下己莺，創(chuàng)建Dockerfile

Dockerfile用來將我們的程序構(gòu)建成一個(gè)docker 鏡像奏甫，即docker image。一般Dockerfile中會(huì)定義我們的代碼運(yùn)行的基本環(huán)境凌受，程序啟動(dòng)命令扶檐，執(zhí)行端口等。本例的Dockerfile如下

FROM python:3.7-alpine
WORKDIR /code
ENV FLASK_APP=app.py
ENV FLASK_RUN_HOST=0.0.0.0
COPY requirements.txt requirements.txt
RUN pip install -r requirements.txt
EXPOSE 5000
COPY . .
CMD ["flask", "run"]

在相同的文件下胁艰，創(chuàng)建docker-compose.yml文件

上述幾步完成后款筑，我們得到了我們服務(wù)本身的docker化執(zhí)行的能力。但該服務(wù)依賴redis service腾么。所以我們通過docker-compose.yml來組織服務(wù)的依賴關(guān)系奈梳，內(nèi)容如下：

version: "3.8"
services:
  web:
    build: .
    ports:
      - "5000:5000"
  redis:
    image: "redis:alpine"

文件中定義了兩個(gè)服務(wù)web和redis , web中的build:. 會(huì)在當(dāng)前目錄下基于前面定義的Dockerfile將我們的代碼構(gòu)建成一個(gè)image，然后啟動(dòng)成一個(gè)container時(shí)解虱，會(huì)對(duì)外暴露5000端口攘须，映射到當(dāng)前宿主機(jī)的端口也是5000

redis服務(wù)直接使用現(xiàn)成的image redis:alpine，沒有指定端口殴泰，將暴露redis的默認(rèn)端口

基礎(chǔ)運(yùn)維

所有docker-compose相關(guān)的命令于宙，都要在docker-compose.yml所在的路徑下執(zhí)行才行

啟動(dòng)基于docker-compose.yml編織好的服務(wù)

在docker-compose.yml所在的目錄，使用命令docker-compose up即可悍汛。但該命令在console關(guān)閉時(shí)捞魁，對(duì)應(yīng)的docker service也會(huì)被關(guān)閉±敫溃可以是使用docker-compose up -d 以后臺(tái)detach模式去執(zhí)行谱俭。

docker-compose up 也可以單獨(dú)啟動(dòng)compolse file中的某個(gè)服務(wù)及其依賴

查看compose服務(wù)對(duì)應(yīng)的容器服務(wù)列表

docker-compose ps

輸出結(jié)果樣例

# docker-compose ps
            Name                          Command               State           Ports
----------------------------------------------------------------------------------------------
docker_compose_learn_redis_1   docker-entrypoint.sh redis ...   Up      6379/tcp
docker_compose_learn_web_1     flask run                        Up      0.0.0.0:5000->5000/tcp

服務(wù)前綴docker_compose_learn是當(dāng)前項(xiàng)目的名稱奉件。項(xiàng)目名稱可以通過環(huán)境變量COMPOSE_PROJECT_NAME來指定，如果未指定昆著，默認(rèn)的項(xiàng)目名稱為compose 文件所在文件夾的名字县貌。本例中的文件夾名為docker_compose_learn

當(dāng)然compose的一系列服務(wù)，最終也是啟動(dòng)了一系列的container. 所以也可使用docker container命令族進(jìn)行管理凑懂，但是太麻煩

停止service的container

需要在docker-compose.yml所在的路徑煤痕，使用命令docker-compose stop

停止service的container，并且刪除對(duì)應(yīng)的container

需要在docker-compose.yml所在的路徑接谨，使用命令

docker-compose down

停止service的container摆碉，并且刪除對(duì)應(yīng)的container和對(duì)應(yīng)的volumes數(shù)據(jù)

需要在docker-compose.yml所在的路徑，使用命令

docker-compose down --volumes

該命令并不會(huì)刪除掛載的宿主操作系統(tǒng)的文件疤坝。

如何登進(jìn)對(duì)應(yīng)的service

想要登錄到compose中兆解，具體某個(gè)service的命令行馆铁，使用如下命令

docker-compose exec ***servicename*** bash

file

如何顯示指定compose file

docker-compose -f docker-compose.yml -f docker-compose.admin.yml run backup_db

docker-compose up和docker-compose run的區(qū)別

docker-compose up會(huì)基于compose file 啟動(dòng)所有的的服務(wù)跑揉，并對(duì)外暴露端口
docker-compose run需要指定特定的服務(wù)進(jìn)行啟動(dòng)，比如docker-compose run web bash只會(huì)啟動(dòng)compolse文件中的web服務(wù)和其依賴的service埠巨，并且不會(huì)對(duì)外暴露端口历谍，以免跟docker-compose up啟動(dòng)的服務(wù)端口沖突。
docker-compose run僅用在臨時(shí)啟動(dòng)某個(gè)服務(wù)定位問題的場(chǎng)景

一些擴(kuò)展知識(shí)點(diǎn)

環(huán)境變量

docker-compose.yml的內(nèi)容本身可以使用變量占位符辣垒，其具體的變量值定義在具體的環(huán)境變量中望侈，這樣方便同一份docker-compose.yml文件在不同的環(huán)境有不同的執(zhí)行行為。典型的勋桶，我們希望依賴服務(wù)的image的tag版本脱衙，隨環(huán)境不同而不同。

那么我們?cè)赿ocker-compose.yml對(duì)應(yīng)的服務(wù)配置中以占位符配置其tag例驹，以下用${TAG}配置web服務(wù)的image tag

web:
  image: "webapp:${TAG}"

除了指定以的變量意外捐韩，還有多個(gè)docker內(nèi)置的變量可以設(shè)置，他們用來配置docker的或者docker compose的執(zhí)行行為鹃锈。這些內(nèi)置變量是

• COMPOSE_API_VERSION
• COMPOSE_CONVERT_WINDOWS_PATHS
• COMPOSE_FILE
• COMPOSE_HTTP_TIMEOUT
• COMPOSE_TLS_VERSION
• COMPOSE_PROJECT_NAME
• DOCKER_CERT_PATH
• DOCKER_HOST
• DOCKER_TLS_VERIFY
  具體含義參見荤胁；https://docs.docker.com/compose/reference/envvars/

以占位符TAG為例，講解變量的設(shè)置可以有以下幾種方式

在docker-compose.yml中執(zhí)行

在compolse文件中屎债，通過environment配置項(xiàng)指定

web:
  image: "webapp:${TAG}"
  environment:
    - TAG=dev

在執(zhí)行docker-compose 命令之前設(shè)置shell環(huán)境變量

$ export TAG=v2.0
$ docker-compose up

通過env_file文件設(shè)置

docker-compose up默認(rèn)會(huì)找命令執(zhí)行路徑下的.env文件仅政，去其中找變量替換的值，.env文件以key=value的形式配置盆驹。例如

TAG=dev

如果環(huán)境變量的名字不為.env或不在當(dāng)前命令執(zhí)行的路徑下圆丹，可以在使用--env-file參數(shù)顯示加載

docker-compose --env-file ./config/.env.dev up 

直接在compose 文件中，指定其加載的env_file

version: '3'
services:
  api:
    image: 'node:6-alpine'
    env_file:
     - ./Docker/api/api.env
    environment:
     - NODE_ENV=production

以上變量值設(shè)置優(yōu)先級(jí)從高到底

查看最終生效的環(huán)境變量

如果不確定最終生效環(huán)境變量是什么樣躯喇，可以使用以下命令來查看

docker-compose run web env

項(xiàng)目名設(shè)定

一個(gè)compose對(duì)應(yīng)的一組服務(wù)有一個(gè)公用的項(xiàng)目名(project name), 它會(huì)體現(xiàn)在compose服務(wù)的容器名前綴中运褪，網(wǎng)絡(luò)前綴中。
項(xiàng)目名稱可以通過環(huán)境變量COMPOSE_PROJECT_NAME來指定，如果未指定秸讹，默認(rèn)的項(xiàng)目名稱為compose 文件所在文件夾的名字檀咙。

網(wǎng)絡(luò)

默認(rèn)網(wǎng)絡(luò)

默認(rèn)情況下，compose中的多個(gè)服務(wù)會(huì)加入一個(gè)名為default的網(wǎng)絡(luò)璃诀。這些服務(wù)在default網(wǎng)絡(luò)中是互通的弧可。該default網(wǎng)絡(luò)的全稱是以compose文件所在文件夾名字做為前綴。比如文件夾為hello_world的compose劣欢。其一組服務(wù)對(duì)應(yīng)的網(wǎng)絡(luò)名為：hello_world_default棕诵。 這組service在該網(wǎng)絡(luò)中，以compose文件中的第二組端口通信凿将。

version: "3"
services:
  web:
    build: .
    ports:
      - "8000:8000"
  db:
    image: postgres
    ports:
      - "8001:5432"

比如上述配置中校套，在hello_world_default網(wǎng)絡(luò)中，web服務(wù)使用8000端口和db服務(wù)的5432端口通信牧抵。第一組端口8000和8001是宿主機(jī)訪問web和db服務(wù)的端口笛匙。

對(duì)默認(rèn)網(wǎng)絡(luò)進(jìn)行獨(dú)立配置

如果想改變默認(rèn)網(wǎng)絡(luò)的配置，可以在compose文件中犀变，單獨(dú)通過networks項(xiàng)來改變妹孙，比如以下改變默認(rèn)網(wǎng)絡(luò)驅(qū)動(dòng)

networks:
  default:
    # Use a custom driver
    driver: custom-driver-1

配置和使用非默認(rèn)網(wǎng)絡(luò)

定義多個(gè)網(wǎng)絡(luò)，并使用

version: "3"
services:

  proxy:
    build: ./proxy
    networks:
      - frontend
  app:
    build: ./app
    networks:
      - frontend
      - backend
  db:
    image: postgres
    networks:
      - backend

networks:
  frontend:
    # Use a custom driver
    driver: custom-driver-1
  backend:
    # Use a custom driver which takes special options
    driver: custom-driver-2
    driver_opts:
      foo: "1"
      bar: "2"

上述配置定義了兩個(gè)網(wǎng)絡(luò)获枝，frontend 和 backend蠢正。其中app 能訪問這兩個(gè)網(wǎng)絡(luò)，proxy服務(wù)只能訪問frontend網(wǎng)絡(luò)省店，db只能訪問backend網(wǎng)絡(luò)

多service的執(zhí)行順序

一個(gè)compose的多個(gè)service可能會(huì)有依賴關(guān)系嚣崭，比如web服務(wù)依賴db服務(wù)，我們希望先啟動(dòng)db服務(wù)懦傍，再啟動(dòng)web服務(wù)雹舀。這種啟動(dòng)的先后順序，也可以在compose文件中使用depends_on指定

version: "2"
services:
  web:
    build: .
    ports:
      - "80:8000"
    depends_on:
      - "db"
    command: ["./wait-for-it.sh", "db:5432", "--", "python", "app.py"]
  db:
    image: postgres

docker compose的安裝

docker mac版和windows版谎脯，默認(rèn)都帶有docker compose 葱跋。 只有l(wèi)inux版需要單獨(dú)安裝

docker compose和docker stack的異同

• docker compose主要目標(biāo)是在同一臺(tái)機(jī)器上啟動(dòng)并管理多個(gè)服務(wù)
• docker stack主要用于在多個(gè)機(jī)器上，啟動(dòng)并管理多個(gè)服務(wù)
• docker compose 和docker stack都可以使用docker-compose.yml文件源梭。雙方會(huì)自動(dòng)忽略對(duì)自己不生效的配置
• docker compose的服務(wù)可以使用build動(dòng)態(tài)構(gòu)建娱俺，而docker stack的服務(wù)只能基于image

參考資料

https://docs.docker.com/compose/gettingstarted/
https://docs.docker.com/compose/
https://stackoverflow.com/questions/43099408/whats-the-difference-between-a-stack-file-and-a-compose-file
https://nickjanetakis.com/blog/docker-tip-23-docker-compose-vs-docker-stack
https://vsupalov.com/difference-docker-compose-and-docker-stack/
https://stackoverflow.com/questions/33066528/should-i-use-docker-compose-up-or-run

歡迎關(guān)注我的個(gè)人公眾號(hào)"西北偏北UP"，記錄代碼人生废麻，行業(yè)思考荠卷，科技評(píng)論