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

来源:http://www.cnblogs.com/aslongas/archive/2016/10/14/5961144.html
-Advertisement-
Play Games

簡介:Fabric是基於Python實現的SSH命令行工具，簡化了SSH的應用程式部署及系統管理任務，它提供了系統基礎的操作組件，可以實現本地或遠程shell命令，包括：命令執行、文件上傳、下載及完整執行日誌輸出等功能。Fabric在Paramiko的基礎上做了更高一層的封裝，操作起來會更加簡單。 ...


 

簡介:Fabric是基於Python實現的SSH命令行工具，簡化了SSH的應用程式部署及系統管理任務，它提供了系統基礎的操作組件，可以實現本地或遠程shell命令，包括：命令執行、文件上傳、下載及完整執行日誌輸出等功能。Fabric在Paramiko的基礎上做了更高一層的封裝，操作起來會更加簡單。

一、安裝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)

執行:

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'
tar file ...
[localhost] local: tar czf messages.tar.gz messages
put file ...
[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

 

---------------------------------------------------------------

參考資料：

劉天斯《Python自動化運維技術與最佳實踐》

　　

　

　　

　

　　

　　

　　


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java基礎學習總結 -- 圖形用戶界面GUI（持更）
    雖然目前Java算不上前端開發的主力，但是作為Java入門基礎的一部分，學習Java的GUI編程還是有必要的，而且可以做出一些小且有趣的圖形程式來提高學習熱情。本篇學習總結均為一個Beginner的筆記與心得，如有描述不到或錯誤之處，敬請指正。 一個合格的Java Developer，不僅要掌握技術... ...
  • Hibernate ——二級緩存
    一、Hibernate 二級緩存 1.Hibernate 二級緩存是 SessionFactory 級別的緩存。 2.二級緩存分為兩類： （1）Hibernate內置二級緩存 （2）外置緩存，可配置的，可插撥的，外置緩存中的數據是資料庫數據的複製。 3.二級緩存的併發訪問策略 （1）兩個併發的事務同 ...
  • sizeof和strlen()
    sizeof關鍵字和strlen(）標準函數都可以用來測試字元串的長度，但是兩者有很大的不同 sizeof只能在 本函數內 , 使用 和 不指定長度的字元數組 中才能測出字元串的真實長度，當然，包括 strlen()任何情況下都能正確的得出字元串的字面值大小 在 本函數內 ，sizeof測試 的結果 ...
  • 檢查輸入數據類型
    ...
  • 乘法表
    ``` include int main(int argc, const char argv[]) { int i=0,j=0; for(i=1;i ...
  • 全局變數、局部變數、靜態全局變數、靜態局部變數在記憶體里的區別
    C語言 變數存儲 數據結構 嵌入式 ARM 靜態變數 局部變數 全局變數 單片機 記憶體分配 ...
  • Spring之AOP由淺入深
    1.AOP的作用 在OOP中，正是這種分散在各處且與對象核心功能無關的代碼（橫切代碼）的存在，使得模塊復用難度增加。AOP則將封裝好的對象剖開，找出其中對多個對象產生影響的公共行為，並將其封裝為一個可重用的模塊，這個模塊被命名為“切麵”（Aspect），切麵將那些與業務無關，卻被業務模塊共同調用的邏 ...
  • MyEclispe發佈web項目-遁地龍卷風
    (-1)寫在前面 我用的是MyEclipse8.5. 還記得以前幫助一個女同學解決問題的時候，特意情調了要先啟動服務在發佈項目，其實單獨的時候都是知道的，總和起來後就容易片面的給出結論。因為不會發生問題所以啊也不知道自己錯了。倒是瞭解後，很多莫名其妙的問題說的清了。 (0)步驟說明 註意這個名字是m ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類