Jira Server integration

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.

Jira Server integration lets you link Jira Server projects to associated products so you can have visibility into all tickets and related data. This integration lets you prioritize more efficiently and track all work related to those projects.

Jira Server integration includes support for Jira Data Center. Jira Data Center provides a cluster environment that allows you to horizontally scale out your infrastructure so you can support more users. Refer to Atlassian Data Center for more information. Jira Server and Jira Data Center 7.13.0 and above are supported.

Integration with Jira Server is provided through a CloudBees SDM plugin. After you install the plugin, you can establish a connection between the Jira Server and your CloudBees SDM user profile. The CloudBees SDM plugin can be configured to allow a connection between the CloudBees SDM plugin and a proxy server. This allows the Jira Server to connect to your CloudBees SDM user profile using a proxy.

When you upload and install the CloudBees SDM plugin in the Jira Data Center, it automatically runs on all nodes of the cluster.

What data is stored

CloudBees SDM stores the following Jira Server information in the System of Record for each instance that has installed the plugin:

  • Account - The CloudBees user profile or organization profile linked with this Jira Server

  • Client key or Server ID - The unique identifier for the Jira Server

  • Shared secret - The secret used for JWT Authentication and Authorization for communication between the Jira Server Injector and the Jira Server plugin

  • Server version - The version of the Jira Server

  • Plugin version - The installed version of the plugin

  • Base URL - The URL for the Jira Server

  • Installation secret - The secret used by the Jira Server Injector to validate the association request upon plugin install

  • Installed - The flag denoting if the plugin is currently installed on a Jira Server

Uploading and installing the CloudBees SDM plugin on the Jira Server

You must have Jira Server administrative privileges to upload and install the CloudBees SDM plugin.

You must install the CloudBees SDM plugin to establish a connection between the Jira Server and your CloudBees SDM user profile. Use these steps to upload and install the CloudBees SDM plugin on the Jira Server:

  1. Sign into your Jira Server instance.

  2. On the top right of the dashboard, select the Settings icon.

  3. Select Manage apps on the dropdown menu.

  4. Enter your Jira Server administrative privileges.

  5. On the sidebar menu on the left, select the dropdown option for Manage apps.

  6. Select the Manage apps tab.

  7. Select the Upload app link on the right.

  8. Enter this URL into the From this URL text box: https://github.com/cloudbees/sdm-jira-server-plugin-release/releases/latest/download/sdm-jira-server-plugin.obr

  9. Select Upload.

  10. If successful, the Installed and ready to go! window appears. Select Close.

You can check that the plugin is installed by navigating to the Manage Apps tab and looking for CloudBees Jira Server Plugin in the list of User-installed apps.

Connecting your CloudBees SDM user profile and the Jira Server

CloudBees SDM plugin must be installed before connecting to the server.

Use the following sections to connect the Jira Server to your CloudBees SDM user profile by either entering the base Jira Server URL or by manually entering connection parameters. One reason you would want to connect manually using the connection parameters is that you do not have access to the Jira Server instance.

Connecting to the Jira Server with the base URL

Sign into CloudBees SDM with administrative privileges to connect to the Jira Server with the base URL:

  1. From within CloudBees SDM, select Apps, and then select Jira Server.

  2. Select the Configuration tab.

  3. If you are configuring your first connection, select Configure. Otherwise, select Add connection.

  4. Enter your base Jira Server URL.

    1. If you are not logged into the Jira Server, the login window appears. Enter your credentials.

  5. Select Continue.

  6. If successful, the Successful connection box appears. Select Close.

Now that your CloudBees SDM user profile and the Jira Server are connected, you can link your Jira Server projects to products within CloudBees SDM which allows you to have visibility into all tickets and related data. Refer to Monitoring product status and repository health for more information.

Connecting to the Jira Server with connection parameters

First find the connection parameters and then enter them manually. You need the following connection parameters:

  • Server ID

  • Installation secret

Sign into your Jira Server instance with administrative privileges to find the connection parameters:

  1. Sign into your Jira Server instance.

  2. On the top right of the dashboard, select the Settings icon.

  3. Select Manage apps on the dropdown menu.

  4. Enter your Jira Server administrative privileges.

  5. On the menu on the left side, select CloudBees SDM Plugin.

  6. View the Server ID and the Installation secret.

Now that you have the connection parameters, go to CloudBees SDM to enter them manually.

Sign into CloudBees SDM with administrative privileges to connect to the Jira Server:

  1. From within CloudBees SDM, select Apps, and then select Jira Server

  2. Select the Configuration tab.

  3. If you are configuring your first connection, select Configure. Otherwise, select Add connection.

  4. Select Enter manually.

  5. On the Add Jira Connection window, enter the Server ID and the Installation secret.

  6. Select Continue.

  7. If successful, the Successful connection box appears. Select Close.

Now that your CloudBees SDM user profile and the Jira Server are connected, you can link your Jira Server projects to products within CloudBees SDM which allows you to have visibility into all tickets and related data. Refer to Monitoring product status and repository health for more information.

Connecting your CloudBees SDM user profile using a proxy

CloudBees SDM plugin must be installed before connecting your CloudBees SDM user profile using a proxy.

Sign into your Jira Server instance with administrative privileges to connect to a proxy:

  1. Sign into your Jira Server instance.

  2. On the top right of the dashboard, select the Settings icon.

  3. Select Manage apps on the drop-down menu.

  4. Enter your Jira Server administrative privileges.

  5. On the menu on the left side, select CloudBees SDM Plugin.

  6. Select Use proxy.

  7. Enter the URL of a proxy server.

  8. Select Test connectivity to confirm connection.

  9. Select Save.

If no proxy URL is provided, you can establish a direct connection between your CloudBees SDM user profile and the Jira Server.

Removing the connection to a Jira Server

Sign into CloudBees SDM with administrative privileges to remove the connection to a Jira Server:

  1. From within CloudBees SDM, select Apps, and then select Jira Server.

  2. Select the Configuration tab.

  3. Choose the connection that you want to remove and select the vertical three dots on the right side.

  4. Select Remove. The Remove connection window comes up.

  5. Select Remove.

  6. If removed, a window appears with a message that the Jira Server was successfully removed.