专栏首页一日一工具Jenkins流水线即代码之扩展共享库

Jenkins流水线即代码之扩展共享库

Jenkin的多分支流水线,允许Jenkinsfile与需要 Jenkins 构建的应用程序代码放在一起,然后 Jenkins 从源代码管理系统中检出 Jenkinsfile 文件作为流水线项目构建过程的一部分并接着执行你的流水线。

Jenkins这种构建方式正是“谁构建,谁运行”DevOps理念的一种体现。

由于流水线代码(特别是脚本式流水线)是使用类似 Groovy 的语法编写的,因此我们要想学习需要了解Groovy的语法。

目录结构

共享库的目录结构如下:

(root)
+- src                     # Groovy source files
|   +- org
|       +- foo
|           +- Bar.groovy  # for org.foo.Bar class
+- vars
|   +- foo.groovy          # for global 'foo' variable
|   +- foo.txt             # help for 'foo' variable
+- resources               # resource files (external libraries only)
|   +- org
|       +- foo
|           +- bar.json    # static helper data for org.foo.Bar
  1. src 目录应该看起来像标准的 Java 源目录结构。当执行流水线时,该目录被添加到类路径下。
  2. vars 目录定义可从流水线访问的全局变量的脚本。每个 *.groovy 文件的基名应该是一个 Groovy (~ Java) 标识符, 通常是 camelCased。匹配 *.txt, 如果存在, 可以包含文档, 通过系统的配置标记格式化从处理 (所以可能是 HTML, Markdown 等,虽然 txt 扩展是必需的)。
  3. resources 目录允许从外部库中使用 libraryResource 步骤来加载有关的非 Groovy 文件。目前,内部库不支持该特性。

注意:初次使用src、resources目录可以为空,我们可以在vars中定义脚本,使用call方法实现功能。

全局共享库

Manage Jenkins » Configure System » Global Pipeline Libraries 可以配置许多全局共享库。系统中的任何流水线都可以使用这些库中实现的功能。

使用类库

标记为 Load implicitly 的共享库允许流水线立即使用任何此库定义的类或全局变量。为了访问其他共享库, Jenkinsfile 需要使用 @Library 注解。

在此我们将共享库托管在git上,在jenkins中设置如下:

  • 使用“shared-library”命名
  • 默认使用master分支调用

Jenkinsfile 需要使用 @Library 注解, 指定库的名字:

#调用共享库的默认master分支
@Library('my-shared-library') _
#使用test分支的共享库,也可使用tag等区分
@Library('my-shared-library@test') _

部署使用

1.定义pipeline共享库

└── pipeline-shared-library
    ├── README.en.md
    ├── README.md
    ├── resources
    ├── src
    └── vars
        └── helloworld.groovy

由于初步使用,resources和src我们都只保留项目结构,但设置为空;只在vars中设置脚本即可,并定义call方法,通过允许访问全局变量实现相关功能。

#遵循groovy语法
cat vars/helloworld.groovy 
def call(String s = "groovy") {
    echo "Hello, $s."
}

2.流水线调用

在项目中定义Jenkinsfile文件,通过声明式流水线调用共享库。

其中需要使用“@Library('shared-library') _”来引入共享库。

#cat Jenkinsfile
@Library('shared-library') _

