阿里云-云小站(无限量代金券发放中)
【腾讯云】云服务器、云数据库、COS、CDN、短信等热卖云产品特惠抢购

通过 CLI 管理 Jenkins Server

469次阅读
没有评论

共计 2637 个字符,预计需要花费 7 分钟才能阅读完成。

Jenkins 内置的命令行接口允许管理员通过命令行工具访问并管理 Jenkins。这让我们可以通过脚本自动化的创建配置或执行任务,也就是把 Jenkins 中的配置代码化了。Jenkins 同时支持通过 SSH 和客户端命令行工具 jenkins-cli.jar 进行访问。本文主要介绍如何通过这两种方式用命令行操作 Jenkins。说明:本文的演示环境为 Ubuntu 16.04。

通过 SSH 执行命令

在 Jenkins Server 的默认安装中,内置的 SSH service 是没有启用的:

通过 CLI 管理 Jenkins Server

我们可以通过下面的配置让 Jenkins 启用 SSH service,Jenkins ->Configure Global Security:

通过 CLI 管理 Jenkins Server

笔者选择让 Jenkins 的 SSH Server 监听 8090 端口,如果你选择的是 Random,那么监听的端口是随机产生的,无论如何,我们都可以用下面的命令来获得  Jenkins SSH Server 监听的端口号:

$ curl -Lv http://192.168.21.145:8080/login 2>&1 | grep 'X-SSH-Endpoint'

通过 CLI 管理 Jenkins Server

说明:笔者的 Jenkins Server 部署在主机 192.168.21.145 上,监听的端口号为 8080。用户至少要有 Overall/Read 权限才能访问命令行接口,但是根据执行的命令的不同还需要更高的权限。本文主要演示如何配置远程执行命令,所以演示用的用户具有全部权限。

为用户添加身份验证的秘钥
使用 SSH 的最佳方式是通过秘钥进行身份验证,这里我们把远程机器上用户的公钥添加到 Jenkins 用户 jack 的 Public Keys 列表中(Jenkins -> jack):

通过 CLI 管理 Jenkins Server

现在就可以远程调用 Jenkins Server 提供的命令了,先来问一下 “ 我是谁?”:
$ ssh -l jack -p 8090 192.168.21.145 who-am-i

通过 CLI 管理 Jenkins Server

help 命令
我们可以通过 help 命令来查看所有的可用命令:

$ ssh -l jack -p 8090 192.168.21.145 help

通过 CLI 管理 Jenkins Server

help 命令的输出很长,上图仅截取了一部分,我们还可以通过 help 命令查看其它命令的详细用法,笔者会在后面的文章中详细介绍常用命令,这里先一笔带过。

build 命令
为了演示方便,我们先来简单了解一下 build 命令,它用来触发 job 和 pipeline 的执行。下面的是用它来触发一个名称为 test 的 job,这个 job 非常简单,仅仅输出字符串 “hello”:

$ ssh -l jack -p 8090 192.168.21.145 build test -f -v

通过 CLI 管理 Jenkins Server

还不赖,任务被成功的执行了!

到此为止,我们已经可以组织自动化脚本远程操作 Jenkins Server 了。下面我们一起看看 Jenkins 提供的另外一种方式:客户端命令行工具。

客户端命令行工具

虽然基于 SSH 的 CLI 非常便捷,并且能够满足大多数需求,但是在某些情况下,与 Jenkins 一起发布的客户端 CLI 工具可能更合适。例如,客户端 CLI 工具的默认传输方式是 HTTP,这意味着不需要在防火墙中打开额外的端口来就可以使用。
通常不需要进行特殊的系统配置来启用基于 HTTP 的命令行连接。如果是在 HTTP(S) 反向代理后面运行 Jenkins,一定要确保请求和响应不会被缓存。

下载客户端命令行工具
Jenkins 自带的命令行工具是一个 Java 程序,可以通过下面的 url 下载到远程主机上:

JENKINS_URL/jnlpJars/jenkins-cli.jar

比如:

$ wget http://192.168.21.145:8080/jnlpJars/jenkins-cli.jar

