This topic describes how to use the Jenkins step in a Harness CD pipeline.
Continuous Integration (CI) can be performed in Harness using the module and CI pipelines.
If you are using Harness Continuous Delivery (CD) but not Harness Continuous Integration (CI), you can still perform CI using the Jenkins step in your CD stage.
Harness integrates with Jenkins, enabling you to run Jenkins jobs and dynamically capture inputs and outputs from the jobs.
Supported platforms and technologies
For more information and supported versions, go to supported platforms and technologies.
Limitations and requirements
- EnvInject plugin: For Harness to capture Jenkins environment variables, your Jenkins configuration requires the EnvInject plugin. The plugin does not provide full compatibility with the pipeline plugin. Go to known limitations from Jenkins for more information.
- CD and custom stage types only: The Jenkins step is available in CD (deploy) and custom stages only.
- Jenkins with GitHub plugin: Branch names cannot contain double quotes if you are using Jenkins with a GitHub plugin. If any previous build executed by Jenkins used a branch with double quotes in its name, delete the history of branches built already, or recreate the job.
With the Jenkins step, you can execute Jenkins jobs in the stage's shell session.
When executing a job, you can also dynamically capture the output from the job, using runtime variables based on the context. You can then use those variables in another step in the same or other stage or pipeline.
What information is available to capture?
Any Jenkins job information in the particular shell session of the pipeline can be captured and output using one or more Jenkins steps. In addition, you can capture information available using the built-in Harness variables. For more information, go to built-in and custom Harness variables reference.
Capturing and exporting output in the Jenkins step can be very powerful. For example, a Jenkins step could capture Jenkins build information, and a Harness service could echo the build information and use it in a complex function, and then export the output down the pipeline for further evaluation.
Add the Jenkins step
This step assumes you have a created a pipeline and CD stage. If you are new to stages, go to add a stage.
In your CD stage's Execution, select Add Step, then select Jenkins.
Select the Jenkins server you added as a Harness Jenkins connector. For more information, go to connect to Jenkins.
Set the polling interval for verifying the progress of step execution. Must be less than the timeout configured for the step.
Default: 5 sec
Minimum value: 5 sec
Select the Jenkins job (also called a project) to execute. The list is automatically populated using the Jenkins server you set up in the Jenkins connector you selected.
If you select a folder, then a new setting for the folder appears. For example, if you selected the folder Test Jobs, then a setting named Test Jobs appears. In the new setting, select the job to execute.
To filter a job, search for its name.
Use runtime inputs and expressions
You can use runtime inputs or expressions for the Jenkins connector and job name.
Go to fixed values, runtime inputs, and expressions for more information.
If you are using a parameterized build, when you select the job in Job Name, Harness will automatically populate any job parameters from the server.
You can also add parameters manually by selecting Add Job Parameter.
Runtime inputs and expressions are supported for the Value only. You can reference a job parameter from the Input tab of the executed step.
|Job parameters from Jenkins step||Executed Jenkins step inputs|
Treat unstable Jenkins status as success
If this setting is enabled then
Unstable statuses will be considered as
In Advanced, you can use the following options:
Captured environment variables from Jenkins builds
For Harness to capture Jenkins environment variables, your Jenkins configuration requires the EnvInject plugin. The plugin does not provide full compatibility with the pipeline plugin. Go to known incompatibilities from Jenkins for more information. Harness captures certain environment variables from the Jenkins build.
The following list shows examples of the environment variables and the expressions you can use to reference them.
- Job Status:
- Job URL:
- Build number:
- Build display name:
- Full build display name:
Here's a sample script.
echo "Job Status:" <+execution.steps.Jenkins_Build.build.executionStatus>
echo "Job URL:" <+execution.steps.Jenkins_Build.build.jobUrl>
echo "Build number:" <+execution.steps.Jenkins_Build.build.buildNumber>
echo "Build display name:" <+execution.steps.Jenkins_Build.build.buildDisplayName>
echo "Full build display name:" <+execution.steps.[step_Id].build.buildFullDisplayName>
If you are using step groups the expressions must include the step group Ids also.
<+execution.steps.[step group Id].steps.[step Id].build.jobUrl>.
You can reference this job information in subsequent steps in your pipeline or in another pipeline.
To reference the job information in another stage in this pipeline, use the full pipeline path to the build information. For example,
Multibranch pipeline support
For Harness to capture Jenkins environment variables, your Jenkins configuration requires the EnvInject plugin. The plugin does not provide full compatibility with the pipeline plugin. Go to known incompatibilities from Jenkins for more information. The Jenkins multibranch pipeline (workflow multibranch) feature enables you to automatically create a Jenkins pipeline for each branch on your source control repo.
Each branch has its own Jenkinsfile, which can be changed independently. This features enables you to handle branches better by automatically grouping builds from feature or experimental branches.
In Job Name, multibranch pipelines are displayed alongside other jobs, with the child branches as subordinate options.
Select > and select the branch.
Some components in Jenkins, like controllers, might require a separate Harness Jenkins connector for proper integration. The URL for accessing Jenkins could be different for different installations of Jenkins or even for different instances of Jenkins running on the same server. If you're experiencing issues integrating Jenkins components, try a separate connector and update the connector's URL accordingly.
You can copy expressions for the job outputs from the Output tab of the Jenkins step.
To access Jenkins job's environment variables from the step output, use:
When the step is inside a step group, use: