jenkins自动部署

柔情只为你懂 2022-02-28 01:36 445阅读 0赞

## 1、前言 ##

根据官网介绍：

> `What is Jenkins?`  
>   Jenkins is a self-contained, open source automation server which can be used to automate all sorts of tasks related to building, testing, and delivering or deploying software.  
>   Jenkins can be installed through native system packages, Docker, or even run standalone by any machine with a Java Runtime Environment (JRE) installed.

翻译：

> `什么是Jenkins？`  
>   Jenkins是一个完备的、开源的自动化服务，用于自动化与构建、测试、交付或部署软件相关的各种任务。  
>   Jenkins能通过系统包和docker安装、甚至在任何安装了jre的系统中独立运行。

因为Jenkins是java写的，所以就是与平台无关，但是具体部署脚本跟系统有关。最重要的是Jenkins的广泛应用，问题解决比较容易和生态比较完整，可以有很多参考和插件可以用。

系统环境：

*  tomcat 9.0
 *  jdk 1.8
 *  Jenkins 2.164.1

note：这个安装过程某些阶段需要科学上网

## 2、安装 ##

### 2.1、下载war包 ###

[https://jenkins.io/][https_jenkins.io]，点击download，下载`Generic Java package (.war)`下载最新war包即可。

### 2.2、启动Jenkins及初始化 ###

将`jenkins.war`放入tomcat的webapps文件夹下即可，接着使用tomcat的bin目录下startup.bat（windows下用这个）或者 [startup.sh][]（linux下用这个），启动tomcat，运行了Jenkins，访问\[[http://127.0.0.1:8080/jenkins/][http_127.0.0.1_8080_jenkins]\]  
([http://127.0.0.1:8080/jenkins/][http_127.0.0.1_8080_jenkins])，看看如果长时间是这样子：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70]  
最好用tomcat的bin目录下shutdown.bat或者shutdown.sh停止tomcat，再startup一下。  
在我启动过程中还遇到提示说缓存不足，cmd在tomcat的bin目录下使用如下命令：

.\startup.bat JAVA_OPTS="-server -XX:PermSize=64M -XX:MaxPermSize=128m"

更改jvm的Perm区的内存大小

`下面路径必须先启动一次Jenkins，再去找才会出现，不用`  
找到用户文件夹（C:\\Users\\用户名.jenkins）下的hudson.model.UpdateCenter.xml，修改插件的更新地址为:[https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json][https_mirrors.tuna.tsinghua.edu.cn_jenkins_updates_update-center.json]  
这个是国内源，翻墙的话可能遇到No such plugin: cloudbees-folder这个错误。

进入后会如下界面提示输入初始密码：

![hhh][]  
按照提示找到这个文件，复制里面的文本进入密码框，或者在tomcat控制日志输出中找到对应提示即可。  
接着选择安装插件：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 1]  
其实选择默认插件即可，进去后再选择需要的插件安装即可。  
安装过程不太顺利，这个是墙的问题，你们自己想办法补全吧，我已经换了国内源了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 2]  
接着输入管理员的账户名和密码，里面的额邮箱必填，不然过不了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 3]  
这里默认即可，点保存并完成。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 4]

### 2.3、添加插件及添加服务器信息 ###

#### 2.3.1、添加插件 ####

在主页面中找到系统管理->插件管理->可选插件的右上角搜索下面的插件名，勾选并点直接安装。

*  Git Parameter
 *  Active Choices Plug-in
 *  Publish Over SSH

#### 2.3.2、添加服务器信息 ####

由于添加了Publish Over SSH，在系统管理->系统设置菜单在底部的Publish over SSH分类中找到SSH Servers，点新增，添加新的ssh service  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 5]  
暂时添加了两个service，用户后面讲解  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 6]

## 3、新建工程 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 7]  
输入项目名，选择自由项目类型，点确定  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 8]

## 4、填写部署配置 ##

这里配置有个问题存在，就是`不能动态推送到正式服和测试服`。虽然配置的时候配置了动态的，能打包出正式包和测试的包，但是服务器实际上早就写死了，有列进去就会推送过去。这章完结后给出一个解决方法。

### 4.1、配置项 ###

过程：

1.  `源码管理：`填写git远程仓库的url(github、gitlab、gitee这些仓库的url)和使用git用户
2.  `参数化构建过程：`设置部署前的选择项(这里包含git分支、打包的执行的gradle的task任务)
3.  `构建：`Jenkins执行gradle的打包task
4.  `构建后操作：`选择服务器(可多个)，通过ssh将打包后的文件传输到服务器，执行重启脚本

