Python Web App開發Dockerfiles編寫示例

Posted on by
  • 原文地址：How to write Dockerfiles for Python Web Apps
  • 原文作者：Praveen Durairaj
  • 譯文出自：https://github.com/xitu/gold-miner
  • 本文永久鏈接：github.com/xitu/gold-m…
  • 譯者：lsvih
  • 校對者：Starriers, steinliber

TL;DR

本文涵蓋瞭從創建簡單的 Dockerfile 到生產環境多級構建 Python 應用的例子。以下為本指南的內容摘要：

  • 使用合適的基礎鏡像（開發環境使用 debian，生產環境使用 alpine）。
  • 在開發時使用 gunicorn 進行熱加載。
  • 優化 Docker 的 cache layer（緩存層）—— 按照正確的順序使用命令，僅在必要時運行 pip install。
  • 使用 flask 的 static 及 template 目錄部署靜態文件（比如 React、Vue、Angular 生成的 bundle）。
  • 使用 alpine 進行生產環境下的多級構建，減少最終鏡像文件的大小。
  • #彩蛋 — 在開發時可以用 gunicorn 的 –reload 與 –reload_extra_files 監視文件（包括 html、css 及 js）的修改。

如果你需要以上步驟的代碼，請參考 GitHub repo.

內容

  • 簡單的 Dockerfile 與 .dockerignore
  • 使用 gunicorn 實現熱加載
  • 運行一個單文件 python 腳本
  • 部署靜態文件
  • 生產環境中的直接構建
  • 生產環境中的多級構建

假設我們有一個名為 python-app 的應用，為其準備一個簡單的目錄結構。在頂級目錄下，包含 Dockerfile 以及 src 文件夾。

python app 的源碼就存放在 src 目錄中，app 的依賴關系保存在 requirements.txt 裡。為瞭簡潔起見，我們假設 server.py 定義瞭一個運行於 8080 端口的 flask 服務。

python-app
├── Dockerfile
└── src
    └── server.py
    └── requirements.txt

1. 簡單的 Dockerfile 樣例

FROM python:3.6
# 創建 app 目錄
WORKDIR /app
# 安裝 app 依賴
COPY src/requirements.txt ./
RUN pip install -r requirements.txt
# 打包 app 源碼
COPY src /app
EXPOSE 8080
CMD [ "python", "server.py" ]

我們將使用最新版本的 python:3.6 作為基礎鏡像。

在構建鏡像時，docker 會獲取所有位於 context 目錄下的文件。為瞭提高 docker 構建的速度，可以在 context 目錄中添加 .dockerignore 文件來排除不需要的文件與目錄。

通常，你的 .dockerignore 文件件應該如下所示：

.git
__pycache__
*.pyc
*.pyo
*.pyd
.Python
env

構建並運行此鏡像：

$ cd python-docker
$ docker build -t python-docker-dev .
$ docker run --rm -it -p 8080:8080 python-docker-dev

