基于角色策略访问Jenkins API

简介

  Jenkins是一个开源软件项目,是基于Java开发的一种持续集成工具,用于监控持续重复的工作,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。

入口

  首先在Jenkins主页选择系统管理, 选择全局安全配置

Management

在Authorization(授权)中选择Role-Based Strategy(基于角色策略)

Authorization

  项目矩阵授权策略也比较常见,配置也很简单,在角色管理中配置相应的角色和组后可以在这里对角色和组进行授权即可。


  在安装了第三方Jenkins插件 Role Strategy Plugin 后,即可在管理页面看到 Manage and Assign Roles,进入后如下图。


  

角色配置

  选择Manage Roles,进行角色配置
  这里是为了授权已登录或有合法Token的用于可以正确的调用Job API,所以添加角色User,授权至少要有Read和Build,其他权限可根据实际情况配置。
  更改授权策略会清空除了操作账号外所有已绑定的用户!

用户配置

  选择Assign Roles,对用户进行角色的指派


  通过User/group to add添加用户,然后分配角色配置中配置好的角色。
  笔者这里是使用GitHub账户登录过来的,所以要先登录GitHub账号,这里User/group显示的账号,然后加载时被动态修改成了昵称,可以在刷新的一瞬间看到,昵称的设置可以在右上角进入自己的Config进行设置,Anonymous为未登录的匿名用户,这里只允许登录的用户进行访问,图中有两个相同昵称的账号,其实是不同的账号相同的昵称,下面会说明原因。
  另外有权限登录的这个界面的用户可以互删!!哪怕都是Admin!!!(就是说你可以删掉你的Leader的权限)
  

Token配置

  在首页选择People

  这里可以看到Jenkins中的所有用户,但请注意,这里的个人用户名全部被Jenkins定为了小写!笔者的GitHub账号是大写,这里记录的是小写,Jenkins大部分情况是不区分大小写的,除了调用API的账号!也就是说,即使按照按照下文的配置完成后调用API也会报 “xinzheng-li is missing the Overall/Read permission” 的异常,因为笔者的账号是大写首字母!
  为了解决这个问题,只好在Assign Roles里面加入小写账号,Jenkins因为已经录入了大写的账号,所以会识别出来并显示昵称,所以出现了有两个相同的账号昵称。把GitHub账号也就是登录Jenkins的账号修改为小写理论上也可行,笔者这里不再测试。
右边的On是角色的范围,这里使用全局账号进行配置,点击账号名称,点击Configure。



Token注意保存,关闭页面后将无法再次看到,如遗忘可重新生成。

API地址

  为了方便理解,下文中所有的Jenkins根目录使用{JenkinsURL}代替,Job的名称使用{JobName}代替。
  首先,可以在https://{JenkinsURL}/api/json中看到Jenkins的整体配置和Job的api接口地址,一般为https://{JenkinsURL}/job/{JobName}。
  调用具体Job API的文档可以在https://{JenkinsURL}/job/{JobName}/api下面看到


调用Jenkins API

  调用API无非就是像Jenkins服务器发起请求,在C#中的HttpWebRequest,WebClient,HttpClient或者其他类库,Js中的Ajax,CMD中的curl等等均可实现。Authorization由用户名加冒号加Token组成,如: xinzheng-li:1234567890。URL无参数可使用{JobName}/build,部分URL区分大小写

CMD命令:

      curl https://{JenkinsURL}/job/{JobName}/buildWithParameters?{Parameters} -X POST --user xinzheng-li:1234567890

Powershell脚本(需要对Authorization 进行 Basic64编码并在前面加“Basic ”):

      $Url = "https://$JenkinsURL/job/$JobName/buildWithParameters"
      $byteArray = [System.Text.UnicodeEncoding]::UTF8.GetBytes("xinzheng-li:1234567890")
      $Auth =  [Convert]::ToBase64String($byteArray)
      $Paras = "A=1&B=2"
      $Response =Invoke-WebRequest $Url -Headers @{"Authorization"= "Basic $Auth"} -Method POST -Body $Paras -UseBasicParsing

C# (同样需要Basic编码)

      byte[] byteArray = Encoding.UTF8.GetBytes("A=1&B=2");
      HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
      request.Headers.Add(HttpRequestHeader.Authorization, "Basic abcdefghigklmnopqrstuvwxyz");
      request.Method = "POST";
      request.PreAuthenticate = true;
      request.ContentLength = byteArray.Length;
      Stream newStream = request.GetRequestStream();
      newStream.Write(byteArray, 0, byteArray.Length);
      newStream.Close();

      HttpWebResponse response = (HttpWebResponse)request.GetResponse();
      using (StreamReader read = new StreamReader(response.GetResponseStream(), Encoding.GetEncoding("utf-8")))
      {
            string content = read.ReadToEnd();
      }
      var result = response.Headers["Location"];

  在返回的Headers中可以得到Location:https://{JenkinsURL}/queue/item/{Queueid}/
笔者推测Jenkins想直接返回Job的Url,但不知道怎么留了这个BUG,访问此url会得到404,不过我们可以通过分割URL得到Queueid,这个是全局的TaskId,目前也没有直接可以通过Queueid得到TaskId的方法,只能调用API获取最后一次的TaskId和Queueid,通过比较Queueid来确定TaskId是否是刚刚触发的TaskId。

查询最后一次构建的TaskId和QueueId

      $url = "$JenkinsURL/job/$JobName/lastBuild/api/json?pretty=true&tree=queueId,number"

  如果QueueId不符,则可以通过增减TaskId替换调lastBuild再次查询比较,直到得到准确的TaskId。
  最后,在通过计时器等方式循环访问API获取结果,如果构建较快,也可以在查询TaskId的时候直接在url后增加result参数获取结果。

      $url = "$JenkinsURL/job/$JobName/$TaskId/api/json?pretty=true&tree=number,result"

欢迎来我的博客查看更多文章

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

推荐阅读更多精彩内容

  • 教程:https://www.yiibai.com/jenkins/ 本节内容: Jenkins介绍 安装部署Je...
    达微阅读 9,007评论 2 77
  • 目的这篇教程从用户的角度出发,全面地介绍了Hadoop Map/Reduce框架的各个方面。先决条件请先确认Had...
    SeanC52111阅读 1,717评论 0 1
  • WINDOWS 1. 安装JDK JDK下载地址: http://www.oracle.com/technetwo...
    烨枫_邱阅读 1,953评论 0 11
  • REST API 可以让你用任何支持发送 HTTP 请求的设备来与 Parse 进行交互,你可以使用 REST A...
    Caroline嗯哼阅读 2,006评论 0 0
  • 不知大家有没有看过这两本书,反正我是很喜欢。 我从初一便开始看一些玄幻类的小说。无论是网上很火的《斗破苍穹》《...
    刘星星_三月阅读 1,736评论 8 6