|
1 | | -Jira integration for Splunk On-Call |
| 1 | +Jira App integration for Splunk On-Call |
2 | 2 | ********************************************************** |
3 | 3 |
|
4 | | -[ht_toggle title=“Requirements” id=“” class=“” style=“” ] |
| 4 | +Requirements |
| 5 | +================ |
5 | 6 |
|
6 | | -**Jira Version Required**: Jira Server 7.7.0 - 8.22.6, Jira Cloud |
7 | | -(versionless) |
| 7 | +* Jira Version Required: Jira Server 7.7.0 - 8.22.6, Jira Cloud |
| 8 | +* Splunk On-Call Version Required: Starter, Growth, or Enterprise |
| 9 | +* Global Admin privileges are required for the Splunk On-Call configuration. |
8 | 10 |
|
9 | | -**Splunk On-Call Version Required:** Starter, Growth, or Enterprise |
| 11 | +Configure in Splunk On-Call |
| 12 | +===================================== |
10 | 13 |
|
11 | | -[/ht_toggle] |
| 14 | +#. In Splunk On-Call, go to :guilabel:`Integrations` then :guilabel:`API`. |
| 15 | +#. Select :guilabel:`New Key`. |
| 16 | +#. Give the key a description and copy the resulting API key and API ID. |
12 | 17 |
|
13 | | -**Configuration in Splunk On-Call** |
14 | | ------------------------------------ |
| 18 | +Install the Splunk On-Call Add-On in Jira |
| 19 | +========================================== |
15 | 20 |
|
16 | | -**NOTE**\ *: Global Admin privileges are required for the Splunk On-Call |
17 | | -portion of the configuration.* |
| 21 | +#. Log in as a Jira administrator, then select the Jira administration gear icon then select :guilabel:`Manage apps` to go to the Atlassian Marketplace. |
| 22 | +#. In the sidebar, select :guilabel:`Find new apps` under the Atlassian Marketplace header. |
| 23 | +#. If you are on Jira Server, search for the app "Splunk On-Call for Jira Server". If you are on Jira Cloud, search for "VictorOps for Jira Cloud". After you've located the right app, select :guilabel:`Install`. |
| 24 | +#. After installation completes, select :guilabel:`Configure`. |
18 | 25 |
|
19 | | -In Splunk On-Call, navigate to **Integrations >> API**. |
20 | | - |
21 | | -Click the **New Key** button. Give the key a description. Note the |
22 | | -resulting **API key** and existing **API ID**. |
23 | | - |
24 | | -**Installing the Splunk On-Call Add-On** |
25 | | ----------------------------------------- |
| 26 | +Configuring application settings |
| 27 | +-------------------------------- |
26 | 28 |
|
27 | | -1. Log in as a Jira administrator, then navigate to the Atlassian |
28 | | - Marketplace by clicking on **Jira administration gear** **icon > |
29 | | - Manage apps**. |
30 | | -2. In the left-hand sidebar, click **Find new apps** under the Atlassian |
31 | | - Marketplace header. |
32 | | -3. If on Jira Server, search for the app \_Splunk On-Call for Jira |
33 | | - Server\_\_.\_ If on Jira Cloud, search for the app *VictorOps for |
34 | | - Jira Cloud*. Once you've located the right app, click *Install*. |
| 29 | +#. Enter the API key you generated in VictorOps in the :guilabel:`API Key` field under :guilabel:`Connect to your VictorOps Organization` on the VictorOps for Jira Server Configuration page. |
| 30 | +#. In the :guilabel:`API ID` field in the same section, insert the API ID you coped in the preceding Configure Splunk On-Call step. |
| 31 | +#. Copy the Splunk On-Call org ID displayed in your VictorOps URL. The org ID is at the end of the URL you use to log in: ``https://portal.victorops.com/client/<Org_ID>``. Paste the org ID in Jira's :guilabel:`Organization ID` field. |
| 32 | +#. Select :guilabel:`Connect`. |
35 | 33 |
|
36 | | -Once installation completes, click on **Configure**. |
| 34 | +A new entry appears in the Connected VictorOps Organizations section with a green VALID flag. |
37 | 35 |
|
38 | | -Configuring Application Settings |
39 | | --------------------------------- |
| 36 | +.. image:: /_images/spoc/1jira.png |
40 | 37 |
|
41 | | -1. Insert the API key you generated in VictorOps into the **API Key** |
42 | | - field under the *Connect to your VictorOps Organization* section of |
43 | | - Jira's *VictorOps for Jira Server Configuration* page. |
44 | | -2. In the **API ID** field in the same section, insert the API ID you |
45 | | - noted in the Splunk On-Call step above. |
46 | | -3. Copy the Splunk On-Call Org ID displayed in your VictorOps URL |
47 | | - (for example :samp:`https://portal.victorops.com/client/%7BOrg_ID`) and paste it in |
48 | | - Jira's **Organization ID** field. This is appended to the incident |
49 | | - link within Jira tickets. |
50 | | -4. Once all three fields have been populated, click **Connect**. On |
51 | | - success, a new entry will appear in the *Connected VictorOps |
52 | | - Organizations* section, and display a green “VALID” flag. |
53 | | - |
54 | | -/_images/spoc/1jira.png |
55 | | - |
56 | | -**Configuring Jira Project Settings** |
| 38 | +Configure Jira project settings |
57 | 39 | ------------------------------------- |
58 | 40 |
|
59 | | -The Splunk On-Call add-on must be enabled and configured for each Jira |
60 | | -project you wish to associate. Note that while multiple projects can |
61 | | -connect to the same Splunk On-Call organization, projects cannot share |
62 | | -the same *Default Team Escalation Policy*. |
| 41 | +The Splunk On-Call add-on must be activated and configured for each Jira project you want to associate. While multiple projects can |
| 42 | +connect to the same Splunk On-Call organization, projects cannot share the same Default Team Escalation Policy. |
63 | 43 |
|
64 | | -1. In Jira, click **Projects** |
65 | | -2. Navigate to **Project settings** of the project **you wish to enable |
66 | | - for the Splunk On-Call add-on**, then click **VictorOps Settings**. |
67 | | -3. Click **Enable VictorOps for this Project**. This will expand the |
68 | | - page to display a list of configurable fields. |
| 44 | +#. In Jira, select :guilabel:`Projects`. |
| 45 | +#. Go to :guilabel:`Project settings` of the project you want to activate for the Splunk On-Call add-on. |
| 46 | +#. Select :guilabel:`VictorOps Settings`. |
| 47 | +#. Select :guilabel:`Enable VictorOps for this Project`. |
69 | 48 |
|
70 | | -Default Incident Settings |
| 49 | +The page displays a list of configurable fields. |
| 50 | + |
| 51 | +Default incident settings |
71 | 52 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
72 | 53 |
|
73 | | -1. Under *VictorOps Instance*, select the Splunk On-Call organization |
74 | | - you wish to associate with this project. |
75 | | -2. Under *Default Team Escalation Policy*, select the Splunk On-Call |
76 | | - Escalation Policy you would like to page when Jira issues create |
77 | | - incidents in Splunk On-Call. NOTE: Incoming VictorOps incidents |
78 | | - assigned to this Escalation Policy will be the only ones allowed to |
79 | | - create issues in your Jira project. |
80 | | -3. Under *Default User*, select the Jira user you wish to designate as |
81 | | - Reporter for issues generated by incoming Splunk On-Call incidents. |
82 | | - |
83 | | -Incoming Issue Settings |
| 54 | +#. Under :guilabel:`VictorOps Instance`, select the Splunk On-Call organization you want to associate with this project. |
| 55 | +#. Under :guilabel:`Default Team Escalation Policy`, select the Splunk On-Call Escalation Policy you want to page when Jira issues create incidents in Splunk On-Call. Incoming VictorOps incidents assigned to this Escalation Policy are the only incidents allowed to create issues in your Jira project. |
| 56 | +#. Under :guilabel:`Default User`, select the Jira user you want to designate as reporter for issues generated by incoming Splunk On-Call incidents. |
| 57 | + |
| 58 | +Incoming issue settings |
84 | 59 | ~~~~~~~~~~~~~~~~~~~~~~~ |
85 | 60 |
|
86 | | -Splunk On-Call incidents created for a project's *Default Team |
87 | | -Escalation Policy* will automatically generate Jira issues. The default |
88 | | -type for such issues (Bug, Epic, Story, or Task) is set by selecting the |
89 | | -desired option from the **Issue type to use for incoming VictorOps |
90 | | -incidents** dropdown. |
| 61 | +Splunk On-Call incidents created for a project's Default Team Escalation Policy automatically generate Jira issues. The default type for such issues (Bug, Epic, Story, or Task) is set by selecting the desired option from the :guilabel:`Issue type to use for incoming VictorOps incidents` dropdown menu. |
91 | 62 |
|
92 | | -If you wish to disable such issue creation, deselect the **Allow issues |
93 | | -to be created from incidents via the REST API** checkbox. |
| 63 | +If you want to disable such issue creation, deselect the :guilabel:`Allow issues to be created from incidents via the REST API` checkbox. |
94 | 64 |
|
95 | | -/_images/spoc/2jira.png |
| 65 | +.. image:: /_images/spoc/2jira.png |
| 66 | + :width: 50% |
96 | 67 |
|
97 | | -Jira State Configuration |
| 68 | +Jira state configuration |
98 | 69 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
99 | 70 |
|
100 | | -Defining state mapping allows Jira issues to remain synchronized as |
101 | | -incidents move through their life cycle in VictorOps. |
| 71 | +Define state mapping to allows Jira issues to remain synchronized as incidents move through their life cycle in VictorOps. |
102 | 72 |
|
103 | | -/_images/spoc/3jira.png |
| 73 | +.. image:: /_images/spoc/3jira.png |
| 74 | + :alt: |
| 75 | + :width: 50% |
104 | 76 |
|
105 | | -**Creating a Splunk On-Call Incident Within Jira** |
| 77 | +Create a Splunk On-Call incident in Jira |
106 | 78 | -------------------------------------------------- |
107 | 79 |
|
108 | | -Currently, Splunk On-Call incidents can only be created from the Jira |
109 | | -issue view. |
110 | | - |
111 | | -1. Click **More** > **Create VictorOps Incident**. A preview of the |
112 | | - Splunk On-Call incident card will display, using the project's |
113 | | - *Default Team Escalation Policy*. Note: For Jira Cloud, the More |
114 | | - button is an ellipsis button. |
115 | | -2. You may select a different escalation policy from the *VictorOps Team |
116 | | - Escalation Policy* dropdown. You may also use the *Additional Users* |
117 | | - dropdown to optionally include additional users for response. Note |
118 | | - that adding users to an incident will *not* create a “Multi-Responder |
119 | | - incident” in Splunk On-Call. |
120 | | -3. Click **Create Incident** to generate a Splunk On-Call incident. |
121 | | - This will then display a *Triggered* Splunk On-Call incident card |
122 | | - under the *VictorOps* section in the lower right frame of the issue |
123 | | - view. |
124 | | -4. Click the incident card's **Incident Details** link to display the |
125 | | - incident in Splunk On-Call in a new browser tab. |
126 | | - |
127 | | -/_images/spoc/4jira.png |
| 80 | +Splunk On-Call incidents can only be created from the Jira issue view. |
| 81 | + |
| 82 | +#. Select :guilabel:`More` then :guilabel:`Create VictorOps Incident`. |
| 83 | +#. A preview of the Splunk On-Call incident card displays using the project's Default Team Escalation Policy. |
| 84 | +#. (Optional) Select a different escalation policy from the :guilabel:`VictorOps Team Escalation Policy` dropdown menu. |
| 85 | +#. (Optional) Use the :guilabel:`Additional Users` dropdown menu to include additional users for response. Adding users to an incident does not create a multi-responder incident in Splunk On-Call. |
| 86 | +#. Select :guilabel:`Create Incident` to generate a Splunk On-Call incident. A triggered Splunk On-Call incident card displays under the VictorOps section in the issue view. |
| 87 | +#. Select the :guilabel:`Incident Details` in the incident card in Splunk On-Call to display the incident in a new browser tab. |
| 88 | + |
| 89 | +.. image:: /_images/spoc/4jira.png |
| 90 | + :alt: |
0 commit comments