pipeline {
    options {
        ansiColor('xterm')
        timestamps()
    }
    agent {
        label 'docker-slave-java'
    }

    stages {
        stage('test测试') {
            when {}
            steps {
              
                script {
                    println "import shared-library"
                    result = helloworld 'test'
                    println result
                }
            }
        }
    post {
        unstable {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Unstable!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
        success {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Successful!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
        failure {
            emailext (
                body: """项目名称:${JOB_NAME}\n构建编号:${BUILD_NUMBER}\n构建日志:${BUILD_URL}console""",
                subject: '【Jenkins构建通知】:$JOB_NAME - Build # $BUILD_NUMBER - Failure!',
                to: 'test@aa.cn',
                from: 'jenkins@aa.cn'
            )   
        }   
    }
  }

应用项目在jenkins上使用多分支流水线,通过when当test分支更新时,“测试环境部署”步骤才执行,最后将构建结果以邮件的形式通知。

注意:声明式流水线不允许在`script`指令之外使用全局变量。

3.执行过程

通过多分支流水线,可以将项目的多个分支在同一个jenkins任务中管理,避免了一个分支对应一个任务。如下图所示:docker-test-java3项目,分master/test/develop分支分别管理。

如下图所示,在流水线中“测试环境部署”中的操作已经调用共享库方法,打印出对应消息。

注意:

在流水线构建任务中,BlueOcean 可以引导用户通过直观的、可视化的过程来创建Pipeline,从而使Pipeline的创建更加简单。而且Blue Ocean 与普通界面相比,屏蔽了部分输出,只展示 Pipeline中需要关注的地方, 简化异常处理。

总结

Jenkins扩展共享库是真正意义上的流水线即代码,通过共享库可以实现多个项目之间共享流水线,有助于减少冗余并保持代码干净整洁。

在CI/CD过程中,引入扩展共享库使管理过程更加灵活,重新定义了运维和开发之前的协作方式。但是groovy对于运维人员上手操作需要一定时间,而对于java开发人员却是天作之合。也正是这个原因,我也是对扩展共享库做了简单的介绍,更高级的使用需深入研究。

本文分享自微信公众号 - 追马Linux(zhuima_k8s)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-07-13

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Jenkins扩展共享库进阶

    前面我们介绍了Jenkins多分支流水线、Jenkins流水线即代码之扩展共享库,其实都是“流水线即代码”的体现。我们将Jenkinsfile纳入项目版本库中统...

    追马
  • Jenkins——the thing which auto everything

    今天突然想起来原先的关注者可能还不知道Jenkins是什么,上来就是Jenkins常见问题,有些突兀。是我交代不清楚,所以这篇就来介绍一下。注意...

    DevOps持续交付
  • 使用 YAML 文件配置 Jenkins 流水线

    几年前,我们的 CTO 写了一篇关于使用 Jenkins 和 Docker 为 Ruby On Rails 应用提供持续集成服务的文章。这些年,我们一直使用这个...

    LinuxSuRen
  • Jenkins之Pipeline代码流水线

    Pipeline翻译过来就是流水线的意思,在公司中可能会有很多项目,如果使用Jenkins构建完成后,开发构建项目需要一项一项点击,比较麻烦,因此,pipeli...

    小手冰凉
  • 在大型企业里维护多分支流水线

    当一个开发人员创建一个新分支并将其推送到远程代码仓库时,Jenkins 会为这个新分支动态创建流水线。根据代码仓库,甚至也可以作为动态创建 Pull Reque...

    LinuxSuRen
  • 在大型企业里维护多分支流水线

    Jenkins 是 DevOps 领域里非常好的 CI/CD 工具,它凭借其独特的功能,几乎可以满足你一切的的业务要求。其中一个独特的功能是多分支流水线(Mul...

    kubernetes中文社区
  • 「持续集成实践系列」Jenkins 2.x 搭建CI需要掌握的硬核要点

    随着互联网软件行业快速发展,为了抢占市场先机,企业不得不持续提高软件的交付效率。特别是现在国内越来越多企业已经在逐步引入DevOps研发模式的变迁,在这些背景催...

    测试开发技术
  • 「持续集成实践系列」Jenkins 2.x 搭建CI需要掌握的硬核要点(一)

    随着互联网软件行业快速发展,为了抢占市场先机,企业不得不持续提高软件的交付效率。特别是现在国内越来越多企业已经在逐步引入DevOps研发模式的变迁,在这些背景催...

    测试开发技术
  • 介绍 Jenkins 模板引擎

    在企业范围内实施 DevSecOps 实践具有挑战性。由于组织内的不同应用程序正在使用多种编程语言、自动化测试框架和安全遵从性安全合规工具,因此每个团队构建和维...

    LinuxSuRen
  • JenkinsShareLibrary实践之自定义通知器

    随着devops理念在公司越来越多的实践,jenkins等工具的应用场景越来越多,当我们在执行完成某个流水线任务后,常常需要关注的是这个任务为什么执行,执行成功...

    DevOps云学堂
  • T-Mobile 和 Jenkins 案例研究

    大多数人都知道 T-Mobile 是无线服务提供商。毕竟,我们拥有国际化的业务,并且是美国第三大移动运营商。但是我们还是一家技术公司,提供的新产品包括 TVis...

    LinuxSuRen
  • 大型团队 Jenkins 实践分享

    本文我将分享之前咨询DevOps客户的案例,他们做的是在Jenkins的基础上构建一个他们自己的CI环境。我把两个客户的例子混合到一起了,其中一个大概有80个人...

    DevOps时代
  • Jenkins共享库之自定义通知器

    与任何编程环境一样,在Jenkins流水线中,集中化功能,共享公共代码和代码重用都是快速、有效地进行开发的基本技术,这些实践鼓励使用标准方法来调用功能,为更复杂...

    常见_youmen
  • 实践: 使用共享库扩展Jenkinsfile

    共享库这并不是一个全新的概念,其实具有编程能力的同学应该清楚一些。例如在编程语言Python中,我们可以将Python代码写到一个文件中,当代码数量增加,我们可...

    DevOps云学堂
  • 第1章 开篇-为什么要做CI/CD?

    本章阐述持续集成系统的发展历程、持续集成系统的原理,以及持续集成系统的实现过程,目的是让大家全面了解持续集成系统,更加深入的学习持续集成系统的原理,为后续章节的...

    DevOps云学堂
  • Jenkins常见问题集锦(八)

    Hudson由Sun公司在2004年启动,第一个版本于2005年在java.net发布。

    DevOps持续交付
  • MPL - 模块化的流水线库

    尽管通过自动化部署加快了开发速度,但由于在 DevOps 方面缺少协作,我们一个客户正因此而放慢产品的上市时间。虽然他们也投入了资源来做 DevOps ,但每条...

    LinuxSuRen
  • 每个 Jenkins 用户都应该知道这三个最佳实践

    在使用 Jenkins 实施了企业级的 CI/CD 工作,有如下三个最重要的实践和总结。

    Peter Shen
  • DevOps技术实践中的一些总结

    构建平台是部署在vm中,一个生产的Master和N多个Slave。由于构建项目的增加,平台现有项目1k+,并发数量也增加了很多。问题也来了。磁盘空间不足/构建执...

    DevOps云学堂

扫码关注云+社区

领取腾讯云代金券