Skip to content

Commit

Permalink
[8.6] [DOCS] Clarify preconfigured connectors (#149904) (#149965)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.6`:
- [[DOCS] Clarify preconfigured connectors
(#149904)](#149904)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-01-31T17:18:16Z","message":"[DOCS]
Clarify preconfigured connectors
(#149904)","sha":"26a0b8ab060061021f1eecbe4902714695511e6f","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorsManagement","backport:prev-minor","v8.7.0"],"number":149904,"url":"https://github.com/elastic/kibana/pull/149904","mergeCommit":{"message":"[DOCS]
Clarify preconfigured connectors
(#149904)","sha":"26a0b8ab060061021f1eecbe4902714695511e6f"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/149904","number":149904,"mergeCommit":{"message":"[DOCS]
Clarify preconfigured connectors
(#149904)","sha":"26a0b8ab060061021f1eecbe4902714695511e6f"}}]}]
BACKPORT-->
  • Loading branch information
lcawl authored Jan 31, 2023
1 parent ec5d92f commit 110fd24
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 28 deletions.
10 changes: 3 additions & 7 deletions docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,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
Expand All @@ -157,13 +160,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
Expand Down
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/management/connectors/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ include::action-types/tines.asciidoc[leveloffset=+1]
include::action-types/webhook.asciidoc[]
include::action-types/cases-webhook.asciidoc[leveloffset=+1]
include::action-types/xmatters.asciidoc[]
include::pre-configured-connectors.asciidoc[]
include::pre-configured-connectors.asciidoc[leveloffset=+1]

42 changes: 22 additions & 20 deletions docs/management/connectors/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -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

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
two out-of-the box connectors: <<slack-action-type, Slack>> and
<<webhook-action-type, Webhook>>.
This example shows a valid configuration for a Slack connector and a Webhook
connector:

```js
xpack.actions.preconfigured:
Expand Down Expand Up @@ -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]

0 comments on commit 110fd24

Please sign in to comment.