REVIEW - Registering Issue Management Systems in Workbench 🔒

In order to register a new DataStage Project with MettleCI you first need to be logged in as a DataStage Administrator. You can then access the project registration interface by clicking User → Manage Projects

You will then be presented with the new project list. On each project you can see that there is an ‘Issue Management’ column which allows you to configure the issue management system on a project by project basis.

It's possible that the ‘Default Issue Management’ System that is initially configured will not be the one that you want to use for the majority of your projects and you will have to update this manually. It would be tedious to have to input the required credentials each time a new DataStage Project is registered. Therefore you will only need to register each different ‘Issue Management System’ once for which you can then choose which projects to associate with.

Updating the default Issue Management System

Before we worry about configuring multiple issue management systems it would probably be best to set a default one that can be used for all currently registered projects.

First select User → Issue Management:

To Configure the Default Issue Management System to be the same as the one we were using before the upgrade you will be required to change it’s type and enter your new details. Click on the Pencil (Edit) button

Select the Issue Management Type and set it to the type you would like to be the default for all projects. In this example we will be using Jira however there are also guides for Azure, Gitlab, ServiceNow

You will now want to fill out all the details for your particular Jira Configuration. If you have already configured Jira, I recommend:

• Getting Your Consumer Secret from the jira_privatekey.pcks8 file off the device running workbench. (Most likely in /opt/dm/mci/jira_privatekey.pcks8)

• Getting Your Jira Key and Jira URL from the config.yml of the host running workbench (most likely in /opt/dm/mci/config.yml)

If you have not configured Jira before, or do not have access to the machine where these details are stored there is no issue in configuring it again, there will be a few extra steps. Otherwise Jump straight down to Step 3 - Enter your credentials into workbench

Step 1 - Generating an RSA Public/Private Key Pair

If you haven’t already, you will need to create a key pair for Workbench to use to authenticate with Jira.

On your local machine (or alternatively any secure machine with openssl installed)

1. Generate a 1024-bit private key:

   openssl genrsa -out jira_privatekey.pem 1024

2. Create an X509 certificate:

   openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365

3. Extract the private key (PKCS8 format) to the jira_privatekey.pcks8 file:

   openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8

4. Extract the public key from the certificate to the jira_publickey.pem file:
   openssl x509 -pubkey -noout -in jira_publickey.cer > jira_publickey.pem

Step 2 - Creating a Jira Application Link

These steps are geared specifically towards Workbench. Atlassian’s own documentation is under the Create an application link section of this page: https://developer.atlassian.com/server/jira/platform/oauth/

1. Start by going to the Application links option (under Integrations) of your Jira Administration area.

2. In the field at the top (under ‘Configure Application Links’) enter your MettleCI Workbench URL, including protocol and port number (e.g. https://my-engine.company-intranet.com:8443)

3. Click Create new link

4. Click Continue on the Configure Application URL window (ignore the “No response…” message):

On the next window, enter the Application Name, check the Create incoming link checkbox and then click Continue (you can leave the other fields blank):

On the next window, enter a random value for Consumer Key, the Consumer Name (e.g. MettleCI Workbench), and the Public Key (jira_publickey.pem) that will be used by your Workbench application.

Step 3 - Enter the credentials into workbench

The Jira URL needed should be visible as the Application URL when configuring the Link Application for Jira (or inside your config.yml already)

The Jira Key is also the consumer key you entered when configuring the application link (or the consumerKey inside your config.yml)

For the Consumer Secret field make sure to copy and paste the contents of your jira_privatekey.pcks8 file.

Now all of your currently registered projects will use this Jira configuration by default and you can choose to move to another issue management service or server by creating another configuration. To create additional issue management services simply click the '+' icon in the top right hand corner.