python使用Fabric模塊實現自動化運維

示例

 

編寫一個fabfile.py文件html

vim fabfile.pypython

複製代碼
#!/usr/bin/env python
# -*- coding:utf-8 -*-

from fabric.api import run

#定義一個任務函數,經過run方法實現遠程執行‘uname -s’命令
def host_type():   
        run('uname -s')
複製代碼

 

fab命令操做:mysql

 
複製代碼
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.
複製代碼

 

上面實例也能夠寫成一行代碼:nginx

1
fab -p 123456 -H localhost  --   'uname -s'    #--後面要加空格

fabfile文件的編寫

fab命令是結合fabfile.py文件(其餘文件經過-f filename 參數來引用)來搭配使用的。fab的部分命令行參數還能經過相應的方法來代替。web

如:redis

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的全局設定,就像上面的舉例。下面對各屬性進行說明:sql

複製代碼
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 = {'root@192.168.1.21:22':'123456','root@192.168.1.22: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的使用方法實例:vim

複製代碼
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。centos

複製代碼
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應用示例說明 

一、查看本地與遠程主機信息

本示例調用local方法執行本地命令,添加@runs_once修飾符保證任務函數只執行一次,調用run方法執行遠程命令。api

 1 #!/usr/bin/env python
 2 # -*- encoding: utf-8 -*-
 3 
 4 from fabric.api import *
 5 
 6 env.user = 'root'
 7 env.hosts = ['192.168.1.22']  8 env.password = '123456'
 9 
10 @runs_once   #查看本地系統信息,當有多臺主機時只運行一次
11 def local_task():   #本地任務函數
12     local('uname -a') 13     
14 def remote_task(): 15     with cd('/var/logs'):   #with的做用是讓後面的表達式語句繼承當前狀態,實現:cd /var/logs && ls -l的效果
16         run('ls -l')
simple1.py

 

執行:

1
2
fab -f simple1.py local_task
fab -f simple1.py remote_task

二、動態獲取遠程目錄列表

本例調用@task修飾符標誌入口函數go()對外部可見,配合@runs_once修飾符接收用戶輸入,最後調用worktask()函數實現遠程命令執行。

 1 #!/usr/bin/env python
 2 # -*- encoding: utf-8 -*-
 3 
 4 from fabric.api import *
 5 
 6 env.user = 'root'
 7 env.hosts = ['192.168.1.22']  8 env.password = '123456'
 9 
10 @runs_once   #主機遍歷過程當中,只有第一臺觸發此函數
11 def input_raw(): 12     return prompt('please input directoryname:',default='/root') 13 
14 def worktask(dirname): 15     run('ls -l'+dirname) 16 
17 @task    #限定只有go函數對fab命令可見,其餘沒有使用@task標記的函數fab命令不可用
18 def go(): 19     getdirname = input_raw() 20     worktask(getdirname)
simple2.py

 

執行:

1
fab  - f simple2.py go

對於上面的結果作了一些測試發現:

1.設置了默認值,不輸入就是以默認值爲準,若是不設置默認值,那麼dirname就是空的,ls -l的就是你登陸用戶的家目錄,例如是root就是/root

2.對於寫在go函數下的內容,有多少主機就會循環多少次,他是以主機爲循環的.

3.這個腳本是對於全部的主機列出同一個目錄,對於不一樣的主機讓選擇不一樣的目錄,能夠簡單的修改成:

1
2
3
4
5
6
7
def  worktask(dirname):
         run( 'ls -l ' + dirname)
  
@task
def  go():
         getdirname = raw_input ( "please input directory:" )
         worktask(getdirname)

 

3.文件打包上傳校驗

 1 #!/usr/bin/env python
 2 from fabric.api import *
 3 from fabric.colors import *
 4  
 5 env.hosts=['192.168.56.30']  6 env.user='root'
 7 env.passwords={'root@192.168.56.30:22':'rooter'}  8  
 9 @runs_once 10 @task 11 def tarfile(): 12     print yellow('tar file ...') 13 #使用with lcd命令,不然須要寫全路徑,直接lcd沒用
14     with lcd('/var/log'): 15         local('tar czf messages.tar.gz messages') 16  
17 @task 18 def putfile(): 19     print blue('put file ...') 20     run('mkdir -p /tmp/log') 21     with cd('/tmp/log'): 22 #warn_only當出現異常的時候繼續執行
23         with settings(warn_only=True): 24             result=put('/var/log/messages.tar.gz','/tmp/log') 25         if result.failed and not confirm('put file filed,Continue[Y/N]?'): 26             abort('Aborting file put task!') 27  
28 @task 29 def checkfile(): 30     print red('check file ...') 31     with settings(warn_only=True): 32 #本地local命令須要配置capture=True才能獲取返回值
33         lmd5=local('md5sum /var/log/messages.tar.gz',capture=True).split(' ')[0] 34         rmd5=run('md5sum /tmp/log/messages.tar.gz').split(' ')[0] 35     if lmd5==rmd5: 36         print 'ok'
37     else: 38         print 'error'
39  
40 @task 41 def go(): 42  tarfile() 43  putfile() 44     checkfile()
simple3.py

 

 

下面是運行結果,有顏色的區別:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[ 192.168 . 56.30 ] Executing task  'go'
tar  file  ...
[localhost] local: tar czf messages.tar.gz messages
put  file  ...
[ 192.168 . 56.30 ] run: mkdir  - / 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

  

四、網關模式文件上傳與執行

 本例經過定義env.gateway網關模式,即俗稱的中轉、堡壘機環境。經過網關對其餘主機進行文件上傳和執行。

 1 #!/usr/bin/env python
 2 # -*- encoding: utf-8 -*-
 3 
 4 from fabric.api import *
 5 from fabric.context_managers import *
 6 from fabric.contrib.console import confirm  7 
 8 env.user = 'root'
 9 env.gateway = '192.168.1.23'   #定義堡壘機IP,做爲文件上傳、執行的中轉設置
10 env.hosts = ['192.168.1.21','192.168.1.22'] 11 env.passwords = { 12     'root@192.168.1.21:22':'123456', 13     'root@192.168.1.22:22':'abcdef', 14     'root@192.168.1.23:22':'123abc',  #堡壘機帳號信息
15 } 16 
17 lpackpath = '/home/install/lnmp.tar.gz'   #本地安裝包路徑
18 rpackpath = '/tmp/install'    #遠程安裝包路徑
19 
20 
21 @task 22 def put_task():  #上傳文件
23     run('mkdir -p /tmp/install') 24     #默認狀況下,當命令執行失敗時,Fabric會中止執行後續命令。有時,咱們容許忽略失敗的命令繼續執行,好比run(‘rm /tmp/abc')在文件不存在的時候有可能失敗,這時能夠用with settings(warn_only=True):執行命令,這樣Fabric只會打出警告信息而不會中斷執行。
25     with settings(warn_only=True): 26         result = put(lpackpath,rpackpath)   #上傳
27     if result.failed and not confirm('put file failed,Continue[Y/N]?'): 28         abort('Aborting file put task!') 29 
30 @task 31 def run_task():   #安裝
32     with cd('/tmp/install'): 33         run('tar -zxvf lnmp.tar.gz') 34         with cd('lnmp/'):    #使用with繼承/tmp/install目錄位置狀態
35             run('./centos.sh') 36 
37 
38 @task 39 def go():   #上傳、安裝組合命令
40  put_task() 41     run_task()
simple3.py

 

執行:

1
2
3
4
5
6
#上傳文件
fab simple3.py put_task
#執行文件
fab simple3.py run_task
#上傳並執行
fab simple3.py go

 

執行模式

  • 執行模式可讓你在多個主機上執行多個任務。

執行策略:

  • 默認fabric是單個有序地執行方法,其行爲以下:

      1. 建立一系列任務,經過fab任務執行要執行的任務;

      2. 根據主機列表定義,去執行每個任務;

      3. 沒有主機定義的任務,將在本地執行一次。

如:

複製代碼
from fabric.api import run, env

env.hosts = ['host1', 'host2']

def taskA():
    run('ls')

def taskB():
    run('whoami')

# 將在host1, host2都執行taskA, taskB
$ fab taskA taskB 

# 執行順序以下
taskA executed on host1
taskA executed on host2
taskB executed on host1
taskB executed on host2
複製代碼

定義任務:

  • 如何定義任務,詳情可見這裏

定義主機列表:

  • 大多數時候你都須要根據目標,來定義多個遠程主機,而不是僅在本地。

主機:

  • python定義的主機字符串爲:
username@hostname:port #用戶名和端口均可以省略
  • 主機定義也支持IPV6格式,如:
::1, [::1]:1222
user@2001:db8::1 
user@[2001:db8::1]:1222

角色:

  • 角色提供了能夠定義一個字符串對應於一組主機列表,而不是每次都針對的是整個主機列表,如:
複製代碼
from fabric.api import env
#假如www1, www2, www3是你的web服務器, 你能夠指定任務由特定的角色來執行
env.roledefs['webservers'] = ['www1', 'www2', 'www3']

# 定義多個角色
env.roledefs = {
    'web': ['www1', 'www2', 'www3'],
    'dns': ['ns1', 'ns2']
}
複製代碼

怎麼構建hosts:

  • 經過全局的env:
from fabric.api import env, run

env.hosts = ['host1', 'host2']

def mytask():
    run('ls /var/www')
  • env配置會被每一個任務檢查,所以你徹底能夠在方法中設置env,如:
複製代碼
from fabric.api import env, run

def set_hosts():
    env.hosts = ['host1', 'host2']

def mytask():
    run('ls /var/www')

# 調用
fab set_hosts mytask, set_hosts
複製代碼
  • 經過命令行參數指定:
$ fab -H host1,host2 mytask #會被env.hosts所重寫,相似角色也能夠經過-R role1, role2, ...來定義
  • 你也能夠擴展命令行定義的主機,如:
複製代碼
from fabric.api import env, run

env.hosts.extend(['host3', 'host4'])

def mytask():
    run('ls /var/www')

# 那麼執行主機將merge爲host1,host2,host3,host4
fab -H host1, host2 mytask
複製代碼
1
<span style = "font-family: verdana, Arial, Helvetica, sans-serif; font-size: 14px; line-height: 1.5;" >NOTE: env.hosts是python的 list 對象,因此你能夠用 list .append()方法添加host,或者其餘方法。< / span>
  • 針對每一個任務的命令行參數:這是fabric提供一種更細粒度的定製:
複製代碼
from fabric.api import run

def mytask():
    run('ls /var/www')

# 該定義將重寫其餘任何hosts定義,mytask僅會在host1,host2上執行
fab mytask:hosts="host1;host2"
複製代碼
  • 針對每一個任務進行修飾:
複製代碼
from fabric.api import hosts, run

@hosts('host1', 'host2')
def mytask():
    run('ls /var/www')

# 或者
my_hosts = ('host1', 'host2')
@hosts(my_hosts)
def mytask():
    # ...

# 這種修飾將重寫env.hosts設置, 但不會重寫上面經過命令行定義的任務。
複製代碼
  • 總結下上面這些host與task綁定定義的優先級:
# 由高到低
1. 命令行 fab mytask:host=host1
2. fabfile中修飾任務@hosts('host1')
3. 在fabfile中設置env.hosts = ['host1']
4. 在命令行中-H host1,host2,...
  • 主機列表組合
複製代碼
from fabric.api import env, hosts, roles, run

env.roledefs = {'role1': ['b', 'c']}

@hosts('a', 'b')
@roles('role1')
def mytask():
    run('ls /var/www')

# 若命令行不包含task定義,則上面的mytask家在a, b, c主機上執行
複製代碼
  • 排除特定的主機
# 若myrole被定義運行[host1, host2,...,host15], 則該命令將排除host2,host5
$ fab -R myrole -x host2,host5 mytask #該-x並不會修改env.hosts

 

用Execute智能地執行任務:

  • 看這麼一個例子:
複製代碼
from fabric.api import run, roles

env.roledefs = {
    'db': ['db1', 'db2'],
    'web': ['web1', 'web2', 'web3'],
}

@roles('db')
def migrate():
    # Database stuff here.
    pass

@roles('web')
def update():
    # Code updates here.
    pass

# 在fabric1.2以前,咱們須要fab migrate update來執行這兩個任務,
# 在fabric1.2以後,咱們能夠經過execute函數來執行這兩個任務:

from fabric.api import run, roles, execute

def deploy():
    execute(migrate)
    execute(update)
複製代碼

 

經過Execute訪問多主機的結果:

  • 一個範例
複製代碼
from fabric.api import env, roles, task, execute, run, runs_once

env.roledefs = {
    'zoo': ['zooserver'],
    'mysql': ['mysqlmaster'],
}

@task
def workhorse():
    return run("uname -a")

@roles('zoo')
@task
@runs_once
def go():
    results = execute(workhorse)
    print results

#執行
fab go
複製代碼

 

用Execute動態設置host列表:

  • 咱們能夠經過傳遞參數,動態設置hosts,如:
複製代碼
from fabric.api import run, execute, task

# For example, code talking to an HTTP API, or a database, or ...
from mylib import external_datastore

# This is the actual algorithm involved. It does not care about host
# lists at all.
def do_work():
    run("something interesting on a host")

# This is the user-facing task invoked on the command line.
@task
def deploy(lookup_param):
    # This is the magic you don't get with @hosts or @roles.
    # Even lazy-loading roles require you to declare available roles
    # beforehand. Here, the sky is the limit.
    host_list = external_datastore.query(lookup_param)
    # Put this dynamically generated host list together with the work to be
    # done.
    execute(do_work, hosts=host_list)

# 調用
fab deploy:app
fab deploy:other
複製代碼
  • 一個替代的方法:
複製代碼
from fabric.api import run, task

from mylib import external_datastore

# Marked as a publicly visible task, but otherwise unchanged: still just
# "do the work, let somebody else worry about what hosts to run on".
@task
def do_work():
    run("something interesting on a host")

@task
def set_hosts(lookup_param):
    # Update env.hosts instead of calling execute()
    env.hosts = external_datastore.query(lookup_param)

#調用
fab set_hosts:app do_work

#相比上一種方法,該方法能夠輕易替換其餘任務,如
fab set_hosts:db snapshot
fab set_hosts:cassandra,cluster2 repair_ring
fab set_hosts:redis,environ=prod status
複製代碼

故障處理:

  • 故障處理也是一個比較實用的東西,fabric默認是"快速失敗"的,一旦出現錯誤,就當即中止。
  • 咱們能夠經過settings上下文中的env.warn_only=True來臨時指定,失敗也繼續執行。

鏈接:

  • fab自己是不對任何主機作遠程鏈接的,她只會設置env.host_string的值(即當前的host)。
  • NOTE: 鏈接對象Connection會保存在fabric.state.connections中,並作緩存,以減小建立新鏈接的消耗。

懶鏈接:

  • fab在執行遠程操做前,並不會事先去鏈接遠程主機,如:
複製代碼
from fabric.api import *

@hosts('host1')
def clean_and_upload():
    local('find assets/ -name "*.DS_Store" -exec rm '{}' \;')
    local('tar czf /tmp/assets.tgz assets/')
    put('/tmp/assets.tgz', '/tmp/assets.tgz') //這裏纔會開始進行遠程鏈接相關的操做:cache.get() == null?new : cache.get()
    with cd('/var/www/myapp/'):
        run('tar xzf /tmp/assets.tgz')
複製代碼

關閉鏈接:

  • 鏈接緩存並不會關閉鏈接。fab工具會幫你管理鏈接,它會遍歷全部鏈接,並在其退出前關閉鏈接。你也能夠調用fabric.network.disconnect_all()來確保關閉全部鏈接。

屢次鏈接嘗試和跳過錯誤的主機:

密碼管理:

  • Fabric在內存中維護了兩層的密碼緩存管理,會記住你登陸的密碼和sudo時的密碼,以避免之後再次輸入。
  • 第一層密碼由 env.password保存,其值爲ssh默認密碼或sudo提示輸入密碼。第二層密碼保存在env.passwords中,主要用於緩存user/host/port:password。
  • Fabric仍是建議使用密鑰進行ssh訪問,如無密登陸。

使用本地的SSH配置文件:

  • 你能夠爲Fabric指定特定的ssh配置文件(--ssh-config-path/env.ssh_config_path.),但默認Fabric並無開啓加載配置文件,須要設置env.use_ssh_config爲True。
  • 若開啓了Fabric加載配置文件的選項,則Fabric爲使用如下一些配置項:

      User/Port ,HostName, IdentityFile, ForwardAgent, ProxyCommand。

 

 

 

1. Fabric的任務運行規則

根據Fabric Execution model的說明,fabric默認以串行方式運行tasks,具體而言: 
1)在fabfile及其import文件中定義的task對象依次被建立(只是建立對象,並未真正執行),任務之間保持其定義的前後順序。 
2)對於每一個task,生成將要運行該task的目標機器列表。 
3)fab執行tasks時,按任務被指定的順序依次執行這些任務;針對每一個任務,依次在其指定的目標機器運行且只運行一次。 
4)未指定目標機器的task被看成本地任務運行,且只會被運行一次。

