Jenkins基础：Jenkinsfile使用实例：1:环境与Stage使用

随着Jenkins2的推广&＃xff0c;Jenkinsfile的使用愈加地广泛&＃xff0c;这篇文章介绍一下Jenkinsfile最基础的Stage的使用示例。

Jenkinsfile的实践场景&＃xff1a;
在DevOps实践中&＃xff0c;经常会提及的一个概念是是“IaaS”&＃xff0c;我们进行持续集成和部署&＃xff0c;最终的实现很有可能是Jenkins上的一个Job&＃xff0c;有可能是FreeStyle的和有可能是其他形式的&＃xff0c;通过插件或其他方式我们打通了Jenkins和其他组件&＃xff0c;可以使得用户在Jenkins上通过使用Gitlab拉取分支代码&＃xff0c;使用Maven进行构建&＃xff0c;将结果上传至二进制私库Nexus上&＃xff0c;使用SonarQube进行代码扫描&＃xff0c;通过Docker进行镜像生成&＃xff0c;将镜像推送至Harbor镜像私库上&＃xff0c;使用Ansible进行服务部署等常见操作。
而这些操作大部分都是共通的&＃xff0c;而不同的大多是这些组件工具的URL和用户名/密码或者Token有所不同&＃xff0c;而Jenkins的打通过程&＃xff0c;传统方式往往以手工方式为主&＃xff0c;持续集成和持续交付本身是为了带来效率的&＃xff0c;这个打通的过程自身一旦稳定往往并不像应用程序变更那样频繁&＃xff0c;但是作为软件开发生命周期不可获取的一个环节&＃xff0c;这些流水线手工设定的过程也应该以代码的形式保存起来&＃xff0c;这样才能保证持续集成环境的一致性和可扩展性。而Jenkinsfile就是将持续集成和持续交付流水线以代码形式进行保存的一种方式。

示例

本文示例&＃xff1a;
将流水线分按照功能分为逻辑上的三段&＃xff1a;构建(Build) 、测试(Test)、部署(Deploy)&＃xff0c;顺序如下所示。

环境准备

环境准备

这里使用Easypack的Jenkins 2.176.1来创建验证用的Jenkins环境。使用如下步骤即可完成。

事前准备

事前准备docker和docker-compose&＃xff0c;版本要求如下所示&＃xff1a;

• Docker&＃xff1a; >&＃61; 1.13.1
• docker-compose: >&＃61; 1.13

liumiaocn:~ liumiao$ docker version
Client:
Version:18.03.1-ce
API version: 1.37
Go version:go1.9.5
Git commit:9ee9f40
Built: Thu Apr 26 07:13:02 2018
OS/Arch:darwin/amd64
Experimental: false
Orchestrator: swarm
Server:
Engine:
Version:18.03.1-ce
API version: 1.37 (minimum version 1.12)
Go version:go1.9.5
Git commit:9ee9f40
Built: Thu Apr 26 07:22:38 2018
OS/Arch:linux/amd64
Experimental: true
liumiaocn:~ liumiao$
liumiaocn:~ liumiao$ docker-compose --version
docker-compose version 1.21.1, build 5a3f1a3
liumiaocn:~ liumiao$


启动Jenkins

使用Easypack中准备好的LTS的Jenkins镜像&＃xff0c;启动Jenkins。

• git clone

命令&＃xff1a;git clone https://github.com/liumiaocn/easypack.git

• 启动服务

命令&＃xff1a;
cd easypack/containers/alpine/jenkins
docker-compose up -d

• 使用的docker-compose配置文件

liumiaocn:jenkins liumiao$ cat docker-compose.yml
version: &＃39;2&＃39;
services:
# jenkins service based on Jenkins LTS version
jenkins:
image: liumiaocn/jenkins:2.176.1
ports:
- "32002:8080"
- "50000:50000"
environment:
- JENKINS_ADMIN_ID&＃61;root
- JENKINS_ADMIN_PW&＃61;liumiaocn
- JENKINS_MODE&＃61;master
volumes:
- ./data/:/data/jenkins
restart: "no"
liumiaocn:jenkins liumiao$


• 执行日志

liumiaocn:jenkins liumiao$ docker-compose up -d
Creating network "jenkins_default" with the default driver
Creating jenkins_jenkins_1 ... done
liumiaocn:jenkins liumiao$ docker-compose ps
NameCommandState Ports
--------------------------------------------------------------------------------------------------------------
jenkins_jenkins_1/bin/tini -- /usr/local/bi ...Up0.0.0.0:50000->50000/tcp, 0.0.0.0:32002->8080/tcp
liumiaocn:jenkins liumiao$


获取Jenkins-Crumb

