將 FastAPI 應用程式部署到 Heroku
將具有加密 .env.vault 檔案的 FastAPI 應用程式部署到 Heroku。
在此指南中，請在 GitHub 上找到完整的程式碼範例。
初始設定
安裝 fastapi、uvicorn 和 gunicorn。
pip install --upgrade fastapi "uvicorn[standard]" gunicorn
建立一個包含網頁伺服器程式碼的 main.py 檔案。
main.py
import os
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
hello = os.getenv("HELLO")
return {"Hello": hello}
新增一個 Procfile 以在 Heroku 上執行您的應用程式。
Procfile
web: gunicorn --workers 4 -k uvicorn.workers.UvicornWorker main:app
建立 runtime.txt。
runtime.txt
python-3.9.13
凍結您的 requirements.txt。
pip freeze > requirements.txt
設定您的 .gitignore 檔案。
.gitignore
.DS_Store
.env
*.pyc
*.pyo
env/
venv/
.venv/
env*
dist/
build/
將程式碼提交並推送至 Heroku。
heroku create
git push heroku
部署完成後，您的應用程式將顯示 { "Hello": null }，因為它還沒有存取環境變數的方法。接下來我們來解決這個問題。
安裝 python-dotenv-vault
pip install --upgrade python-dotenv-vault
在您的專案根目錄中建立一個 .env 檔案。
.env
# .env
HELLO="World"
盡可能在您的應用程式中提早匯入並設定 dotenv-vault。
main.py
from dotenv_vault import load_dotenv
load_dotenv()
import os
from fastapi import FastAPI
...
嘗試在本機執行。
uvicorn main:app --reload
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
它應該顯示 { "Hello": "World" }。
太棒了！ os.environ 現在有您在 .env 檔案中定義的金鑰和值。這涵蓋了本機開發。接下來，我們來解決生產環境的問題。
建立 .env.vault
推送您最新的 .env 檔案變更，並編輯您的生產環境機密。 深入了解同步
npx dotenv-vault@latest new
npx dotenv-vault@latest push
npx dotenv-vault@latest open production
使用使用者介面來設定每個環境的機密。
然後建置您加密的 .env.vault 檔案。
npx dotenv-vault@latest build
其內容應該如下所示。
.env.vault
#/-------------------.env.vault---------------------/
#/ cloud-agnostic vaulting standard /
#/ [how it works](https://dotenv.org/env-vault) /
#/--------------------------------------------------/
# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2
# production
DOTENV_VAULT_PRODUCTION="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_PRODUCTION_VERSION=2
設定 DOTENV_KEY
擷取您的生產環境 DOTENV_KEY。
npx dotenv-vault@latest keys production
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=production
使用 CLI 在 Heroku 上設定 DOTENV_KEY。
heroku config:set DOTENV_KEY='dotenv://:key_1234…@dotenv.org/vault/.env.vault?environment=production'
或使用 Heroku 的使用者介面。
部署
安全地將這些變更提交到程式碼並部署。
就這樣！在部署時，您的 .env.vault 檔案將會被解密，並且其生產環境機密會即時注入為環境變數。
當您在記錄中看到 Loading env from encrypted .env.vault 時，就知道事情運作正常。如果未設定 DOTENV_KEY (例如在本機電腦上開發時)，它會回退到標準的 dotenv 功能。
您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將機密分散在多個第三方平台和工具上安全得多。每當您需要新增或變更機密時，只需重建您的 .env.vault 檔案並重新部署即可。