注意,这是个 java 程序,要运行它需要确保你的主机上安装了 jre。

通过用户名和密码认证用户身份
下面我们用客户端工具来触发 test job,先通过用户名和密码的方式进行认证:

$ java -jar jenkins-cli.jar -s http://192.168.21.145:8080 -auth jack:123456 build test -f -v

通过 CLI 管理 Jenkins Server

虽然命令成功执行了,但使用密码毕竟太不安全。

使用 API Token
安全起见还是应该使用 API Token,先为用户 jack 生成 API Token:

通过 CLI 管理 Jenkins Server

把上面命令中的密码换成 API Token 就可以了:

$ java -jar jenkins-cli.jar -s http://192.168.21.145:8080 -auth jack:11d5ca0f9ee2dac8c47492b3e6b71c82cd build test -f -v

结果和上面是一样的。还可以把用户名和 API Token 保存到文件中,这样能进一步提高安全性:

$ echo jack:11d5ca0f9ee2dac8c47492b3e6b71c82cd > .jenkins-token

然后可以使用 @ 符以下面的方式引用:

$ java -jar jenkins-cli.jar -s http://192.168.21.145:8080 -auth @/home/nick/.jenkins-token build test -f -v

执行的结果也是一样的。注意要在 @ 后面不要用 ~ 号代替用户的家目录。

除此之外还可以通过环境变量来指定用户名和 API Token:

$ export JENKINS_USER_ID=jack
$ export JENKINS_API_TOKEN=11d5ca0f9ee2dac8c47492b3e6b71c82cd
$ java -jar jenkins-cli.jar -s http://192.168.21.145:8080 build test -f -v

效果也是一样的。

通过 SSH 进行连接
好吧,客户端命令行工具也支持通过 SSH 进行连接。同时指定 -ssh 和 -user 选项就可以了:

$ java -jar jenkins-cli.jar -s http://192.168.21.145:8080 -ssh -user jack build test -f -v

通过 CLI 管理 Jenkins Server

总结

通过 Ansible 等工具自动化的创建 Jenkins Server(参考前文《通过 Ansible 创建 Jenkins Server》),然后再通过 Jenkins 提供的 CLI 自动化的操作 Jenkins 中的配置。这样我们就打通了整个 Jenkins Server 的自动化过程(当然,笔者还会介绍如何自动化的创建运行 Jenkins Server 的宿主机)。好吧,这都只是些简单的 demo,在生产环境中要做的事情可要多的多!

参考:
Jenkins CLI

正文完
星哥玩云-微信公众号
post-qrcode
 0
星锅
版权声明:本站原创文章,由 星锅 于2022-01-21发表,共计2637字。
转载说明:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
【腾讯云】推广者专属福利,新客户无门槛领取总价值高达2860元代金券,每种代金券限量500张,先到先得。
阿里云-最新活动爆款每日限量供应
评论(没有评论)
验证码
【腾讯云】云服务器、云数据库、COS、CDN、短信等云产品特惠热卖中

星哥玩云

星哥玩云
星哥玩云
分享互联网知识
用户数
4
文章数
19350
评论数
4
阅读量
7961297
文章搜索
热门文章
星哥带你玩飞牛NAS-6:抖音视频同步工具,视频下载自动下载保存

星哥带你玩飞牛NAS-6:抖音视频同步工具,视频下载自动下载保存

星哥带你玩飞牛 NAS-6:抖音视频同步工具,视频下载自动下载保存 前言 各位玩 NAS 的朋友好,我是星哥!...
星哥带你玩飞牛NAS-3:安装飞牛NAS后的很有必要的操作

星哥带你玩飞牛NAS-3:安装飞牛NAS后的很有必要的操作

星哥带你玩飞牛 NAS-3:安装飞牛 NAS 后的很有必要的操作 前言 如果你已经有了飞牛 NAS 系统,之前...
我把用了20年的360安全卫士卸载了

我把用了20年的360安全卫士卸载了

我把用了 20 年的 360 安全卫士卸载了 是的,正如标题你看到的。 原因 偷摸安装自家的软件 莫名其妙安装...
再见zabbix!轻量级自建服务器监控神器在Linux 的完整部署指南

