You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/search-connectors/connectors-ui-in-kibana.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,17 @@ In 8.12 we introduced a set of [connector APIs]({{es-apis}}group/endpoint-connec
24
24
25
25
You connector writes data to an {{es}} index.
26
26
27
-
To create [self-managed connectors](/reference/search-connectors/self-managed-connectors.md), use the buttons under **{{es}} > Content > {{connectors-app}}**. Once you’ve chosen the data source type you’d like to sync, you’ll be prompted to create an {{es}} index.
27
+
To create [self-managed connectors](/reference/search-connectors/self-managed-connectors.md):
28
+
1. Use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
29
+
2. On the **Elasticsearch connectors** page, select **New Connector**.
30
+
Once you’ve chosen the data source type you’d like to sync, you’ll be prompted to create an {{es}} index.
28
31
29
32
## Manage connector indices [es-connectors-usage-indices]
30
33
31
34
View and manage all Elasticsearch indices managed by connectors.
32
35
33
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects). Here, you can view a list of connector indices and their attributes, including connector type health and ingestion status.
36
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
37
+
Here, you can view a list of connector indices and their attributes, including connector type health and ingestion status.
34
38
35
39
Within this interface, you can choose to view the details for each existing index or delete an index. Or, you can [create a new connector index](#es-connectors-usage-index-create).
36
40
@@ -49,9 +53,11 @@ When you create an index with a connector, the index is created with default sea
49
53
50
54
You can inspect your index mappings in the following ways:
51
55
52
-
* In the {{kib}} UI: Navigate to **{{es}} > Content > Indices > *YOUR-INDEX* > Index Mappings**.
53
-
* By API: Use the [get mapping API]({{es-apis}}operation/operation-indices-get-mapping).
56
+
* In the {{kib}} UI:
57
+
1. Go to the **Index Management** page using the navigation menu or the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md).
58
+
2. Select the index you want to work with and then the **Mappings** tab.
54
59
60
+
* By API: Use the [get mapping API]({{es-apis}}operation/operation-indices-get-mapping).
55
61
You can manually **edit** the mappings and settings via the {{es}} APIs:
56
62
57
63
* Use the [put mapping API]({{es-apis}}operation/operation-indices-put-mapping) to update index mappings.
@@ -84,8 +90,7 @@ The workflow for these updates is as follows:
84
90
85
91
After creating an index to be managed by a connector, you can configure automatic, recurring syncs.
86
92
87
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
88
-
93
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
89
94
Choose the connector and then the **Scheduling** tab.
90
95
91
96
Within this interface, you can enable or disable scheduled:
@@ -107,8 +112,7 @@ After you enable recurring syncs or sync once, the first sync will begin. (There
107
112
108
113
After creating the index to be managed by a connector, you can request a single sync at any time.
109
114
110
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
111
-
115
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
112
116
Then choose the connector to sync.
113
117
114
118
Regardless of which tab is active, the **Sync** button is always visible in the top right. Choose this button to reveal sync options:
@@ -126,8 +130,7 @@ This operation requires access to Kibana and the `write` [indices privilege^](/r
126
130
127
131
After a sync has started, you can cancel the sync before it completes.
128
132
129
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
130
-
133
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
131
134
Then choose the connector with the running sync.
132
135
133
136
Regardless of which tab is active, the **Sync** button is always visible in the top right. Choose this button to reveal sync options, and choose **Cancel Syncs** to cancel active syncs. This will cancel the running job, and marks all *pending* and *suspended* jobs as canceled as well. (There may be a short delay before the connector service cancels the syncs.)
@@ -139,8 +142,7 @@ This operation requires access to Kibana and the `write` [indices privilege^](/r
139
142
140
143
View the index details to see a variety of information that communicate the status of the index and connector.
141
144
142
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
143
-
145
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
144
146
Then choose the connector to view.
145
147
146
148
The **Overview** tab presents a variety of information, including:
@@ -183,10 +185,9 @@ This operation requires access to Kibana and the `read` [indices privilege^](/re
183
185
184
186
## View documents [es-connectors-usage-documents]
185
187
186
-
View the documents the connector has synced from the data. Additionally view the index mappings to determine the current document schema.
187
-
188
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
188
+
View the documents the connector has synced from the data. Additionally, view the index mappings to determine the current document schema.
189
189
190
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
190
191
Select the connector then the **Documents** tab to view the synced documents. Choose the **Mappings** tab to view the index mappings that were created by the connector.
191
192
192
193
When setting up a new connector, ensure you are getting the documents and fields you were expecting from the data source. If not, see [Troubleshooting](/reference/search-connectors/es-connectors-troubleshooting.md) for help.
@@ -200,14 +201,13 @@ See [Security](/reference/search-connectors/es-connectors-security.md) for secur
200
201
201
202
Use [sync rules](/reference/search-connectors/es-sync-rules.md) to limit which documents are fetched from the data source, or limit which fetched documents are stored in Elastic.
202
203
203
-
In the {{kib}} UI, navigate to **{{es}} > Content > Elasticsearch indices** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
204
-
204
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
205
205
Then choose the index to manage and choose the **Sync rules** tab.
Use [ingest pipelines](docs-content://solutions/search/ingest-for-search.md) to transform fetched data before it is stored in Elastic.
211
211
212
-
In the {{kib}} UI, navigate to **{{es}} > Content > {{connectors-app}}** from the main menu, or use the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
212
+
In the {{kib}} UI, use the [global search field](docs-content:///explore-analyze/find-and-organize/find-apps-and-objects.md) to find Connectors, then select **Build / Connectors** from the results.
213
213
Then choose the connector and view its **Pipelines** tab.
0 commit comments