专栏首页python3python Fabric使用详解及示例

python Fabric使用详解及示例

abric是基于Python实现的SSH命令行工具,简化了SSH的应用程序部署及系统管理任务,它提供了系统基础的操作组件,可以实现本地或远程shell命令,包括:命令执行、文件上传、下载及完整执行日志输出等功能。Fabric在Paramiko的基础上做了更高一层的封装,操作起来会更加简单

安装时候需要安装一些依赖包   setuptools-18.5  paramiko-2.4.1  pycrypto-2.6.1  Fabric-1.8.2

wget https://files.pythonhosted.org/packages/ec/6d/b433a14c77ad17b917a9646d5ac96275309170a88fcffc967def7a1ba8ce/setuptools-18.5.tar.gz

wget https://files.pythonhosted.org/packages/ab/82/4cd6cbb2001431aece679c5c496bb49d2094f10e9cc98b9f94fa7261a935/Fabric-1.8.2.tar.gz

wget https://files.pythonhosted.org/packages/60/db/645aa9af249f059cc3a368b118de33889219e0362141e75d4eaf6f80f163/pycrypto-2.6.1.tar.gz

wget https://files.pythonhosted.org/packages/29/65/83181630befb17cd1370a6abb9a87957947a43c2332216e5975353f61d64/paramiko-2.4.1.tar.gz

全部解压安装  python setup.py install

命令格式:

fab [options] <command>[:arg1,arg2=val2,host=foo,hosts='h1;h2',...] ...

常用参数:

-l     #显示定义好的任务函数名
-f     #指定fab入口文件,默认入口文件名为fabfile.py
-f     #指定网关(中转)设备,比如堡垒机环境,填写堡垒机IP即可
-H     #指定目标主机,多台主机用‘,’号分隔
-p     #远程账号的密码,fab执行时默认使用root账户
-P     #以异步并行方式运行多主机任务,默认为串行运行
-R     #指定role(角色),以角色名区分不同业务组设备
-t     #设置设备连接超时时间(秒)
-T     #设置远程主机命令执行超时时间(秒)
-w     #当命令执行失败,发出警告,而非默认中止任务。

示例:test.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 
fab -p 123456 -H localhost  --  'uname -s'

fabfile文件编写

env对象:

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

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:查看本地与远程主机信息   fab -f test.py local_task     fab -f test.py remote_task

#!/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')

示例2:动态获取远程目录列表      fab -f test.py go

#!/usr/bin/env python
# -*- coding: 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)

示例3:网关模式文件上传与执行(中转,堡垒机)  fab -f test.py go

#!/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()

示例4:文件的打包上传和校验

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from fabric.api import *
from fabric.context_managers import *
from fabric.contrib.console import confirm
env.user = 'root'
env.hosts = ['192.168.1.23','192.168.1.24']
env.password = '123456'

@task
@runs_once
def tar_task():
	with lcd("/data/logs"):
		local("tar zcf logs.tar.gz test.log")

@task
def put_task():
	run('mkdir -p /data/logs')
	with cd("/data/logs"):
		with settings(warn_only=True):
			result=put("/data/logs/logs.tar.gz","/data/logs/logs.tar.gz")
		if result.failed and not confirm("put file failed,Continue[Y/N]?"):
			abort('Aborting file put task')

@task
def check_task():
	with settings(warn_only=True):
		lmd5=local("md5sum /data/logs/logs.tar.gz",capture=True).split(' ')[0]
		rmd5=run("md5sum /data/logs/logs.tar.gz").split(' ')[0]
	if lmd5==rmd5:
		print "OK"
	else:
		print "ERROR"
		
def go():
	tar_task()
	put_task()
	check_task()
		
fab -f test.py go

示例5:部署lnmp环境

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from fabric.colors import *
from fabric.api import *
env.user='root'

env.roledefs={
	'webservers': ['192.168.1.21','192.168.1.22'],
	'dbservers': ['192.168.1.23']
}

env.passwords={
	'root@192.168.1.21:22':'123456',
	'root@192.168.1.22:22':'asdfgh',
	'root@192.168.1.23:22':'654321'
}

@roles('webservers')
def web_task():
	print yellow("install nginx php php-fpm....")
	with settings(warn_only=True):
		run("yum install -y nginx")
		run("yum install -y php-fpm php-mysql php-mbstring php-xml php-mcrypt php-gd")
		run("systemctl enable php-fpm")
		run("systemctl enable nginx")
		
@roles(dbservers)
def db_task():
	print yellow("install mysql...")
	with settings(warn_only=True):
		run("yum install -y mariadb mariadb-server")
		run("systemctl enable mariadb")
		
@roles('webservers','dbservers')
def pub_task():
	print yellow("install ntp....")
	with settings(warn_only=True):
		run("yum install epel-release -y")
		run("yum install ntp -y ")

def deploy():
	execute(pub_task)
	execute(web_task)
	execute(db_task)
	
fab -f test.py deploy

示例:6:生产环境代码发布管理  (打包 发布 回滚)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from fabric.api import *
from fabric.colors import *
from fabric.context_managers import *
from fabric.contrib.console import confirm
import time

