簡介:Fabric是基於Python實現的SSH命令行工具，簡化了SSH的應用程序部署及系統管理任務，它提供了系統基礎的操作組件，可以實現本地或遠程shell命令，包括：命令執行、文件上傳、下載及完整執行日志輸出等功能。Fabric在Paramiko的基礎上做了更高一層的封裝，操作起來會更加簡單。
參考資料：
劉天斯《Python自動化運維技術與最佳實踐》 PDF下載見 http://www.linuxidc.com/Linux/2016-10/136025.htm
一、安裝Fabric
使用pip install Fabric來安裝,安裝需要paramiko包和Crypto包
驗證是否安裝成功，出現如下圖所示，說明fabric模塊安裝成功
命令說明
1.格式
fab [options] <command>[:arg1,arg2=val2,host=foo,hosts='h1;h2',...] ...
2. 常用參數
-l #顯示定義好的任務函數名
-f #指定fab入口文件，默認入口文件名為fabfile.py
-f #指定網關（中轉）設備，比如堡壘機環境，填寫堡壘機IP即可
-H #指定目標主機，多台主機用‘,’號分隔
-p #遠程賬號的密碼，fab執行時默認使用root賬戶
-P #以異步並行方式運行多主機任務，默認為串行運行
-R #指定role（角色），以角色名區分不同業務組設備
-t #設置設備連接超時時間（秒）
-T #設置遠程主機命令執行超時時間（秒）
-w #當命令執行失敗，發出警告，而非默認中止任務。
示例
編寫一個fabfile.py文件
vim fabfile.py
#!/usr/bin/env python
# -*- coding:utf-8 -*-
from fabric.api import run
#定義一個任務函數，通過run方法實現遠程執行‘uname -s’命令
def host_type():
run('uname -s')
fab命令操作：
fab -H localhost host_type
#結果：
[localhost] Executing task 'host_type'
[localhost] run: uname -s
[localhost] Login password for 'root':
[localhost] out: Linux
[localhost] out:
Done.
Disconnecting from localhost... done.
上面實例也可以寫成一行代碼：
fab -p 123456 -H localhost -- 'uname -s' #--後面要加空格
fabfile文件的編寫
fab命令是結合fabfile.py文件（其他文件通過-f filename 參數來引用）來搭配使用的。fab的部分命令行參數還能通過相應的方法來代替。
如：
fab -H 192.168.1.21,192.168.1.22 ... ...
#可以在fabfile.py文件中用env.hosts來實現，命令行中就可以不用寫了
#可以在fabfile中這麼寫：
env.hosts = ['192.168.1.21','192.168.1.22']
fabfile之env對象
env對象的作用是定義fabfile的全局設定，就像上面的舉例。下面對各屬性進行說明：
env.hosts #定義目標主機，可以用IP或主機名表示，以python的列表形式定義。如env.hosts=['192.168.1.21','192.168.1.22']
env.exclude_hosts #排除指定主機，如env.exclude_hosts=['192.168.1.21']
env.user #定義用戶名，如env.user='root'
env.port #定義端口，默認為22，如env.port='22'
env.password #定義密碼，如env.password='123456'
env.passwords #定義多個密碼，不同主機對應不同密碼，如：env.passwords = {'[email protected]:22':'123456','[email protected]:22':'654321'}
env.gateway #定義網關（中轉、堡壘機）IP，如env.gateway='192.168.1.23
env.roledefs #定義角色分組，比如web組合db組主機區分開來：env.roledefs = {'webserver':['192.168.1.21','192.168.1.22'],'dbserver':['192.168.1.25','192.168.1.26']}
env.deploy_release_dir #自定義全局變量，格式：env. + '變量名稱'，如env.age,env.sex等
env.roledefs的使用方法實例：
env.roledefs = {'webserver':['192.168.1.21','192.168.1.22'],'dbserver':['192.168.1.25','192.168.1.26']}
#引用分組時使用python裝飾器方式來進行,如：
@roles('webserver')
def webtask():
run('/usr/local/nginx/sbin/nginx')
@roles('webserver','dbserver')
def publictask():
run('uptime')
Fabric常用API
最上面的簡單實例中使用了api函數run,下面再列舉幾個常用的api。
local #執行本地命令，如local('uname -s')
lcd #切換本地目錄，如lcd('/home')
cd #切換遠程目錄
run #執行遠程命令
sudo #sudo方式執行遠程命令，如sudo('/etc/init.d/httpd start')
put #上次本地文件導遠程主機，如put('/home/user.info','/data/user.info')
get #從遠程主機下載文件到本地，如：get('/data/user.info','/home/user.info')
prompt #獲得用戶輸入信息，如：prompt('please input user password:')
confirm #獲得提示信息確認，如：confirm('Test failed,Continue[Y/N]?')
reboot #重啟遠程主機，如：reboot()
@task #函數修飾符，標識的函數為fab可調用的，非標記對fab不可見，純業務邏輯
@runs_once #函數修飾符，標識的函數只會執行一次，不受多台主機影響
Fabric應用示例說明
1、查看本地與遠程主機信息
本示例調用local方法執行本地命令，添加@runs_once修飾符保證任務函數只執行一次，調用run方法執行遠程命令。
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from fabric.api import *
env.user = 'root'
env.hosts = ['192.168.1.22']
env.password = '123456'
@runs_once #查看本地系統信息，當有多台主機時只運行一次
def local_task(): #本地任務函數
local('uname -a')
def remote_task():
with cd('/var/logs'): #with的作用是讓後面的表達式語句繼承當前狀態，實現：cd /var/logs && ls -l的效果
run('ls -l')
執行：
fab -f simple1.py local_task
fab -f simple1.py remote_task
2、動態獲取遠程目錄列表
本例調用@task修飾符標志入口函數go()對外部可見，配合@runs_once修飾符接收用戶輸入，最後調用worktask()函數實現遠程命令執行。
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from fabric.api import *
env.user = 'root'
env.hosts = ['192.168.1.22']
env.password = '123456'
@runs_once #主機遍歷過程中，只有第一台觸發此函數
def input_raw():
return prompt('please input directoryname:',default='/root')
def worktask(dirname):
run('ls -l'+dirname)
@task #限定只有go函數對fab命令可見,其他沒有使用@task標記的函數fab命令不可用
def go():
getdirname = input_raw()
worktask(getdirname)
執行:
1
fab -f simple2.py go
對於上面的結果做了一些測試發現:
1.設置了默認值,不輸入就是以默認值為准,如果不設置默認值,那麼dirname就是空的,ls -l的就是你登錄用戶的家目錄,例如是root就是/root
2.對於寫在go函數下的內容,有多少主機就會循環多少次,他是以主機為循環的.
3.這個腳本是對於所有的主機列出同一個目錄,對於不同的主機讓選擇不同的目錄,可以簡單的修改為:
def worktask(dirname):
run('ls -l '+dirname)
@task
def go():
getdirname=raw_input("please input directory:")
worktask(getdirname)
3.文件打包上傳校驗
#!/usr/bin/env python
from fabric.api import *
from fabric.colors import *
env.hosts=['192.168.56.30']
env.user='root'
env.passwords={'[email protected]:22':'rooter'}
@runs_once
@task
def tarfile():
print yellow('tar file ...')
#使用with lcd命令,否則需要寫全路徑,直接lcd沒用
with lcd('/var/log'):
local('tar czf messages.tar.gz messages')
@task
def putfile():
print blue('put file ...')
run('mkdir -p /tmp/log')
with cd('/tmp/log'):
#warn_only當出現異常的時候繼續執行
with settings(warn_only=True):
result=put('/var/log/messages.tar.gz','/tmp/log')
if result.failed and not confirm('put file filed,Continue[Y/N]?'):
abort('Aborting file put task!')
@task
def checkfile():
print red('check file ...')
with settings(warn_only=True):
#本地local命令需要配置capture=True才能獲取返回值
lmd5=local('md5sum /var/log/messages.tar.gz',capture=True).split(' ')[0]
rmd5=run('md5sum /tmp/log/messages.tar.gz').split(' ')[0]
if lmd5==rmd5:
print 'ok'
else:
print 'error'
@task
def go():
tarfile()
putfile()
checkfile()
下面是運行結果，有顏色的區別:
[192.168.56.30] Executing task 'go'
<span >tar file ...</span>
[localhost] local: tar czf messages.tar.gz messages
<span >put file ..</span>.
[192.168.56.30] run: mkdir -p /tmp/log
[192.168.56.30] put: /var/log/messages.tar.gz -> /tmp/log/messages.tar.gz
check file ...
[localhost] local: md5sum /var/log/messages.tar.gz
[192.168.56.30] run: md5sum /tmp/log/messages.tar.gz
[192.168.56.30] out: 958b813fd7bdaa61cc206aa1012d8129 /tmp/log/messages.tar.gz
[192.168.56.30] out:
ok
Done.
Disconnecting from 192.168.56.30... done
4、網關模式文件上傳與執行
本例通過定義env.gateway網關模式，即俗稱的中轉、堡壘機環境。通過網關對其他主機進行文件上傳和執行。
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from fabric.api import *
from fabric.context_managers import *
from fabric.contrib.console import confirm
env.user = 'root'
env.gateway = '192.168.1.23' #定義堡壘機IP，作為文件上傳、執行的中轉設置
env.hosts = ['192.168.1.21','192.168.1.22']
env.passwords = {
'[email protected]:22':'123456',
'[email protected]:22':'abcdef',
'[email protected]:22':'123abc', #堡壘機賬號信息
}
lpackpath = '/home/install/lnmp.tar.gz' #本地安裝包路徑
rpackpath = '/tmp/install' #遠程安裝包路徑
@task
def put_task(): #上傳文件
run('mkdir -p /tmp/install')
#默認情況下，當命令執行失敗時，Fabric會停止執行後續命令。有時，我們允許忽略失敗的命令繼續執行，比如run(‘rm /tmp/abc')在文件不存在的時候有可能失敗，這時可以用with settings(warn_only=True):執行命令，這樣Fabric只會打出警告信息而不會中斷執行。
with settings(warn_only=True):
result = put(lpackpath,rpackpath) #上傳
if result.failed and not confirm('put file failed,Continue[Y/N]?'):
abort('Aborting file put task!')
@task
def run_task(): #安裝
with cd('/tmp/install'):
run('tar -zxvf lnmp.tar.gz')
with cd('lnmp/'): #使用with繼承/tmp/install目錄位置狀態
run('./CentOS.sh')
@task
def go(): #上傳、安裝組合命令
put_task()
run_task()
simple3.py
simple3.py
執行:
#上傳文件
fab simple3.py put_task
#執行文件
fab simple3.py run_task
#上傳並執行
fab simple3.py go
---------------------------------------------------------------
