简介:Fabric是基于Python实现的SSH命令行工具,简化了SSH的应用程序部署及系统管理任务,它提供了系统基础的操作组件,可以实现本地或远程shell命令,包括:命令执行、文件上传、下载及完整执行日志输出等功能。Fabric在Paramiko的基础上做了更高一层的封装,操作起来会更加简单。
参考资料:
刘天斯《Python自动化运维技术与最佳实践》 PDF下载见
一、安装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 = {'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()