env.hosts=['192.168.1.21','192.168.1.22']
env.user='root'
env.password='124530'

env.project_dev_source='/data/dev/webadmin/'
env.project_tar_source='/data/dev/releases/'
env.project_pack_name='release'

env.deploy_project_root='/data/www/webadmin/'
env.deploy_release_dir='releases'
env.deploy_current_dir='current'
env.deploy_version=time.strftime("%Y-%m-%d")+"v2"

@runs_once
def input_version():
	return prompt("please input your roolback version ID ",default="")

@task
@runs_once
def tar_source():
	print yellow("creating source package....")
	with lcd(env.project_dev_source):
		local("tar -zcf %s.tar.gz ." % (env.project_tar_source + env.project_pack_name))
	print green("creating source package success!")
	
@task
def put_package():
	print yellow("start put package....")
	with settings(warn_only=True):
		with cd(env.deploy_project_root+env.deploy_release_dir):
			run("mkdir %s" % (env.deploy_version))
	env.deploy_full_path=env.deploy_project_root + env.deploy_release_dir + "/" +env.deploy_version
	with settings(warn_only=True):
		result=put(env.project_tar_source+env.project_pack_name+".tar.gz",env.deploy_full_path)
	if result.failed and not ("put file failed,Continue[Y/N]?"):
		abort('Aborting file put task')
	with cd(env.deploy_full_path):
		run("tar -zxf %s.tar.gz" % (env.project_pack_name))
		run("rm -rf %s.tar.gz" % (env.project_pack_name))
	print green("put & untar package success!")
	
@task
def make_symlink():
	print yellow("update current symlink")
	env.deploy_full_path=env.deploy_project_root + env.deploy_release_dir + "/" +env.deploy_version
	with settings(warn_only=True):
		run("rm -rf %s" % (env.deploy_project_root+env.deploy_current_dir))
		run("ln -s %s %s" % (env.deploy_full_path,env.deploy_project_root+env.deploy_current_dir))
	print green("make symlink success!")
	
@task
def roolback():
	print yellow("roolback project version")
	versionid=input_version()
	if versionid=='':
		abort("project version Id error,abort!")
	env.deploy_full_path=env.deploy_project_root + env.deploy_release_dir + "/" +versionid
	run("rm -f %s" % (env.deploy_project_root+env.deploy_current_dir))
	run("ln -s %s %s" % (env.deploy_full_path,env.deploy_project_root+env.deploy_current_dir))
	print green("roolback success!")
	
@task
def go():
	tar_source()
	put_package()
	make_symlink()


生产nginx目录配置
root /data/www/webadmin/current;

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • php yield关键字以及协程的实现

    php的yield是在php5.5版本就出来了,而在初级php界却很少有人提起,我就说说个人对php yield的理解

    仙士可
  • 用Python做一个简单的翻译工具

    编程本身是跟年龄无关的一件事,不论你现在是十四五岁,还是四五十岁,如果你热爱它,并且愿意持续投入其中,必定会有所收获。

    Crossin先生
  • 赶上年底最后一趟末班车——Python编程基础之小白入门

    正如人与人之间的沟通需要语言,人与计算机之间的沟通,也需要语言,连接人与计算机沟通的桥梁就是编程语言。任何编程语言只要用来开发程序,都怀揣着同一使命——“为人类...

    CDA数据分析师
  • BERT中文实战:文本相似度计算与文本分类

    谷歌提供了以下几个版本的BERT模型,每个模型的参数都做了简单的说明,中文的预训练模型在11月3日的时候提供了,这里我们只需要用到中文的版本

    机器学习入门与实战
  • pytest文档29-allure-pytest(最新最全,保证能搞成功!)

    之前写了个pytest的allure相关的教程,只是停留在环境搭建完成,后续一直没用,小编一直不喜欢这种花里胡哨的报告。 没办法,领导就喜欢这种,小伙伴们也喜欢...

    上海-悠悠
  • Python数据可视化:5段代码搞定散点图绘制与使用,值得收藏

    导读:什么是散点图?可以用来呈现哪些数据关系?在数据分析过程中可以解决哪些问题?怎样用Python绘制散点图?本文逐一为你解答。

    CDA数据分析师
  • python中的__init__.py作用

    在Python中,我们经常会看到一个文件夹下有若干个py文件,其中总有那么一个py文件在命名上很特别,就是__init__.py。该py文件前后各是两个下划线,...

    Defu Li
  • 【漏洞实战】Apache Shiro反序列化远程代码执行复现及“批量杀鸡”

    利用vmware workstation,安装一个操作系统,执行以下指令,更换系统源,并且安装docker

    用户1631416
  • GitHub 长期被中国人“霸榜”?看完榜单我呆了...

    作为「技术行业观察者」的我,平时经常会逛 GitHub 找选题,最近我又在上面发现了很多宝藏...或者叫大宝箱...

    Rocky0429
  • 深度学习环境配置有哪些坑?

    深度学习第一问是关于环境配置的。之前笔者也在深度学习60讲系列中讲到如何配置深度学习开发环境的问题:深度学习笔记15:ubuntu16.04 下深度学习开发环境...

    石晓文

扫码关注云+社区

领取腾讯云代金券