python使用Fabric模块实现自动化运维
简介:Fabric是基于Python实现的SSH命令行工具，简化了SSH的应用程序部署及系统管理任务，它提供了系统基础的操作组件，可以实现本地或远程shell命令，包括：命令执行、文件上传、下载及完整执行日志输出等功能。Fabric在Paramiko的基础上做了更高一层的封装，操作起来会更加简单。
一、安装Fabric
使用pip install Fabric来安装,安装需要paramiko包和Crypto包
验证是否安装成功，出现如下图所示，说明fabric模块安装成功
命令说明
- 格式
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 = {'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的使用方法实例：
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={'root@192.168.56.30: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 = { 'root@192.168.1.21:22':'123456', 'root@192.168.1.22:22':'abcdef', 'root@192.168.1.23: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自动化运维技术与最佳实践》