### 4.2、配置前的准备 ###

*  添加要上传的服务器信息
    
     *  这个在本文章`2.3.2、添加服务器信息`已经讲解
 *  一个git远程仓库url，私密仓库则添加Credentials(用户凭证)
    
     *  这个填写的时候录入即可
 *  给项目添加gradle wrapper能力
    
     *  把wrapper文件夹下的文件也提交的git远程仓库即可
 *  spring boot的正式测试的打包脚本
    
     *  这里找我的博客[gradle打包spring boot的测试、正式war、jar包][gradle_spring boot_war_jar] 参照即可，里面给出了两个思路
 *  上传后的停止脚本和启动脚本
    
     *  停止脚本使用shell脚本来停止、启动脚本使用java -jar xxx.jar即可，既然都要写shell脚本，最后打算合并成重启脚本

重启脚本restart-jar.sh：

#!/bin/bash
    
    EC_PID=`jps -v |grep "ec-1.0.jar"|awk '{print $1}'`
    
    if [ $EC_PID ]
    then
        kill -15 $EC_PID
        echo "kill -15 $EC_PID"
    else
        echo "没有spring boot项目启动"
    fi
    
    nohup java -jar /data/ec-1.0.jar > /data/ec-1.0.out 2>&1 &

### 4.3、配置项 ###

#### 4.3.1、参数化构建过程 ####

点击添加参数按钮，选择相应的项。

git parameter参数：填写name，供后面作为变量；选择parameter type，git选择菜单显示什么内容；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 9]  
Activie Choices Parameter参数：填写name，供后面作为变量；选择Groovy Script，填写Groovy Script文本框为`return ['Dev','Prod']`，提供这个参数的选项值；选择Choice Type，选择恰当的显示控件。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 10]

#### 4.3.2、源码管理 ####

本文选择git，在Repository URL填入git远程仓库url，由于是私有仓库，在Credentials选择新增项，Branch Specifier (blank for ‘any’) 填入前面的git parameter的name，即$\{branch\}，作为动态参数check out分支。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 11]  
添加账户密码界面：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 12]

#### 4.3.3、构建tab ####

点击增加构建步骤

Invoke Gradle script参数：  
准备工作已经提了添加wrapper，所以这里是按照wrapper方式执行gradle脚本的。  
选择Use Gradle Wrapper，在子文本框Tasks，填入boot$\{packType\}Jar，这里的额task是自己写的，所以你去本文准备哪里看资料，使用动态参数填充自定义task名字。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 13]

#### 4.3.4、构建后操作tab ####

点增加构架后操作步骤  
选择Send build artifaces over SSH，再点add server。

*  name选择设置里面添加的ssh server
 *  Source files填写相对于当前workspace的相对路径
 *  Remove prefix填写要去除的目录前缀，不去除的画，会接在Remote directory之后
 *  Remote directory填写远程服务去的防止文件的路径
 *  Exec command填写需要执行的命令，这里执行自己编写的重启shell脚本

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 14]  
我这里选中/data目录作为防止目录，先设置好权限，命令才能正确执行，比如我这里用了`chmod 774 /data`改变目录权限

#### 4.3.5、效果及输出 ####

效果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 15]  
分别请求接口：  
![在这里插入图片描述][20190420195457982.png]  
![在这里插入图片描述][20190420195515979.png]

都能请求，但是同一份jar包，这里上传的是正式的jar包，测试的jar上传上去，肯定是找不到相关配置而启动失败

## 5、相关问题 ##

### 5.1、动态部署测试服和正式服 ###

我找了一下，没有动态改变jenkins server配置项目的东西，最后用了gradle的task来实现这个选择服务器的功能。  
同时也变相，将jenkins变为一个界面似的都在task实现了大部分功能，除了源码的管理。

添加ssh插件请查看[gradle打包spring boot的测试、正式war、jar包][gradle_spring boot_war_jar]的第五小节。

添加ssh插件和编写推送脚本后，改动配置文件：

*  增加服务器配置或者只区分正式测试两种情况的选择
 *  更改构建tab的gradle的task任务
 *  去除增加构建后操作步骤【因为service的信息在task已经定义好了】

#### 5.1.1、参数化构建过程–更改 ####