你將能在 [http://localhost:8080](http://localhost:8080.) 訪問此 app。使用 Ctrl+C 組合鍵可以退出程序。

現在，假設你希望在每次修改代碼（比如在本地部署時）時都運行以上代碼，那麼你需要在啟停 python 服務時將代碼源文件掛載到容器中。

$ docker run --rm -it -p 8080:8080 -v $(pwd):/app \
             python-docker-dev bash
root@id:/app# python src/server.py

2. 使用 Gunicorn 實現熱更新

gunicorn 是一款運行於 Unix 下的 Python WSGI HTTP server，使用的是 pre-fork worker 模型（註，Arbiter 是 gunicorn 的 master，因此稱 gunicorn 為 pre-fork worker）。你可以使用各種各樣的選項來配置 gunicorn。向 gunicorn 命令中傳入 –reload 或是將 reload 寫入配置文件，就可以讓 gunicorn 在有文件發生變化時自動重啟 python 服務。

FROM python:3.6
# 創建 app 目錄
WORKDIR /app
# 安裝 app 依賴
COPY gunicorn_app/requirements.txt ./
RUN pip install -r requirements.txt
# 打包 app 源碼
COPY gunicorn_app /app
EXPOSE 8080

我們將構建鏡像並運行 gunicorn，以便在 app 目錄下文件發生變動時對代碼進行 rebuild。

$ cd python-docker
$ docker build -t python-hot-reload-docker .
$ docker run --rm -it -p 8080:8080 -v $(pwd):/app \
             python-hot-reload-docker bash
root@id:/app# gunicorn --config ./gunicorn_app/conf/gunicorn_config.py gunicorn_app:app

一切在 app 目錄下 python 文件的更改都會觸發 rebuild，發生的變化都能在 [http://localhost:8080](http://localhost:8080.) 上實時展示。請註意，我們已經將文件掛載到瞭容器中，因此 gunicorn 才能正常工作。

其它格式的文件怎麼辦？ 如果你希望 gunicorn 在監視代碼變動的時候也監視其它類型的文件（如 template、view 之類的文件），可以在 reload_extra_files 參數中進行指定。此參數接受數組形式的多個文件名。

3. 運行一個單文件 python 腳本

你可以通過 docker run，使用 python 鏡像來簡單地運行 python 單文件腳本。

docker run -it --rm --name single-python-script -v "$PWD":/app -w /app python:3 python your-daemon-or-script.py

你也可以給腳本傳遞一些參數。在上面的例子中，我們就已經掛載瞭當前工作目錄，也就是說可以將目錄中的文件當做參數傳遞。

4. 部署靜態文件

上面的 Dockerfile 假定瞭你是使用 Python 運行一個 API 服務器。如果你想用 Python 為 React.js、Vue.js、Angular.js app 提供服務，可以使用 Flask。Flask 為渲染靜態文件提供瞭一種便捷的方式：html 文件放在 templates 目錄中，css、js 及圖片放在 static 目錄中。

請在此 repo 中查看簡單的 hello world 靜態 app 的目錄結構。

FROM python:3.6
# 創建 app 目錄
WORKDIR /app
# 安裝 app 依賴
COPY static_app/requirements.txt ./
RUN pip install -r requirements.txt
# 打包 app 源碼
COPY static_app /app
EXPOSE 8080
CMD ["python","server.py"]

In your server.py,

if __name__ == '__main__':
    app.run(host='0.0.0.0')

請註意，host 需要設置為 0.0.0.0 – 這樣可以讓你的服務在容器外被訪問。如果不設置此參數，host 會默認設為 localhost。

5. 生產環境中的直接構建

FROM python:3.6
# 創建 app 目錄
WORKDIR /app
# 安裝 app 依賴
COPY gunicorn_app/requirements.txt ./
RUN pip install -r requirements.txt
# 打包 app 源碼
COPY . /app
EXPOSE 8080
CMD ["gunicorn", "--config", "./gunicorn_app/conf/gunicorn_config.py", "gunicorn_app:app"]

構建並運行這個一體化鏡像：

$ cd python-docker
$ docker build -t python-docker-prod .
$ docker run --rm -it -p 8080:8080 python-docker-prod

由於底層為 Debian，構建完成後鏡像約為 700MB（具體數值取決於你的源碼）。下面探討如何減小這個文件的大小。

6. 生產環境中的多級構建

使用多級構建時，將在 Dockerfile 中使用多個 FROM 語句，但最後僅會使用最終階段構建的文件。這樣，得到的鏡像將僅包含生產服務器中所需的依賴，理想情況下文件將非常小。

當你需要使用依賴於系統的模塊或需要編譯的模塊時，這種構建模式十分有用。比如 pycrypto 和 numpy 就很適合這種方法。

# ---- 基礎 python 鏡像 ----
FROM python:3.6 AS base
# 創建 app 目錄
WORKDIR /app
# ---- 依賴 ----
FROM base AS dependencies  
COPY gunicorn_app/requirements.txt ./
# 安裝 app 依賴
RUN pip install -r requirements.txt
# ---- 復制文件並 build ----
FROM dependencies AS build  
WORKDIR /app
COPY . /app
# 在需要時進行 Build 或 Compile
# --- 使用 Alpine 發佈 ----
FROM python:3.6-alpine3.7 AS release  
# 創建 app 目錄
WORKDIR /app
COPY --from=dependencies /app/requirements.txt ./
COPY --from=dependencies /root/.cache /root/.cache
# 安裝 app 依賴
RUN pip install -r requirements.txt
COPY --from=build /app/ ./
CMD ["gunicorn", "--config", "./gunicorn_app/conf/gunicorn_config.py", "gunicorn_app:app"]

使用上面的方法，用 Alpine 構建的鏡像文件大小約 90MB，比之前少瞭 8 倍。使用 alpine 版本進行構建能有效減小鏡像的大小。

註意： 上面的 Dockerfiles 是為 python 3 編寫的，你可以隻做少數修改就能將其改為 python 2 版本。如果你要部署的是 django 應用，也應該能通過少數改動就做出可部署於生產環境的 Dockerfiles。

此外，你是否試過將 python web app 部署在 Hasura 上呢？這其實是將 python 應用部署於 HTTPS 域名的最快的方法（僅需使用 git push）。嘗試使用 hasura.io/hub/project… 的模板快速入門吧！Hasura 中所有的項目模板都帶有 Dockerfile 與 Kubernetes 標準文件，你可以自由進行定義

以上就是Python Web App編寫Dockerfiles示例的詳細內容，更多關於Python Web App編寫Dockerfiles的資料請關註WalkonNet其它相關文章！

推薦閱讀：