“Jenkins是一个独立的开源软件项目,是基于Java开发的一种持续集成工具,用于监控持续重复的工作,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。前身是Hudson是一个可扩展的持续集成引擎。可用于自动化各种任务,如构建,测试和部署软件。”
以上是官方的介绍,专业术语较多,理解起来可能有点费劲,举个栗子:我刚开始在线上部署代码的时候用的是最笨的手动部署方法,费时又费力,还容易出错,后来使用svn进行部署,方便了不少,但是功能有限,操作也不是这么便捷,再来看jenkins,当我们提交更新的代码到github或者gitlab等平台的时候,jenkins能够自动将代码同步到服务器,并且能够自动运行各种指令,比如构建go服务,真的是做到了一步到位,当然,前提是jenkins与项目的关联配置需要做好,重要的是它有图形操作界面,说是项目自动化神器也不为过。
那么接下来,我们来学习一下jenkins的安装以及使用。
安装
这里环境是centos7,首先需要安装好java环境,然后通过 .war 包安装jenkins十分方便(war是java的web项目打包而成),去官网就可以下载 https://jenkins.io/download/
选择最下面的war包进行下载,我将其放在 /usr/local/jenkins
目录下
然后进到目录运行这个指令 java -jar jenkins.war
就能够启动jenkins了,简单得令人发指,以下就是启动界面,等待少许时间即可
然后在浏览器中访问 http://主机ip:8080 会出现如下界面,复制页面上的路径,执行 vim /root/.jenkins/secrets/initialAdminPassword
复制密码到页面上进行管理员认证一下即可
然后到选择安装插件界面,一般选择'安装推荐的插件',这里可能会遇到jenkins离线的问题,我从网上找的方法,修改升级站点url然后重启还是会显示jenkins离线的界面,所以我索性跳过插件安装,先完善后续的账号信息,然后手动添加插件成功了,关于插件,也是使用jenkins必须要了解的一个知识
这就是安装好之后的插件界面,路径为 系统管理 -> 插件管理 ,到此,jenkins的安装算是初步完成了,接下来就是如何使用了,不过在使用之前建议先熟悉下各个界面和常用插件
使用jenkins
准备
这里我使用jenkins自动构建部署go项目的服务,如下图所示,这是一个基于go语言的项目
运行go项目的基础指令是 go run main.go
,这里我将构建go服务的指令写成脚本 start.sh
,需要重新构建的时候直接运行下 ./start.sh
脚本即可,如果没有jenkins,一旦代码有更新,那么正常的流程就是到这个项目目录下 git pull
拉取最新的代码,然后手动运行start脚本运行程序
使用jenkins的话,只要在本地提交代码,jenkins就会自动帮我们到服务器上拉取最新的代码,并且自动执行start脚本运行程序,方便了很多
这里重点介绍一下 start.sh
脚本,这是脚本中的指令:
#!/bin/sh
#go build -a -o file_pool_ser main.go
kill -9 $(pidof /var/go/src/file_pool_service/file_pool_ser)
nohup /var/go/src/file_pool_service/file_pool_ser -c /var/go/src/file_pool_service/conf/conf.yaml > /var/go/src/file_pool_service/sys.log 2>&1 &
-
kill -9 $(pidof /var/gowww/src/file_pool_service/file_pool_ser)
用于在构建新的进程之前删除旧的正在运行的进程,file_pool_ser
是构建go程序的时候生成的二进制文件,在服务器中运行的就是这个构建的二进制文件 -
go build -a -o file_pool_ser main.go
就是构建这个go项目的指令,生成二进制文件file_pool_ser
,这个过程放在jenkins中执行,所以start脚本中不运行这个指令 - 最后那句指令是运行
file_pool_ser
,即在后台运行此项目,相关日志输出到同目录下的sys.log
文件中,这就是运行一个go程序所执行的步骤
配置jenkins
准备好相关项目文件之后,接下来就要在jenkins中配置使之自动构建了
来到jenkins首页,新建一个任务,输入任务名称,然后选择第一个 '构建一个自由风格的软件'
接下来就是配置项目了,首先是常规配置,这里填写描述信息,然后选择 '丢弃旧的构建' ,因为jenkins每次构建都会产生构建的项目包和历史记录,如果一直保留的话会占用更多的磁盘空间,所以这里要做过期处理,数值可以自己根据真实环境来设置
然后是 '源码管理' ,现在的公司基本上都是采用git对项目进行版本控制以及源码管理的,比较有名的就是github和gitlab了,这里我使用github,公司内部的话建议自搭建gitlab环境
首先我们选择git这个选项,填写项目的Git地址,然后点击下面的添加按钮添加凭证,这里选择账号密码的类型,填写自己git的账号跟密码,最后设置服务器上项目需要从github上check out的地址
构建触发器就选择当github有代码提交时构建
构建环境默认,直接到构建选项增加步骤 '执行shell',输入下面的指令,即在项目目录中构建go项目的可执行文件,设置一些文件的权限,然后运行 start.sh 执行脚本即可,这部分上面已经介绍过了,最后点击保存就配置好了
cd /var/gowww/src/file_pool_api
go build -a -o file_pool_api main.go
sudo chmod +x /var/gowww/src/file_pool_api/file_pool_api
sudo chmod +x /var/gowww/src/file_pool_api/start.sh
sudo /var/gowww/src/file_pool_api/start.sh
echo "OK"
注意
完成以上步骤之后会发现,本地提交代码到github之后jenkins并没有自动构建,然后我手动点击 '立即构建' 按钮之后项目就开始构建了,这是因为jenkins跟github并没有建立通知关系,也就是说github更新代码之后没有通知jenkins我代码更新了,需要开始构建了
所以,我们还缺少了建立通知关系的配置,先到github界面,进入到访问token设置界面,勾选hook(钩子)相关的权限即可
然后还是在github上,进入到需要通知构建的项目中,进入设置,配置一下 'webhook' 地址,意味着github将会通知到jenkins的这个地址上
上面的这个jenkins webhook地址需要回到jenkins中设置,进入到 '系统设置' ,往下来找到github插件的配置,点击红圈处没展开前有一个高级按钮,勾选下面的 '为github指定另一个Hook URL' ,将会自动生成webhook的地址
结果
到此为止,所有的设置工作都做完了,现在我们来验证一下,我在项目 main.go
中打印一个测试字符串,并提交代码
fmt.Println("test jenkins!!")
提交成功之后回到jenkins界面,会发现项目已经开始在构建了,蓝色的表示构建成功,红色的表示构建失败,我们可以点击这些构建历史查看控制台输出的信息,控制台将会输出失败或者成功的日志,方便我们排查错误
最后查看服务上的项目日志,发现成功打印出了代码中的字符串,那就恭喜你,使用jenkins自动更新并构建项目成功了!
结语
本文过了一遍jenkins的安装以及基本用法,但jenkins的很多知识还没有涵盖,大家多多实践,多多查阅资料,感受自动化构建项目的乐趣