爲 Python Web App 編寫 Dockerfiles

• 原文地址：How to write Dockerfiles for Python Web Apps
• 原文做者：Praveen Durairaj
• 譯文出自：掘金翻譯計劃
• 本文永久連接：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.

內容

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

假設咱們有一個名爲 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。

若是你對前面的方法有任何建議，或但願看到別的用例，請告知做者。

歡迎加入 Reddit 或 HackerNews 參與討論 :)

---

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

---

掘金翻譯計劃 是一個翻譯優質互聯網技術文章的社區，文章來源爲 掘金 上的英文分享文章。內容覆蓋 Android、iOS、前端、後端、區塊鏈、產品、設計、人工智能等領域，想要查看更多優質譯文請持續關注 掘金翻譯計劃、官方微博、知乎專欄。