假設在fabfile.py中定義了以下tasks:

from fabric.api import run, envenv.hosts = ['host1', 'host2']def taskA(): run('ls')def taskB(): run('whoami')

在終端運行fab –list時,咱們會看到taskA和taskB兩個任務,運行之:

$ fab taskA taskB

結果示例以下:

taskA executed on host1taskA executed on host2taskB executed on host1taskB executed on host2

經過上面的實例,你們應該能夠明白fabric默認的串行執行策略是怎麼回事。

Fabric還容許咱們指定以並行方式(藉助multiprocessing模塊實現多個進程並行執行)在多臺機器上並行地運行任務,甚至還可在同一個fabfile文件中指定某些task以並行方式運行,而某些task以默認的串行方式運行。具體地,能夠藉助@parallel或@serial指定任務的運行模式,還能夠在命令行中經過-P參數指定任務是否要並性執行。示例以下:

from fabric.api import *@paralleldef runs_in_parallel(): passdef runs_serially(): pass

當運行以下命令時:

$ fab -H host1,host2,host3 runs_in_parallel runs_serially

執行結果示例以下:

runs_in_parallel on host1, host2, and host3runs_serially on host1runs_serially on host2runs_serially on host3

此外,還能夠經過對@parallel傳入pool_size參數來控制並行進程數以防並行進程太多把機器拖垮。

