3.【小试】Python远程操作Jenkins

Jenkins除了有GUI界面,还提供了RestAPI的方式来方便用户,使用代码(Python、Java)控制Jenkins的工作流。

【本文要点】

  • 使用python-jenkins库和python3.6.3作为基础。
  • Jenkins被安装在虚拟机上,开放部分Jenkins的“安全设置”
  • 设置Jenkins中当前登录用户API Token
  • 在Pycharm中写一些简单的代码来控制远程的Jenkins。

1.Python-Jenkins库

1.1 What is python-jenkins?

Python Jenkins is a python wrapper for the Jenkins REST API which aims to provide a more conventionally pythonic way of controlling a Jenkins server. It provides a higher-level API containing a number of convenience functions.

1.2 Python-Jenkins能做什么?

Python-Jenkins可以做很多事情见图1所示:


图1 Python-Jenkins能做什么?
1.3 Python-Jenkins的安装

如果你的Python环境中有pip管理工具,请使用pip进行python-jenkins库文件的安装,安装命令如下所示。【PS:建议python版本使用3.x】

#使用pip进行python-jenkins库的安装

 $ pip install python-jenkins

2.修改Jenkins的“安全设置”

笔者所用的Jenkins版本为2.89.3,对于Jenkins2.x以上的版本,安全防护更加的严格。因此,我们需要降低一点Jenkins的安全防护级别,将“安全矩阵”替换为“登录用户可以做任何事”。图2和图3为具体更改后的安全配置情况。

图2 具体更改后的安全配置情况--上半部分

图3 具体更改后的安全配置情况--下半部分

修改完“全局安全配置”后,请重启您的Jenkins服务

[PS]重启Jenkins服务可以采用在地址栏输入http://ip:port/restart的方式。


3.Jenkins中设置当前登录用户的 API Token

只有已登录的用户才能设置自己相对应的API Token,API token是用户登录操作Jenkins的另外意义上的Password,可以将API Token 等价于Password。

3.1 启用用户所属的API Token

当你成功登录进Jenkins系统,根据图3所示的操作进行Show API Token 的操作,你就会得到当前用户唯一的API Token,API Token的用法见本文第四节(编写python控制jenkins的代码)

图3 启用用户所属的API Token

3.2 修改用户所属的API Token

如果,你想修改你的API Token,请根据图4所示进行修改操作。


图4 修改用户所属的API Token

4.编写python控制jenkins的代码

下面是一个获取Jenkins版本号的小Demo:

import jenkins

#远程Jenkins的地址
jenkins_server_url = 'http://192.168.1.13:8080'

#用户名
user_id = 'admin'

#用户的token值(每个user有对应的token----如本文第3.1节所示)
api_token = 'ea8c65123036cf95cd038b1d8e5cc3c9'

#登录密码
#passwd = 'admin'

#server = jenkins.Jenkins(jenkins_server_url, username=user_id, password=passwd)

#使用  API_Token    进行Jenkins登录操作
server = jenkins.Jenkins(jenkins_server_url, username=user_id, password=api_token)

#使用get.version()方法获取版本号
version = server.get_version()

print(version)
#server.build_job('oschina_selenium_docker')

图5为Jenkins GUI上的版本号信息

图5 Jenkins GUI上的版本号信息

图6为Python代码执行后获取Jenkins版本号的结果

图6 Python代码执行后获取Jenkins版本号的结果

笔者遇到的坑点填坑
【坑点1】一定要修改Jenkins的“全局安全设置”,不然代码运行时就会报错“jenkins.BadHTTPException: Error communicating with server[http://192.168.1.13:8080/]”
【填坑1】要想解决坑点1,请具体本文【图2图3】进行设置Jenkins的【全局安全配置】即可。

更多Python代码方式操作Jenkins的事例代码请访问Pthon-Jenkins官方

本文END,请换一种方式体验下Jenkins的不同玩法!

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