腳本之家服務器常用軟件

快捷導航

詳解docker compose 用法

更新時間：2020年10月26日 08:37:45 作者：返回主頁西北偏北UP

這篇文章主要介紹了docker compose 用法,本文通過實例代碼演示給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

docker compose的使用場景

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

一個基本的demo演示

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

找一個目錄，在其中創(chuàng)建一個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，有點像java中的maven pom文件。上述代碼使用的組件有flask和redis。所以requirements.txt文件內容為

flask
redis

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

Dockerfile用來將我們的程序構建成一個docker 鏡像，即docker image。一般Dockerfile中會定義我們的代碼運行的基本環(huán)境，程序啟動命令，執(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文件

上述幾步完成后，我們得到了我們服務本身的docker化執(zhí)行的能力。但該服務依賴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服務直接使用現(xiàn)成的image redis:alpine，沒有指定端口，將暴露redis的默認端口

基礎運維

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

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

在docker-compose.yml所在的目錄，使用命令docker-compose up即可。但該命令在console關閉時，對應的docker service也會被關閉?？梢允鞘褂?code>docker-compose up -d 以后臺detach模式去執(zhí)行。

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是當前項目的名稱。項目名稱可以通過環(huán)境變量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數(shù)據

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

docker-compose down --volumes

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

如何登進對應的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的區(qū)別

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

一些擴展知識點

環(huán)境變量

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

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

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

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

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中執(zhí)行

在compolse文件中，通過environment配置項指定

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

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

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

通過env_file文件設置

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

TAG=dev

如果環(huán)境變量的名字不為.env或不在當前命令執(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

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

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

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

docker-compose run web env

項目名設定

一個compose對應的一組服務有一個公用的項目名(project name), 它會體現(xiàn)在compose服務的容器名前綴中，網絡前綴中。
項目名稱可以通過環(huán)境變量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的執(zhí)行順序

一個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