2. 爲task指定目標機器

有多種方式能夠指定任務的將要運行的目標機器,下面分別進行說明。 
1)經過env.hosts或env.roles進行全局指定 
Fabric的env模塊中定義了一系列全局變量,能夠將其理解爲能夠控制fabric行爲的環境變量。其中env.hosts和env.roles能夠用來全局指定task的目標機器列表,這兩個「環境變量」的默認值都是空列表[]。

env.hosts的元素是fabric約定的」host strings」,每一個host strings由aliyunzixun@xxx.com:port三部分構成,其中username和port部分能夠缺省。本篇筆記前面的第1個代碼實例其實已經說明了如何用env.hosts全局地指定task的目標機器列表,這裏再也不贅述。

env.roles則是在配置了env.roledefs的狀況下才有用武之地。在不少時候,不一樣的機器有着不一樣的角色,若有些是接入層,有些是業務層,有些是數據存儲層。env.roledefs能夠用來組織這些機器列表以體現其角色,示例以下:

from fabric.api import envenv.roledefs = { 'web': { 'hosts': ['www1', 'www2', 'www3'], }, 'db': { 'hosts': ['db1', 'db2'], }}@roles('web')def mytask(): run('ls /var/www')

上例經過env.roledefs配置了兩個角色web和db,分別包含3臺、2臺機器,並藉助@roles爲mytask指定了目標機器列表。

