jenkins流水线（jenkinsfile）详解，保姆式教程

悠悠 2023-09-28 19:42 36阅读 0赞

## jenkins流水线（jenkinsfile）详解 ##

> 在学习本篇文章的时候，可以去看看jenkins官网的文档，jenkins官网支持中文，观看十分便捷
> 
> 此教程使用的是gitee+docker+jenkins的部署方式，gitlab与github异曲同工，还有就是我目前写jenkins的教程已经更新了两期，关于插件啥的安装都不多详细的讲解了，但用到的旧知识点我也会简单讲解一下，新的知识点我也都会讲到，只是需要pipeline代码的小伙伴，直接拉到教程的最后
> 
> [jenkins使用docker安装保姆级教程（面向小白教程，最新最全，全图文）2022-8-1，不会docker也没关系][jenkins_docker_2022-8-1_docker]
> 
> [使用jenkins+gitee创建docker镜像并运行][jenkins_gitee_docker]

![在这里插入图片描述][98c55e1ee528425a93322a9d89cf081f.png]

## 新建一个任务，选择流水线 ##

![在这里插入图片描述][494d059021db4750bc72e101470a91c3.png]

可以看见啊，比起自由风格的软件项目，这个项目是非常的简单

## webhook钩子（使用git工具时执行相应步骤，比如说拉取，推送，会触发钩子函数，jenkins接收到钩子然后开始执行打包部署等工作，这里不配置也是可以的，如果是新手，可以看看我之前的教程，从基础学起） ##

我在之前的教程中已经详细的讲解了，这里都不多加赘述了

![在这里插入图片描述][1b49c3c17ae04e60a5e9649d1e36f1f3.png]

配置一个密码

![在这里插入图片描述][f44a875efd53482c8d4c15cbba76b6de.png]

在gitee中连接

## 写pipeline ##

![在这里插入图片描述][7be7665c93484269a116b1d47497c815.png]

### 然后我从最基础的讲起 ###

#### 首先选择wello world，不是说只能选这个，就是我需要一步一步讲所以选个最原始的 ####

![在这里插入图片描述][8583974de57443c9856b21196efc9896.png]

#### 讲解一下这个hello world ####

pipeline {
        agent any  	
    
        stages {
            stage('Hello') {
                steps {
                    echo 'Hello World'
                }
            }
            // 这里的hello2 是我加的，就是说明，这是stages下的第二个任务 ,就是在pipeline中加单行注释 用 // 就行
            stage('Hello2') {
                steps {
                    echo 'Hello World'
                }
            }
        }
    }

> `pipeline` 定义一个流水线脚本
> 
> `agent`指示 Jenkins 为整个流水线分配一个执行器（在 Jenkins 环境中的任何可用代理/节点上）和工作区。
> 
> `stages` 全部的工作都在这里执行
> 
> `stage` 每个工作开始
> 
> `steps` jenkinsfile 声明式脚本往这里面写
> 
> `echo` 写一个简单的字符串到控制台输出。

#### 保存测试一下（保存以后点立即构建） ####

![在这里插入图片描述][5eea687a4ff04516aa43e9b62b999dd5.png]

#### 我们来看一下日志，以后我都不放图片了，这里只是给新来的朋友说明一下在哪看日志 ####

![在这里插入图片描述][63a59307633b4e839877e341887b907d.png]

> 在下面我们可以看见执行了两个 hello world ，这就是我们执行脚本得到的结果

![在这里插入图片描述][4cd46e844fa549f5812d38466ed2538a.png]

#### 返回项目点击配置 ####

![在这里插入图片描述][3c285d5e07bd41df8fbd8c6686a9679b.png]

### 开始使用pipeline ###

#### 首先我们要了解一下，我们的项目要经历几个步骤，1、从git中拉取；2、maven打包；3、docker生成镜像并运行，好了，我们了解到普通的项目只需要这几个步骤，我们就来规划一下pipeline代码部分 ####

