Skip to content

Commit 31304e9

Browse files
merging connectors content (#484)
Co-authored-by: shainaraskas <[email protected]>
1 parent c913055 commit 31304e9

File tree

7 files changed

+78
-178
lines changed

7 files changed

+78
-178
lines changed

deploy-manage/manage-connectors.md

Lines changed: 77 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,90 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/kibana/current/action-types.html
44
- https://www.elastic.co/guide/en/serverless/current/action-connectors.html
5+
applies_to:
6+
stack:
7+
serverless:
58
---
69

7-
# Manage connectors
10+
# Manage connectors [connector-management]
811

9-
% What needs to be done: Align serverless/stateful
12+
Connectors serve as a central place to store connection information for both Elastic and third-party systems. They enable the linking of actions to rules, which execute as background tasks on the {{kib}} server when rule conditions are met. This allows rules to route actions to various destinations such as log files, ticketing systems, and messaging tools. Different {{kib}} apps may have their own rule types, but they typically share connectors. The **{{stack-manage-app}} > {{connectors-ui}}** provides a central location to view and manage all connectors in the current space.
1013

11-
% GitHub issue: https://github.com/elastic/docs-projects/issues/352
14+
::::{note}
15+
This page is about {{kib}} connectors that integrate with services like generative AI model providers. If you’re looking for Search connectors that synchronize third-party data into {{es}}, refer to [Connector clients](https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-data-through-integrations-connector-client.html).
1216

13-
% Scope notes: Connectors management, probably moving some content to reference. We should align the serverless and stateful documentation.
17+
::::
1418

15-
% Use migrated content from existing pages that map to this page:
19+
## Required permissions [_required_permissions_2]
1620

17-
% - [ ] ./raw-migrated-files/kibana/kibana/action-types.md
18-
% Notes: 28 children
19-
% - [ ] ./raw-migrated-files/docs-content/serverless/action-connectors.md
21+
Access to connectors is granted based on your privileges to alerting-enabled features. For more information, go to [Security](../explore-analyze/alerts-cases/alerts/alerting-setup.md#alerting-security).
2022

21-
$$$connector-management$$$
23+
## Connector networking configuration [_connector_networking_configuration]
2224

23-
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
25+
```yaml {applies_to}
26+
stack:
27+
```
2428
25-
* [/raw-migrated-files/kibana/kibana/action-types.md](/raw-migrated-files/kibana/kibana/action-types.md)
26-
* [/raw-migrated-files/docs-content/serverless/action-connectors.md](/raw-migrated-files/docs-content/serverless/action-connectors.md)
29+
If you're using {{stack}}, use the [action configuration settings](https://www.elastic.co/guide/en/kibana/current/alert-action-settings-kb.html#action-settings) to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
30+
31+
## Connector list [connectors-list]
32+
33+
In **{{stack-manage-app}} > {{connectors-ui}}**, you can find a list of the connectors in the current space. You can use the search bar to find specific connectors by name and type. The **Type** dropdown also enables you to filter to a subset of connector types.
34+
35+
:::{image} ../images/kibana-connector-filter-by-type.png
36+
:alt: Filtering the connector list by types of connectors
37+
:class: screenshot
38+
:::
39+
40+
You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.
41+
42+
:::{image} ../images/kibana-connector-delete.png
43+
:alt: Deleting connectors individually or in bulk
44+
:class: screenshot
45+
:::
46+
47+
::::{note}
48+
You can delete a connector even if there are still actions referencing it. When this happens the action will fail to run and errors appear in the {{kib}} logs.
49+
50+
::::
51+
52+
## Creating a new connector [creating-new-connector]
53+
54+
New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties. For a full list of available connectors, see [Available connectors](asciidocalypse://docs/kibana/docs/reference/connectors-kibana/connectors-kibana.md).
55+
56+
::::{note}
57+
Some connector types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, go to [the subscription page](https://www.elastic.co/subscriptions).
58+
::::
59+
60+
:::{image} ../images/kibana-connector-select-type.png
61+
:alt: Connector select type
62+
:class: screenshot
63+
:width: 75%
64+
:::
65+
66+
After you create a connector, it is available for use any time you set up an action in the current space.
67+
68+
::::{tip}
69+
For out-of-the-box and standardized connectors, refer to [preconfigured connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html).
70+
71+
You can also manage connectors as resources with the [Elasticstack provider](https://registry.terraform.io/providers/elastic/elasticstack/latest) for Terraform. For more details, refer to the [elasticstack_kibana_action_connector](https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/kibana_action_connector) resource.
72+
73+
Preconfigured connectors and the Terraform resource are not available in {{serverless-full}} projects.
74+
::::
75+
76+
## Importing and exporting connectors [importing-and-exporting-connectors]
77+
78+
To import and export connectors, use the [Saved Objects Management UI](/explore-analyze/find-and-organize/saved-objects.md).
79+
80+
If a connector is missing sensitive information after the import, a **Fix** button appears in **{{connectors-ui}}**.
81+
82+
:::{image} ../images/kibana-connectors-with-missing-secrets.png
83+
:alt: Connectors with missing secrets
84+
:class: screenshot
85+
:::
86+
87+
## Monitoring connectors [monitoring-connectors]
88+
89+
You can query the [Event log index](/explore-analyze/alerts-cases/alerts/event-log-index.md) to gather information on connector successes and failures.
90+
91+
If you're using {{stack}}, then you can also use the [Task Manager health API](/deploy-manage/monitor/kibana-task-manager-health-monitoring.md) to monitor connector performance. However, if connectors fail to run, they will report as successful to Task Manager. The failure stats will not accurately depict connector failures.
-118 KB
Binary file not shown.
-275 KB
Binary file not shown.

raw-migrated-files/docs-content/serverless/action-connectors.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

raw-migrated-files/kibana/kibana/action-types.md

Lines changed: 0 additions & 123 deletions
This file was deleted.

0 commit comments

Comments
 (0)