[DOCS] Clarify preconfigured connectors (#149904)

This commit is contained in:
Lisa Cawley 2023-01-31 09:18:16 -08:00 committed by GitHub
parent f33568f74e
commit 26a0b8ab06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 28 additions and 29 deletions

View file

@ -145,6 +145,9 @@ image::images/connector-select-type.png[Connector select type]
After you create a connector, it is available for use any time you set up an
action in the current space.
For out-of-the-box and standardized connectors, refer to
<<pre-configured-connectors,preconfigured connectors>>.
[float]
[[importing-and-exporting-connectors]]
=== Importing and exporting connectors
@ -161,13 +164,6 @@ button appears in *{connectors-ui}*.
[role="screenshot"]
image::images/connectors-with-missing-secrets.png[Connectors with missing secrets]
[float]
[[create-connectors]]
=== Preconfigured connectors
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
before {kib} starts.
[float]
[[montoring-connectors]]
=== Monitoring connectors

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

View file

@ -12,8 +12,9 @@ include::action-types/servicenow-itom.asciidoc[leveloffset=+1]
include::action-types/swimlane.asciidoc[]
include::action-types/slack.asciidoc[]
include::action-types/tines.asciidoc[leveloffset=+1]
include::action-types/torq.asciidoc[]
include::action-types/webhook.asciidoc[]
include::action-types/cases-webhook.asciidoc[leveloffset=+1]
include::action-types/xmatters.asciidoc[]
include::action-types/torq.asciidoc[]
include::pre-configured-connectors.asciidoc[]
include::pre-configured-connectors.asciidoc[leveloffset=+1]

View file

@ -1,24 +1,28 @@
[role="xpack"]
[[pre-configured-connectors]]
=== Preconfigured connectors
== Preconfigured connectors
You can preconfigure a connector to have all the information it needs prior to
startup by adding it to the `kibana.yml` file.
If you are running {kib} on-prem, you can preconfigure a connector to have all
the information it needs prior to startup by adding it to the `kibana.yml` file.
NOTE: {ess} provides a preconfigured email connector but you cannot create
additional preconfigured connectors.
Preconfigured connectors offer the following benefits:
- Require no setup. Configuration and credentials needed to execute an
action are predefined, including the connector name and ID.
- Require no setup. Configuration and credentials needed to run 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]]
==== Preconfigured connectors example
[[create-preconfigured-connectors]]
=== Create preconfigured connectors
This example shows a valid configuration for
two out-of-the box connectors: <<slack-action-type, Slack>> and
<<webhook-action-type, Webhook>>.
Add `xpack.actions.preconfigured` settings to your `kibana.yml` file. The
settings vary depending on which type of connector you're adding.
This example shows a valid configuration for a Slack connector and a Webhook
connector:
```js
xpack.actions.preconfigured:
@ -50,31 +54,29 @@ two out-of-the box connectors: <<slack-action-type, Slack>> and
[NOTE]
==============================================
Sensitive properties, such as passwords, can also be stored in the
<<creating-keystore, {kib} keystore>>.
<<creating-keystore,{kib} keystore>>.
==============================================
[float]
[[build-in-preconfigured-connectors]]
==== Built-in preconfigured connectors
=== Built-in preconfigured connectors
{kib} provides the following built-in preconfigured connectors:
* <<preconfigured-connector-alert-history, Alert history preconfigured {es} index connector>>
* <<elasticcloud, `Elastic-Cloud-SMTP` preconfigured email connector>>
* <<preconfigured-connector-alert-history,Alert history preconfigured {es} index connector>>
* <<elasticcloud,`Elastic-Cloud-SMTP` preconfigured email connector>>
[float]
[[managing-pre-configured-connectors]]
==== View preconfigured connectors
=== View preconfigured connectors
When you open the main menu, click *{stack-manage-app} > {connectors-ui}*.
Preconfigured connectors appear 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-configured]
image::images/preconfigured-connectors-managing.png[Connectors managing tab with pre-configured]
Clicking a preconfigured connector shows the description, but not the
configuration. A message indicates that this is a preconfigured connector.
configuration.
[role="screenshot"]
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details]