pipeline {
        agent any
        stages {
            stage('拉取代码') {
                steps {
                    echo '拉取成功'
                }
            }
            stage('执行构建') {
                steps {
                    echo '构建完成'
                }
            }
            stage('把jar包构建为docker镜像并运行') {
                steps {
                    echo '运行成功'
                }
            }
        }
    }

#### 连接到git ####

##### 使用jenkins自带的脚本生成器 #####

![在这里插入图片描述][f221a4cfbd9c4a0ebaaecaf606c6827b.png]

##### 到了片段生成器 #####

###### 首先我们需要从git中拉取，就选git ######

![在这里插入图片描述][1a3ba5a3fbac40bfb4ec481b12654c7b.png]

###### 连接git ######

![在这里插入图片描述][517f9b40814341d89b3c6a423faf9268.png]

##### 复制粘贴（自己去测试一下有用没有，如果你不是用的docker镜像，并且报错，原因：1、压根没连接上，去看看你账号密码和git链接到底连的通不；2、没用docker安装jenkins，缺少了git环境，使用`yum -y install git`安装；3、我也想不出来了，自己去搜搜） #####

pipeline {
        agent any
        stages {
            stage('拉取代码') {
                steps {
                    git credentialsId: '93f024b8-6456-4c98-a131-9a5ee9f42027', url: 'https://gitee.com/i-dont-recognize-you/school-page.git'
                    echo '拉取成功'
                }
            }
            
            stage('执行构建') {
                steps {
                    echo '构建完成'
                }
            }
            
            stage('把jar包构建为docker镜像并运行') {
                steps {
                    echo '运行成功'
                }
            }
        }
    }

### 连接maven ###

#### 全局工具配置里面配置maven，之前教程讲了的，我就不详细讲了 ####

![在这里插入图片描述][11bfae2e5ab04392b88fff7f33b57e95.png]

#### maven需要引用使用`tools`就行，注意不要直接cope运行，看看代码中的注解，而且git是我的，你也跑不通 ####

pipeline {
        agent any
    	// 看这里，导入maven，名字就是在全局工作配置中配置了的
        tools{
            maven 'maven_3.8.4'
        }
        stages {
            stage('拉取代码') {
                steps {
                    git credentialsId: '93f024b8-6456-4c98-a131-9a5ee9f42027', url: 'https://gitee.com/i-dont-recognize-you/school-page.git'
                    echo '拉取成功'
                }
            }
            
            stage('执行构建') {
                steps {
                // 看这里哈，先运行一下maven版本，看看maven是否配置好了， sh 是指 执行shell脚本
                    sh "mvn --version"
                // 如果maven可以运行，那么执行以下代码，这里需要注意一下，pom.xml文件是否在你创建的任务目录下
                //  sh "mvn clean package"
                    echo '构建完成'
                }
            }
            
            stage('把jar包构建为docker镜像并运行') {
                steps {
                    echo '运行成功'
                }
            }
        }
    }

#### 如果打印了maven的版本信息，但打包报错看看是否pom.xml文件是否在test2（这是我取的任务名，至于名字为啥不是Demo，我爱咋取咋取，管的着吗）的目录下，我这个就是在任务目录下的，所以方向执行`sh "mvn clean package"`就行如果还有多一层目录才有pom.xml，那你举一反三啊，在使用`sh "mvn clean package"`命令打包之前执行`sh "cd 目录"`不就可以了 ####

[root@instance-3806mxkl ~]# cd /data/jenkins_home/workspace/test2
    [root@instance-3806mxkl test2]# ls
    Dockerfile  LICENSE  pom.xml  src  target

### 使用docker本地打包（完整代码），这里没什么讲事，就是执行了上个教程的shell脚本，之前的教程中我有关于这个shell脚本完整的讲解 ###

