Fabric 是基于 SSH 協議的 Python 工具,相比傳統的 ssh/scp 方式,用 Python 的語法寫管理命令更易讀也更容易擴展,管理單臺或者多臺機器猶如本地操作一般。
官網地址:http://fabfile.org
安裝
省略python、pip管理工具安裝過程
1
|
pip install fabric |
驗證是否安裝成功
進入python編輯模式,輸入代碼,無錯即表示成功安裝
1
|
from fabric.api import local |
fabric版hello world
fabric 默認文件fabfile.py,當然如果不想用這個名字,需要加-f參數
創建fabfile.py文件
1
|
vim fabrile.py |
編輯代碼
1
2
3
4
5
|
#coding:utf-8 from fabric.api import local # def hello(): # local函數用來執行本地命令 local( 'echo "hello wolrd!"' ) |
執行代碼
1
|
fab hello |
可以通過fab -l查看可以執行的任務,當前為hello函數
運行結果
1
2
3
|
[localhost] local: echo "hello world!" hello world! Done. |
傳統維護方法:
1
|
$ ssh x.x.x.x 'uname -a' -- 輸出略 |
Fabric 示例:
1
|
$ cat fabfile.py |
1
2
3
|
from fabric.api import run def uname(): run( 'uname -a' ) |
1
|
$ fab -H x.x.x.x uname -- 輸出略 |
肉眼直觀看上去,貌似比 ssh 方式要寫不少代碼,但是基于 ssh 方式中間可控環節比較少,例如:你想判斷某服務是否已經啟動,沒有啟動則執行啟動等等操作。ssh 命令式的做法稍顯麻煩。(當然齷齪一點可以在被操作機器上寫好一個腳本,ssh 調用這個腳本)
說幾個 Fabric 的優點吧:
- 角色定義
- 代碼易讀
- 封裝了本地、遠程操作(還需要自己封裝system/popen/ssh操作么?)
- 參數靈活(動態指定 host/role 等,還有并發執行 基于multiprocessing )
- 完整的日志輸出
羅列的這些,其實日常工作里基本都有類似的封裝了,但是有現成的一個成熟的工具,干啥不用呢?對吧。
常用的配置:
- env.host -- 主機ip,當然也可以-H參數指定
- env.password -- 密碼,打好通道的請無視
- env.roledefs -- 角色分組,比如:{'web': ['x', 'y'], 'db': ['z']}
- fab -l -- 顯示可用的task(命令)
- fab -H -- 指定host,支持多host逗號分開
- fab -R -- 指定role,支持多個
- fab -P -- 并發數,默認是串行
- fab -w -- warn_only,默認是碰到異常直接abort退出
- fab -f -- 指定入口文件,fab默認入口文件是:fabfile/fabfile.py
更多請參考:fab --help
常用的函數:
- local('pwd') -- 執行本地命令
- lcd('/tmp') -- 切換本地目錄
- cd('/tmp') -- 切換遠程目錄
- run('uname -a') -- 執行遠程命令
- sudo('/etc/init.d/nginx start') -- 執行遠程sudo,注意pty選項
示例1:管理遠程 nginx 服務
1
|
$ cat fabfile.py |
1
2
3
4
5
6
7
8
9
10
|
from fabric.api import * @task def nginx_start(): ''' nginx start ''' sudo( '/etc/init.d/nginx start' ) @task def nginx_stop(): ''' nginx stop ''' sudo( '/etc/init.d/nginx stop' ) |
1
2
3
4
5
6
7
|
$ fab --list -- 查看可用命令 Available commands: nginx_start nginx start nginx_stop nginx stop $ fab -H x.x.x.x nginx_start -- 啟動 nginx |
示例2:基于角色
1
|
$ cat fabfile.py |
1
2
3
4
5
6
|
from fabric.api import * env.roledefs = { 'nginx' : [ 'x.x.x.x' , 'y.y.y.y' ], 'mysql' : 'z.z.z.z' } @task def mysql_start() ''' mysql start ''' sudo( '/etc/init.d/mysql start' ) |
1
2
3
4
5
6
7
8
9
|
$ fab --list -- 查看可用命令 Available commands: nginx_start nginx start nginx_stop nginx stop mysql_start mysql start $ fab -R nginx nginx_start -- 啟動 nginx $ fab -R mysql mysql_start -- 啟動 mysql |
示例3:混合本地和遠程操作
1
|
$ cat fabfile |
1
2
3
4
5
6
7
8
|
def hello(): ''' test hello ''' with lcd( '/tmp' ): # 切換到 /tmp 目錄下 local( 'svn co http://xxx xxx' ) # check 代碼到本地 local( 'tar czf xxx.tar.gz xxx/' ) # 壓縮本地包 put( 'xxx.tar.gz' , '/tmp' ) # 上傳壓縮包到遠程 /tmp 目錄下 with cd( '/tmp' ): # 切換到遠程 /tmp 目錄 run( 'tar zxf xxx.tar.gz' ) # 遠程解壓 |
是不是看上去都是像本地一樣?對吧。
示例4:多個目標服務器
相同密碼或者手動輸入:
1
|
env.hosts = [ 'root@ip1:22' ,root@ip2: 22 ] |
不同密碼或者不想手動輸入(此方法也可定義不角色一組服務器):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
#coding:utf-8 from fabric.api import local,cd,put,lcd,env,run,execute,roles env.roledefs = { 'role1' :[ 'root@ip1:22' ,], 'role2' :[ 'root@ip2:22' ,] } env.passwords = { 'root@ip1:22' : 'pwd1' , 'root@ip2:22' : 'pwd2' } @roles ( 'role1' ) def role1(): with cd( '/tmp' ): run( 'ls -l' ) @roles ( 'role2' ) def role2(): with cd( '/tmp' ): run( 'ls' ) def task(): execute(role1) execute(role2) |