萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

Python Fabric 自動化部署實戰筆記

Fabric 是基於 SSH 的 Python 自動化部署工具,能將重複的遠端操作 (部署、重啟、備份) 封裝為可重複執行的腳本。本文從安裝、基本用法、參數傳遞、本地/遠端混合操作、多伺服器角色定義、錯誤處理到密碼管理,完整記錄實戰經驗。

環境安裝

pip install fabric==1.14.0  # 或 2.x 版本,API 差異較大,本文以 1.x 為例
# 驗證
fab --version

Hello World

# fabfile.py
def hello():
    print("Hello world!")

# 執行
fab hello
# 輸出: Hello world!

帶參數任務

def hello(name, value):
    print(f"{name} = {value}!")

# 執行方式
fab hello:name=age,value=20
fab hello:age,20   # 位置參數

本地操作 local()

from fabric.api import local

def lsfab():
    local('cd ~/project && ls -la')

遠端操作 run()、cd()

from fabric.api import env, run, cd

env.hosts = ['user@host:port']
env.password = 'password'  # 或使用 SSH Key

def deploy():
    with cd('/home/user/project'):
        run('git pull')
        run('pip install -r requirements.txt')
        run('systemctl restart myapp')

混合本地與遠端流程

from fabric.api import local, run, cd, execute

def local_commit():
    local('git add . && git commit -m "auto" && git push')

def remote_deploy():
    with cd('/var/www/app'):
        run('git pull')
        run('systemctl reload nginx')

def full_deploy():
    execute(local_commit)
    execute(remote_deploy)

多伺服器角色定義 @roles

from fabric.api import env, roles, run, execute

env.roledefs = {
    'web': ['web1@10.0.0.1', 'web2@10.0.0.2'],
    'db':  ['db@10.0.0.10'],
}

@roles('web')
def update_web():
    run('git pull && systemctl reload nginx')

@roles('db')
def migrate_db():
    run('python manage.py migrate')

def deploy_all():
    execute(update_web)
    execute(migrate_db)

輸出顏色與除錯

from fabric.colors import green, red, yellow

def status():
    print(green("Success"))
    print(red("Failed"))
    print(yellow("Warning"))

錯誤處理策略

  • 預設:任一指令失敗 (非零退出碼) 即停止後續執行。
  • settings(warn_only=True):忽略失敗繼續執行,需自行檢查 result.failed。
  • 自訂例外處理:with settings(abort_exception=MyException):。

密碼管理最佳實務

  1. SSH Key 授權 (最推薦):本地 ssh-keygen,公鑰加入遠端 ~/.ssh/authorized_keys,免密碼登入。
  2. SSH Agent Forwarding:env.forward_agent = True,本地 Key 透過 SSH 轉發至遠端再連第三台。
  3. 環境變數/配置檔:密碼勿硬編碼,讀取 os.environ 或加密配置檔 (如 ansible-vault 風格)。
  4. 每台主機不同密碼:使用 env.passwords = {'host1': 'pwd1', 'host2': 'pwd2'} 字典對應。

Fabric 1.x vs 2.x 遷移提醒

  • 2.x 重寫為 invoke 為核心,API 不相容 (如 run → Connection.run)。
  • 舊專案維持 1.x 穩定;新專案建議直接學 2.x 或改用 invoke + paramiko。

Fabric 讓「手動 SSH 執行指令」變成「一鍵部署」,是運維自動化的利器。

copyright © 萬盛學電腦網 all rights reserved