Table of contents

DevOptics User Guide


Integrations

DevOptics integrates with both Git and Jira®.

Git integration

Git integration allows you to view Git commits within a value stream. It enables you to track commits through various phases and gates of a value stream. This provides visibility into the commit to production journey of your commits. Git integration is made possible by installing the Git plugin and its dependencies in Jenkins. Its part of the recommended plugins when you first setup a Jenkins master. If you have installed the recommended plugins already, then you do not need any further steps to integrate with Git. If you do not have the Git plugin installed, then refer to https://www.cloudbees.com/blog/using-git-jenkins to install it.

Jira® integration

Jira® integration allows you to view Jira® tickets within a value stream. It enables you to track tickets through various phases and gates of a value stream. This provides visibility into the commit to production journey of your critical features.

Note
Jira® integration is enabled by direct communication between Jira® and the browser. We do not store any of your Jira® project information in our datastore.

These are the current ways to integrate DevOptics with Jira®:

DevOptics recommends integrating directly with Jira® Cloud or Server in preference to integrating via Jenkins for the following reasons:

  • When integrating directly to Jira®, each user of DevOptics can use their own Jira® login credentials. This allows DevOptics to fetch details for tickets from the projects that that particular user has permissions for. Conversely, DevOptics will not be able to fetch details for tickets that the user does not have permissions for.

  • When integrating via Jenkins, all DevOptics users in an organization must use whatever login credentials have been configured in the DevOptics plugin. This may not be permissive or restrictive enough for all users in the organization.

  • Integrating directly to Jira® removes a dependency on Jenkins and the DevOptics plugin for the Jira® integration feature.

Jenkins master as a Jira® proxy

This Jenkins master will act as a proxy between the browser and the Jira® server.

Configure Jira® in Jenkins master

Add the Jira® server as an Issue Tracker in the DevOptics section of Jenkins  Manage Jenkins › Configure System. You only need to configure Jira® in one of your Jenkins masters. Remember the URL of this master where you have configured Jira®.

Important
You may find a JIRA section in Jenkins  Manage Jenkins › Configure System. For the DevOptics integration, that is not the place to put your Jira® details.

01 define jira server and credentials

Configure Jenkins Jira® proxy in the browser

DevOptics does not store your Jira® information in the cloud. DevOptics uses your Jenkins server as a proxy to communicate with your Jira® server. Configure that proxy:

  1. Log in into https://devoptics.cloudbees.com and go to Settings  Jira

  2. Select Configure

  3. In the Jenkins Jira Proxy Configuration dialog enter the:

    • Jenkins URL of the Jenkins master where you configured Jira®. Ensure that the Jenkins URL uses the https scheme

    • Your Jenkins username

    • Your Jenkins API Key

  4. Click Connect

02 jira proxy configuration

Note
To obtain your API Key, navigate to http://your.jenkins.server/me/configure and press API Key

Direct Jira® Integration

Jira® Server

Jira® Server Plugin Installation
  1. Log in to your Jira® Server instance with an account that has admin permissions.

  2. Navigate to Administration  Add-ons  Find new apps.

  3. In the Search the Marketplace search box, enter “DevOptics Plugin” to search for the plugin.

  4. Locate the "DevOptics Plugin" in the results list and click on Install.

  5. After installation is complete, go to Manage apps to see the plugin in the list of User-installed apps.

04 manage apps

DevOptics UI Configuration
  1. Log in to DevOptics.

  2. Select Settings, and then select JIRA.

  3. Select the Connect to JIRA Server connection type.

  4. Enter your Jira® Server URL (e.g. https://jira.my-org.com).

  5. Select Save.

  6. If you are not already logged in to Jira® from that browser:

    • Select Log into JIRA.

    • Log in using Jira® Server’s login page.

    • If successfully connected, you will see a list of projects for which you have permissions.

Jira® Cloud

Getting an API Token

A DevOptics user will use an API token to authenticate with their Jira® Cloud application. An API token is used by 3rd party applications to authenticate in place of the user’s password. The benefits of an API token are that a user does not have to disclose their primary password to a 3rd party application, an API token can be revoked at the user’s discretion if they no longer want a 3rd party application to be authenticated, and a user can change their password without affecting the authentication of 3rd party applications.

To get an API token, log in to https://id.atlassian.com/manage/api-tokens with the Jira® account you wish to connect with and create an API token for DevOptics.

The recommendation is to create a dedicated “DevOptics” API token that can be revoked at a later date, if necessary, without affecting any other applications that may be integrating via API tokens. Documentation on creating API tokens is https://confluence.atlassian.com/cloud/api-tokens-938839638.html.

DevOptics UI Configuration
  1. Log in to DevOptics.

  2. Select Settings, and then select JIRA.

  3. Select the Connect to JIRA Cloud connection type.

  4. Enter your Jira® Cloud URL (e.g. https://my-org.atlassian.net)

  5. Enter your Jira® username (e.g. me@my-org.com) and API token (e.g. x2trFY9gZO0FOCsSBXcHFD86).

  6. Click Connect.

If successfully connected, you will see a list of the projects for which you have permissions

07 jira authentication