Skip to content

Commit 163ab97

Browse files
committed
Improvements
1 parent 1b8ad0f commit 163ab97

File tree

4 files changed

+26
-28
lines changed

4 files changed

+26
-28
lines changed

docs/user/alerting/action-types.asciidoc

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,19 @@ a| <<email-action-type, Email>>
1111

1212
| Send email from your server.
1313

14+
a| <<resilient-action-type, IBM Resilient>>
15+
16+
| Create an incident in IBM Resilient.
17+
1418
a| <<index-action-type, Index>>
1519

1620
| Index data into Elasticsearch.
1721

22+
a| <<jira-action-type, Jira>>
23+
24+
| Create an incident in Jira.
25+
26+
1827
a| <<pagerduty-action-type, PagerDuty>>
1928

2029
| Send an event in PagerDuty.
@@ -27,17 +36,6 @@ a| <<servicenow-action-type, ServiceNow>>
2736

2837
| Create an incident in ServiceNow.
2938

30-
a| <<jira-action-type, Jira>>
31-
32-
| Create an incident in Jira.
33-
34-
a| <<resilient-action-type, IBM Resilient>>
35-
36-
| Create an incident in IBM Resilient.
37-
38-
a| <<slack-action-type, Slack>>
39-
| Create an incident in ServiceNow.
40-
4139
a| <<slack-action-type, Slack>>
4240

4341
| Send a message to a Slack channel or user.
@@ -64,12 +62,12 @@ before {kib} starts.
6462
If you preconfigure a connector, you can also <<preconfigured-action-type-example, preconfigure its action type>>.
6563

6664
include::action-types/email.asciidoc[]
65+
include::action-types/resilient.asciidoc[]
6766
include::action-types/index.asciidoc[]
67+
include::action-types/jira.asciidoc[]
6868
include::action-types/pagerduty.asciidoc[]
6969
include::action-types/server-log.asciidoc[]
70+
include::action-types/servicenow.asciidoc[]
7071
include::action-types/slack.asciidoc[]
7172
include::action-types/webhook.asciidoc[]
7273
include::action-types/pre-configured-connectors.asciidoc[]
73-
include::action-types/servicenow.asciidoc[]
74-
include::action-types/jira.asciidoc[]
75-
include::action-types/resilient.asciidoc[]

docs/user/alerting/action-types/jira.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Jira action type uses the https://developer.atlassian.com/cloud/jira/platfor
1010

1111
Jira connectors have the following configuration properties:
1212

13-
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
13+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
1414
URL:: Jira instance URL.
1515
Project key:: Jira project key.
1616
Email (or username):: The account email (or username) for HTTP Basic authentication.
@@ -39,7 +39,7 @@ API token (or password):: Jira API authentication token (or password) for HTTP
3939
|===
4040

4141
| `apiUrl`
42-
| An address that corresponds to *Sender*.
42+
| An address that corresponds to *URL*.
4343

4444
| `projectKey`
4545
| A key that corresponds to *Project Key*.
@@ -52,7 +52,7 @@ API token (or password):: Jira API authentication token (or password) for HTTP
5252
|===
5353

5454
| `email`
55-
| A string that corresponds to *User*.
55+
| A string that corresponds to *Email*.
5656

5757
| `apiToken`
5858
| A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.
@@ -67,7 +67,7 @@ Jira actions have the following configuration properties:
6767
Issue type:: The type of the issue.
6868
Priority:: The priority of the incident.
6969
Labels:: The labels of the incident.
70-
Title:: A title of the issue, used for searching the contents of the knowledge base.
70+
Title:: A title for the issue, used for searching the contents of the knowledge base.
7171
Description:: The details about the incident.
7272
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
7373

docs/user/alerting/action-types/resilient.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The IBM Resilient action type uses the https://developer.ibm.com/security/resili
1010

1111
IBM Resilient connectors have the following configuration properties:
1212

13-
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
13+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
1414
URL:: IBM Resilient instance URL.
15-
Organization ID:: IBM Resilient organization ID..
15+
Organization ID:: IBM Resilient organization ID.
1616
API key ID:: The authentication key ID for HTTP Basic authentication.
1717
API key secret:: The authentication key secret for HTTP Basic authentication.
1818

@@ -39,7 +39,7 @@ API key secret:: The authentication key secret for HTTP Basic authentication.
3939
|===
4040

4141
| `apiUrl`
42-
| An address that corresponds to *Sender*.
42+
| An address that corresponds to *URL*.
4343

4444
| `orgId`
4545
| An ID that corresponds to *Organization ID*.
@@ -52,7 +52,7 @@ API key secret:: The authentication key secret for HTTP Basic authentication.
5252
|===
5353

5454
| `apiKeyId`
55-
| A string that corresponds to *User*.
55+
| A string that corresponds to *API key ID*.
5656

5757
| `apiKeySecret`
5858
| A string that corresponds to *API Key secret*. Should be stored in the <<creating-keystore, {kib} keystore>>.
@@ -66,11 +66,11 @@ IBM Resilient actions have the following configuration properties:
6666

6767
Incident types:: The incident types of the incident.
6868
Severity code:: The severity of the incident.
69-
Title:: A title of the issue, used for searching the contents of the knowledge base.
69+
Name:: A name for the issue, used for searching the contents of the knowledge base.
7070
Description:: The details about the incident.
7171
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
7272

7373
[[configuring-resilient]]
7474
==== Configuring and testing IBM Resilient
7575

76-
IBM Resilient offers free https://www.atlassian.com/software/resilient/free[Instances], which you can use to test incidents.
76+
IBM Resilient offers https://www.ibm.com/security/intelligent-orchestration/resilient[Instances], which you can use to test incidents.

docs/user/alerting/action-types/servicenow.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The ServiceNow action type uses the https://developer.servicenow.com/app.do#!/re
1010

1111
ServiceNow connectors have the following configuration properties:
1212

13-
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
13+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
1414
URL:: ServiceNow instance URL.
1515
Username:: Username for HTTP Basic authentication.
1616
Password:: Password for HTTP Basic authentication.
@@ -37,7 +37,7 @@ Password:: Password for HTTP Basic authentication.
3737
|===
3838

3939
| `apiUrl`
40-
| An address that corresponds to *Sender*.
40+
| An address that corresponds to *URL*.
4141

4242
|===
4343

@@ -47,7 +47,7 @@ Password:: Password for HTTP Basic authentication.
4747
|===
4848

4949
| `username`
50-
| A string that corresponds to *User*.
50+
| A string that corresponds to *Username*.
5151

5252
| `password`
5353
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
@@ -62,7 +62,7 @@ ServiceNow actions have the following configuration properties:
6262
Urgency:: The extent to which the incident resolution can delay.
6363
Severity:: The severity of the incident.
6464
Impact:: The effect an incident has on business. Can be measured by the number of affected users or by how critical it is to the business in question.
65-
Short description:: A short description of the incident, used for searching the contents of the knowledge base.
65+
Short description:: A short description for the incident, used for searching the contents of the knowledge base.
6666
Description:: The details about the incident.
6767
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
6868

0 commit comments

Comments
 (0)