docker compose 用法

目錄

• docker compose的使用場景
• 一個基本的demo演示
  • 找一個目錄，在其中建立一個python檔案app.py
  • 在相同的資料夾下，建立requirements.txt檔案
  • 在相同的資料夾下，建立Dockerfile
  • 在相同的檔案下，建立docker-compose.yml檔案
• 基礎運維
  • 啟動基於docker-compose.yml編織好的服務
  • 檢視compose服務對應的容器服務列表
  • 停止service的container
  • 停止service的container，並且刪除對應的container
  • 停止service的container，並且刪除對應的container和對應的volumes資料
  • 如何登進對應的service
  • 如何顯示指定compose file
• docker-compose up和docker-compose run的區別
• 一些擴充套件知識點
  • 環境變數
    • 在docker-compose.yml中執行
    • 在執行docker-compose 命令之前設定shell環境變數
    • 通過env_file檔案設定
    • 直接在compose 檔案中，指定其載入的env_file
    • 以上變數值設定優先順序從高到底
    • 檢視最終生效的環境變數
    • 專案名設定
  • 網路
    • 預設網路
    • 對預設網路進行獨立配置
    • 配置和使用非預設網路
  • 多service的執行順序
• docker compose的安裝
• docker compose和docker stack的異同
• 參考資料

docker compose的使用場景

我們開發的時候，一個應用往往依賴多個服務。採用傳統的docker run方式，要挨個啟動多個服務，甚至需要配置對應的網路,過程比較繁瑣，很不方便。 docker compose旨在通過將多服務的構建和依賴關係都編寫在docker-compose.yml中，通過docker-compose命令，即可完成對整個服務叢集的啟動，關閉等操作。

一個基本的demo演示

demo的功能是一個簡單的python程式，暴露一個web服務。該服務用於統計當前服務被訪問的次數。次數的累加和儲存，都是基於redis進行的。也即該程式本身除了自己的服務，還要依賴一個redis服務。以下是詳細步驟

找一個目錄，在其中建立一個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)

在相同的資料夾下，建立requirements.txt檔案

requirements.txt檔案用來宣告python程式需要使用到的依賴lib，有點像java中的maven pom檔案。上述程式碼使用的元件有flask和redis。所以requirements.txt檔案內容為

flask
redis

在相同的資料夾下，建立Dockerfile

Dockerfile用來將我們的程式構建成一個docker 映象，即docker image。一般Dockerfile中會定義我們的程式碼執行的基本環境，程式啟動命令，執行埠等。本例的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"]

在相同的檔案下，建立docker-compose.yml檔案

上述幾步完成後，我們得到了我們服務本身的docker化執行的能力。但該服務依賴redis service。所以我們通過docker-compose.yml來組織服務的依賴關係，內容如下：

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

檔案中定義了兩個服務web和redis , web中的build:. 會在當前目錄下基於前面定義的Dockerfile將我們的程式碼構建成一個image，然後啟動成一個container時，會對外暴露5000埠，對映到當前宿主機的埠也是5000

redis服務直接使用現成的image redis:alpine，沒有指定埠，將暴露redis的預設埠

基礎運維

所有docker-compose相關的命令，都要在docker-compose.yml所在的路徑下執行才行

啟動基於docker-compose.yml編織好的服務

在docker-compose.yml所在的目錄，使用命令docker-compose up即可。但該命令在console關閉時，對應的docker service也會被關閉。可以是使用docker-compose up -d 以後臺detach模式去執行。

docker-compose up 也可以單獨啟動compolse file中的某個服務及其依賴

檢視compose服務對應的容器服務列表

docker-compose ps

輸出結果樣例

# 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

服務字首docker_compose_learn是當前專案的名稱。專案名稱可以通過環境變數COMPOSE_PROJECT_NAME來指定，如果未指定，預設的專案名稱為compose 檔案所在資料夾的名字。本例中的資料夾名為docker_compose_learn

當然compose的一系列服務，最終也是啟動了一系列的container. 所以也可使用docker container命令族進行管理，但是太麻煩

