Skip to content

Commit 114a354

Browse files
committed
Merge branch 'master' into fix-lodash-imports
2 parents 720de1a + e0755a7 commit 114a354

File tree

527 files changed

+14429
-4242
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

527 files changed

+14429
-4242
lines changed

docs/api/saved-objects/create.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ experimental[] Create {kib} saved objects.
1313

1414
`POST <kibana host>:<port>/api/saved_objects/<type>/<id>`
1515

16-
`POST <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>`
16+
`POST <kibana host>:<port>/s/<space_id>/saved_objects/<type>`
1717

1818
[[saved-objects-api-create-path-params]]
1919
==== Path parameters

docs/developer/getting-started/development-plugin-resources.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To enable TypeScript support, create a `tsconfig.json` file at the root of your
3333
["source","js"]
3434
-----------
3535
{
36-
// extend {kib}'s tsconfig, or use your own settings
36+
// extend Kibana's tsconfig, or use your own settings
3737
"extends": "../../kibana/tsconfig.json",
3838
3939
// tell the TypeScript compiler where to find your source files

docs/getting-started/tutorial-define-index.asciidoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,11 @@ contains the time series data.
4747
[role="screenshot"]
4848
image::images/tutorial_index_patterns.png[All tutorial index patterns]
4949

50+
NOTE: When you define an index pattern, the indices that match that pattern must
51+
exist in Elasticsearch and they must contain data. To check if the indices are
52+
available, open the menu, go to *Dev Tools > Console*, then enter `GET _cat/indices`. Alternately, use
53+
`curl -XGET "http://localhost:9200/_cat/indices"`.
54+
For Windows, run `Invoke-RestMethod -Uri "http://localhost:9200/_cat/indices"` in Powershell.
55+
5056

5157

docs/getting-started/tutorial-full-experience.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,14 @@ curl -O https://download.elastic.co/demos/kibana/gettingstarted/8.x/shakespeare.
2525
curl -O https://download.elastic.co/demos/kibana/gettingstarted/8.x/accounts.zip
2626
curl -O https://download.elastic.co/demos/kibana/gettingstarted/8.x/logs.jsonl.gz
2727

28-
Two of the data sets are compressed. To extract the files, use the following commands:
28+
Alternatively, for Windows users, run the following commands in Powershell:
29+
30+
[source,shell]
31+
Invoke-RestMethod https://download.elastic.co/demos/kibana/gettingstarted/8.x/shakespeare.json -OutFile shakespeare.json
32+
Invoke-RestMethod https://download.elastic.co/demos/kibana/gettingstarted/8.x/accounts.zip -OutFile accounts.zip
33+
Invoke-RestMethod https://download.elastic.co/demos/kibana/gettingstarted/8.x/logs.jsonl.gz -OutFile logs.jsonl.gz
34+
35+
Two of the data sets are compressed. To extract the files, use these commands:
2936

3037
[source,shell]
3138
unzip accounts.zip

docs/user/alerting/action-types.asciidoc

Lines changed: 12 additions & 1 deletion
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.
@@ -53,10 +62,12 @@ before {kib} starts.
5362
If you preconfigure a connector, you can also <<preconfigured-action-type-example, preconfigure its action type>>.
5463

5564
include::action-types/email.asciidoc[]
65+
include::action-types/resilient.asciidoc[]
5666
include::action-types/index.asciidoc[]
67+
include::action-types/jira.asciidoc[]
5768
include::action-types/pagerduty.asciidoc[]
5869
include::action-types/server-log.asciidoc[]
70+
include::action-types/servicenow.asciidoc[]
5971
include::action-types/slack.asciidoc[]
6072
include::action-types/webhook.asciidoc[]
6173
include::action-types/pre-configured-connectors.asciidoc[]
62-
include::action-types/servicenow.asciidoc[]
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
[role="xpack"]
2+
[[jira-action-type]]
3+
=== Jira action
4+
5+
The Jira action type uses the https://developer.atlassian.com/cloud/jira/platform/rest/v2/[REST API v2] to create Jira issues.
6+
7+
[float]
8+
[[jira-connector-configuration]]
9+
==== Connector configuration
10+
11+
Jira connectors have the following configuration properties:
12+
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.
14+
URL:: Jira instance URL.
15+
Project key:: Jira project key.
16+
Email (or username):: The account email (or username) for HTTP Basic authentication.
17+
API token (or password):: Jira API authentication token (or password) for HTTP Basic authentication.
18+
19+
[float]
20+
[[Preconfigured-jira-configuration]]
21+
==== Preconfigured action type
22+
23+
[source,text]
24+
--
25+
my-jira:
26+
name: preconfigured-jira-action-type
27+
actionTypeId: .jira
28+
config:
29+
apiUrl: https://elastic.atlassian.net
30+
projectKey: ES
31+
secrets:
32+
email: testuser
33+
apiToken: tokenkeystorevalue
34+
--
35+
36+
`config` defines the action type specific to the configuration and contains the following properties:
37+
38+
[cols="2*<"]
39+
|===
40+
41+
| `apiUrl`
42+
| An address that corresponds to *URL*.
43+
44+
| `projectKey`
45+
| A key that corresponds to *Project Key*.
46+
47+
|===
48+
49+
`secrets` defines sensitive information for the action type:
50+
51+
[cols="2*<"]
52+
|===
53+
54+
| `email`
55+
| A string that corresponds to *Email*.
56+
57+
| `apiToken`
58+
| A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.
59+
60+
|===
61+
62+
[[jira-action-configuration]]
63+
==== Action configuration
64+
65+
Jira actions have the following configuration properties:
66+
67+
Issue type:: The type of the issue.
68+
Priority:: The priority of the incident.
69+
Labels:: The labels of the incident.
70+
Title:: A title for the issue, used for searching the contents of the knowledge base.
71+
Description:: The details about the incident.
72+
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
73+
74+
[[configuring-jira]]
75+
==== Configuring and testing Jira
76+
77+
Jira offers free https://www.atlassian.com/software/jira/free[Instances], which you can use to test incidents.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This is required to encrypt parameters that must be secured, for example PagerDu
3636
If you have security enabled:
3737

3838
* You must have
39-
application privileges to access Metrics, APM, Uptime, or SIEM.
39+
application privileges to access Metrics, APM, Uptime, or Security.
4040
* If you are using a self-managed deployment with security, you must have
4141
Transport Security Layer (TLS) enabled for communication <<configuring-tls-kib-es, between Elasticsearch and Kibana>>.
4242
Alerts uses API keys to secure background alert checks and actions,
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
[role="xpack"]
2+
[[resilient-action-type]]
3+
=== IBM Resilient action
4+
5+
The IBM Resilient action type uses the https://developer.ibm.com/security/resilient/rest/[RESILIENT REST v2] to create IBM Resilient incidents.
6+
7+
[float]
8+
[[resilient-connector-configuration]]
9+
==== Connector configuration
10+
11+
IBM Resilient connectors have the following configuration properties:
12+
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.
14+
URL:: IBM Resilient instance URL.
15+
Organization ID:: IBM Resilient organization ID.
16+
API key ID:: The authentication key ID for HTTP Basic authentication.
17+
API key secret:: The authentication key secret for HTTP Basic authentication.
18+
19+
[float]
20+
[[Preconfigured-resilient-configuration]]
21+
==== Preconfigured action type
22+
23+
[source,text]
24+
--
25+
my-resilient:
26+
name: preconfigured-resilient-action-type
27+
actionTypeId: .resilient
28+
config:
29+
apiUrl: https://elastic.resilient.net
30+
orgId: ES
31+
secrets:
32+
apiKeyId: testuser
33+
apiKeySecret: tokenkeystorevalue
34+
--
35+
36+
`config` defines the action type specific to the configuration and contains the following properties:
37+
38+
[cols="2*<"]
39+
|===
40+
41+
| `apiUrl`
42+
| An address that corresponds to *URL*.
43+
44+
| `orgId`
45+
| An ID that corresponds to *Organization ID*.
46+
47+
|===
48+
49+
`secrets` defines sensitive information for the action type:
50+
51+
[cols="2*<"]
52+
|===
53+
54+
| `apiKeyId`
55+
| A string that corresponds to *API key ID*.
56+
57+
| `apiKeySecret`
58+
| A string that corresponds to *API Key secret*. Should be stored in the <<creating-keystore, {kib} keystore>>.
59+
60+
|===
61+
62+
[[resilient-action-configuration]]
63+
==== Action configuration
64+
65+
IBM Resilient actions have the following configuration properties:
66+
67+
Incident types:: The incident types of the incident.
68+
Severity code:: The severity of the incident.
69+
Name:: A name for the issue, used for searching the contents of the knowledge base.
70+
Description:: The details about the incident.
71+
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
72+
73+
[[configuring-resilient]]
74+
==== Configuring and testing IBM Resilient
75+
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

docs/user/alerting/alerting-getting-started.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ beta[]
66

77
--
88

9-
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*SIEM*>>, <<xpack-uptime,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
9+
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, <<xpack-uptime,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
1010

1111
image::images/alerting-overview.png[Alerts and actions UI]
1212

@@ -148,7 +148,7 @@ Functionally, {kib} alerting differs in that:
148148
* {kib} alerts tracks and persists the state of each detected condition through *alert instances*. This makes it possible to mute and throttle individual instances, and detect changes in state such as resolution.
149149
* Actions are linked to *alert instances* in {kib} alerting. Actions are fired for each occurrence of a detected condition, rather than for the entire alert.
150150

151-
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*SIEM*>>, and <<xpack-uptime,*Uptime*>>.
151+
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, and <<xpack-uptime,*Uptime*>>.
152152
Pre-packaged *alert types* simplify setup, hide the details complex domain-specific detections, while providing a consistent interface across {kib}.
153153

154154
[float]
@@ -171,7 +171,7 @@ To access alerting in a space, a user must have access to one of the following f
171171

172172
* <<xpack-apm,*APM*>>
173173
* <<xpack-infra,*Metrics*>>
174-
* <<xpack-siem,*SIEM*>>
174+
* <<xpack-siem,*Security*>>
175175
* <<xpack-uptime,*Uptime*>>
176176

177177
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to these features.

0 commit comments

Comments
 (0)