使用Active Choices Plug-in插件功能，增加关联项配置：  
Activie Choices Reactive Parameter参数：填写name参数名，选择Groovy Script，填写Groovy Script文本框为

if(packType.equals("Dev")){
        return ["false"]
    }else if(packType.equals("Prod")){
        return ["true"]
    }

提供这个参数的选项值；选择Choice Type，选择恰当的显示控件，同时填写Referenced parameters，关联上一级参数，`达到动态改变当前参数`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 16]

#### 5.1.2、构建tab–更改 ####

更改tasks为`boot${packType}Jar putJar -PisRelease=${isRelease}`，这里有两个参数，都是上面动态化构建时的提供的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 17]

#### 5.1.3、增加构建后操作步骤–更改 ####

由于gradle的task已经存在服务器信息，并动态发布，说以这个步骤直接删除，把配置单service删去即可。

#### 5.1.4、效果 ####

![在这里插入图片描述][20190427130310107.gif]

参考博客：  
[An error occurred during installation: No such plugin: cloudbees-folder][An error occurred during installation_ No such plugin_ cloudbees-folder]  
[HTML ASCII 参考手册][HTML ASCII]  
[jenkins插件下载镜像加速][jenkins]  
[jenkins-参数化构建(三)插件：Git Parameter][jenkins-_Git Parameter]  
[运行中的java程序怎么停止。。][java]  
[每天一个linux命令（42）：kill命令][linux_42_kill]

[https_jenkins.io]: https://jenkins.io/
[startup.sh]: http://startup.sh
[http_127.0.0.1_8080_jenkins]: http://127.0.0.1:8080/jenkins/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70]: /images/20220228/edf81badd76c4087856e04fa211c5bbc.png
[https_mirrors.tuna.tsinghua.edu.cn_jenkins_updates_update-center.json]: https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json
[hhh]: /images/20220228/fc3bfd8e7f8c4232bfa866a6e0a868a6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 1]: /images/20220228/45f26dd9050d4389a94ff7a82b8f4b02.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 2]: /images/20220228/a060f71a5e6447faaef0fb5e4746eac3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 3]: /images/20220228/dd0fce91f6b24a34bbf25bc608232ae7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 4]: /images/20220228/53e4ecd27e9c461e8264e2863de27a1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 5]: /images/20220228/3928e6abb06349368530b12c76c75690.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 6]: /images/20220228/485ad09731ae49158872136d9cae18a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 7]: /images/20220228/3643508f6a8946a484196e7308b8a41b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 8]: /images/20220228/0f01b89e1d5b46d2b21bb51c093a7dd9.png
[gradle_spring boot_war_jar]: https://blog.csdn.net/qq_26819733/article/details/87924124
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 9]: /images/20220228/d1aaae3cde084651a79caa11bcc8fe11.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 10]: /images/20220228/afa28e118c724818be169c4fdbd68b96.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 11]: /images/20220228/e55f6efbb13543c5948996b682390775.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 12]: /images/20220228/2409f5213f434a018187120463c194a5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 13]: /images/20220228/49c70e271c494735b534e6b7a1bcbf13.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 14]: /images/20220228/7fbe6ba2cbc3496f9cf5990194294d06.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 15]: /images/20220228/ec0bff6bae0a40b1b642e0ee35388d86.png
[20190420195457982.png]: /images/20220228/4f374a249ade4879ab1545d8f619b797.png
[20190420195515979.png]: /images/20220228/4da97b9ae03b430ab96622a9f329da69.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 16]: /images/20220228/c2e58394ea314f0c9563ca612001aecf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI2ODE5NzMz_size_16_color_FFFFFF_t_70 17]: /images/20220228/86313261a3b948ed9a147614fc42c3ce.png
[20190427130310107.gif]: /images/20220228/1969dcfddd5340bbb8db8c8ba94ff268.png
[An error occurred during installation_ No such plugin_ cloudbees-folder]: https://www.cnblogs.com/sea-stream/p/9637363.html
[HTML ASCII]: http://www.w3school.com.cn/tags/html_ref_ascii.asp
[jenkins]: https://blog.csdn.net/you227/article/details/81076032
[jenkins-_Git Parameter]: https://www.cnblogs.com/zhaojingyu/p/9862443.html
[java]: https://ask.csdn.net/questions/358132
[linux_42_kill]: http://www.cnblogs.com/peida/archive/2012/12/20/2825837.html