pipeline {
        agent any
    
        tools{
            maven 'maven_3.8.4'
        }
        stages {
            stage('拉取代码') {
                steps {
                    git credentialsId: '93f024b8-6456-4c98-a131-9a5ee9f42027', url: 'https://gitee.com/i-dont-recognize-you/school-page.git'
                    echo '拉取成功'
                }
            }
            
            stage('执行构建') {
                steps {
                //    sh "mvn --version"
                    sh "mvn clean package"
                    echo '构建完成'
                }
            }
            
            stage('把jar包构建为docker镜像并运行') {
                steps {
                    sh '''#!/bin/bash
                            # 服务名称
                            SERVER_NAME=test2
                            
                            # 源jar名称，mvn打包之后，target目录下的jar包名称
                            JAR_NAME= "School-0.0.1-SNAPSHOT"
                            
                            # jenkins下的目录
                            JENKINS_HOME= "/var/jenkins_home/workspace/test2"
                            
                            # 等待三秒
                            echo sleep 3s
                            sleep 1
                            echo sleep 2s
                            sleep 1
                            echo sleep 1s
                            sleep 1
                                  
                            echo "结束进程完成"
                            
                            # JENKINS_HOME
                            cd /var/jenkins_home/workspace/test2/target
                            
                            # JENKINS_HOME
                            cp /var/jenkins_home/workspace/test2/Dockerfile /var/jenkins_home/workspace/test2/target
                            
                            # 修改文件权限  JAR_NAME
                            chmod 755 School-0.0.1-SNAPSHOT.jar
                            
                            echo "看看docker能不能用"
                            docker -v
                            
                            echo "停止容器"
                            # 停止容器
                            docker stop test2
                            
                            echo "删除容器"
                            # 删除容器
                            docker rm test2
                            echo "删除镜像"
                            # 删除镜像
                            docker rmi test2
                            echo "打包镜像"
                            # 打包镜像
                            docker build -t test2 -f Dockerfile .
                            echo "运行镜像"
                            # 运行镜像
                            docker run -d -p 9999:9600 --name test2 test2
                    '''
                    echo '运行成功'
                }
            }
        }
    }

### 通过ssh在其他服务器上打包（这里因为小编只需要在本机中运行使用小编没有测试，但流程就是这么个流程） ###

#### 下载Publish over SSH插件，在体统配置中配置ssh连接，拉到最下面 ####

![在这里插入图片描述][395d3ea0a2f04dc2914b2d7a94682b53.png]

![在这里插入图片描述][c71b5ceae8ce453d80c4fd4d5c6b682c.png]

![在这里插入图片描述][41a5b71821214ed1b6da4d3eda4f080f.png]

![在这里插入图片描述][52836ada63bf4421b09721157d661cfd.png]

#### 点击保存 ####

#### 在代码生成器上选择这个 ####

![在这里插入图片描述][48ae337dd324479ab89befad30cb871a.png]

#### 传jar包 ####

![在这里插入图片描述][592355cea4d94c9bba4b1f140b67652c.png]

#### 传dockerfile ####

![在这里插入图片描述][cfc23be852ea4291aa096c27ec1ee2b6.png]

#### 传Dockerfile文件，并执行shell脚本 ####

![在这里插入图片描述][270d38562ea148ceb27a09c329522c6e.png]

#### 点击生成脚本，放在之前打包那就行，比如 ####

## 下载Blue Ocean插件，会得到这样的图标 ##

![在这里插入图片描述][f7eb7a3853ad4ca6ac7759b5fc107f8a.png]

### 点击这个图标后会得到一个崭新的UI页面，以后的流水线工作就可以在这里面操作 ###

![在这里插入图片描述][da06c4bea6be441b98c410faef4ebf96.png]

## 完整代码（我可能以后要翻着看，所以放在最后） ##

## 8月12日新增 通过 Pipline script from SCM 执行 Jenkinsfile ##

### 配置参数化构建过程（字符参数） ###

![在这里插入图片描述][cc778a24cb7c415da09fcd18909248b7.png]

#### 效果是这样（这样打包镜像的时候可以根据版本号和项目名做变动） ####

![在这里插入图片描述][85d44ddf7c714538bc9620d26f2fef12.png]

### 流水线这里像这样 ###