2)經過命令行進行全局指定

$ fab -H host1,host2 mytask

須要注意的是,命令行經過-H參數指定的機器列表在fabfile腳本load前被解釋,故若是fabfile中從新配置了env.hosts或env.roles,則命令行指定的機器列表會被覆蓋。爲了不fabfile覆蓋命令行參數,在fabfile中應該藉助list.extend()指定env.hosts或env.roles,示例以下:

from fabric.api import env, runenv.hosts.extend(['host3', 'host4'])def mytask(): run('ls /var/www')

此時,當咱們運行」fab -H host1,host2 mytask」時,env.hosts包含來自命令行和fabfile的4臺機器。

3)經過命令行爲每一個任務指定機器列表

$ fab mytask:hosts="host1;host2"

上述方式會覆蓋全局指定的機器列表,確保mytask只會在host1, host2上執行。

4)藉助裝飾器@hosts爲每一個任務指定目標機器

from fabric.api import hosts, run@hosts('host1', 'host2')def mytask(): run('ls /var/www')

或者:

my_hosts = ('host1', 'host2')@hosts(my_hosts)def mytask(): # ...

每一個任務的@hosts裝飾器指定的機器列表會覆蓋全局目標機器列表,但不會覆蓋經過命令行爲該任務單獨指定的目標機器列表

