專案輕量級部署神器:Fabric

劉志軍發表於2018-12-27

如果你搜一圈 "Fabric "關鍵字,你會發現 90% 的資料都是過時的,因為現在 Fabric 支援 Python3,但是它又不相容舊版 Fabric。所以,如果你按照那些教程去操作的話根本跑不通。而這篇文章是給使用Python3的同學準備的。

如果你還沒用過 Fabric,那麼這篇文章就是幫你快速上手 Fabric 的,不管你現在用不用,先了解了以後也用得著。

平時我們的開發流程是這樣,經過幾個月奮戰,專案終於開發完了,測試也沒問題了,我們就把程式碼提交到 GitHub 那樣的託管平臺,準備部署到正式環境。你小心翼翼地登入到正式伺服器,進入到專案目錄中,把程式碼從遠端倉庫拉下來,然後啟動程式。後面每次有新功能釋出或者哪怕只是修改了一個小小的 Bug 時,你都要執行重複的操作,登入伺服器,切換到指定目錄,拉取程式碼,重啟服務。

其實這種操作非常繁瑣,也沒什麼技術含量,還容易出問題,於是 Fabric 出場了。Fabric 是一個遠端部署神器,它可以在本地執行遠端伺服器的命令。

怎麼做?很簡單,就幾個步驟。

安裝 Fabric

$ pip install fabric --upgrade
複製程式碼

注意,如果你安裝的是舊版的 Fabric,那麼新版的 Fabric 是不相容舊版的,目前 Fabric 有三個版本,Fabric1 就是以前的 Fabric,只支援 Python2,已不推薦使用,而 Fabric2 就是現在的 Fabric,同時支援 Python2 和 Python3, 也是官方強烈推薦的版本, 還有一個 Fabric3,這是網友從舊版的 Fabric1 克隆過來的非官方版本,但是相容 Fabric1,也支援 Python2 和 Python3。

最新的 Fabric 不需要 fabfile.py 檔案, 也不需要 fab 命令,而現在網路上幾乎所有的教程、資料都還是基於 fabric1 寫的,當你在看那些教程的時候,注意甄別。 而新版 Fabric 提供的 API 非常簡單。

執行命令

先看個例子,下面是一段部署指令碼

# deploy.py
# 1.  建立一個遠端連線
# 2. 進入指定目錄
# 3. 在指定目錄下面執行重啟命令

from fabric import Connection

def main():
	# ip 我是隨便填的
	# 如果你的電腦配了ssh免密碼登入,就不需要 connect_kwargs 來指定密碼了。
    c = Connection("root@232.231.231.22", connect_kwargs={"password": "youpassword"})

    with c.cd('/var/www/youproject'):
        c.run("git pull origin master")
        c.run("/usr/bin/supervisorctl -c ../supervisor/supervisord.conf restart youproject")

if __name__ == '__main__':
    main()
複製程式碼

執行

python deploy.py
複製程式碼

執行完成後,最新程式碼就已經部署到正式環境並重啟了服務,是不是非常方便,媽媽再也不要擔心我在正式環境敲錯命令刪資料庫跑路了。

Fabric 不僅支援 Linux,而且在 Windows 平臺也能很好的執行,在中小型專案,它是非常不錯的運維工具,有了 Frabic ,管理上百臺伺服器都不成問題。

構建連線

class Connection(Context):
    host = None
    user = None
    port = None
    ssh_config = None
    connect_timeout = None
    connect_kwargs = None
    ...
複製程式碼

構建 Connection 物件的方式有不同的方式,例如你可以將 host 寫成 "root@192.168.101.1:22" ,也可以作為3個引數分開寫。而 connect_kwargs 是字典物件,通常填伺服器的登入密碼或者金鑰。

上傳檔案

run 方法用於執行命令,cd 進入指定目錄,put 方法用於上傳檔案, 例如:

from fabric import Connection
c = Connection('web1')
c.put('myfiles.tgz', '/opt/mydata')
c.run('tar -C /opt/mydata -xzvf /opt/mydata/myfiles.tgz')
複製程式碼

多臺伺服器

如果是要在多臺伺服器執行命令,簡單的辦法就是使用迭代,挨個伺服器執行命令:

# web1,web2,mac1 都是伺服器的名字,你也可以用ip代替
>>> from fabric import Connection
>>> for host in ('web1', 'web2', 'mac1'):
>>>     result = Connection(host).run('uname -s')
...     print("{}: {}".format(host, result.stdout.strip()))
...
web1: Linux
web2: Linux
mac1: Darwin
複製程式碼

或者使用 SerialGroup

from fabric import SerialGroup as Group
pool = Group('web1', 'web2', 'web3', connect_kwargs={"password": "youpassword"} )
pool.put('myfiles.tgz', '/opt/mydata')
pool.run('tar -C /opt/mydata -xzvf /opt/mydata/myfiles.tgz')
複製程式碼

Group(*hosts, **kwargs) 引數說明:

  • *hosts: 可以傳入多個主機名或IP
  • **kwargs 接收的引數可以和Connection一樣,可以指定密碼

你 get 了嗎? 獲取更多文章可關注公眾號 “Python之禪”

更多參考請點選官方文件: www.fabfile.org/

本文首發:foofish.net/fabric.html

相關文章