Setting up integrations

CloudBees SDM is a preview, with early access for select preview members. Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support. Learn more about the preview program.

Integrating external services like GitHub, Jira, and Jenkins lets CloudBees SDM access data from these services. This data lets you monitor and manage the delivery of your products and features. Integrating a service like GitHub with CloudBees SDM lets you add GitHub repositories to products so you can display branches, pull requests, commits, and branch status.

You can integrate services by installing apps. CloudBees SDM includes apps for Jira Server, Jira Cloud, GitHub, GitHub Enterprise, and Jenkins. You can also develop your own apps to integrate other services using the app framework for developing custom apps.

Some on-premise systems can be integrated using an NGINX gateway.

Integrating GitHub

CloudBees SDM integrates with GitHub using the CloudBees SDM app, which connects a GitHub organization to your CloudBees SDM user profile. You need administrative rights on your GitHub organization to install the CloudBees SDM app.

You can associate a GitHub organization with only a single CloudBees SDM uesr profile currently.

To connect to GitHub.com, you must install the CloudBees SDM app on GitHub. After you have connected GitHub to CloudBees SDM, you can see your GitHub repository data in CloudBees SDM. Then, you can link repositories and data to products to help you to prioritize work and locate blockers.

You must have administrative privileges in CloudBees to connect GitHub to CloudBees SDM.

To connect GitHub to CloudBees SDM:

  1. Select Apps.

  2. Select GitHub, and then select Install app.

  3. On the Add GitHub app screen, verify that you want to install and configure the CloudBees SDM app, and then click Install GitHub App.

  4. On the CloudBees SDM app screen, select Configuration.

  5. Select Configure GitHub and then select Configure GitHub on the pop-up window.

  6. Select Configure on the GitHub app.

  7. Select the GitHub organization you want to associate with your CloudBees SDM user profile. If you only have one user profile, that one is associated automatically.

  8. Select one of the following options:

    • To make all repositories in the organization available in CloudBees SDM, select All repositories. All future updates will automatically be imported into CloudBees SDM.

    • To allow CloudBees SDM to access only specific repositories, select Only select repositories, and then select the repositories you want to add. Any time a new repository is added, you must update the list of approved repositories to import the updates into CloudBees SDM.

  9. Select Install.

The GitHub page now displays a list of the authorized organizations and repositories. Use Configure GitHub to update the repositories list.

To remove an integration, refer to the GitHub integrations section.

Integrating Jenkins

Refer to Jenkins integration for instructions.

Integrating Jira

Refer to Jira Cloud integration and Jira Server for instructions.

Integrating with on-premise servers

You can use an NGINX gateway to integrate on-premise services like Jira Server with CloudBees SDM.

Refer to Configuring NGINX for instructions on how to configure the gateway.