上述4種爲task指定目標機器列表的方式之間的優先級規則總結以下: 
1) Per-task, command-line host lists (fab mytask:host=host1) override absolutely everything else. 
2) Per-task, decorator-specified host lists (@hosts(‘host1’)) override the env variables. 
3) Globally specified host lists set in the fabfile (env.hosts = [‘host1’]) can override such lists set on the command-line, but only if you’re not careful (or want them to.) 
4) Globally specified host lists set on the command-line (–hosts=host1) will initialize the env variables, but that’s it.

截止目前,咱們能夠看到,fabric容許咱們混合使用上面列出的幾種目標機器指定方式,可是咱們要明白混合的結果是否符合預期。

此外,fabric默認會對經過不一樣來源出現屢次的同一個目標機器作去重,固然,能夠經過設置env.dedupe_hosts爲False來關閉默認的去重策略。甚至還能夠指定任務須要跳過的機器列表。具體細節能夠參考Fabric Execution model的說明,這裏不贅述。

3. 任務執行時,目標機器的密碼管理

若是你親自運行上面的示例代碼,就會發現,每次在目標機器遠程執行task時,fabric均會要求輸入目標機器的登陸名及密碼。若是要在多臺機器上執行task,那這些密碼輸入的過程能夠自動化嗎?

