Integrate single CloudBees CI or Jenkins® controllers with CloudBees Unify to visualize CI jobs and builds, analyze test results and artifacts, and orchestrate software releases. This method connects one controller at a time to CloudBees Unify, and is ideal for Jenkins users, environments with few controllers, or selective integration.
|
Set up the integration
Follow these steps to integrate your controller with CloudBees Unify.
| Step | Where | Action |
|---|---|---|
1 |
Your controller |
Set up a CloudBees CI or Jenkins Multibranch Pipeline or an Organization Folder with a GitHub, Bitbucket, or GitLab branch source. |
2 |
Your controller |
|
3 |
CloudBees Unify |
|
4 |
CloudBees Unify |
Create an SCM integration for the Multibranch or Organization Folder code source. |
5 |
CloudBees Unify |
Create a component with the integrated source code. |
System specifications
This CloudBees Unify feature has the following technical requirements and limitations. These factors may evolve.
-
Use a CloudBees CI or Jenkins Multibranch Pipeline or Organization Folder, as other project types are not supported.
-
Use a GitHub, Bitbucket, or GitLab branch source for the Multibranch Pipeline or Organization Folder. Other SCM providers are not supported at this time.
-
Create an SCM integration between the SCM repository associated with your Multibranch Pipeline or Organization Folder and CloudBees Unify.
-
If your Multibranch or Organization Folder contains more than one repository, only the first detected SCM repository is considered by CloudBees Unify.
-
Only CI jobs and builds executed from your controller after integrating with CloudBees Unify are displayed.
Set up a CloudBees CI or Jenkins Multibranch Pipeline or an Organization Folder
Set up a CloudBees CI or Jenkins Multibranch Pipeline or an Organization Folder on your controller with a GitHub, Bitbucket, or GitLab branch source. Refer to Create Multibranch Projects and Organization Folders with large repositories for details.
| GitLab Cloud and Bitbucket Data Center are supported. |
Install the required plugin to the controller
CloudBees Platform Integration Plugin::Controllers (cloudbees-cbp-unify-integration-plugin) connects CI controller instances to CloudBees Unify.
| This plugin is only available for CloudBees CI version 2.504.2.5 or later and Jenkins version 2.504.2 or later. |
To install the plugin:
-
From the controller dashboard, select in the upper-right corner to navigate to the Manage Jenkins page.
-
Select .
-
In the Search available plugins field, enter
CloudBees Platform Integration Plugin::Controllers. -
Select the checkbox next to the plugin.
-
Select Install in the upper-right corner.
Set up the controller integration in CloudBees Unify
After installing the plugin, set up a single controller integration in CloudBees Unify.
Create an SCM integration
After your controller is integrated with CloudBees Unify, create an SCM integration for the Multibranch Pipeline or Organization Folder code source.
Create an integrated component
To fully integrate a CI pipeline with CloudBees Unify, create a component to link the source code in your controllers with CloudBees Unify. Each component connects to a single source code repository via an SCM integration. By creating a component for your pipeline source code, you can facilitate the management of complex CI pipelines and ensure traceability and insight into your SDLC. Components ensure that all code updates are systematically processed, logged, and integrated, enhancing the scalability and reliability of software delivery.
-
Create an SCM integration with CloudBees Unify for the Multibranch or Organization Folder project code source on your controllers.
-
Create a CloudBees Unify component with the integrated source code to enable metrics for your project.
-
indicates a repository integrated with a Multibranch Pipeline that you can select to create a component. -
If you do not find your repository listed with
, select Set up your controller to confirm that it is connected to the CI controller.
Figure 1. An integrated repository is highlightedThe component for your integrated CI pipeline is created accordingly.
-
Next steps
After you integrate your CI with CloudBees Unify, you can:
-
Visualize details of your CI jobs and builds, including test results and build artifacts.
-
Set up automatically triggered implicit security analysis.
-
Create an application, which enables you to orchestrate complex software releases.
-
Monitor your integrated CI data in CloudBees Unify value stream management (VSM) dashboards.
Upgrade CloudBees Platform Integration Plugin::Controllers from version 1.422 or earlier
The CloudBees Platform Integration Plugin::Controllers version 1.422 or earlier automatically installs and configures the OpenTelemetry plugin to populate data to the CloudBees Unify. Starting with version 1.422.639, the OpenTelemetry plugin is no longer used, so this dependency has been removed.
When you upgrade the CloudBees Platform Integration Plugin::Controllers to version 1.422.639 or later, it automatically restores the OpenTelemetry plugin configuration to its default settings, but the plugin remains installed and requires manual removal.
You should manually remove the OpenTelemetry plugin if you do not use it with any other observability backend. This is strongly recommended because the plugin has a known bug that causes it to send metrics even when not configured. You can remove the OpenTelemetry plugin by following the instructions for Removing a plugin. If you prefer, you can disable the plugin instead.
| The OpenTelemetry plugin also adds a transitive dependency to OpenTelemetry API plugin, which you can safely uninstall. |
(Optional) Uninstall additional plugins
You can also uninstall the following general-use plugins required by the OpenTelemetry plugin if you no longer use them.
| In most CloudBees CI or Jenkins instances, these plugins are already installed and in use, so removal is rarely necessary. |