[DOCS] Improves formatting in action types (#65932)
* [DOCS] Fixes formatting in action types * [DOCS] Updates preconfigured connectors and alerts
|
@ -41,9 +41,9 @@ see https://www.elastic.co/subscriptions[the subscription page].
|
|||
|
||||
[float]
|
||||
[[create-connectors]]
|
||||
=== Preconfigured connectors and action types
|
||||
=== Preconfigured actions and connectors
|
||||
|
||||
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
|
||||
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure the connector>>
|
||||
before {kib} starts.
|
||||
|
||||
If you preconfigure a connector, you can also <<preconfigured-action-type-example, preconfigure its action type>>.
|
||||
|
@ -54,4 +54,4 @@ include::action-types/pagerduty.asciidoc[]
|
|||
include::action-types/server-log.asciidoc[]
|
||||
include::action-types/slack.asciidoc[]
|
||||
include::action-types/webhook.asciidoc[]
|
||||
include::pre-configured-connectors.asciidoc[]
|
||||
include::action-types/pre-configured-connectors.asciidoc[]
|
||||
|
|
|
@ -28,27 +28,46 @@ Password:: password for 'login' type authentication.
|
|||
name: preconfigured-email-action-type
|
||||
actionTypeId: .email
|
||||
config:
|
||||
from: testsender@test.com <1.1>
|
||||
host: validhostname <1.2>
|
||||
port: 8080 <1.3>
|
||||
secure: false <1.4>
|
||||
from: testsender@test.com
|
||||
host: validhostname
|
||||
port: 8080
|
||||
secure: false
|
||||
secrets:
|
||||
user: testuser <2.1>
|
||||
password: passwordkeystorevalue <2.2>
|
||||
user: testuser
|
||||
password: passwordkeystorevalue
|
||||
--
|
||||
|
||||
`config` defines the action type specific to the configuration and contains the following properties:
|
||||
|
||||
<1.1> `from:` is an email address and correspond to *Sender*.
|
||||
<1.2> `host:` is a string and correspond to *Host*.
|
||||
<1.3> `port:` is a number and correspond to *Port*.
|
||||
<1.4> `secure:` is a boolean and correspond to *Secure*.
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
`secrets` defines action type sensitive configuration:
|
||||
| `from`
|
||||
| An email address that corresponds to *Sender*.
|
||||
|
||||
<2.1> `user:` is a string and correspond to *User*.
|
||||
<2.2> `password:` is a string and correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
| `host`
|
||||
| A string that corresponds to *Host*.
|
||||
|
||||
| `port`
|
||||
| A number that corresponds to *Port*.
|
||||
|
||||
| `secure`
|
||||
| A boolean that corresponds to *Secure*.
|
||||
|
||||
|===
|
||||
|
||||
`secrets` defines sensitive information for the action type:
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
| `user`
|
||||
| A string that corresponds to *User*.
|
||||
|
||||
| `password`
|
||||
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
|===
|
||||
|
||||
[[email-action-configuration]]
|
||||
==== Action configuration
|
||||
|
|
|
@ -25,16 +25,26 @@ Execution time field:: This field will be automatically set to the time the ale
|
|||
name: action-type-index
|
||||
actionTypeId: .index
|
||||
config:
|
||||
index: .kibana <1>
|
||||
refresh: true <2>
|
||||
executionTimeField: somedate <3>
|
||||
index: .kibana
|
||||
refresh: true
|
||||
executionTimeField: somedate
|
||||
--
|
||||
|
||||
`config` defines the action type specific to the configuration and contains the following properties:
|
||||
|
||||
<1> `index:` is a string and correspond to *Index*.
|
||||
<2> `refresh:` is a boolean and correspond to *Refresh*.
|
||||
<3> `executionTimeField:` is a string and correspond to *Execution time field*.
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
|`index`
|
||||
| A string that corresponds to *Index*.
|
||||
|
||||
|`refresh`
|
||||
| A boolean that corresponds to *Refresh*.
|
||||
|
||||
|`executionTimeField`
|
||||
| A string that corresponds to *Execution time field*.
|
||||
|
||||
|===
|
||||
|
||||
|
||||
[float]
|
||||
|
|
|
@ -145,18 +145,19 @@ Integration Key:: A 32 character PagerDuty Integration Key for an integration
|
|||
name: preconfigured-pagerduty-action-type
|
||||
actionTypeId: .pagerduty
|
||||
config:
|
||||
apiUrl: https://test.host <1.1>
|
||||
apiUrl: https://test.host
|
||||
secrets:
|
||||
routingKey: testroutingkey <2.1>
|
||||
routingKey: testroutingkey
|
||||
--
|
||||
|
||||
`config` defines the action type specific to the configuration and contains the following properties:
|
||||
`config` defines the action type specific to the configuration.
|
||||
`config` contains
|
||||
`apiURL`, a string that corresponds to *API URL*.
|
||||
|
||||
<1.1> `apiUrl:` is URL string and correspond to *API URL*.
|
||||
`secrets` defines sensitive information for the action type.
|
||||
`secrets` contains
|
||||
`routingKey`, a string that corresponds to *Integration Key*.
|
||||
|
||||
`secrets` defines action type sensitive configuration:
|
||||
|
||||
<2.1> `routingKey:` is a string and correspond to *Integration Key*.
|
||||
|
||||
[float]
|
||||
[[pagerduty-action-configuration]]
|
||||
|
|
|
@ -1,9 +1,9 @@
|
|||
[role="xpack"]
|
||||
[[pre-configured-action-types-and-connectors]]
|
||||
|
||||
== Preconfigured connectors and action types
|
||||
=== Preconfigured connectors and action types
|
||||
|
||||
You can preconfigure an action type or a connector to have all the information it needs prior to startup
|
||||
You can preconfigure a connector or action type to have all the information it needs prior to startup
|
||||
by adding it to the `kibana.yml` file.
|
||||
|
||||
Preconfigured connectors offer the following capabilities:
|
||||
|
@ -13,15 +13,15 @@ action are predefined, including the connector name and ID.
|
|||
- Appear in all spaces because they are not saved objects.
|
||||
- Cannot be edited or deleted.
|
||||
|
||||
Sensitive configuration information, such as credentials, can use the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
A preconfigured action types has only preconfigured connectors. Preconfigured connectors can belong to either the preconfigured action type or to the regular action type.
|
||||
A preconfigured action type has only preconfigured connectors. Preconfigured
|
||||
connectors can belong to either the preconfigured action type or to the regular action type.
|
||||
|
||||
[float]
|
||||
[[preconfigured-connector-example]]
|
||||
=== Creating a preconfigured connector
|
||||
==== Preconfigured connectors
|
||||
|
||||
The following example shows a valid configuration of two out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action-type, Webhook>>.
|
||||
This example shows a valid configuration for
|
||||
two out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action-type, Webhook>>.
|
||||
|
||||
```js
|
||||
xpack.actions.preconfigured:
|
||||
|
@ -44,7 +44,7 @@ The following example shows a valid configuration of two out-of-the box connecto
|
|||
password: changeme
|
||||
```
|
||||
|
||||
<1> the key is the action connector identifier, eg `my-slack1` in this example.
|
||||
<1> The key is the action connector identifier, `my-slack1` in this example.
|
||||
<2> `actionTypeId` is the action type identifier.
|
||||
<3> `name` is the name of the preconfigured connector.
|
||||
<4> `config` is the action type specific to the configuration.
|
||||
|
@ -55,16 +55,37 @@ The following example shows a valid configuration of two out-of-the box connecto
|
|||
Sensitive properties, such as passwords, can also be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
==============================================
|
||||
|
||||
////
|
||||
[float]
|
||||
[[managing-pre-configured-connectors]]
|
||||
==== View preconfigured connectors
|
||||
////
|
||||
|
||||
In *Management > Alerts and Actions*, preconfigured connectors
|
||||
appear in the <<connector-management, *Connectors* tab>>,
|
||||
regardless of which space you are in.
|
||||
They are tagged as “preconfigured”, and you cannot delete them.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-connectors-managing.png[Connectors managing tab with pre-cofigured]
|
||||
|
||||
Clicking a preconfigured connector shows the description, but not the configuration.
|
||||
A message indicates that this is a preconfigured connector.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details]
|
||||
|
||||
The connector details preview is disabled for preconfigured connectors
|
||||
of a preconfigured action type.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-action-type-managing.png[Connectors managing tab with pre-cofigured]
|
||||
|
||||
[float]
|
||||
[[preconfigured-action-type-example]]
|
||||
=== Creating a preconfigured action type
|
||||
==== Preconfigured action type
|
||||
|
||||
In the `kibana.yml` file:
|
||||
|
||||
. Exclude the action type from `xpack.actions.enabledActionTypes`.
|
||||
. Add all its preconfigured connectors.
|
||||
|
||||
The following example shows a valid configuration of preconfigured action type with one out-of-the box connector.
|
||||
This example shows a preconfigured action type with one out-of-the box connector.
|
||||
|
||||
```js
|
||||
xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] <1>
|
||||
|
@ -74,55 +95,27 @@ The following example shows a valid configuration of preconfigured action type w
|
|||
name: 'Server log #xyz'
|
||||
```
|
||||
|
||||
<1> `enabledActionTypes` should exclude preconfigured action type to prevent creating and deleting connectors.
|
||||
<1> `enabledActionTypes` excludes the preconfigured action type to prevent creating and deleting connectors.
|
||||
<2> `preconfigured` is the setting for defining the list of available connectors for the preconfigured action type.
|
||||
|
||||
[float]
|
||||
[[managing-pre-configured-connectors]]
|
||||
=== Managing preconfigured connectors
|
||||
|
||||
Preconfigured connectors appear in the connector list, regardless of which space the user is in.
|
||||
They are tagged as “preconfigured” and cannot be deleted.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-connectors-managing.png[Connectors managing tab with pre-cofigured]
|
||||
|
||||
Clicking on a preconfigured connector shows the description, but not any of the configuration.
|
||||
A message indicates that this is a preconfigured connector.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details]
|
||||
|
||||
The connector details preview is disabled for preconfigured connectors.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-action-type-managing.png[Connectors managing tab with pre-cofigured]
|
||||
|
||||
|
||||
[float]
|
||||
[[managing-pre-configured-action-types]]
|
||||
=== Managing preconfigured action types
|
||||
To attach a preconfigured action to an alert:
|
||||
|
||||
Clicking *Create connector* shows the list of available action types.
|
||||
Disabled action types are not included.
|
||||
. In *Management > Alerts and Actions*, open the *Connectors* tab.
|
||||
|
||||
. Click *Create connector.*
|
||||
|
||||
. In the list of available action types, select the preconfigured action type you want.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/pre-configured-action-type-select-type.png[Pre-configured connector create menu]
|
||||
|
||||
[float]
|
||||
[[pre-configured-connector-alert-form]]
|
||||
=== Alert with a preconfigured connector
|
||||
|
||||
When attaching an action to an alert,
|
||||
select from a list of available action types, and
|
||||
then select the Slack or Webhook type. Those action types were configured previously.
|
||||
The preconfigured connector is installed and is automatically selected.
|
||||
|
||||
[role="screenshot"]
|
||||
image::images/alert-pre-configured-slack-connector.png[Create alert with selected Slack action type]
|
||||
|
||||
The dropdown is populated with additional preconfigured Slack connectors.
|
||||
The `preconfigured` label distinguishes them from space-aware connectors that use saved objects.
|
||||
|
||||
. In *Create alert*, open the connector dropdown, and then select the preconfigured
|
||||
connector.
|
||||
+
|
||||
The `preconfigured` label distinguishes it from a space-aware connector.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image::images/alert-pre-configured-connectors-dropdown.png[Dropdown list with pre-cofigured connectors]
|
||||
|
||||
. Click *Add action*.
|
|
@ -23,12 +23,12 @@ Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messa
|
|||
name: preconfigured-slack-action-type
|
||||
actionTypeId: .slack
|
||||
config:
|
||||
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' <1>
|
||||
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
|
||||
--
|
||||
|
||||
`config` defines the action type specific to the configuration and contains the following properties:
|
||||
|
||||
<1> `webhookUrl:` is URL string and correspond to *Webhook URL*.
|
||||
`config` defines the action type specific to the configuration.
|
||||
`config` contains
|
||||
`webhookUrl`, a string that corresponds to *Webhook URL*.
|
||||
|
||||
|
||||
[float]
|
||||
|
|
|
@ -19,7 +19,7 @@ Password:: An optional password. If set, HTTP basic authentication is used. Cur
|
|||
|
||||
[float]
|
||||
[[Preconfigured-webhook-configuration]]
|
||||
==== Preconfigured action type
|
||||
==== Preconfigured action type
|
||||
|
||||
[source,text]
|
||||
--
|
||||
|
@ -27,25 +27,44 @@ Password:: An optional password. If set, HTTP basic authentication is used. Cur
|
|||
name: preconfigured-webhook-action-type
|
||||
actionTypeId: .webhook
|
||||
config:
|
||||
url: https://test.host <1.1>
|
||||
method: POST <1.2>
|
||||
headers: <1.3>
|
||||
url: https://test.host
|
||||
method: POST
|
||||
headers:
|
||||
testheader: testvalue
|
||||
secrets:
|
||||
user: testuser <2.1>
|
||||
password: passwordkeystorevalue <2.2>
|
||||
user: testuser
|
||||
password: passwordkeystorevalue
|
||||
--
|
||||
|
||||
`config` defines the action type specific to the configuration and contains the following properties:
|
||||
|
||||
<1.1> `url:` is URL string and correspond to *URL*.
|
||||
<1.2> `method:` is a string and correspond to *Method*.
|
||||
<1.3> `headers:` is Record<String, String> and correspond to *Headers*.
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
`secrets` defines action type sensitive configuration:
|
||||
|`url`
|
||||
| A URL string that corresponds to *URL*.
|
||||
|
||||
|`method`
|
||||
| A string that corresponds to *Method*.
|
||||
|
||||
|`headers`
|
||||
|A record<string, string> that corresponds to *Headers*.
|
||||
|
||||
|===
|
||||
|
||||
`secrets` defines sensitive information for the action type:
|
||||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
|
||||
|`user`
|
||||
|A string that corresponds to *User*.
|
||||
|
||||
|`password`
|
||||
|A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
|===
|
||||
|
||||
<2.1> `user:` is a string and correspond to *User*.
|
||||
<2.2> `password:` is a string and correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
|
||||
|
||||
[float]
|
||||
[[webhook-action-configuration]]
|
||||
|
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 61 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 82 KiB |
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 48 KiB |