![在这里插入图片描述][8c881a802e9e40d08131978f09f21e3f.png]

### 在项目中添加Jenkinsfile文件 ###

![在这里插入图片描述][294691346fb5479983af5732bd29221f.png]  
这个代码和上面的大同小异，就是我简化了一下，加上了字符参数

pipeline {
        agent any
    
        tools{
            maven 'maven_3.8.4'
        }
        stages {
            stage('拉取代码') {
                steps {
                  git credentialsId: '93f024b8-6456-4c98-a131-9a5ee9f42027', url: 'https://gitee.com/i-dont-recognize-you/school-page.git'
                    echo '拉取成功'
                }
            }
            
            stage('执行构建') {
                steps {
                //    sh "mvn --version"
                  sh "mvn clean package"
                    echo '构建完成'
                }
            }
            
            stage('把jar包构建为docker镜像并运行') {
                steps {
                    sh '''#!/bin/bash
                            
                            # 源jar名称，mvn打包之后，target目录下的jar包名称
                            JAR_NAME=School*
                            
                            # jenkins下的目录
                            JENKINS_HOME=/var/jenkins_home/workspace/test2
                            
                            
                            cd $JENKINS_HOME/target
                            
                            cp $JENKINS_HOME/Dockerfile $JENKINS_HOME/target
                            
                            # 修改文件权限  JAR_NAME
                            chmod 755 $JAR_NAME.jar
                            
                            
                            echo "停止容器"
                            docker stop $test2
                            
                            echo "删除容器"
                            docker rm $test2
                            
                            echo "删除镜像"
                            docker rmi $test2
                            
                            echo "打包镜像"
                            docker build -t $test2:$tag .
                            
                            echo "运行镜像"
                            docker run -d -p 9999:9600 --name $test2 $test2:$tag
                    '''
                    echo '运行成功'
                }
            }
        }
    }

### 之前的教程 ###

[CICD与DevOps][CICD_DevOps]

[jenkins使用docker安装保姆级教程（面向小白教程，最新最全，全图文）2022-8-1，不会docker也没关系][jenkins_docker_2022-8-1_docker]

[使用jenkins+gitee创建docker镜像并运行][jenkins_gitee_docker]

### 我的学习途径 ###

[27-使用pipeline自动打包Docker镜像\_哔哩哔哩\_bilibili][27-_pipeline_Docker_bilibili]

[DevOps最新教程2022版 目前最好的DevOps课程][DevOps_2022_ _DevOps]

[jenkins中文文档][jenkins]