停止service的container

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

停止service的container，並且刪除對應的container

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

docker-compose down

停止service的container，並且刪除對應的container和對應的volumes資料

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

docker-compose down --volumes

該命令並不會刪除掛載的宿主作業系統的檔案。

如何登進對應的service

想要登入到compose中，具體某個service的命令列，使用如下命令

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

如何顯示指定compose file

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

docker-compose up和docker-compose run的區別

docker-compose up會基於compose file 啟動所有的的服務，並對外暴露埠
docker-compose run需要指定特定的服務進行啟動，比如docker-compose run web bash只會啟動compolse檔案中的web服務和其依賴的service，並且不會對外暴露埠，以免跟docker-compose up啟動的服務埠衝突。
docker-compose run僅用在臨時啟動某個服務定位問題的場景

一些擴充套件知識點

環境變數

docker-compose.yml的內容本身可以使用變數佔位符，其具體的變數值定義在具體的環境變數中，這樣方便同一份docker-compose.yml檔案在不同的環境有不同的執行行為。典型的，我們希望依賴服務的image的tag版本，隨環境不同而不同。

那麼我們在docker-compose.yml對應的服務配置中以佔位符配置其tag，以下用${TAG}配置web服務的image tag

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

除了指定以的變數意外，還有多個docker內建的變數可以設定，他們用來配置docker的或者docker compose的執行行為。這些內建變數是

• 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為例，講解變數的設定可以有以下幾種方式

在docker-compose.yml中執行

在compolse檔案中，通過environment配置項指定

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

在執行docker-compose 命令之前設定shell環境變數

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

通過env_file檔案設定

docker-compose up預設會找命令執行路徑下的.env檔案，去其中找變數替換的值，.env檔案以key=value的形式配置。例如

TAG=dev

如果環境變數的名字不為.env或不在當前命令執行的路徑下，可以在使用--env-file引數顯示載入

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

以上變數值設定優先順序從高到底

檢視最終生效的環境變數

如果不確定最終生效環境變數是什麼樣，可以使用以下命令來檢視

docker-compose run web env

專案名設定

一個compose對應的一組服務有一個公用的專案名(project name), 它會體現在compose服務的容器名字首中，網路字首中。
專案名稱可以通過環境變數COMPOSE_PROJECT_NAME來指定，如果未指定，預設的專案名稱為compose 檔案所在資料夾的名字。

網路

預設網路

預設情況下，compose中的多個服務會加入一個名為default的網路。這些服務在default網路中是互通的。該default網路的全稱是以compose檔案所在資料夾名字做為字首。比如資料夾為hello_world的compose。其一組服務對應的網路名為：hello_world_default。 這組service在該網路中，以compose檔案中的第二組埠通訊。

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

比如上述配置中，在hello_world_default網路中，web服務使用8000埠和db服務的5432埠通訊。第一組埠8000和8001是宿主機訪問web和db服務的埠。

對預設網路進行獨立配置

如果想改變預設網路的配置，可以在compose檔案中，單獨通過networks項來改變，比如以下改變預設網路驅動

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

配置和使用非預設網路

定義多個網路，並使用

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"

上述配置定義了兩個網路，frontend 和 backend。其中app 能訪問這兩個網路，proxy服務只能訪問frontend網路，db只能訪問backend網路

多service的執行順序

一個compose的多個service可能會有依賴關係，比如web服務依賴db服務，我們希望先啟動db服務，再啟動web服務。這種啟動的先後順序，也可以在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版，預設都帶有docker compose 。 只有linux版需要單獨安裝

docker compose和docker stack的異同

• docker compose主要目標是在同一臺機器上啟動並管理多個服務
• docker stack主要用於在多個機器上，啟動並管理多個服務
• docker compose 和docker stack都可以使用docker-compose.yml檔案。雙方會自動忽略對自己不生效的配置
• docker compose的服務可以使用build動態構建，而docker stack的服務只能基於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

歡迎關注我的個人公眾號"西北偏北UP"，記錄程式碼人生，行業思考，科技評論