forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Alerting] Documentation for how to pre-configure connectors. (elasti…
…c#63807) * [Alerting] Documentation for how to pre-configure connectors. * small fix * Adjusted titles * Fixed wrong link * fixed warning * Fixed ci issues * [DOCS] Edits preconfigured connector docs * Replaced words 'pre-configured' with 'preconfigured' Co-authored-by: gchaps <chappell_5@yahoo.com>
- Loading branch information
1 parent
126415b
commit c0ab0ce
Showing
12 changed files
with
109 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+90.1 KB
docs/user/alerting/images/alert-pre-configured-connectors-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
[role="xpack"] | ||
[[pre-configured-connectors]] | ||
|
||
== Preconfigured connectors | ||
|
||
You can preconfigure an action connector to have all the information it needs prior to startup | ||
by adding it to the `kibana.yml` file. | ||
Sensitive configuration information, such as credentials, can use the {kib} keystore. | ||
|
||
Preconfigured connectors offer the following capabilities: | ||
|
||
- Require no setup. Configuration and credentials needed to execute an | ||
action are predefined, including the connector name and ID. | ||
- Appear in all spaces because they are not saved objects. | ||
- Cannot be edited or deleted. | ||
|
||
[float] | ||
[[preconfigured-connector-example]] | ||
=== Example of a preconfigured connector | ||
|
||
The following example shows a valid configuration 2 out-of-the box connector. | ||
|
||
[source,console] | ||
------------------------ | ||
xpack.actions.preconfigured: | ||
- id: 'my-slack1' <1> | ||
actionTypeId: .slack <2> | ||
name: 'Slack #xyz' <3> | ||
config: <4> | ||
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' | ||
- id: 'webhook-service' | ||
actionTypeId: .webhook | ||
name: 'Email service' | ||
config: | ||
url: 'https://email-alert-service.elastic.co' | ||
method: post | ||
headers: | ||
header1: value1 | ||
header2: value2 | ||
secrets: <5> | ||
user: elastic | ||
password: changeme | ||
------------------------ | ||
|
||
<1> `id` is the action connector identifier. | ||
<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. | ||
<5> `secrets` is sensitive configuration, such as username, password, and keys. | ||
|
||
[NOTE] | ||
============================================== | ||
Sensitive properties, such as passwords, can also be stored in the {kib} keystore. | ||
============================================== | ||
|
||
[float] | ||
[[pre-configured-connector-alert-form]] | ||
=== Creating an 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. | ||
|
||
[role="screenshot"] | ||
image::images/alert-pre-configured-connectors-dropdown.png[Dropdown list with pre-cofigured connectors] | ||
|
||
[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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters