持续集成高级篇之Jenkins cli与Jenkins ssh

系列目录

Jenkins Cli介绍

Jenkins Cli为Jenkins提供的一个cli工具,此工具功能非常强大,可以完成诸如重启jenkins,创建/删除job,查看job控制台输出,添加/删除节点等功能.但是实际工作中,像创建任务这样的配置显然cli非常吃力,不如直接在web管理界面操作,但是对于重启Jenkins,查看诊断信息等,执行一个手动构建任务等,则直接使用cli比进入web管理界面操作更加方便.因此什么时候web管理界面,什么时候使用cli,要看是否有利于提升生产力,是否有利于提升个人能力,是否有利于提升团队的自动化作业水平这些指标,不要以为使用cli就代表水平高而盲目使用cli从而导致效率下降或者问题增多.

jenkins cli可以通过jenkins提供的jar包来创建一个cli环境或者使用ssh客户端来执行cli,本节也会分别介绍它们.

使用jenkins自身客户端来执行cli

我们打开jenkins的安装目录,进入到war\WEB-INF目录,此目录下面有一个jenkins-cli.jar文件,它便是用来创建jenkins cli环境的.我们在这个目录下打开命令行工具,然后执行java -jar jenkins-cli.jar help便可以看到它的输出帮助信息

可以看到-s选项可以指定一个url,这个url就是jenkins web管理界面的url,现在是测试环境,url为http://localhost:8080,当然想要执行cli,还需要输入你的用户名和密码,这里通过 -auth选项指定用户名密码.

我们把上以信息综合起来,组成以下命令

java -jar jenkins-cli.jar -s http://localhost:8080 -auth tylerzhou:密码 help

以上语句中,help为要执行的命令.

需要注意的是,这里执行的命令直接是命令名称,不能加像其它命令行工具- -- 或/标识

如果你找不到Jenkins-cli.jar,可以通过在浏览器输入http://localhost:8080/jnlpJars/jenkins-cli.jar进行下载保存,注意把以上地址替换为您的实际地址

点击回车,可以看到所有Jenkins cli可执行的命令和命令的简短描述.下面介绍几个可能比较常用的命令

1) list-jobs,可以列出Jenkins里所有的job,就像打开jenkins web管理界面首页看到的那样.

命令如下

java -jar jenkins-cli.jar -s http://localhost:8080 -auth 您的账户:您的密码 list-jobs

需要注意的是,Jenkins cli需要每次执行命令的时候都带上java -jar jenkins-cli.jar -s http://localhost:8080 -auth 您的账户:您的密码+要执行的命令,而不是进入一个环境后只输入命令就行了.

2) build+要构建的job名,即可通过cli来触发一次构建.

构建成功后,我们打开web管理界面便可以看到多一次构建.

cli构建命令是一个非常实用的命令,虽然我们的大部分任务都是基于git的一个自动化流程.但是有些时候也需要手动执行一些脚本来完成工作中的一些自动化操作.如果每次打开web管理界面手动执行显然不如通过cli来执行效率高.

3) restart/safe-restart 可以重启jenkins服务,通过它们的名称可以看到safe-restart为安全重启,它会等到所有的操作都完成然后执行重启

4) clear-queue 清除构建队列.没有实际jenkins使用经验的朋友可能不知道,由于Jenkins自身原因或者我们脚本测试不够充分导致的bug,有时候会造成Jenkins构建阻塞,一直处于构建状态无法完成,这时候通过web管理界面点击取消构建也无法取消掉.此时呆以尝试这个命令.当然也可能仍然无法终止,此时需要使用restart命令暴力重启服务.

使用api token登陆

以上我们都是通过用户名:密码的方式来登陆cli,这样把明文密码暴露出来是不可取的,其实Jenkins cli还可以通过用户名:apitoken的方式来实现登陆cli.下面我们介绍五如何设置api token.

我们打开jenkins web管理界面,点击左侧的People按钮,在出现的界面中会列出可能不止一个用户,此时点击自身登陆jenkins的用户名,在进入的界面中点击configure按钮,在出现的界面中找到Api token栏

点击Add new token便会出现一个生成token的小界面,输入token的名称,可以是任意名称,然后点击generate,这时候就会生成一个token

注意一定要把这个token复制下来然后保存到其它地方,下次再找开的时候就看不到它了.

完成后点击保存.

此时我们在cli中输入以下命令

java -jar jenkins-cli.jar -s http://localhost:8080 -auth tylerzhou:11f52cef1324556a41d966083ffcf0ac1b

其中tylerhzou为用户名,后面就是我们刚才创建的token

如果执行成功,以上命令就输出jenkins cli的所有命令.

把命令信息保存到单独文件

我们可以看到,使用token的方式登陆会导致命令行非常长,严重影响命令可读性,其实我们可以把auth信息保存到一个文件文件里.我在Jenkins安装目录/war/WEB-INF目录下创建了一个名为password.txt的文本文件,内容如下

tylerzhou:11f52cef1324556a41d966083ffcf0ac1b

也即上面auth里输入的用户名:apitoken

这时我们在-auth选项里 通过指定@文件名方式指定包含用户名(密码或token)的文件来实现登陆.

代码如下

java -jar jenkins-cli.jar -s http://localhost:8080 -auth @password.txt

以上@后面的password.txt即为我们创建的密码文件

SSH方式登陆Jenkins执行cli

使用SSH方式登陆Jenkins需要进行配置,默认情况下jenkins SSHD port使用的是一个随机端口号,这样显然不利于ssh登陆,使用ssh登陆我们需要显式知道端口号是多少.我们打开Manage jenkins>Configure Global Security找到SSH Server栏,把默认random选项切为fixed然后输入一个同用端口号,我使用的是16022配置完成后点击保存.端口配置好了,我们还需要添加公钥到当前用户配置项,请参照上面使用api token登陆一节,进入到当前用户设置界面,这次我们不配置apitoken,而是往下拉找到SSH Public Keys选项,把我们生成的ssh公钥复制到这里.关于生成ssh key请参阅其它资料或者前面章节,这里不再赘述.

完成以后,我们就可以通过ssh方式执行命令了.

输入以下命令

ssh -l tylerzhou -p 16022 localhost help

其中-l指定的用户为我们登陆jenkins时的账户.
如果配置成功,以上命令就会列出所有的Jenkins 命令和简短介绍.

ssh执行的命令和上面通过jenkins-cli.jar执行的命令是一样,可以互相参照.

对jenkins cli进行简单封装

使用bat简单封装

可以看到,以上执行cli不论是通过工具还是ssh,每次都需要带上一些固定的登陆信息,非常烦,我们可以进行一下简单的封装,这样每次只需要输入命令,不再需要每次重复输入固定内容

我们把它封装成个bat命令,命令如下

@echo off
cls
:start
set /p arg="请输入您的命令: "
java -jar jenkins-cli.jar -s http://localhost:8080 -auth @password.txt %arg%
goto start

以上命令产首先创建一个start标签,然后提示用户输入命令,输入以后传到的jenkins cli工具里,然后执行goto语句跳到start标签.以上命令会重复执行,想要终止需要按下ctrl+c来终止

使用powershell脚本进行封装

由于笔者对bat不是很熟练,因此写起复杂脚本感觉比较费劲,这里使用powershell进行一下封装,支持清屏,查看执行状态和退出选项,脚本内容如下

[System.Console]::ForegroundColor=[System.ConsoleColor]::Green
 $writeout= 
  "  退出请按1或者输入exit
  清屏请按2或者输入cls或者clear
  查看执行状态请按3
  查看帮助请输入help
  查看提示信息请按4"
  Write-Host $writeout
[System.Console]::ForegroundColor=[System.ConsoleColor]::White

while ($true) {
$myvar=Read-Host "请输入命令 "
if(($myvar -eq 1)-or($myvar -eq "exit")){break}
elseif (($myval -eq 2) -or ($myvar -eq "cls") -or($myvar -eq "clear")) {
    Clear-Host
}
elseif ($myvar -eq 3) {
    if($LASTEXITCODE -eq 0){
      Write-Host "执行成功"
    }else{
        [System.Console]::ForegroundColor=[System.ConsoleColor]::Red
        Write-Host "执行失败"
        [System.Console]::ForegroundColor=[System.ConsoleColor]::White
    }
}
elseif($myvar -eq 4){
[System.Console]::ForegroundColor=[System.ConsoleColor]::Green
Write-Host $writeout
[System.Console]::ForegroundColor=[System.ConsoleColor]::White
}
else {
   java -jar jenkins-cli.jar -s http://localhost:8080 -ssh -user tylerzhou $myvar.split(" ")
}
}

大家创建一个ps1文件,把以上内容复制进去然后按提示操作,便可以执行脚本了.

windows 没有ssh客户端的问题

有些童鞋在跟着做上面的ssh方式登陆时,可能在命令行输入ssh会提示找不到命令,这是因为只有最新版本的windows 10(不是所有的版本都有).幸运的是,Jenkins-cli.jar也提供了ssh登陆方式.我们输入以下命令

java -jar jenkins-cli.jar -s http://localhost:8080 -ssh -user tylerzhou help

通过以上方式指定ssh方式登陆,并指定-user,不需要指定端口,便可以使用ssh方式连接了.我们可以使用上面讲到的封闭方法简单的封闭一下,这样就不用每次都输入重复的,固定的内容了.