Jenkins Pipeline 脚本优化实践：从繁琐到简洁

引言

在持续集成的过程中，Jenkins Pipeline 是非常关键的一环。它定义了如何自动编译、测试和部署代码。随着项目的不断发展，Pipeline 的复杂性也在不断上升，这就需要我们持续优化 Pipeline 脚本，以提高代码的可读性和维护性。本文将介绍一次从繁琐Pipeline脚本到精简Pipeline脚本的转化过程，以及这种转化所带来的好处。

原始的 Pipeline 脚本:

image.png
注： loader其实已经废弃了

pipeline {agent { label  "build01" }stages {stage("GetCode"){agent { label  "build01" }steps{script{println("下载代码 --> 分支： ${env.branchName}")checkout([$class: 'GitSCM', branches: [[name: "${env.branchName}"]],doGenerateSubmoduleConfigurations: false,extensions: [[$class: 'CloneOption', depth: 1, noTags: false, reference: '', shallow: true]],submoduleCfg: [],userRemoteConfigs: [[credentialsId: 'xxxxx',url: "${env.gitHttpURL}"]]])}}}    stage('docker build dataloader-game-ucenter') {agent { label  "build01" }when {environment name: 'dataloader', value: 'true'}steps {sh ''' cd dataloaderdocker build  --build-arg NODE_ENV=game-ucenter  -t swr.cn-north-4.myhuaweicloud.com/master-metaspace/dataloader-game-ucenter:$data .'''withCredentials([usernamePassword(credentialsId: 'hw-registry', passwordVariable: 'dockerPassword', usernameVariable: 'dockerUser')]) {sh "docker login -u ${dockerUser} -p ${dockerPassword} swr.cn-north-4.myhuaweicloud.com"sh "docker push swr.cn-north-4.myhuaweicloud.com/master-metaspace/dataloader-game-ucenter:$data"}}}stage('docker build datawriter-game-ucenter') {agent { label  "build01" }when {environment name: 'datawriter', value: 'true'}steps {sh ''' cd datawriter-game-ucenterdocker build  --build-arg NODE_ENV=game-ucenter  -t swr.cn-north-4.myhuaweicloud.com/master-metaspace/datawriter-game-ucenter:$data .'''withCredentials([usernamePassword(credentialsId: 'hw-registry', passwordVariable: 'dockerPassword', usernameVariable: 'dockerUser')]) {sh "docker login -u ${dockerUser} -p ${dockerPassword} swr.cn-north-4.myhuaweicloud.com"sh "docker push swr.cn-north-4.myhuaweicloud.com/master-metaspace/datawriter-game-ucenter:$data"}}}   stage('docker build game-ucenter') {agent { label  "build01" }when {environment name: 'game-ucenter', value: 'true'}steps {sh ''' cd game-ucenterdocker build  --build-arg NODE_ENV=game-ucenter  -t swr.cn-north-4.myhuaweicloud.com/master-metaspace/game-ucenter:$data .'''withCredentials([usernamePassword(credentialsId: 'hw-registry', passwordVariable: 'dockerPassword', usernameVariable: 'dockerUser')]) {sh "docker login -u ${dockerUser} -p ${dockerPassword} swr.cn-north-4.myhuaweicloud.com"sh "docker push swr.cn-north-4.myhuaweicloud.com/master-metaspace/game-ucenter:$data"}}}              stage('develop') {parallel {stage("develop datawriter-game-ucenter") {when {environment name: 'datawriter-game-ucenter', value: 'true'}agent { label  "huaweiyun-xx" }steps {sh "sed -e 's/{data}/$data/g' /home/jenkins/workspace/yaml/master-metaspace/datawriter-game-ucenter.tpl > /home/jenkins/workspace/yaml/master-metaspace/datawriter-game-ucenter.yaml"sh "sudo kubectl apply -f /home/jenkins/workspace/yaml/master-metaspace/datawriter-game-ucenter.yaml --namespace=master-metaspace --context=master"}}stage("develop dataloader-game-ucenter") {when {environment name: 'dataloader', value: 'true'}agent { label  "huaweiyun-xx" }steps {sh "sed -e 's/{data}/$data/g' /home/jenkins/workspace/yaml/master-metaspace/dataloader-game-ucenter.tpl > /home/jenkins/workspace/yaml/master-metaspace/dataloader-game-ucenter.yaml"sh "sudo kubectl apply -f /home/jenkins/workspace/yaml/master-metaspace/dataloader-game-ucenter.yaml --namespace=master-metaspace --context=master"}}stage("develop game-ucenter") {when {environment name: 'game-ucenter', value: 'true'}agent { label  "huaweiyun-xx" }steps {sh "sed -e 's/{data}/$data/g' /home/jenkins/workspace/yaml/master-metaspace/game-ucenter.tpl > /home/jenkins/workspace/yaml/master-metaspace/game-ucenter.yaml"sh "sudo kubectl apply -f /home/jenkins/workspace/yaml/master-metaspace/game-ucenter.yaml --namespace=master-metaspace --context=master"}}                                  }}}
}