再见zabbix!轻量级自建服务器监控神器在Linux 的完整部署指南

再见 zabbix!轻量级自建服务器监控神器在 Linux 的完整部署指南 在日常运维中,服务器监控是绕不开的...
飞牛NAS中安装Navidrome音乐文件中文标签乱码问题解决、安装FntermX终端

飞牛NAS中安装Navidrome音乐文件中文标签乱码问题解决、安装FntermX终端

飞牛 NAS 中安装 Navidrome 音乐文件中文标签乱码问题解决、安装 FntermX 终端 问题背景 ...
阿里云CDN
阿里云CDN-提高用户访问的响应速度和成功率
随机文章
仅2MB大小!开源硬件监控工具:Win11 无缝适配,CPU、GPU、网速全维度掌控

仅2MB大小!开源硬件监控工具:Win11 无缝适配,CPU、GPU、网速全维度掌控

还在忍受动辄数百兆的“全家桶”监控软件?后台偷占资源、界面杂乱冗余,想查个 CPU 温度都要层层点选? 今天给...
在Windows系统中通过VMware安装苹果macOS15

在Windows系统中通过VMware安装苹果macOS15

在 Windows 系统中通过 VMware 安装苹果 macOS15 许多开发者和爱好者希望在 Window...
手把手教你,购买云服务器并且安装宝塔面板

手把手教你,购买云服务器并且安装宝塔面板

手把手教你,购买云服务器并且安装宝塔面板 前言 大家好,我是星哥。星哥发现很多新手刚接触服务器时,都会被“选购...
告别Notion焦虑!这款全平台开源加密笔记神器,让你的隐私真正“上锁”

告别Notion焦虑!这款全平台开源加密笔记神器,让你的隐私真正“上锁”

  告别 Notion 焦虑!这款全平台开源加密笔记神器,让你的隐私真正“上锁” 引言 在数字笔记工...
240 元左右!五盘位 NAS主机,7 代U硬解4K稳如狗,拓展性碾压同价位

240 元左右!五盘位 NAS主机,7 代U硬解4K稳如狗,拓展性碾压同价位

  240 元左右!五盘位 NAS 主机,7 代 U 硬解 4K 稳如狗,拓展性碾压同价位 在 NA...

免费图片视频管理工具让灵感库告别混乱

一言一句话
-「
手气不错
星哥带你玩飞牛NAS硬件03:五盘位+N5105+双网口的成品NAS值得入手吗

星哥带你玩飞牛NAS硬件03:五盘位+N5105+双网口的成品NAS值得入手吗

星哥带你玩飞牛 NAS 硬件 03:五盘位 +N5105+ 双网口的成品 NAS 值得入手吗 前言 大家好,我...
星哥带你玩飞牛 NAS-9:全能网盘搜索工具 13 种云盘一键搞定!

星哥带你玩飞牛 NAS-9:全能网盘搜索工具 13 种云盘一键搞定!

星哥带你玩飞牛 NAS-9:全能网盘搜索工具 13 种云盘一键搞定! 前言 作为 NAS 玩家,你是否总被这些...
240 元左右!五盘位 NAS主机,7 代U硬解4K稳如狗,拓展性碾压同价位

240 元左右!五盘位 NAS主机,7 代U硬解4K稳如狗,拓展性碾压同价位

  240 元左右!五盘位 NAS 主机,7 代 U 硬解 4K 稳如狗,拓展性碾压同价位 在 NA...
手把手教你,购买云服务器并且安装宝塔面板

手把手教你,购买云服务器并且安装宝塔面板

手把手教你,购买云服务器并且安装宝塔面板 前言 大家好,我是星哥。星哥发现很多新手刚接触服务器时,都会被“选购...
你的云服务器到底有多强?宝塔跑分告诉你

你的云服务器到底有多强?宝塔跑分告诉你

你的云服务器到底有多强?宝塔跑分告诉你 为什么要用宝塔跑分? 宝塔跑分其实就是对 CPU、内存、磁盘、IO 做...