四海网络网站建设定制,如何引导企业老板做网站,成都网站建设司,华为云建站怎么样系列文章目录
docker搭建Jenkins2.346.3版本及常用工具集成配置(ldap、maven、ansible、npm等) docker安装低版本的jenkins-2.346.3,在线安装对应版本插件失败的解决方法 文章目录 系列文章目录jenkins流水线基础1、pipeline1.1、什么是pipeline#xff1f;1.2、为什么使用pi…系列文章目录
docker搭建Jenkins2.346.3版本及常用工具集成配置(ldap、maven、ansible、npm等) docker安装低版本的jenkins-2.346.3,在线安装对应版本插件失败的解决方法 文章目录 系列文章目录jenkins流水线基础1、pipeline1.1、什么是pipeline1.2、为什么使用pipeline1.3、pipeline定义1.4、jenkinsfile1.5、声明式pipeline示例1.6、参数解读 2、声明式流水线语法2.1、pipeline语法-agent(代理)2.2、post2.3、stages(阶段)2.4、steps(步骤)2.4.1、script 2.5、指令2.5.1、environment2.5.2、options2.5.3、参数参数构建化过程配置参数如下示例:jenkinsfile中定义参数示例: 2.6、触发器(trigger)2.7、tool2.8、input2.9、when内置条件when使用示例 2.10、parallel并行 总结 jenkins流水线基础
首先,创建一个简单的流水线项目,体验并完成一条流水线项目的构建过程。如下图示
切记: 流水线的运行方式取决于定义的jenkinsfile1、pipeline
提前安装插件 Pipeline:Declarative1.1、什么是pipeline
1、pipeline是jenkins的核心功能,提供一组可扩展的工具
2、通过pipeline的DSL语法完成从简到难的交付流水线实现
3、jenkins的pipeline是通过jenkinsfile来实现的
4、这个文件可以定义jenkins的执行步骤例如:代码拉取、代码检查等1.2、为什么使用pipeline
本质上jenkins是一个自动化引擎它支持许多自动模式。流水线向Jenkins添加了一组强大的工具支持用例、简单的持续集成到全面的持续交付流水线。
通过对一系列的发布任务建立标准的模板用户可以利用更多流水线的特性比如:代码化: 流水线是在代码中实现的通常会存放到源代码控制使团队具有编辑、审查和更新他们项目的交付流水线的能力。耐用性: 流水线可以从Jenkins的master节点重启后继续运行。可暂停的: 流水线可以由人功输入或批准继续执行流水线。解决复杂发布: 支持复杂的交付流程。例如循环、并行执行。可扩展性: 支持扩展DSL和其他插件集成1.3、pipeline定义
一条流水线通过Jenkinsfile描述
安装声明式插件Pipeline: Declarative
Jenkinsfile组成指定node节点workspace指定指定运行选项指定stages阶段指定构建后操作1.4、jenkinsfile
Jenkinsfile使用两种语法进行编写分别是声明式和脚本式。
声明式和脚本式的流水线从根本上是不同的。
声明式是jenkins流水线更友好的特性。
脚本式的流水线语法提供更丰富的语法特性。
声明式流水线使编写和读取流水线代码更容易设计。声明式Pipeline: 使用agent指定运行的slave节点可以是label。
pipeline{agent anystages{// }
}
脚本式Pipleine: 使用node指定运行slave可以是label
node(slave){stage(GetCode){//}
}1.5、声明式pipeline示例
String workspace /home/vagrant/workspace //Pipeline
pipeline {agent { node { label master //指定运行节点的标签或者名称customWorkspace ${workspace} //指定运行工作目录可选}}options { timestamps() //日志会有时间skipDefaultCheckout() //删除隐式checkout scm 语句disableConcurrentBuilds() //静止并行timeout(time: 1, unit: HOURS) //流水线超时设置1h}stages { //下载代码stage(GetCode){ //阶段名称steps{ //名称timeout(time:5, unit:MINUTES){ //步骤超时时间script{ //填写运行代码println(获取代码) } } } }//构建stage(Build){ steps{timeout(time:20, unit:MINUTES){ script{ println(应用打包)}} }}//代码扫描stage(CodeScan){steps{ timeout(time:30, unit:MINUTES){ script{ print(代码扫描)} }}}} //构建后操作post {always { script{ println(always) } } success {script{currentBuild.description \n 构建成功! } }failure {script{ currentBuild.description \n 构建失败! } }aborted { script{ currentBuild.description \n 构建取消! } } }
}1.6、参数解读
Agent-Options
指定node节点/workspace指定运行选项声明式Pipeline: 使用agent指定运行的slave节点可以是label。
pipeline{agent { node { label master //指定运行节点的标签或者名称customWorkspace ${workspace} //指定运行工作目录可选}}options { timestamps() //日志会有时间skipDefaultCheckout() //删除隐式checkout scm 语句disableConcurrentBuilds() //静止并行timeout(time: 1, unit: HOURS) //流水线超时设置1h}}脚本式Pipleine 使用node指定运行slave可以是label。
node(slave){options { timestamps() //日志会有时间skipDefaultCheckout() //删除隐式checkout scm 语句disableConcurrentBuilds() //静止并行timeout(time: 1, unit: HOURS) //流水线超时设置1h}
}Stages stage定义了在整个流水线的执行任务的概念性的不同的阶段。例如 GetCode、Build、Test、Deploy、CodeScan每个阶段。 解释上述示例添加了三个阶段 GetCodeBuildCodeScan 声明式pipeline 定义stages-stage。
pipeline{agent anystages{stage(GetCode){//steps }stage(build){//step}}
}脚本式Pipeline: 直接使用stage。
node(slave){stage(GetCode){//}stage(build){//}
}step(步骤)
step是每个阶段中要执行的每个步骤。例如 在执行GetCode的时候需要判断用户提供的参数srcType的值是Git还是svn。
pipeline{
agent any
stages{stage(GetCode){steps{ sh ls //step} } }
}脚本式Pipeline 不需要step关键字。
node(slave){
stage(GetCode){//stepif(${srcType} Git){//用git方式代码检出} else if (${srcType} SVN){//用svn方式代码检出} else {error srcType is not in [Git|SVN]}
}
}Post
指定构建后操作解释 always{}总是执行脚本片段success{}成功后执行failure{}失败后执行aborted{}取消后执行 currendBuild是jenkins内部的全局变量 description构建描述
2、声明式流水线语法
2.1、pipeline语法-agent(代理)
agent指定了流水线的执行节点
参数:any 在任何可以节点上执行pipelinenone 没有指定agent的时候默认label 在指定标签的节点上执行pipelinenode 允许额外的选项
语法示例一:agent {node {label labelname}}
语法示例二:agent {label labelname}2.2、post 定义一个或多个steps,这些阶段根据流水线或阶段的完成情况而运行(取决于流水线中post部分的位置),post支持以下post-condition块其中之一:always、changed、failure、success、unstable、aborted,这些条件块允许在post部分的步骤的执行取决于流水线阶段的完成状态。always: 无论流水线或者阶段的完成状态。
changed: 只有当流水线或者阶段完成状态与之前不同时。
failure: 只有当流水线或者阶段状态为”failure”运行。
success: 只有当流水线或者阶段状态为”success”运行。
unstable: 只有当流水线或者阶段状态为”unstable”运行。例如测试失败。
aborted: 只有当流水线或者阶段状态为”aborted “运行。例如手动取消。
如下示例pipeline {
agent any
stages {stage(Example) {steps {echo Hello World}}
}
post { always { echo I will always say Hello again!}
}
}2.3、stages(阶段) 包含一系列一个或多个stage指令,建议stages至少包含一个stage指令用于连续交付过程的每个离散部分,比如:构建、测试、部署等pipeline {agent anystages { stage(Example) {steps {echo Hello World}}}
}2.4、steps(步骤)
每个阶段要执行的步骤pipeline {agent anystages {stage(Example) {steps { echo Hello World}}}
}2.4.1、script script 步骤需要 [scripted-pipeline]块并在声明式流水线中执行。对于大多数用例来说,应该声明式流水线中的“脚本”步骤是不必要的但是它可以提供一个有用的”逃生出口”。非平凡的规模和/或复杂性的script块应该被转移到 共享库 。pipeline {agent anystages {stage(Example) {steps {echo Hello Worldscript {def browsers [chrome, firefox]for (int i 0; i browsers.size(); i) {echo Testing the ${browsers[i]} browser}}}}}
}2.5、指令
2.5.1、environment environment 指令指定一个键值对序列,也称为环境变量,该序列将被定义为所有步骤的环境变量,或者是特定于阶段的步骤,这取决于 environment 指令在流水线内的位置。该指令支持一个特殊的方法 credentials() ,该方法可用于在Jenkins环境中通过标识符访问预定义的凭证。对于类型为 “Secret Text”的凭证, credentials() 将确保指定的环境变量包含秘密文本内容。对于类型为 “SStandard username and password”的凭证, 指定的环境变量指定为 username:password 并且两个额外的环境变量将被自动定义 :分别为 MYVARNAME_USR 和 MYVARNAME_PSW 。pipeline {agent anyenvironment { CC clang}stages {stage(Example) {environment { AN_ACCESS_KEY credentials(my-prefined-secret-text) }steps {sh printenv}}}
}2.5.2、options options 指令允许从流水线内部配置特定于流水线的选项。 流水线提供了许多这样的选项, 比如buildDiscarder,但也可以由插件提供, 比如 timestamps。buildDiscarder: 为最近的流水线运行的特定数量保存组件和控制台输出。disableConcurrentBuilds: 不允许同时执行流水线。 可被用来防止同时访问共享资源等。overrideIndexTriggers: 允许覆盖分支索引触发器的默认处理。skipDefaultCheckout: 在agent 指令中跳过从源代码控制中检出代码的默认情况。skipStagesAfterUnstable: 一旦构建状态变得UNSTABLE跳过该阶段。checkoutToSubdirectory: 在工作空间的子目录中自动地执行源代码控制检出。timeout: 设置流水线运行的超时时间, 在此之后Jenkins将中止流水线。retry: 在失败时, 重新尝试整个流水线的指定次数。timestamps: 预测所有由流水线生成的控制台输出与该流水线发出的时间一致。//指定一个小时的全局执行超时, 在此之后Jenkins将中止流水线运行。
pipeline {
agent any
options {timeout(time: 1, unit: HOURS)
}
stages {stage(Example) {steps {echo Hello World}}
}
}2.5.3、参数 如上图所示,再上述位置配置的参数其实都可以再Jenkinsfile中定义实现
为流水线运行时设置项目相关的参数,参数定义的两种方法1、参数可以在这个参数化构建过程中定义,然后再Jenkinsfile中调用2、参数也可以再jenkinsfile中定义并使用参数参数构建化过程配置参数如下示例: jenkinsfile中定义参数示例: 值得注意的是,当保存后再构建页面中是看不到新添加的参数,只有执行一次构建过程后,该页面才会有新添加的参数,如下所示 2.6、触发器(trigger)
定时去做某件事情时可以考虑使用,如下示例cron 计划任务定期执行构建。 triggers { cron(H */4 * * 1-5) }pollSCM 与cron定义类似但是由jenkins定期检测源码变化。 triggers { pollSCM(H */4 * * 1-5) }upstream 接受逗号分隔的工作字符串和阈值。 当字符串中的任何作业以最小阈值结束时流水线被重新触发。 triggers { upstream(upstreamProjects: job1,job2, threshold: hudson.model.Result.SUCCESS) }pipeline {
agent any
triggers {cron(H */4 * * 1-5)
}2.7、tool 获取通过自动安装或手动放置工具的环境变量。支持maven/jdk/gradle。工具的名称必须在系统设置-全局工具配置中定义。使用示例如下: 在jenkinsfile中使用全局工具maven2.8、input
input用户在执行各个阶段的时候由人工确认是否继续进行。比较常用message 呈现给用户的提示信息。id 可选默认为stage名称。ok 默认表单上的ok文本。submitter 可选的,以逗号分隔的用户列表或允许提交的外部组名。默认允许任何用户。submitterParameter 环境变量的可选名称。如果存在用submitter 名称设置。parameters 提示提交者提供的一个可选的参数列表。如下示例:1、使用流水线语法生成一个示例input2、将生成的input粘贴至pipeline3、执行构建,查看是否有提示2.9、when when 指令允许流水线根据给定的条件决定是否应该执行阶段。 when 指令必须包含至少一个条件。 如果when 指令包含多个条件, 所有的子条件必须返回True阶段才能执行。 这与子条件在 allOf 条件下嵌套的情况相同。内置条件 branch: 当正在构建的分支与模式给定的分支匹配时执行这个阶段,这只适用于多分支流水线例如: when { branch master }environment: 当指定的环境变量是给定的值时执行这个步骤,例如: when { environment name: DEPLOY_TO, value: production }expression 当指定的Groovy表达式评估为true时执行这个阶段, 例如: when { expression { return params.DEBUG_BUILD } }not 当嵌套条件是错误时执行这个阶段,必须包含一个条件例如: when { not { branch master } }allOf 当所有的嵌套条件都正确时执行这个阶段,必须包含至少一个条件例如: when { allOf { branch master; environment name: DEPLOY_TO, value: production } }anyOf 当至少有一个嵌套条件为真时执行这个阶段,必须包含至少一个条件例如: when { anyOf { branch master; branch staging } }when使用示例
当参数test的值是123456时执行下载代码操作,即GetCode动作2.10、parallel并行 声明式流水线的阶段可以在他们内部声明多个嵌套阶段, 它们将并行执行。 注意一个阶段必须只有一个 steps 或 parallel的阶段。 嵌套阶段本身不能包含 进一步的 parallel 阶段, 但是其他的阶段的行为与任何其他 stageparallel的阶段不能包含 agent 或 tools阶段, 因为他们没有相关 steps。另外, 通过添加 failFast true 到包含parallel的 stage中 当其中一个进程失败时你可以强制所有的 parallel 阶段都被终止如下示例:因为打包和扫描时间较长,将这两个操作添加到并行操作总结
本篇文章主要针对常用的声明式Jenkinsfile流水线脚本的参数和框架做出了一个示例及简单的解释,因为平常接触和编写最多的就是声明式的流水线脚本。加油,开始练习写声明式流水线脚本吧,光看不练假把式~~~
