Installation

Process steps for the Jenkins plugin includes the following:

• Generate an Integration ID and Integration token.
• Install the plugin on your Jenkins instance.
• Populate the Jenkins configuration with Integration ID, Integration token, and Jenkins credentials.

1. On the HCL Accelerate home page, click Settings > Integrations > Plugins and locate the Jenkins plugin in the table.
2. Click the Add integration button to display the Add Jenkins Integration window.
3. In the Enter a name to identify this integration from others field, enter a logical name representing the Jenkins instance you are connecting to HCL Accelerate.
4. Click Create to generate an Integration ID and Integration token under Generated credentials.
5. In a text editor, copy and paste both the Integration ID and Integration token by clicking the copy to clipboard icon on the right side of each value.
6. Click Save.
7. In Jenkins on the left navigation pane, click Up > Manage Jenkins > Manage Plugins. Note: Manage Plugins is located in the System Configuration section of the page.
8. Navigate to hcl-accelerate.hpi and click the Download button to save the file.
9. In Jenkins on the Manage Plugins page, click the Advanced tab and in the Upload Plugin section, upload the file downloaded in the previous step.
10. On the Manage Jenkins page in the System Configuration section, click Configure System and locate the HCL Accelerate section and perform the following:

• • Copy and paste the Integration ID and Integration token from your text editor into the respective fields.
  • In the Jenkins credentials drop-down, select and Add the required credentials.
  • If you are configuring Jenkins integrations on Kubernetes or Openshift instances, click the Advanced button, and in the Rabbit MQ Port field, enter the port number.
    Note: Typically, the port number is 31672 instead of the default value of 5672 that does not work.
  • Click the Save button.
  • Click the Test Connection button to validate your connection with HCL Accelerate. Note: Upon successful connection, your data is accessible in HCL Accelerate.

Manual build

To perform a manual build for the plugin directly from the GitHub repository, clone the repository from https://github.com/UrbanCode/hcl-accelerate-plugin

From the root directory, run either of the following commands:

• mvn install
• mvn clean package -DskipTests with the -DskipTests flag enabled to expedite the build without running tests

Note: The plugin requires Java 8 or later. To avoid potential errors, delete the target directory.

License

Copyright© HCL Technologies Ltd. 2018, 2019, 2020, 2021. All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage

• Posting job metadata to your HCL Accelerate instance – As you create and edit jobs, the metadata for the jobs is uploaded including the job names and parameter names so jobs can be invoked from HCL Accelerate within the HCL Accelerate security model.
• Invoke jobs from HCL Accelerate – An authenticated, encrypted persistent connection is established with HCL Accelerate so that you can trigger jobs and pipelines with no special firewall configuration.
• Updates status of running jobs – You will receive instant feedback in HCL Accelerate with links to the execution.
• Job executions can create versions in the HCL Accelerate pipeline – You will have the option to select Jenkins jobs as “input jobs” that create a version with special properties that you can specify.

Configuration properties

• Check gate in HCL Accelerat
• Upload Build to HCL Accelerate
• Upload Deployment to HCL Accelerate
• Upload JUnit Results to HCL Accelerate
• Upload JUnit Metrics File to HCL Accelerate

Check gate in HCL Accelerate

The CheckGate class is used to check gates applied on a particular stage of the HCL Accelerate pipeline for a particular versionId of an application.

step($class: 'CheckGate',
pipelineId: "63a4591b-4d0d-4b8d-a6fb-4e9e7d79e754",
stageName: "DEV",
versionId: "NWZkOWUyZjYtOGE3Yy00NmJhLTlmZD-#48",
)


Pipeline script

Check gate input properties

Upload build to HCL Accelerate

The UploadBuild class is used to upload build data to HCL Accelerate. The revision parameter is important for linking the build to the work item via GitHub data (GIT_COMMIT in this case). The versionName is important for linking forward to deployments. The appName corresponds to the HCL Accelerate pipeline application name.

step($class: 'UploadBuild',
tenantId: "5ade13625558f2c6688d15ce",
revision: "${GIT_COMMIT}",
appName: "${ACCELERATE_APP_NAME}",
versionName:"${currentBuild.displayName}",
requestor: "admin",
id: "${currentBuild.displayName}"
)


Pipeline script

Upload build input properties

Upload deployment to HCL Accelerate

The UploadDeployment class is used to upload deployment data to HCL Accelerate. The versionName parameter is critical for linking to build data. The appName corresponds to the HCL Accelerate pipeline application name, while environmentName and environmentId are used to identify the deployment environment.

step([$class:
'UploadDeployment',
tenantId: "5ade13625558f2c6688d15ce",
versionName: "${currentBuild.displayName}",
versionExtId: "${currentBuild.displayName}",
type: 'Jenkins',
environmentId: "${ACCELERATE_ENV_ID_DEV}",
environmentName: 'DEV',
appName: "${ACCELERATE_APP_NAME}",
description: '[Description ex: Terraform Deployment]',
initiator: "admin",
result: 'true'
])


Pipeline script

Upload deployment input properties

Upload JUnit results to HCL Accelerate

Upload metrics file to HCL Accelerate

The UploadMetricsFile class is used to upload metrics file into HCL Accelerate. The uploaded metrics file will be available in Insights in graphical form.

step($class: 'UploadMetricsFile',
tenantId: "5ade13625558f2c6688d15ce",
filePath: "junit.xml",
appName: "${ACCELERATE_APP_NAME}",
name:"Junit",
dataFormat: "junitXML",
pluginType: "junitXML",
testSetName: "Junit",
metricsRecordUrl: "${env.BUILD_URL}",
buildUrl: "${env.BUILD_URL}",
)


Pipeline script

Upload metrics file input properties