答案是確定的。實現方式有兩種,下面分別進行說明。

1)經過env.password或env.passwords配置目標機器的登陸信息 
下面的示例說明了如何經過env.passwords配置多臺機器的登陸信息:

#!/bin/env python#-*- encoding: utf-8 -*-from fabric.api import run, env, hosts## 須要注意的是,這裏的host strings必須由aliyunzixun@xxx.com:port三部分構成,缺一不可,不然運行時仍是會要求輸入密碼env.passwords = { 'aliyunzixun@xxx.com:22': 'xxx', 'aliyunzixun@xxx.com:23': 'yyy',}@hosts('10.123.11.209', '10.123.11.210')def host_os_type(): run('uname -a')

因爲經過env.passwords配置了目標機器的登陸用戶名/密碼,因此,當咱們在終端運行fab host_os_type時,會發現不用手動輸入密碼了,大大方便了腳本遠程自動執行。

可是,這種明文指定登陸名/密碼的方式存在安全性問題,因此,fabric還支持以ssh key認證的方式免密在遠程機器執行任務

在具體實現上,須要事先在目標機器上生成ssh public key並配置在~/.ssh/config文件中,而後在定義任務的fabfile中將env.use_ssh_config設置爲True來啓用基於ssh public key方式的身份認證,以便實現免密碼遠程執行任務

 

 