使用如下示例代码获取Jenkins-Crumb,为使用API方式生成三个Stage的Pipeline示例作准备。

liumiaocn:jenkins liumiao$ jenkins_host_url&＃61;http://localhost:32002
liumiaocn:jenkins liumiao$ user_passwd&＃61;"root:liumiaocn"
liumiaocn:jenkins liumiao$ jenkins_crumb&＃61;&＃96;curl -u $user_passwd ${
jenkins_host_url}&＃39;/crumbIssuer/api/xml?xpath&＃61;concat(//crumbRequestField,":",//crumb)&＃39; 2>/dev/null&＃96;
liumiaocn:jenkins liumiao$ echo $jenkins_crumb
Jenkins-Crumb:83d748ee92512c4dccd589aaa5c55a9a
liumiaocn:jenkins liumiao$


创建Job

使用如下代码示例创建Job

liumiaocn:jenkins liumiao$ ls demo/pipeline/stage/config.xml
demo/pipeline/stage/config.xml
liumiaocn:jenkins liumiao$ cat demo/pipeline/stage/config.xml





Pipeline Job Sample
false








false


false

liumiaocn:jenkins liumiao$ curl -X POST -u $user_passwd -H ${jenkins_crumb} -H "Content-Type:application/xml" --data-binary "&＃64;demo/pipeline/stage/config.xml" ${jenkins_host_url}/createItem?name&＃61;pipeline_job_noparam
liumiaocn:jenkins liumiao$ echo $?
0
liumiaocn:jenkins liumiao$


Jenkinsfile说明

本文示例所使用的Jenkinsfile信息如下所示&＃xff0c;内容非常简单易读&＃xff0c;简单说明如下&＃xff1a;

• pipeline是结构&＃xff0c;在其中可以指定agent和stages等相关信息
• agent用于指定执行job的节点&＃xff0c;any为不做限制
• stages用与设定具体的stage
• stage为具体的节点&＃xff0c;比如本文示例中模拟实际的 Build&＃xff08;构建&＃xff09;、测试&＃xff08;Test&＃xff09;、部署&＃xff08;Deploy&＃xff09;的过程&＃xff0c;当然实际情况要复杂地多。

pipeline {
agent any
stages {
stage(&＃39;Build&＃39;) {
steps {
sh &＃39;echo Build stage ...&＃39;
}
}
stage(&＃39;Test&＃39;){
steps {
sh &＃39;echo Test stage ...&＃39;
}
}
stage(&＃39;Deploy&＃39;) {
steps {
sh &＃39;echo Deploy stage ...&＃39;
}
}
}
}


执行Job

使用如下命令或者直接在Jenkins上点击构建

liumiaocn:jenkins liumiao$ curl -X POST -u $user_passwd -H ${jenkins_crumb} ${jenkins_host_url}/job/pipeline_job_noparam/build
liumiaocn:jenkins liumiao$ echo $?
0
liumiaocn:jenkins liumiao$


确认执行结果

使用如下命令可以确认相关的执行日志信息

liumiaocn:jenkins liumiao$ curl -u $user_passwd ${jenkins_host_url}/job/pipeline_job_noparam/1/consoleText
Started by user root
Running in Durability level: MAX_SURVIVABILITY
[Pipeline] Start of Pipeline
[Pipeline] node
Running on Jenkins in /data/jenkins/workspace/pipeline_job_noparam
[Pipeline] {
[Pipeline] stage
[Pipeline] {
(Build)
[Pipeline] sh
&＃43; echo Build stage ...
Build stage ...
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] {
(Test)
[Pipeline] sh
&＃43; echo Test stage ...
Test stage ...
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] {
(Deploy)
[Pipeline] sh
&＃43; echo Deploy stage ...
Deploy stage ...
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS
liumiaocn:jenkins liumiao$


同时也可以通过Jenkins的BlueOcean插件&＃xff08;Easypack集成&＃xff09;来确认&＃xff0c;可以更为清晰地进行可视化结果的展示。

在SCM中使用Jenkinsfile的方式

除了在Jenkins中直接使用Jenkinsfile&＃xff0c;还可以结合SCM进行管理&＃xff0c;简单来说&＃xff0c;Jenkinsfile在Gitlab等SCM上进行管理&＃xff0c;Jenkins与SCM进行关联来获取生成Job的流水线。详细可参看&＃xff1a;

• https://blog.csdn.net/liumiaocn/article/details/86344537

总结

在Jenkins中使用Jenkinsfile可以通过API方式&＃xff0c;Jenkinsfile支持Groovy语法&＃xff0c;写起来非常方便&＃xff0c;非常适合“流水线即代码”的实践思路的落地。