[jenkins_docker_2022-8-1_docker]: https://blog.csdn.net/qq_57581439/article/details/126112953
[jenkins_gitee_docker]: https://blog.csdn.net/qq_57581439/article/details/126132268
[98c55e1ee528425a93322a9d89cf081f.png]: https://img-blog.csdnimg.cn/98c55e1ee528425a93322a9d89cf081f.png
[494d059021db4750bc72e101470a91c3.png]: https://img-blog.csdnimg.cn/494d059021db4750bc72e101470a91c3.png
[1b49c3c17ae04e60a5e9649d1e36f1f3.png]: https://img-blog.csdnimg.cn/1b49c3c17ae04e60a5e9649d1e36f1f3.png
[f44a875efd53482c8d4c15cbba76b6de.png]: https://img-blog.csdnimg.cn/f44a875efd53482c8d4c15cbba76b6de.png
[7be7665c93484269a116b1d47497c815.png]: https://img-blog.csdnimg.cn/7be7665c93484269a116b1d47497c815.png
[8583974de57443c9856b21196efc9896.png]: https://img-blog.csdnimg.cn/8583974de57443c9856b21196efc9896.png
[5eea687a4ff04516aa43e9b62b999dd5.png]: https://img-blog.csdnimg.cn/5eea687a4ff04516aa43e9b62b999dd5.png
[63a59307633b4e839877e341887b907d.png]: https://img-blog.csdnimg.cn/63a59307633b4e839877e341887b907d.png
[4cd46e844fa549f5812d38466ed2538a.png]: https://img-blog.csdnimg.cn/4cd46e844fa549f5812d38466ed2538a.png
[3c285d5e07bd41df8fbd8c6686a9679b.png]: https://img-blog.csdnimg.cn/3c285d5e07bd41df8fbd8c6686a9679b.png
[f221a4cfbd9c4a0ebaaecaf606c6827b.png]: https://img-blog.csdnimg.cn/f221a4cfbd9c4a0ebaaecaf606c6827b.png
[1a3ba5a3fbac40bfb4ec481b12654c7b.png]: https://img-blog.csdnimg.cn/1a3ba5a3fbac40bfb4ec481b12654c7b.png
[517f9b40814341d89b3c6a423faf9268.png]: https://img-blog.csdnimg.cn/517f9b40814341d89b3c6a423faf9268.png
[11bfae2e5ab04392b88fff7f33b57e95.png]: https://img-blog.csdnimg.cn/11bfae2e5ab04392b88fff7f33b57e95.png
[395d3ea0a2f04dc2914b2d7a94682b53.png]: https://img-blog.csdnimg.cn/395d3ea0a2f04dc2914b2d7a94682b53.png
[c71b5ceae8ce453d80c4fd4d5c6b682c.png]: https://img-blog.csdnimg.cn/c71b5ceae8ce453d80c4fd4d5c6b682c.png
[41a5b71821214ed1b6da4d3eda4f080f.png]: https://img-blog.csdnimg.cn/41a5b71821214ed1b6da4d3eda4f080f.png
[52836ada63bf4421b09721157d661cfd.png]: https://img-blog.csdnimg.cn/52836ada63bf4421b09721157d661cfd.png
[48ae337dd324479ab89befad30cb871a.png]: https://img-blog.csdnimg.cn/48ae337dd324479ab89befad30cb871a.png
[592355cea4d94c9bba4b1f140b67652c.png]: https://img-blog.csdnimg.cn/592355cea4d94c9bba4b1f140b67652c.png
[cfc23be852ea4291aa096c27ec1ee2b6.png]: https://img-blog.csdnimg.cn/cfc23be852ea4291aa096c27ec1ee2b6.png
[270d38562ea148ceb27a09c329522c6e.png]: https://img-blog.csdnimg.cn/270d38562ea148ceb27a09c329522c6e.png
[f7eb7a3853ad4ca6ac7759b5fc107f8a.png]: https://img-blog.csdnimg.cn/f7eb7a3853ad4ca6ac7759b5fc107f8a.png
[da06c4bea6be441b98c410faef4ebf96.png]: https://img-blog.csdnimg.cn/da06c4bea6be441b98c410faef4ebf96.png
[cc778a24cb7c415da09fcd18909248b7.png]: https://img-blog.csdnimg.cn/cc778a24cb7c415da09fcd18909248b7.png
[85d44ddf7c714538bc9620d26f2fef12.png]: https://img-blog.csdnimg.cn/85d44ddf7c714538bc9620d26f2fef12.png
[8c881a802e9e40d08131978f09f21e3f.png]: https://img-blog.csdnimg.cn/8c881a802e9e40d08131978f09f21e3f.png
[294691346fb5479983af5732bd29221f.png]: https://img-blog.csdnimg.cn/294691346fb5479983af5732bd29221f.png
[CICD_DevOps]: https://blog.csdn.net/qq_57581439/article/details/126281832?spm=1001.2014.3001.5502
[27-_pipeline_Docker_bilibili]: https://www.bilibili.com/video/BV1bS4y1471A?p=27&vd_source=09be6f84d15366f03d0a38fb8aee890f
[DevOps_2022_ _DevOps]: https://www.bilibili.com/video/BV1Pt4y1H7Zq?p=45&spm_id_from=pageDriver&vd_source=09be6f84d15366f03d0a38fb8aee890f
[jenkins]: https://www.jenkins.io/zh/doc/book/pipeline/getting-started/