1、fab的經常使用參數
fab做爲Fabric程序的命令入口,提供了豐富的參數調用,命令格式以下:
fab [options] <command>[:arg1,arg2=val2,host=foo,hosts='h1;h2',....]
下面列舉了經常使用的幾個參數,更多參數可以使用fab -help查看.
-l,顯示定義好的任務函數名;
-f,指定fab入口文件,默認入口文件名爲fabfile.py;
-g,指定網關設備,好比堡壘機環境,填寫堡壘機IP便可;
-H,指定目標主機,多臺主機用','號分隔;
-P,以異步並行方式運行多個主機任務,默認爲串行運行;
-R,指定role(角色),以角色名區分不一樣業務組設備;
-t,設置設備鏈接超時時間;
-T,設置遠程主機命令執行超時時間;
-w,當命令執行失敗,發出警告,而非默認終止任務
2、fabfile的編寫
fab命令是結合咱們編寫的fabfile.py(其餘文件名必須添加-f filename引用)來搭配使用,部分命令行參數能夠經過相應的方法來代替,使之更加靈活,列如"-H 192.168.1.23,192.168.1.24",咱們能夠經過定義env.hosts來實現,如"env.hosts=[192.168.1.23,192.168.1.24]".fabfile的主體由多個自定義的任務函數組成,不一樣任務函數實現不一樣的操做邏輯,下面詳細介紹
3、全局屬性設定
env對象的做用是定義fabfile的全局設定,支持多個屬性,包括目標主機,用戶,密碼角色,各屬性說明以下:
複製代碼 代碼以下:

env.host,定義目標主機,能夠用IP或主機名錶示,以Python的列表形式定義,如env.hosts=['192.168.1.23,192.168.1.24'].
env.exculde_hosts,排除指定主機,如env.exclude_hosts=['192.168.1.23']
env.user,定義用戶名,如env.user="root"
env.port,定義目標主機端口,如env.port = '22'
env.password,定義密碼,如env.password='123456'
env.passwords,與password功能同樣,區別在於不一樣主機不一樣密碼的應用場景,須要注意的是,配置passwords時須要配置用戶,主機,端口等信息,如:env.passwords = {'root@192.168.1.21:22':'123456',
'root@192.168.1.23:22':'3234234',
'root@192.168.1.24:23':'09887',
}
env.gateway,定義網關(中轉,堡壘機)IP,如env.gateway = '192.168.1.1'
env.roledefs,定義角色分組,好比web組與db組主機區分開來,定義以下:
env.roledefs = {
'webservers':['192.168.1.21','192.168.1.22','192.168.1.23'],
'dbservers':['192.168.1.24','192.168.1.25'],
}

引用時使用python修飾符的形式進行,角色修飾符下面的任務函數爲其做用域,下面來看一個示例:
@roles('webservers')
def webtask():
run('/etc/init.d/nginx start')
@roles('dbservers'):
def dbtask():
run('/etc/init.d/mysql start')
@roles('webservers','dbservers')
def publictask():
run('uptime')
def deploy():
execute(webtask)
execute(dbtask)
execute(publictask)
在命令執行fab deploy就能夠實現不一樣角色執行不一樣的任務函數。
經常使用API
Fabric提供了一組簡單但功能強大的fabric.api命令集,簡單地調用這樣API就能完成大部分應用場景需求,Fabric支持經常使用的方法及說明以下:
複製代碼 代碼以下:

local,執行本地命令,如local:('uname -s');lcd,切換本地目錄,如lcd:('/home');cd,切換遠程目錄,如cd:('/data/logs/');run,執行遠程命令,如:run('free -m')sudo,sudo方式執行遠程命令,如:sudo('/etc/init.d/httpd start');put,上傳本地文件到遠程主機,如:put('/home/user.info','/data/user.info');get,從遠程主機下載文件到本地,如:get('/home/user.info','/data/user.info');prompt,得到用戶輸入信息,如:prompt('please input user password:');confirm,得到提示信息確認,如:confirm('Test failed,Continue[Y/N]');reboot,重啓遠程主機,如reboot();@task,函數修飾符,標識符的函數爲fab可調用,非標記對fab不可見,純業務邏輯;@runs_once,函數修飾符,標識符的函數只會執行一次,不受多臺主機影響;示例1:查看本地與遠程主機信息本示例調用local()方法執行本地命令,添加"@runs_once"修飾保證該任務函數只執行一次。調用run()方法執行遠程命令,#!/usr/bin/env python# -*- coding: utf-8 -*-from fabric.api import *env.user = 'root'env.hosts = ['192.168.1.43','192.168.1.23','192.168.1.24']env.port = '22'env.password = '123456' @runs_once #查看本地系統信息,當有多臺主機時只運行一次def local_task(): #本地任務函數 local('uname -a') def remote_task(): with cd('/data'): #with的做用是讓後面的表達式語句繼承當前狀態,實現cd /var && ls -l的效果 run('ls -l')經過fab命令分別調用local_task任務函數運行效果以下圖所示201608281657386.jpg結果中顯示了[192.168.1.23] Executing task 'local_task',但事實上並不是在主機192.168.1.23上執行任務,而是返回Fabric主機本地的'uname -a'的執行效果調用remtoe_task任務函數的執行結果以下圖所示201608281657387.jpg示例2;動態獲取遠程目錄列表本示例使用"@task"修飾符標誌入口函數go()對外部能夠,配合"@runs_once"符等待接受用戶輸入,最後調用worktask()任務函數實現遠程命令執行,#!/usr/bin/env python# -*- coding: utf-8 -*-from fabric.api import *env.user = 'root'env.hosts = ['192.168.1.23','192.168.1.24']env.password = '123456'@runs_once #在主機遍歷過程當中,只有一臺出發此函數def input_raw(): return prompt("please input direcotry name:",default="/home") def worktask(dirname): run("ls -l %s" %dirname) @taskdef go(): getdirname = input_raw() worktask(getdirname)該示例實現了一個動態輸入遠程目錄名稱,在獲取目錄列表的功能,因爲咱們只要求輸入一次,再顯示全部主機上該目錄的列表信息,調用了一個子函數input_raw(同時配置)@runs_once修飾符來達到此目的,執行結果以下圖201608281657388.jpg文件上傳與執行#!/usr/bin/env python# -*- coding: utf-8 -*-from fabric.api import *from fabric.context_managers import *from fabric.contrib.console import confirmenv.hosts=['192.168.1.23','192.168.1.24']#假如全部主機密碼都不同,能夠經過env.passwords字典變量一一指定env.passwords = { 'root@192.168.1.23:22': '123456', 'root@192.168.1.24:22': '123456',} lpackpath="/home/a.tar.gz"rpackpath="/tmp/install" @taskdef put_task(): run("mkdir -p /tmp/install") 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!") @taskdef run_task(): with cd("/tmp/install"): run("tar -zxvf a.tar.gz") @taskdef go(): put_task() run_task()

相關文章
相關標籤/搜索