Jira

Plugin details
Created by	Roadie
Category	Agile Planning
Source	GitHub
Type	Open-source plugin

Configuration

Application configuration YAML

This plugin requires a backend proxy configuration to make calls to Jira with authentication. In the following configuration, replace <your-jira-url> with the Jira instance project (for example https://mycompany.atlassian.net):

proxy:
  "/jira/api":
    target: "<your-jira-url>"
    pathRewrite:
      "api/proxy/jira/api/?": "/"
    headers:
      Authorization: ${JIRA_TOKEN}
      Accept: "application/json"
      Content-Type: "application/json"
      X-Atlassian-Token: "nocheck"
      User-Agent: "MY-UA-STRING"

Secrets

Since the JIRA_TOKEN variable is used in the application configuration, you must generate a Jira API key and set it as the value of JIRA_TOKEN. For information about how to generate a Jira API key, go to the instructions.

Delegate proxy

No action required

This plugin does not require a delegate proxy to be set up because Jira is publicly accessible.

Layout

This plugin exports a UI card that you can show on the Overview tab of a service or any other layout page. Go to Admin > Layout, select Service in the dropdown menu, and then add the following in the Overview section:

- component: EntityJiraOverviewCard

You can also make the card appear conditionally for services (only if Jira is configured for the service) by replacing the card with a switch case, as follows:

- component: EntitySwitch
  specs:
    cases:
      - if: isJiraAvailable
        content:
          component: EntityJiraOverviewCard

Annotations

To configure the plugin for a service in the software catalog, set one of the following annotations in its catalog-info.yaml definition file:

metadata:
  annotations:
    jira/project-key: <example-jira-project-key>
    jira/component: <example-component> # optional, you might skip this value to fetch data for all components

Support

The plugin is owned by Roadie and managed in the Roadie plugins repository as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.