基于Fabric的代码自动化发布:(二) Fabric的使用教程

更多Fabric的介绍和使用教程,可以访问 官方教程地址

一. Hello, Fabric
首先用vim fabfile.py创建一个名为fabfile.py的文件,文件内容如下:

def hello(): 
  print("Hello world!")

wq退出保存后,我们就可以用fab工具来执行这个hello函数,输入命令

fab hello
运行结果,显示Hello world!

fab工具默认导入当前目录的 fabfile文件, 并执行了命令指定的函数,你能在 fabfile 中完成任何普通 Python 模块中可以做的事情。

二. fab 命令的常用参数

fab --help  #显示fab的参数和作用
fab -l      # 显示可用的task(命令)
fab -H      # 指定host,支持多个host,以逗号分开
fab -R      # 指定role,支持多个role
fab -P      # 并发数,默认串行
fab -w      # warn_only,默认遇到异常直接abort退出
fab -f      # 指定入口文件,默认fabfile.py

三. Fabric的常用函数

  1. lcd() 切换本地目录
    lcd("/var/www") #打开本地/var/www目录

  2. cd() 切换远程目录
    cd("/var/www") #打开远程/var/www目录

  3. local() 执行本地命令
    local("ls") #在本地执行ls命令,显示本地目录文件

  4. run() 执行远程命令
    run("ls") #在远程执行ls命令,显示远程目录文件

  5. sudo() 执行远程sudo
    sudo("service httpd stop") #远程服务器用sudo停止httpd服务

  6. put() 从本地上传文件到远端
    put('bin/project.zip', '/tmp/project.zip') #本地目录文件上传到远端

  7. 其他实用工具函数

    #终止执行,向 stderr 输入错误信息 msg并退出
    fabric.utils.abort(msg)  
    
    #给定错误信息 message 以调用 func
    fabric.utils.error(message, func=None, exception=None, stdout=None, stderr=None) 
    
    #打印警告信息,但不退出执行。
    fabric.utils.warn(msg) 
    
    #彩色输出的函数 需要引用from fabric.colors import red, green
    print(red("This sentence is red, except for " + green("these words, which are green") + "."))
    
    #询问用户 yes/no 的问题,并将用户输入转换为 True 或 False。
    fabric.contrib.console.confirm(question, default=True)
    

四. 异常处理
官方推荐使用环境字典的settings的warn_only, 具体代码如下:

from __future__ import with_statement
from fabric.api import settings, abort
from fabric.contrib.console import confirm
from fabric.operations import put

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

1 环境字典中的warn_only 默认为False,指定在 run、sudo、local遇到错误时究竟是警告还是退出。
2 put这样运行命令的操作会返回一个包含执行结果( .failed或 .return_code属性)的对象。

3 Fabric contrib.console子模块提供了 confirm函数,用于简单的 yes/no 提示。
4 abort函数用于手动停止任务的执行。

五. 环境字典

环境字典 fabric.state.env是作为全局单例实现的,为方便使用也包含在fabric.api中。 env中的键通常也被称为“环境变量”。

几个常用的环境变量:

  1. **user **:Fabric 在建立 SSH 连接时默认使用本地用户名,必要情况下可以通过修改env.user来设置。
  2. password :用来显式设置默认连接或者在需要的时候提供 sudo 密码。如果没有设置密码或密码错误,Fabric 将会提示你输入。
  3. warn_only : 布尔值,用来设置 Fabric 是否在检测到远程错误时退出。
  4. hosts :组合任务对应主机列表时会包含的全局主机列表。
  5. roledefs :定义角色名和主机列表的映射字典。
  6. roles :按任务足额和主机列表时使用的全局任务列表。

settings会话管理器,临时修改环境变量

from fabric.api import settings, run
 def exists(path): 
    with settings(warn_only=True):  #临时修改warn_only为true
      return run('test -e %s' % path)

六. Fabric的注解

  1. parallel并行注解,代码如下:

    from fabric.api import *
    @parallel
    def runs_in_parallel():
      pass
    def runs_serially(): 
      pass
    

    如果这样执行:

    fab -H host1,host2,host3 runs_in_parallel runs_serially
    

将会按照这样的流程执行:

runs_in_parallel在 host1、host2和 host3上并行运行
runs_serially在 host1、host2和host3上串行运行

  1. serial串行注解,代码如下:

    from fabric.api import *
    
    def runs_in_parallel():
      pass
    @serial
    def runs_serially(): 
      pass
    

如果这样执行:

   fab -H host1,host2,host3 -P runs_in_parallel runs_serially

命令行增加选项 [-P]制所有任务并行执行,但是runs_serially()函数以为增加了串行注解,依然会串行执行

七. 最后举个栗子

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

from fabric.api import *

env.user='root'  
env.hosts=['192.168.1.21','tyiman@192.168.1.22','192.168.1.23']  

env.roledefs = {
  'node_agent': ['192.168.1.21']
  'node_monitor': ['tyiman@192.168.1.22','192.168.1.23']
}

env.passwords = {
  'root@192.168.1.21': 'password1',
  'tyiman@192.168.1.22': 'password2',
  'root@192.168.1.23': 'password3'
}
def test():
  with settings(warn_only=True):
    result = put("/data/logs/access.tar.gz","/data/logs/access.tar.gz")
    print("put the file to the remote success")
if result.failed and not confirm("Put file failed. Continue anyway?"):
    abort("Aborting at user request.")

def deploy():
  test()
  local("git add -p && git commit")
  local("git push")

@task
@parallel
@roles('node_agent')
  def nginx_start():
  sudo('/etc/init.d/nginx start')

@task
@serial
@roles('node_agent')
  def nginx_stop():
  sudo('/etc/init.d/nginx stop')

@task
@parallel(pool_size=5)
@roles('node_monitor')
def mysql_start()
    sudo('/etc/init.d/mysql start')
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容