Jenkins
Use the Jenkins integration to run Jenkins jobs as part of your automation workflows.
The primary use case of Jenkins is CI/CD and it supports users that use Jenkins as the primary automation system. It can also be extended to Ops automation for already authored Jenkins jobs.
Jenkins in a Spot Connect workflow lets you:
- See the list of available jobs and pick a specific job to run (schedule an existing Jenkins job).
- Be able to specify any input parameters needed for the job to run.
Configure Jenkins in Spot Connect
- In the left main menu, click Connect and click Settings.
- Under the Integrations tab, select Jenkins.
- Configure a new integration instance with the information below.
Details needed to set up a Jenkins instance in Spot Connect:
| Parameter | Description | Required |
|---|---|---|
| Integration Alias | A name for the integration instance | True |
| API Token | API token from an authorized user in Jenkins | True |
| Jenkins Username | Jenkins server (url:port) | True |
| Jenkins Server URL | Jenkins username associated with the token | True |
In your Jenkins account:
- Find your Jenkins web URL and port if needed. Add it to the Spot Connect Jenkins Server URL field.
- Sign in to your Jenkins Server.
- In the left menu, click People.
- Select the user you want to integrate with and copy the Jenkins User ID to the Spot Connect Jenkins Username field.
- In the left menu, click Configure. Click API Token, generate a new token, and paste the value in the API Token field.
- Click Add Instance.
note
The Jenkins integration might not work when it is behind a proxy.
Integration Actions
You can add this action in the Spot Connect workflow builder as part of your workflow:
Jenkins Build
Use the action to start a Jenkins job.
Input
| Parameter | Description | Required |
|---|---|---|
| Jenkins Instance | Select a Jenkins integration instance configured in Spot Connect | True |
| Job Name | Name of Jenkins job | True |
| Parameters | Parameters for the build job | True |
Output
| Parameter | Type | Description |
|---|---|---|
| execution_status | String | Status of run (ie: S_OK / E_FAIL) |
You can start a Jenkins job from the workflow builder:
- From the workflow builder in the left panel, drag and drop a Jenkins action node onto the center panel.
- Click the Jenkins Build action node.
- Select a Jenkins Instance.
- Select a Jenkins job from the Job Name dropdown menu.
- Enter JSON input Parameters.