python自动化远程部署-fabric

项目发布部署时，往往需要花大量的时间去ssh多台机器，然后逐一敲重复的命令，同样的操作和同样的命令反复做，作为一个程序员是不能忍受的，这也是自动化存在的意义，可以大大节省不必要的时间，python做为一个脚本语言本身就有这方面的优势，fabric 这个库可以很好的偷懒，本文使用python3。

链接：https://www.jianshu.com/p/0147b2ad9993
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。

安装

会安装一大堆包，提示 Successfully installed 等字样表示安装成功，安装完后，系统有一个 fab 命令可以使用。想要了解更多，看官方文档。

sudo pip3 install fabric3

简单示例

1、先见识一下使用效果，然后再看常用的一些命令
例一：执行远程主机命令，查看主机操作系统， 'uname -o'
首先创建一个 check.py 文件

from fabric.api import run  # 导入api中的run
      
def look():     
     run('uname -o')        # 执行run函数，把用使用的命令传入

然后使用 fab 命令执行，输入目标主机用户密码后即可执行命令，并打印结果

fab -f check.py -H 127.0.0.1 'look'     # -f指定文件， -H 指定主机，这里我们直接用本地， look 是文件里面的任务函数名

输出的结果如下：

这里只是一个小示例，当然不可能每个都自己手动输入密码，通过配置都可以完成自动化。

例二：多台远程主机创建目录 test 。

创建一个 mk_dir.py 文件：

from fabric.api import *
  
# 设置目标主机
env.hosts = ['192.168.139.139', '192.168.139.141']
# 设置多台主机用户名及密码
env.passwords = {
        'python@192.168.139.139:22': '12345678',     
        'python@192.168.139.141:22': '12345678'
    }
# 设置一个任务
@task
def start():
    run('mkdir test')

然后执行任务

fab -f mk_dir.py start      # start 是任务名

结果如下，可以在两个主机的 python 用户家目录看到 test 文件夹，这样就可以实现自动连接远程主机，并执行相应的任务了。

例二执行结果

例三：打包本地文件，上传到目标主机，并校验 md5 ，然后解压并执行这个文件(该例可以配合后面的命令说明测试)

场景：本地有一个 /home/python/test/test.py 文件，打包成 test.tar.gz ，上传到目标主机的 /home/python/temp 目录下，解压并执行。

创建一个本地的test.py如下，用来上传后执行：

print('===========')
print('hello world')
print('===========')

创建一个任务文件 uploadfile.py

from fabric.api import *
 
 
env.hosts = ['192.168.139.139', '192.168.139.141']
env.user = 'python'   # 多台主机用户名密码相同可以只写一次
env.password = '12345678'
 
# 打包
@runs_once            # 该装饰器表示只执行一次，没有的话默认每台主机都执行一次
def task_tar():      # 该场景本地文件打包本身就只需要执行一次
    with lcd('/home/python/test'):
        local('tar zcvf test.tar.gz test.py')
 
# 上传
def task_upload():
    run('mkdir -p /home/python/temp')
    put('/home/python/test/test.tar.gz', '/home/python/temp/test.tar.gz')
 
# 验证md5
def task_md5():
    # 计算本地的md5
    local_md5 = local('md5sum /home/python/test/test.tar.gz', capture=True).split('  ')[0]
    # 计算远程主机md5
    remote_md5 = run('md5sum /home/python/temp/test.tar.gz').split('  ')[0]
    print(local_md5)
    print(remote_md5)
    if remote_md5 == local_md5:
        print('上传成功')
    else:
        print('上传出错')
 
# 解包并执行
def task_exc():
    with cd('/home/python/temp'):
        run('tar zxvf test.tar.gz')
        run('python3 test.py')
 
# 调度
@task
def start():
    task_tar()
    task_upload()
    task_md5()
    task_exc()

执行任务：

fab -f uploadfile.py start

屏幕输出结果如下

[python@ubuntu Test]$ fab -f uploadfile.py start
[192.168.139.139] Executing task 'start'
[localhost] local: tar zcvf test.tar.gz test.py
test.py
[192.168.139.139] run: mkdir -p /home/python/temp
[192.168.139.139] put: /home/python/test/test.tar.gz -> /home/python/temp/test.tar.gz
[localhost] local: md5sum /home/python/test/test.tar.gz
[192.168.139.139] run: md5sum /home/python/temp/test.tar.gz
[192.168.139.139] out: d5e8f717b176270f4c1a4fa72493239a  /home/python/temp/test.tar.gz
[192.168.139.139] out: 
 
d5e8f717b176270f4c1a4fa72493239a
d5e8f717b176270f4c1a4fa72493239a
上传成功
[192.168.139.139] run: tar zxvf test.tar.gz
[192.168.139.139] out: test.py
[192.168.139.139] out: 
 
[192.168.139.139] run: python3 test.py
[192.168.139.139] out: ===========
[192.168.139.139] out: hello world
[192.168.139.139] out: ===========
[192.168.139.139] out: 
 
[192.168.139.141] Executing task 'start'
[192.168.139.141] run: mkdir -p /home/python/temp
[192.168.139.141] put: /home/python/test/test.tar.gz -> /home/python/temp/test.tar.gz
[localhost] local: md5sum /home/python/test/test.tar.gz
[192.168.139.141] run: md5sum /home/python/temp/test.tar.gz
[192.168.139.141] out: d5e8f717b176270f4c1a4fa72493239a  /home/python/temp/test.tar.gz
[192.168.139.141] out: 
 
d5e8f717b176270f4c1a4fa72493239a
d5e8f717b176270f4c1a4fa72493239a
上传成功
[192.168.139.141] run: tar zxvf test.tar.gz
[192.168.139.141] out: test.py
[192.168.139.141] out: 
 
[192.168.139.141] run: python3 test.py
[192.168.139.141] out: ===========
[192.168.139.141] out: hello world
[192.168.139.141] out: ===========
[192.168.139.141] out: 
 
 
Done.
Disconnecting from 192.168.139.139... done.
Disconnecting from 192.168.139.141... done.

常用命令

常用参数

-l : 列出指定文件的任务函数名，只有使用了装饰器 @task 的才会列出
-H : 指定目标主机，多台主机用","号分割
-u：指定远程用户名
-f : 指定fab的任务文件，默认的任务文件名是fabfile.py，即文件直接命名 fabfile.py ，可以不用 -f 指定文件
-t：设置超时时间，单位秒
-V：查看版本

API

@task : 函数装饰器，装饰的函数fab才能调用
@runs_once : 函数装饰器，装饰的函数只执行一次
local : 执行本地命令，例：local('ls -la')
run : 执行远程命令，例：run('ls -la')
lcd : 切换本地目录，例：lcd('/home/python')
cd : 切换远程目录，例：cd('/home/python')
put : 上传本地文件到远程主机，例：put('test', '/home/python/')
get : 从远程主机下载文件到本地，例：get('/home/python/test', './')
reboot : 重启远程主机，例：reboot()
sudo : sudo执行远程命令，例：sudo('service nginx start')

主机设置

env.host : 设置目标主机
env.user : 设置用户名
env.port : 设置目标主机端口，默认是22
env.password : 设置密码
env.passwords : 设置多台主机不同的密码。

作者：谦面客
链接：https://www.jianshu.com/p/0147b2ad9993
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。