In this blog, we will explore the world of Jenkins job DSL and learn how to leverage its capabilities to streamline and automate job configuration management. We will walk through the process of setting up the Job DSL environment, writing Job DSL scripts to define different types of jobs, managing job configurations as code, and integrating Job DSL with your CI\/CD pipelines.<\/p>\r\n\r\n\r\n\r\n
Prerequisites<\/h2>\r\n\r\n\r\n\r\n
Before getting started, ensure that you have the following prerequisites in place:<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Jenkins<\/a> is installed and running.<\/li>\r\n\r\n\r\n\r\n
- Job DSL plugin is installed and configured in Jenkins.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
What is Job DSL?<\/strong><\/h2>\r\n\r\n\r\n\r\n
Job DSL is a powerful plugin that allows you to define Jenkins jobs as code, bringing the benefits of version control, automation, and scalability to job configuration management. With Job DSL, you can write Groovy scripts to define Jenkins job configurations programmatically.\u00a0<\/p>\r\n\r\n\r\n\r\n
DSL stands for Domain Specific Language<\/strong>.\\<\/p>\r\n
[ Also Check: Kubernetes Service<\/a> ]<\/strong><\/p>\r\n\r\n\r\n\r\n
Some of the important methods in Job DSL are<\/strong><\/h2>\r\n\r\n\r\n\r\n
a. folder: <\/strong>You can create a folder using the
folder<\/code> DSL method. Folders provide a way to organize your jobs and create a hierarchical structure in Jenkins. Here’s an example of how to create a folder using the Job DSL:<\/p>\r\n\r\n\r\n\r\nfolder('Microservice') {\r\n displayName('Microservice')\r\n description('Folder for Microservice')\r\n}<\/code><\/pre>\r\n\r\n\r\n\r\n\r\n\r\nb. pipelineJob:<\/strong> To create a Pipeline job, you can use the
pipelineJob<\/code> DSL method. ThepipelineJob<\/code> the method allows you to define a Pipeline job with its stages and configuration. Here’s an example of how to create a Pipeline job using the Job DSL:<\/p>\r\n\r\n\r\n\r\npipelineJob('sample-app') {\r\n definition {\r\n cpsScm {\r\n scm {\r\n git {\r\n remote {\r\n url(\"https:\/\/gitlab.com\/tarandeepsingh009\/infrastructure.git\")\r\n credentials('gitlab-token')\r\n }\r\n branch('main')\r\n }\r\n }\r\n scriptPath(\"Jenkinsfile\")\r\n }\r\n }\r\n}<\/code><\/pre>\r\n\r\n\r\n\r\nc. multibranchPipelineJob:<\/strong> To create a Multi-Branch Pipeline job, you can use the
multibranchPipelineJob<\/code> DSL method. ThemultibranchPipelineJob<\/code> method allows you to define a Multi-Branch Pipeline job that automatically discovers and builds branches in your source code repository. Here’s an example of how to create a Multi-Branch Pipeline job using the Job DSL:<\/p>\r\n\r\n\r\n\r\nmultibranchPipelineJob('sample-app') {\r\n branchSources {\r\n branchSource {\r\n source {\r\n git {\r\n id('sample-app')\r\n remote('https:\/\/gitlab.com\/tarandeepsingh009\/infrastructure.git')\r\n credentialsId('gitlab-token')\r\n }\r\n }\r\n strategy {\r\n defaultBranchPropertyStrategy {\r\n props {\r\n noTriggerBranchProperty()\r\n }\r\n }\r\n }\r\n }\r\n }\r\n configure {\r\n def traits = it \/ sources \/ data \/ 'jenkins.branch.BranchSource' \/ source \/ traits\r\n traits << 'jenkins.plugins.git.traits.BranchDiscoveryTrait' {}\r\n }\r\n factory {\r\n workflowBranchProjectFactory {\r\n scriptPath('Jenkinsfile')\r\n }\r\n }\r\n orphanedItemStrategy {\r\n discardOldItems {\r\n numToKeep(20)\r\n }\r\n }\r\n}<\/code><\/pre>\r\n\r\n\r\n\r\nLet’s move ahead with implementation.<\/p>\r\n\r\n\r\n\r\n
Step 1: Login to Jenkins<\/strong> server.\u00a0<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-18-205143.png?w=515\")
<\/figure><\/div>\r\n\r\n\r\nStep 2: Click on Manage Jenkins<\/strong><\/a> and go to Manage Plugins<\/strong> section.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-18-212254.png?w=1024\")
<\/figure><\/div>\r\n\r\n\r\nStep 3: In the Available plugins<\/strong> search for Job DSL<\/strong> and then install it.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-18-210215.png?w=1024\")
<\/figure><\/div>\r\n\r\n\r\nStep 4: Once you have installed. Click on New Item<\/strong>, enter your item name and select Freestyle Project<\/strong>.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-18-212547.png?w=616\")
<\/figure><\/div>\r\n\r\n\r\nStep 5: Enter your Git repo URL<\/strong> and in the build steps dropdown, search for Process Job DSLs<\/strong>.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/image-8.png?w=1024\")
<\/figure><\/div>\r\n\r\n\r\nStep 6: Select Look on Filesystem<\/strong> as we have stored our Job DSL code in VCS and enter your seed job name.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-19-113911.png?w=1024\")
<\/figure><\/div>\r\n\r\n\r\nStep 7: Save it and then click on Build Now<\/strong>.<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-18-211914.png?w=298\")
<\/figure><\/div>\r\n\r\n\r\nHere is the output:<\/p>\r\n\r\n\r\n
\r\n![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-22-011610.png?w=1024\")
<\/figure><\/div>\r\n\r\n\r\nIn the example below, we are creating a folder and inside that folder creating a pipeline job structure.<\/p>\r\n\r\n\r\n\r\n
folder('Microservice') {\r\n displayName('Microservice')\r\n description('Folder for Microservice')\r\n}\r\n\r\nfolder('Microservice\/application') {\r\n pipelineJob('Microservice\/application\/sample-app') {\r\n\u00a0 definition {\r\n\u00a0 \u00a0 cpsScm {\r\n\u00a0 \u00a0 \u00a0 scm {\r\n\u00a0 \u00a0 \u00a0 \u00a0 git {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 remote {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 url(\"https:\/\/gitlab.com\/tarandeepsingh009\/infrastructure.git\")\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 credentials('gitlab-token')\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 branch('main')\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 scriptPath(\"Jenkinsfile\")\r\n\u00a0 \u00a0 }\r\n\u00a0 }\r\n }\r\n}<\/code><\/pre>\r\n\r\n\r\n\r\nOutput of Pipeline Job:<\/p>\r\n\r\n\r\n\r\n
![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-22-013606.png?w=1024\")
<\/figure>\r\n\r\n\r\n\r\n<\/p>\r\n\r\n\r\n\r\n
The above example was for a single branched setup. What if we create a new branch for adding\/testing a feature and want to test such code? For this, we need to edit our seed job, change branch name and re-run it.<\/p>\r\n\r\n\r\n\r\n
You can see that every time we need to make such changes for running the specific branch.\u00a0<\/p>\r\n\r\n\r\n\r\n
Here comes the concept of Multibranch pipeline. In the example below, we are creating a folder and inside that folder creating a multibranch pipeline job.<\/p>\r\n\r\n\r\n\r\n
folder('Microservice') {\r\n displayName('Microservice')\r\n description('Folder for Microservice')\r\n}\r\n\r\nfolder('Microservice\/application') {\r\n multibranchPipelineJob('Microservice\/application\/sample-app') {\r\n branchSources {\r\n branchSource {\r\n source {\r\n git {\r\n id('sample-app')\r\n\u00a0 \u00a0 \u00a0 \u00a0 remote('https:\/\/gitlab.com\/tarandeepsingh009\/infrastructure.git')\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 credentialsId('gitlab-token')\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 strategy {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 defaultBranchPropertyStrategy {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 props {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 noTriggerBranchProperty()\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 }\r\n\u00a0 \u00a0 configure {\r\n\u00a0 \u00a0 \u00a0 \u00a0 def traits = it \/ sources \/ data \/ 'jenkins.branch.BranchSource' \/ source \/ traits\r\n\u00a0 \u00a0 \u00a0 \u00a0 traits << 'jenkins.plugins.git.traits.BranchDiscoveryTrait' {}\r\n\u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 factory {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 workflowBranchProjectFactory {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 scriptPath('Jenkinsfile')\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 orphanedItemStrategy {\r\n\u00a0 \u00a0 \u00a0 \u00a0 discardOldItems {\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 numToKeep(20)\r\n\u00a0 \u00a0 \u00a0 \u00a0 }\r\n\u00a0 \u00a0 }\r\n\u00a0 }\r\n}<\/code><\/pre>\r\n\r\n\r\n\r\nUsing multibranch pipeline we don\u2019t need to worry about new branch creation in our code. Simply, we just need to click on Scan Multibranch Pipeline Now<\/strong> and it will automatically add the new branches if we have created.<\/p>\r\n\r\n\r\n\r\n
Output of Multibranch Pipeline Job:<\/p>\r\n\r\n\r\n\r\n
![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2023\/05\/screenshot-2023-05-22-012621.png?w=1024\")
<\/figure>\r\n\r\n\r\n\r\n<\/p>\r\n
[ Also Read: LLM-Powered ETL<\/a> ]<\/strong><\/p>\r\n\r\n\r\n\r\n
Conclusion<\/strong><\/h2>\r\n\r\n\r\n\r\n
In conclusion, by leveraging the Job DSL plugin in Jenkins, we have successfully created folders to organize our jobs, defined pipeline jobs to automate our CI\/CD workflows, and utilized multibranch pipeline jobs to dynamically manage branches. With these capabilities, we can streamline our software delivery process and enhance our overall CI\/CD capabilities.<\/p>\r\n\r\n\r\n\r\n
Blog Pundits: Deepak Gupta<\/strong><\/a> and Sandeep Rawat<\/a><\/strong><\/p>\r\n\r\n\r\n\r\n\r\n\r\n
- Job DSL plugin is installed and configured in Jenkins.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n