在优化之前，我们的 Jenkins Pipeline 脚本中包含了多个独立定义的 stage，每个 stage 中都有重复的结构和指令：

  1. 明确指定了 agent。
  2. 在每个 stage 的 steps 中，都使用了类似的脚本来操作 git、构建 docker 镜像和部署到 Kubernetes。
  3. 使用了冗长的 shell 脚本来绑定变量和执行部署。

这种写法虽然直观，但存在以下问题：

  • 代码冗余：相同的任务（例如构建与部署）重复编写了多次。
  • 低效的修改：一旦需要调整构建或部署流程，需要同时修改多个类似的代码段。
  • 可读性差：过于细碎的脚本内容使得新成员阅读和理解这个 Pipeline 变得困难。

转化的原因与过程

简化 agent 的声明

pipeline {agent none // Use none at the top level, each stage will define its own agent.}

在原始脚本中，每个 stage 都重复指定相同的 agent，这是不必要的。转化后，我们在 pipeline 的顶层使用 agent none 声明，表示不在这一层级指定执行者，这样各个 stage 就可以根据需求独立地声明自己的 agent。

将环境变量统一管理

我们创建一个 environment 部分来集中定义环境变量，简化了变量的管理，并且当需要修改时只要在一个地方进行调整即可。

    environment {REGISTRY = "swr.cn-north-4.myhuaweicloud.com/master-metaspace"KUBE_CONFIG = "--namespace=master-metaspace --context=master"KUBE_YAML_PATH = "/home/jenkins/workspace/yaml/master-metaspace"// Assume that 'data' is defined elsewhere or injected as a parameter.}

使用共用方法减少代码重复

对于 Docker 镜像的构建和推送操作，每个应用几乎执行相同的步骤。我们提取了一个方法 buildAndPushDockerImage 来代替在每个 stage 里重复定义的步骤，这样不但减小了脚本体积，也提升了代码的复用性。

def buildAndPushDockerImage(String imageName, String tag) {sh "cd $imageName && docker build --build-arg NODE_ENV=$imageName -t $REGISTRY/$imageName:$tag ."withCredentials([usernamePassword(credentialsId: 'hw-registry', passwordVariable: 'dockerPassword', usernameVariable: 'dockerUser')]) {sh "docker login -u $dockerUser -p $dockerPassword $REGISTRY"sh "docker push $REGISTRY/$imageName:$tag"}
}

同理，部署到 Kubernetes 的指令也被提取到了 deployToKubernetes 方法中，进一步去重。

def deployToKubernetes(String kubernetesComponent) {String templateFile = "${KUBE_YAML_PATH}/${kubernetesComponent}.tpl"String outputFile = "${KUBE_YAML_PATH}/${kubernetesComponent}.yaml"sh "sed -e 's/{data}/$data/g' $templateFile > $outputFile"sh "sudo kubectl apply -f $outputFile $KUBE_CONFIG"
}

结构的并行化

将 Docker 构建步骤组合为一个并行执行的 stage，这样不仅可以缩短整个流水线的执行时间，还可以使得结构更加清晰。

        stage("Docker Builds") {parallel {stage('Build dataloader-game-ucenter') {agent { label "build01" }when { environment name: 'dataloader', value: 'true' }steps {buildAndPushDockerImage("dataloader-game-ucenter", env.data, env.BASE_WORKSPACE)}}stage('Build datawriter-game-ucenter') {agent { label "build01" }when { environment name: 'datawriter', value: 'true' }steps {buildAndPushDockerImage("datawriter-game-ucenter", env.data, env.BASE_WORKSPACE)}}stage('Build game-ucenter') {agent { label "build01" }when { environment name: 'game-ucenter', value: 'true' }steps {buildAndPushDockerImage("game-ucenter", env.data, env.BASE_WORKSPACE)}}}}

转化后的好处

转换后的pipeline如下：

pipeline {agent none // Use none at the top level, each stage will define its own agent.environment {REGISTRY = "swr.cn-north-4.myhuaweicloud.com/master-metaspace"KUBE_CONFIG = "--namespace=master-metaspace --context=master"KUBE_YAML_PATH = "/home/jenkins/workspace/yaml/master-metaspace"// Assume that 'data' is defined elsewhere or injected as a parameter.BASE_WORKSPACE = "xxxxxxx" // 定义一个基础工作空间路径}stages {stage("GetCode") {agent { label "build01" }steps {script {checkout scm: [$class: 'GitSCM',branches: [[name: env.branchName]],extensions: [[$class: 'CloneOption', depth: 1, noTags: false, shallow: true]],userRemoteConfigs: [[credentialsId: 'xxxx', url: env.gitHttpURL]]]}}}stage("Docker Builds") {parallel {stage('Build dataloader-game-ucenter') {agent { label "build01" }when { environment name: 'dataloader', value: 'true' }steps {buildAndPushDockerImage("dataloader-game-ucenter", env.data, env.BASE_WORKSPACE)}}stage('Build datawriter-game-ucenter') {agent { label "build01" }when { environment name: 'datawriter', value: 'true' }steps {buildAndPushDockerImage("datawriter-game-ucenter", env.data, env.BASE_WORKSPACE)}}stage('Build game-ucenter') {agent { label "build01" }when { environment name: 'game-ucenter', value: 'true' }steps {buildAndPushDockerImage("game-ucenter", env.data, env.BASE_WORKSPACE)}}}}stage('Development Deployment') {parallel {stage("Deploy datawriter-game-ucenter") {when { environment name: 'datawriter-game-ucenter', value: 'true' }agent { label  "huaweiyun-xx" }steps {deployToKubernetes("datawriter-game-ucenter")}}stage("Deploy dataloader-game-ucenter") {when { environment name: 'dataloader', value: 'true' }agent { label  "huaweiyun-xx" }steps {deployToKubernetes("dataloader-game-ucenter")}}stage("Deploy game-ucenter") {when { environment name: 'game-ucenter', value: 'true' }agent { label  "huaweiyun-xx" }steps {deployToKubernetes("game-ucenter")}}}}}
}// Define methods outside pipeline to avoid repetitiondef buildAndPushDockerImage(String imageName, String tag, String workspacePath) {sh "cd ${workspacePath} && echo 'Current directory: \$(pwd)'" // 使用基础工作空间变量sh "cd ${workspacePath}/${imageName}&& docker build --build-arg NODE_ENV=$imageName -t $REGISTRY/$imageName:$tag ."withCredentials([usernamePassword(credentialsId: 'hw-registry', passwordVariable: 'dockerPassword', usernameVariable: 'dockerUser')]) {sh "docker login -u $dockerUser -p $dockerPassword $REGISTRY"sh "docker push $REGISTRY/$imageName:$tag"}
}def deployToKubernetes(String kubernetesComponent) {String templateFile = "${KUBE_YAML_PATH}/${kubernetesComponent}.tpl"String outputFile = "${KUBE_YAML_PATH}/${kubernetesComponent}.yaml"sh "sed -e 's/{data}/$data/g' $templateFile > $outputFile"sh "sudo kubectl apply -f $outputFile $KUBE_CONFIG"
}
  • 代码结构清晰：每个阶段的职责更加明确，整个 Pipeline 结构变得简单易懂。
  • 维护成本降低：通用操作被封装成方法，避免了重复代码，当流程需要修改时，只需在一个地方更新。
  • 执行效率提升：使用 parallel 来并行构建 Docker 镜像降低了整体构建时间。
  • 可扩展性增加：如果将来要增加新的镜像构建或者 Kubernetes 部署，只需很少的修改即可。

总结来说，通过优化 Jenkins Pipeline 脚本，我们不仅提高了流程的效率，还大大减小了维护成本。在持续集成和持续部署的实践中，拥有一个简洁和高效的 Pipeline 是至关重要的。

特意强调的

environment 添加了BASE_WORKSPACE，why？
在Jenkins中，当你在一个Pipeline中使用并行步骤执行作业时，默认情况下，每个并行的分支都会创建一个新的工作空间目录，格式一般为workspace@2、workspace@3等，这样做是为了避免各个分支之间产生文件系统上的冲突。
这样带来的后果就是：
image.png
构建过程中就会出现No such file or directory这样的报错：
image.png
所以这里引入了BASE_WORKSPACE

    environment {REGISTRY = "swr.cn-north-4.myhuaweicloud.com/master-metaspace"KUBE_CONFIG = "--namespace=master-metaspace --context=master"KUBE_YAML_PATH = "/home/jenkins/workspace/yaml/master-metaspace"// Assume that 'data' is defined elsewhere or injected as a parameter.BASE_WORKSPACE = "/home/jenkins2/workspace/test6" // 定义一个基础工作空间路径}

build过程中引入了:

sh "cd ${workspacePath} && echo 'Current directory: \$(pwd)'"

确保并行步骤中引用到正确的工作空间目录!

注： 以上脚本代码转换后的pipeline使用chatgpt生成，并多次修订！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/225777.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Python如何匹配库的版本

Python如何匹配库的版本

目录 1. 匹配库的版本 2. Python中pip，库，编译环境的问题回答总结 2.1 虚拟环境 2.2 pip，安装库，版本 1. 匹配库的版本 （别的库的版本冲突同理） 在搭建pyansys环境的时候，安装grpcio-tools…
阅读更多...
3、APScheduler: 详解Trigger种类和用法【Python3测试任务管理总结】

3、APScheduler: 详解Trigger种类和用法【Python3测试任务管理总结】

APScheduler提供了多种类型的触发器（Trigger），每种触发器适用于不同的任务调度需求。 触发器包含调度逻辑。每个作业都有其自己的触发器，该触发器确定作业应该在何时运行下一次。除了它们的初始配置之外，触发器是完全无状态的。 常见的触发器及其用法 1. SimpleTrigger…
阅读更多...
【基础篇】1.4 IO分配（二）

【基础篇】1.4 IO分配（二）

1.7 ADC ADC外设指的是模拟数字转换器（Analog-to-Digital Converter，简称ADC）的硬件设备。ADC是一种将模拟信号转换为数字信号的电子设备，广泛应用于各种数字信号处理系统中。 ADC外设通常作为一个独立的集成电路芯片&#xff0…
阅读更多...
springboot(ssm宠物美容机构CRM系统 宠物服务商城系统Java系统

springboot(ssm宠物美容机构CRM系统 宠物服务商城系统Java系统

springboot(ssm宠物美容机构CRM系统 客户关系管理系统Java系统 开发语言：Java 框架：ssm/springboot vue JDK版本：JDK1.8（或11） 服务器：tomcat 数据库：mysql 5.7（或8.0&#xff…
阅读更多...
uniapp和vue如何使用SheetJS导出excel？

uniapp和vue如何使用SheetJS导出excel？

uniapp和vue如何使用SheetJS导出excel？ SheetJS中文文档详解 一、SheetJS是什么 SheetJS是一款适用于浏览器和Node.js的开源电子表格解析库。 与其他电子表格解析库相比，SheetJS拥有强大的电子表格解析功能，即使电子表格很大，也可…
阅读更多...
Transformer注意力机制模型介绍

Transformer注意力机制模型介绍

文章目录 前言高层次的自我关注(Self-Attention at a High Level)编码器(Encoder)多头注意力机制(The Beast With Many Heads)残差神经网络解码器(Decoder)线性(Linear)层和softmax层位置编码总结参考文献前言 Transformer是一个利用注意力机制来提高模型训练速度的模型。关于…
阅读更多...
RT-DETR优化：轻量化卷积设计 | DualConv双卷积魔改RT-DETR结构

RT-DETR优化：轻量化卷积设计 | DualConv双卷积魔改RT-DETR结构

🚀🚀🚀本文改进： DualConv双卷积魔改v8结构，达到轻量化的同时并能够实现小幅涨点 🚀🚀🚀RT-DETR改进创新专栏：http://t.csdnimg.cn/vuQTz 学姐带你学习YOLOv8，从入门到创新，轻轻松松搞定科研； RT-DETR模型创新优化，涨点技巧分享，科研小助手； 1.DualC…
阅读更多...
软件测试经典面试题（答案解析+视频讲解）

软件测试经典面试题（答案解析+视频讲解）

前言 （第一个就刷掉一大批人） 有很多“会自动化”的同学来咨询技术问题，他总会问到我一些元素定位的问题。元素定位其实都不算自动化面试的问题。 一般我都会问：你是定位不到吗？通常结果都是说确实定位不到。 做自…
阅读更多...
真正可行的vue3迁移到nuxt3方法（本人亲测，完全避坑）

真正可行的vue3迁移到nuxt3方法（本人亲测，完全避坑）

终于到了总结经验的时候了，这绝对是全网唯一、完全真正可行的干货。 在我看来，知识就是要拿来分享的，分享给他人也是在提高自己。我绝对不会搞什么订阅或者vip专栏来搞钱坑害各位， 因为我在csdn写文章最主要的目的是为了记录和总…
阅读更多...
OpenJDK十几种发行版中强烈推荐的发行版：Adoptium Eclipse Temurin和Amazon Corretto

OpenJDK十几种发行版中强烈推荐的发行版：Adoptium Eclipse Temurin和Amazon Corretto

Adoptium Eclipse Temurin官网地址：Home | Adoptium 支持及维护它的厂家： 说明：它的前身是著名的AdoptOpenJDK，更新到jdk16后就停止更新了，因为AdoptOpenJDK移交给Eclipse基金会后改名为：Adoptium Eclipse…
阅读更多...
【开题报告】基于SpringBoot的煤炭企业安全宣传学习平台的设计与实现

【开题报告】基于SpringBoot的煤炭企业安全宣传学习平台的设计与实现

1.选题背景 煤炭企业作为我国能源行业的重要组成部分，承担着国民经济的支撑和推动作用。然而，煤炭生产过程中存在较高的安全风险，煤矿事故频发，给人员生命财产安全带来严重威胁，也给社会稳定和经济发展带来不利影响。…
阅读更多...
多线程 (下) - 学习笔记

多线程 (下) - 学习笔记

常见锁策略 乐观锁和悲观锁 悲观锁 总是假设最坏的情况, 每次去拿数据的时候都会认为会被别人修改, 因此会上锁, 防止数据在使用过程中被别的线程修改, 乐观锁 假设数据一般情况下不会产生并发冲突,因此在拿数据,操作数据的过程中不加锁, 而在数据进行提交更新的时候, 才会正…
阅读更多...
LeetCode day24

LeetCode day24

LeetCode day24 今天主打一个快乐happy(▽ʃ♡ƪ)，主要是今天写哈夫曼树被经典文件读取坑麻了（为啥绝对路径能读取，相对不行。罢了） 一个中等题，但是咋感觉很小学捏。。。 2177. 找到和为给定整数的三个连续整数 相…
阅读更多...
C与C++编程语言的区别和联系

C与C++编程语言的区别和联系

一、引言 C和C是两种广泛使用的编程语言，它们都在软件开发领域有着广泛的应用。虽然C是从C语言演化而来的，但两者之间存在一些重要的区别和联系。本文将详细介绍这两种编程语言的相同点和不同点，并通过实际例子进行说明。 二、C与C的相同点 …
阅读更多...
RocketMq常见问题

RocketMq常见问题

如何保证消息不丢失? 产生丢失消息的节点主要有以下几点 生产者发到brokerbroker把消息从缓存写入磁盘breker同步到从节点消费者消费消息消息积压太多, 会删除历史消息, 这里不会校验消息有没有消费 解决: 生产者同步发送消息, 如果发送失败, 写重试逻辑, 如果重试多次还失…
阅读更多...
机器学习笔记 - 了解学习率对神经网络性能的影响

机器学习笔记 - 了解学习率对神经网络性能的影响

一、简述 深度学习神经网络使用随机梯度下降优化算法进行训练。学习率是一个超参数，它控制每次更新模型权重时响应估计误差而改变模型的程度。学习率值太小可能会导致训练过程过长并可能陷入困境，而值太大可能会导致过快地学习次优权重或训练过程不稳定。 配置神经网络时，学…
阅读更多...
基于Java SSM框架实现抗疫医疗用品销售系统项目【项目源码+论文说明】

基于Java SSM框架实现抗疫医疗用品销售系统项目【项目源码+论文说明】

基于java的SSM框架实现抗疫医疗用品销售系统演示 摘要 随着科学技术的飞速发展，社会的方方面面、各行各业都在努力与现代的先进技术接轨，通过科技手段来提高自身的优势，抗疫医疗用品销售平台当然也不能排除在外。抗疫医疗用品销售平台是以实…
阅读更多...
微服务黑马头条（简略笔记）

微服务黑马头条（简略笔记）

Linux中nacos的拉取安装 拉取naocs镜像：docker pull nacos/nacos-server:1.2.0创建容器：docker run --env MODEstandalone --name nacos --restartalways -d -p 8848:8848 nacos/nacos-server:1.2.0访问地址：http://192.168.200.130:8848/n…
阅读更多...
【MySQL】之联合索引与最左匹配原则

【MySQL】之联合索引与最左匹配原则

前言： 最左匹配原则在我们 MySQL 开发过程中和面试过程中经常遇到，为了加深印象和理解，我在这里把 MySQL 的最左匹配原则详细的讲解一下，包括它的原理以及是否导致索引失效的场景。 在讲解 MySQL 的最左匹配原则之前，…
阅读更多...
管理类联考——逻辑——真题篇——按知识分类——综合推理

管理类联考——逻辑——真题篇——按知识分类——综合推理

文章目录 2023真题（2023-29）-数量关系模型真题（2023-31-32）-综合推理-匹配-数量假言匹配模型-数量假言模型：题干数量加假言，数量关系优先算；假言命题做串联，易出矛盾和二难。真题（2023-37-38）-综合推理-数量假言匹配模型-数量假言模型：题干数量加假言，数量关系优先…
阅读更多...
最新文章

Copyright @ 2022~2023