如何通过 Jenkins 进行资源的锁定和释放

业务场景

日常工作中需要切换到不同平台（包括 Linux, AIX, Windows, Solris, HP-UX）不同的版本进行开发和验证问题，但是由于虚拟机有限，并不能保证每个开发和测试都有所以平台的虚拟机并且安装了不同的版本，因此准备各种各样的开发和测试环境会花费很长时间。

需求分析

对于这样的需求，一般都会首先想到 Docker；其次是从 Artifactory 取 Build 然后通过 CI 工具进行安装；最后从 Source Code 进行构建然后安装。

• 先说 Docker，由于我们所支持的平台繁多，包括 Linux, AIX, Windows, Solris, HP-UX, Docker 只适用于 Linux 和 Windows，因此不能满足这样的需求。

• 由于其他原因我们的 Artifactory 暂时还不能使用，最后只能选择用 Source Code 进行构建然后进行安装。这两种方式都需要解决锁定资源以及释放资源的问题。如果当前环境有人正在使用，那么这台虚拟机的资源应该被锁住，不允许 Jenkins 再去调用这台正在使用的 node，以保证环境在使用过程中不被破坏。

本文主要介绍如何通过 Jenkins Lockable Resources Plugin 来实现资源的上锁和解锁。

演示 Demo

1. 设置 Lockable Resources

   • Jenkins -> configuration -> Lockable Resources Manager -> Add Lockable Resource
     
     这里的 Labels 是你的 node 的 Label，在 Jenkins -> Nodes 设置

2. 查看 Lockable Resources 资源池

   

3. 测试锁资源

   • 这里我配置的是参数化类型的 Job，可以选择不同平台，不同仓库进行构建
     build-with-parameters
   • 运行第一个 Job
     
   • 查看当前可用资源数量 Free resources = 1，看到已经被 #47 这个 Job 所使用
     
   • 继续运行第二个 Job
     
   • 查看当前可用资源数量 Free resources = 0，看到已经被 #48 这个 Job 所使用
     
   • 最关键是这一步，如果继续运行第三个 Job，是否能够被继续行呢
     
   • 可以看到这个任务没有开始执行，看下 log 是否真的没有被执行。通过日志发现，当前正在等待可用的资源
     

4. 测试释放锁

   • 现在释放一个资源，看下第三个 Job 是否能拿到资源，并且执行
     
   • 从下图可以看到 第三个 Job 已经运行成功了
     

Jenkins pipeline 代码

整个 pipeline 最关键的部分就是如何上锁和释放，这里是通过 lock 和 input message 来实现。

当前 Job 只要用户不点击 Yes，就会一直处于没有完成的状态，那么的它的锁会一直生效中。直到点击 Yes， Job 结束，锁也就释放了。

具体可以参考下面的 Jenkinsfile。

pipeline {
    agent {
        node {
            label 'PreDevENV'
        }
    }
    options {
        lock(label: 'PreDevENV', quantity: 1)
    }

    parameters {
        choice(
            name: 'platform',
            choices: ['Linux', 'AIX', 'Windows', 'Solris', 'HP-UX'],
            description: 'Required: which platform do you want to build')
        choice(
            name: 'repository',
            choices: ['repo-0.1', 'repo-1.1', 'repo-2.1', 'repo-3.1', 'repo-4.1'],
            description: 'Required: which repository do you want to build')
        string(
            name: 'branch',
            defaultValue: '',
            description: 'Required: which branch do you want to build')
    }

    stages {
        stage('git clone'){
            steps {
                echo "git clone source"
            }
        }
        stage('start build'){
            steps {
                echo "start build"
            }
        }
        stage('install build'){
            steps{
                echo "installing"
            }
        }
        stage('unlock your resource'){
            steps {
                input message: "do you have finished?"
                echo "Yes, I have finished"
            }
        }
    }
}