Control Panel > Intergrations > JIRA

JIRA is a workflow management system that lets you track your work in any scenario.

Integrating JIRA with ESP will automatically create new issues for new alerts that you subscribe to. For example, if you subscribe to failing status and the alert starts as fail, changes to pass on a later run, and then fails again, two issues will be created for each fail status.

The Evident to JIRA integration requires 5 pieces of JIRA specific information:

  • URL
  • Project Key
  • Issue Type
  • Username
  • Password

URL

The JIRA REST API is enabled by default and has the following format:

http://jirahost.example.com:port/context/rest/api-name/api-version/resource-name

For the ESP integration, you only need the host and port portion of the URL. If you are using a standard port (80|443), you do not need to include the port number.

Example 1
http://jirahost.example.com
Example 2
https://jirahost.example.com:2876

For more information about the JIRA REST API, please follow this link.

Project Key

The JIRA integration needs to be associated with a specific JIRA Project. When you create a JIRA Project, you are required to designate Key. Include this Key when you configure the JIRA integration.

For detailed information on how to manage a JIRA Project, please refer to the JIRA documentation.

Issue Type

The JIRA integration needs to be associated with a specific JIRA Issue Type. Examples of the default Issue Types are Task, Bug, Improvement. You will need to decide which Issue Type to include when configuring the JIRA integration.

Given ESP’s Compliance and Security use case, consider creating a unique Issue Type for the ESP alerts such as “SecurityFinding”. For information on how to add an issue, please refer to the JIRA documentation on creating a new Issue Type.

For more detailed information on Issue Types, please refer to the JIRA documentation.

Username/Password

The ESP to JIRA integration uses Basic Auth so you will need to create a user with access to the Project designated in the previous step. For specifics on how to create a JIRA user and assign access, please refer to the JIRA documentation.

Test JIRA Configuration

Before configuring the ESP integration you may want to test your JIRA configuration by following these instructions. This particular example uses curl so you will need access to bash shell.

  1. Create a text file (example test.txt) with the following:

    {
    "fields": {
    "project":
    {
    "key": "Your_Project_Key"
    },
    "summary": "JIRA configuration test",
    "description": "Creating an issue via REST API",
    "issuetype": {
    "name": "SecurityFinding"
    }
    }
    }


  2. Use curl to create an issue:

    curl -D- -u USERNAME:PASSWORD -X POST --data-binary "@FILENAME" -H "Content-Type: application/json" https://jirahost.example.com/rest/api/latest/issue/


  3. If the command was successful it will return similar output to the following:

    HTTP/1.1 201 Created
    Server: nginx
    Date: Wed, 22 Feb 2017 15:22:14 GMT
    Content-Type: application/json;charset=UTF-8
    Transfer-Encoding: chunked
    Connection: keep-alive
    X-AREQUESTID: 622x1128x1
    X-AUSERNAME: USERNAME
    X-ATENANT-ID: jirahost.example.com
    Cache-Control: no-cache, no-store, no-transform
    X-Content-Type-Options: nosniff
    Set-Cookie: JSESSIONID=974A7D7832157FEB89DF7EFA90EA8691; Path=/; Secure; HttpOnly
    Set-Cookie: atlassian.xsrf.token=BE2J-9QGD-DHYI-2L1Q|95d23adf9a7127427b08570d0955caf2b408daca|lin; Path=/; Secure
    Strict-Transport-Security: max-age=315360000;includeSubDomains

Create JIRA Integration in ESP

  1. Log into ESP.
  2. Navigate to Control Panel > Integrations.
  3. Click the JIRA icon.

    JIRA Icon

  4. Enter the information in the following fields, based on the information from the previous sections:
    1. URL
    2. Project Key
    3. Issue Type
    4. Username
    5. Password

    6. JIRA Integration
  5. Click Save.