Cloud Services

DevOps Intelligence

Atlassian Jira configuration
Published On Dec 12, 2024 - 1:59 PM

Atlassian Jira configuration

Learn how to configure DevOps Intelligence for the integration of Jira to broaden the observability of your hybrid IT estate.
Jira Software is part of a family of products designed to help teams of all types manage work. Originally, Jira was designed as a bug and issue tracker. But today, Jira has evolved into a powerful work management tool for all kinds of use cases, from requirements and test case management to agile software development.
The following items are prerequisite to integration:
  • Jira Account:
     User should have an active Jira account on the specific Jira instance user want to connect to. If user don't have one, user need to sign up for a Jira account.
  • Access to Jira Instance:
     Ensure that User have access to the specific Jira instance where the projects, components, and issues are hosted. Users need the URL or web address of the Jira instance user want to connect to.
  • Project Membership:
     Users must be part of the Jira projects user intend to access. Ensure that users have the necessary project membership to retrieve information about projects, components, and issues.
  • Access Policy as Platform Administrator and DevOps Intelligence Administrator:
     Ensure that the user creating the connection has the necessary access policies. The user should have the Platform Administrator role to create and manage connections effectively. The user needs the DevOps Intelligence Administrator role, which allows them to create and manage configurations.

Jira REST API version compatibility

DevOps Intelligence relies on Jira's REST API, and it is designed to work with a specific version. As of now, the integration is aligned with Jira REST API version 2 (/rest/api/2/). It's crucial to ensure that Jira is using a compatible version for the integration to function optimally.

Integrating Jira with DevOps Intelligence

DevOps Intelligence pulls data from GitHub Actions such as Build and Deploy details, including its unique identifier, status, time stamp, duration, and cause. The process for onboarding GitHub actions comprises the following steps, each of which is a multistep procedure:
  1. Create a Personal Access Token.
  2. Create a connection.
  3. Configure the application.
  4. Onboard the Jira technical service.

Creating a personal access token

Jira API Tokens are used as a form of authentication in Jira Services to access and interact with its resources programmatically or through APIs. Use the following procedure to create a Jira token:
  1. Navigate to the top right corner of the Jira homepage.
  2. Click on your profile picture and select
    Manage Account
    .
  3. Go to the
    Security
     tab.
  4. Click on
    Create and manage API tokens
    .
  5. Select
    Create API token
    .

Creating a connection

To pull data from GitHub Actions, you must establish a connection between DevOps Intelligence and GitHub Actions. Use the following procedure:
  1. Click on
    Settings
     →
    IAM
     →
    Connections
     →
    Add New
     →
    Add connection
    .
  2. Select
    Add Connection
    .
  3. Select the appropriate authentication type.
  4. If you are using a Proxy Adapter to access DevOps Intelligence through an intermediary layer, Enter the UUID for the adapter in the Proxy ID field.
  • When the sync-all is enabled, all the organization and repositories for which the user has access will be synced.
  • When the Archive is enabled, the connection is archived for future use.
  • For OAuth-based authentication, follow the steps given here to get the below-required fields:
    • ConsumerKey:
       Given on Jira Application Link Page.
    • PrivateKey:
       Private key (.pem format) of the public key generated while configuring Jira Application Link Page.
    • Secret:
       Generated after User confirmation from a Dialog box.
    • AccessToken:
       Generated value using Secret.

Configuring DevOps for GitHub Actions, recent customers

The procedures in this section are valid only for customers onboarded 6 June, 2024 or after. Procedures for legacy customers are provided in the subsequent section Configure DevOps Intelligence for GitHub, legacy customers.
Having created a connection, you must now configure the application.Use the following procedure:
  1. Click
    Settings & Utilities
     →
    Application Configuration
    .
  2. Select an existing application or create a new application.
  3. Navigate to
    Add Tools
     step.
  4. Select the phase as
    Plan
    .
  5. Click
    Add Tool Configuration
    .
  6. Complete the configurations, presented in the following tabs:
    1. Release
    2. Work Item Format
    3. Bug Formats
    4. Bug Severity
    5. Bug Status

Onboarding the Jira technical service

You must now onboard the technical service. Use the following procedure:
  1. Click
    Settings & Utilities
     →
    Application Configurations
    .
  2. Click the overflow menu for the chosen application and click on
    Onboard Technical Service
    .
  3. Select the phase as
    Plan
    .
  4. For
    Tool engine
    , select Jira.
  5. For
    Connection
    , select the appropriate connection name from the drop down.
  6. Enter the Technical Service name.
You can select Project tracking or Component tracking. Onboarding technical services are always configured as mutually exclusive. If two users having same privileges attempt to create technical service for the same project/component, only the first user is allowed to create the technical service because the project/component is already configured. The service will not be listed for the second user to configure. This behavior applies to sync.
For project tracking, select the Project Name from the dropdown. Configured projects are omitted from the list. The
Component
 field should remain empty.
For Component tracking, select the Project name and the component name.

Deleting the technical service

The administrator may, at will, delete the GitHub technical service. Use the following procedure:
  1. Click
    Settings & Utilities
     →
    Application Configuration
    .
  2. Expand the application to see all the associated phases.
  3. Click the Overflow menu against the Plan phase.
  4. Click
    Delete Technical Service
    .
  5. For tool engine select
    Jira
    .
  6. Select the appropriate Projects and Components.
  7. Click
    Delete
    .

Configuring DevOps for GitHub Actions, legacy customers

The user needs to select the Project that needs to be tracked through the DevOps Intelligence and its respective Components. Then, tracking can be done at two levels:
  • Project Level
    : This will track all the entities of a given project if no components selected
  • Components Level
    : This will track issues only for those selected Components

Project Level tracking

For this type of tracking, certain selections have to be made in the system, as follows:
  • Tool engine
    : Jira
  • Technical service name
    : It could be any string and is used only for reference.
  • Project
    : Here, the user must select
    Project
     Name from the dropdown. The already configured project will be omitted from the list.
  • Component
    : At project-level tracking, this field should be empty.
The following is an image of the Project Level Tracking configuration screen:

Component level tracking

For this type of tracking, certain selections have to be made in the system, as follows:
  • Tool engine
    : Jira
  • Technical service name
    : It could be any string and is used only for reference.
  • Project
    : Here, the user must select
    Project
     Name from the dropdown. The already configured project will be omitted from the list.
  • Component
    : At project-level tracking, this field should be empty.
API key:
 Personal access token, generated from the following menu selection: your profile and settings → personal settings → app passwords. If the configuration is successful, then a window will appear that shows a table with the configuration details.
The Sync Feature scans current data for visibility after configuring credentials at periodic intervals. The intervals are set as follows:
  • The account Sync Interval is set to 5 mins: Refresh current data
  • The account Delete Interval is set to 7 mins: All deleted accounts updated
  • The history pulled Interval is set to 180 days: Data history
For more details, see your Delivery representative.
Do you have two minutes for a quick survey?
Take Survey