「Jenkins Pipeline」- 相关插件及编程实践

更新日期:2020年09月16日

该部分笔记整理:在 Jenkins Pipeline 中会用到的某些插件,用于在 Pipeline 中的特定问题和特定场景。

关于该部分笔记的内容

该部分笔记只整理 Jenkins Pipeline 相关的内容,而与 Apache Groovy 有关的内容、编程实现将不会整理到该部分中。如下说明:

1)对于连接数据库,Jenkins Pipeline 没有提供(成熟的、可用的)插件或者方法,我们只能使用 Groovy 进行数据库的连接
该部分将记录 Jenkins Pipeline 连接数据库存在的问题和解决办法、以及简单示例,但是数据库连接、更多的代码编程实践(比如指定连接使用 UTF-8 编码)将整理到 Apache Groovy 部分。并且该部分也会记录由于 Jenkins Pipeline 环境导致的 Groovy 编程问题。

基础插件

这里的“基础插件”是指必须安装的插件,或者说及其有用的插件,可能这些插件已经默认安装。

Pipeline Plugin

插件功能: - 这是Pipeline的基础插件,要使用Pipeline功能,需要安装该插件,可让你可以协调简单或复杂的自动化。
插件地址: https://plugins.jenkins.io/workflow-aggregator
步骤手册: https://jenkins.io/doc/book/pipeline/
其他链接: https://github.com/jenkinsci/pipeline-plugin

Pipeline Utility Steps

插件功能: - 提供了一系列Pipeline扩展步骤。比如YAML文件处理
插件地址: https://plugins.jenkins.io/pipeline-utility-steps
步骤手册: https://jenkins.io/doc/pipeline/steps/pipeline-utility-steps
其他链接: https://github.com/jenkinsci/pipeline-plugin

File Operations Plugin

插件功能: - 文件、目录操作插件,包括复制、移动、删除等等动作
插件地址: https://plugins.jenkins.io/file-operations
步骤手册: https://jenkins.io/doc/pipeline/steps/file-operations/
其他链接: https://github.com/jenkinsci/file-operations-plugin

Pipeline: Groovy

- 基于Groovy脚本的CPS转换的Pipeline执行引擎
https://wiki.jenkins.io/display/JENKINS/Pipeline+Groovy+Plugin
https://github.com/jenkinsci/workflow-cps-plugin

# TODO Groovy CPS
https://github.com/cloudbees/groovy-cps

Pipeline: Shared Groovy Libraries

https://plugins.jenkins.io/workflow-cps-global-lib
是Pipeline Plugin的一个组件。提供了使用共享库来扩展Pipeline脚本的功能。

功能插件

这里的“功能插件”是泛指实现某些功能的插件,与特定的场景有关。

SSH Pipeline Steps

插件功能: - 在Pipeline中,使用SSH命令来执行某些远程操作
插件地址: https://plugins.jenkins.io/ssh-steps
步骤手册: https://jenkins.io/doc/pipeline/steps/ssh-steps/
其他链接: SSH Steps for Jenkins Pipeline: https://jenkins.io/blog/2019/02/06/ssh-steps-for-jenkins-pipeline/

Kubernetes CLI Plugin

https://plugins.jenkins.io/kubernetes-cli
https://github.com/jenkinsci/kubernetes-cli-plugin

在Job中可以与k8s集群交互,但是系统中需要安装kubectl命令。

该插件的作用是管理kubectl命令的凭证,操作k8s集群时依旧需要使用kubectl命令。

支持的凭证类型有:

Token, as secrets (see Plain Credentials plugin)
Plain KubeConfig files (see Plain Credentials plugin)
Username and Password (see Credentials plugin)
Certificates (see Credentials plugin)
OpenShift OAuth tokens, as secrets (see Kubernetes Credentials plugin)

在Jenkin中添加凭证时,可以选择「secret file」类型,然后上传$HOME/.kube/config文件。

Last Changes

插件功能: - 输出此次构建变更的内容
插件地址: https://plugins.jenkins.io/last-changes
步骤手册: https://jenkins.io/doc/pipeline/steps/last-changes/
其他链接: https://github.com/jenkinsci/last-changes-plugin

instant-messaging

插件功能: - 提供对构建通知和机器人的通用支持,该插件本身对用户没用,需要使用派生插件,如Jabber或IRC插件!
插件地址: https://plugins.jenkins.io/instant-messaging
步骤手册:  
其他链接: https://github.com/jenkinsci/instant-messaging-plugin

IRC

插件功能: - 提供对构建通知和机器人的通用支持,该插件本身对用户没用,需要使用派生插件,如Jabber或IRC插件!
插件地址: https://plugins.jenkins.io/ircbot
步骤手册: https://jenkins.io/doc/pipeline/steps/ircbot/
其他链接: https://github.com/jenkinsci/ircbot-plugin

Jabber (XMPP) notifier and control

插件功能: - 提供对XMPP通知的支持。!!!目前还不支持PIPELINE中使用,出于WIP状态。
插件地址: https://plugins.jenkins.io/jabber
步骤手册:  
其他链接: https://github.com/jenkinsci/jabber-plugin
  https://issues.jenkins-ci.org/browse/JENKINS-36826

其他内容

在脚本式 PIPELINE 中替代 POST 步骤

post equivalent in scripted pipeline?
使用try...cache...finally语句,可以捕获异常,模拟POST步骤。

转义引号的问题

Jenkinsfile idiosynchrasies with escaping and quotes

Jenkins Shared Library Test Harness Example

https://github.com/stchar/pipeline-sharedlib-testharness

相关链接

Pipeline Syntax reference
Pipeline Steps reference

Private Jenkins Shared Libraries
How-To Use third party libraries in Jenkins Pipeline

Jenkins CPS

What's meaning of CPS in jenkins. what's the full name of CPS?
GitHub/cloudbees/groovy-cps
Basics of Continuation Passing Style

参考文献

Jenkins Plugins
Jenkins / Pipeline


ToC

关于该部分笔记的内容

基础插件

Pipeline Plugin

Pipeline Utility Steps

File Operations Plugin

Pipeline: Groovy

Pipeline: Shared Groovy Libraries

功能插件

SSH Pipeline Steps

Kubernetes CLI Plugin

Last Changes

instant-messaging

IRC

Jabber (XMPP) notifier and control

其他内容

在脚本式 PIPELINE 中替代 POST 步骤

转义引号的问题

Jenkins Shared Library Test Harness Example

相关链接

Jenkins CPS

参考文献