Skip to content

Commit 21f8a7e

Browse files
authored
Cleanup search connectors, add some reference -> docs content signposts in various sections (#123733) (#124210)
(cherry picked from commit 6b27e42)
1 parent 7fcc629 commit 21f8a7e

12 files changed

+60
-59
lines changed

docs/reference/data-analysis/aggregations/index.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@ mapped_pages:
55

66
# Aggregations
77

8-
% What needs to be done: Refine
8+
:::{note}
9+
This section provides detailed **reference information** for aggregations.
910

10-
% Scope notes: need to scope the page down to just reference content
11-
12-
% Use migrated content from existing pages that map to this page:
13-
14-
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/search-aggregations.md
11+
Refer to [Aggregations](docs-content://explore-analyze/query-filter/aggregations.md) in the **Explore and analyze** section for overview, getting started and conceptual information.
12+
:::
1513

1614
Aggregations are a powerful framework that enables you to perform complex data analysis and summarization over indexed documents. They enable you to extract and compute statistics, trends, and patterns from large datasets.
1715

docs/reference/data-analysis/text-analysis/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
% TO-DO: Add links to "Data analysis basics"%
44

5+
:::{note}
6+
This section provides detailed **reference information**.
7+
8+
Refer to [the text analysis overview](docs-content://manage-data/data-store/text-analysis.md) in the **Manage data** section for overview and conceptual information.
9+
:::
10+
511
This section contains reference information for text analysis components features, including:
612

713
* [Analyzers](/reference/data-analysis/text-analysis/analyzer-reference.md)

docs/reference/ingestion-tools/search-connectors/api-tutorial.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
---
22
navigation_title: "API tutorial"
3+
applies_to:
4+
stack: ga
5+
serverless:
6+
elasticsearch: ga
37
mapped_pages:
48
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-tutorial-api.html
59
---

docs/reference/ingestion-tools/search-connectors/connector-reference.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless: ga
25
mapped_pages:
36
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-refs.html
47
---

docs/reference/ingestion-tools/search-connectors/connectors-ui-in-kibana.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless:
5+
elasticsearch: ga
26
mapped_pages:
37
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-usage.html
48
---
59

6-
# Connectors UI in Kibana [es-connectors-usage]
10+
# Connectors UI [es-connectors-usage]
711

812
This document describes operations available to connectors using the UI.
913

10-
In the Kibana UI, navigate to **Search > Content > Connectors** 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 summary of all your connectors and sync jobs, and to create new connectors.
14+
In the Kibana or Serverless UI, find Connectors using the [global search field](docs-content://explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects). Here, you can view a summary of all your connectors and sync jobs, and to create new connectors.
1115

1216
::::{tip}
1317
In 8.12 we introduced a set of [Connector APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-connector) to create and manage Elastic connectors and sync jobs, along with a [CLI tool](https://github.com/elastic/connectors/blob/main/docs/CLI.md). Use these tools if you’d like to work with connectors and sync jobs programmatically, without using the UI.

docs/reference/ingestion-tools/search-connectors/elastic-managed-connectors.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
applies_to:
3+
ess: discontinued 9.0.0
24
mapped_pages:
35
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-native-connectors.html
46
---

docs/reference/ingestion-tools/search-connectors/es-connectors-apis.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless:
5+
elasticsearch: ga
26
mapped_pages:
37
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-apis.html
48
---

docs/reference/ingestion-tools/search-connectors/es-connectors-overview-architecture.md

+2-17
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,9 @@ mapped_pages:
1010
The following section provides a high-level overview of common architecture approaches for the internal knowledge search use case (AKA workplace search).
1111

1212

13-
## Hybrid architecture [es-connectors-overview-architecture-hybrid]
13+
$$$es-connectors-overview-architecture-hybrid$$$
1414

15-
Data is synced to an Elastic Cloud deployment through managed connectors and/or self-managed connectors. A self-managed search application exposes the relevant data that your end users are authorized to see in a search experience.
16-
17-
Summary:
18-
19-
* The best combination in terms of flexibility and out-of-the box functionality
20-
* Integrates with Elastic Cloud hosted managed connectors to bring data to Elasticsearch with minimal operational overhead
21-
* Self-managed connectors allow enterprises to adhere to strict access policies when using firewalls that don’t allow incoming connections to data sources, while outgoing traffic is easier to control
22-
* Provides additional functionality available for self-managed connectors such as the [Extraction Service](/reference/ingestion-tools/search-connectors/es-connectors-content-extraction.md#es-connectors-content-extraction-local)
23-
* Basic functionality available for Standard licenses, advanced features for Platinum licenses
24-
25-
The following diagram provides a high-level overview of the hybrid internal knowledge search architecture.
26-
27-
:::{image} ../../../images/hybrid-architecture.png
28-
:alt: hybrid architecture
29-
:class: screenshot
30-
:::
15+
% ^^ discontinued 9.0.0
3116

3217

3318
## Self-managed architecture [es-connectors-overview-architecture-self-managed]

docs/reference/ingestion-tools/search-connectors/es-connectors-run-from-docker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ elasticsearch.api_key: <ELASTICSEARCH_API_KEY>
4545
connectors:
4646
-
4747
connector_id: <CONNECTOR_ID_FROM_KIBANA>
48-
service_type: Zoom # sharepoint_online (example)
48+
service_type: sharepoint_online # Example value — update this for service type you are connecting to
4949
api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
5050
```
5151

docs/reference/ingestion-tools/search-connectors/index.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless: ga
25
mapped_pages:
36
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors.html
47
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-data-through-integrations-connector-client.html
@@ -7,18 +10,18 @@ mapped_pages:
710

811
# Search connectors
912

10-
% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc):
11-
1213
$$$es-connectors-native$$$
1314

1415

15-
:::{tip}
16-
This page is about Search connectors that synchronize third-party data into Elasticsearch. If you’re looking for Kibana connectors to integrate with services like generative AI model providers, refer to [Kibana Connectors](docs-content://deploy-manage/manage-connectors.md).
16+
:::{note}
17+
This page is about Search connectors that synchronize third-party data into {{es}}. If you’re looking for Kibana connectors to integrate with services like generative AI model providers, refer to [Kibana Connectors](docs-content://deploy-manage/manage-connectors.md).
1718
:::
1819

19-
_connector_ is a type of [Elastic integration](https://www.elastic.co/integrations/data-integrations) that syncs data from an original data source to Elasticsearch. Each connector extracts the original files, records, or objects; and transforms them into documents within Elasticsearch.
20+
_connector_ is an Elastic integration that syncs data from an original data source to {{es}}. Use connectors to create searchable, read-only replicas of your data in {{es}}.
21+
22+
Each connector extracts the original files, records, or objects; and transforms them into documents within {{es}}.
2023

21-
_Connector clients_ are **self-managed** connectors that you run on your own infrastructure. These connectors are written in Python and the source code is available in the [`elastic/connectors`](https://github.com/elastic/connectors/tree/main/connectors/sources) repo.
24+
These connectors are written in Python and the source code is available in the [`elastic/connectors`](https://github.com/elastic/connectors/tree/main/connectors/sources) repo.
2225

2326
## Available connectors
2427

@@ -28,9 +31,7 @@ As of Elastic 9.0, managed connectors on Elastic Cloud Hosted are no longer avai
2831
::::
2932

3033

31-
Connector clients are available for the following third-party data sources:
32-
33-
The following connectors are available as self-managed connectors:
34+
Connectors are available for the following third-party data sources:
3435

3536
- [Azure Blob Storage](/reference/ingestion-tools/search-connectors/es-connectors-azure-blob.md)
3637
- [Box](/reference/ingestion-tools/search-connectors/es-connectors-box.md)
@@ -86,7 +87,6 @@ In order to set up, configure, and run a connector you’ll be moving between yo
8687

8788
### Data source prerequisites
8889

89-
90-
The first decision you need to make before deploying a connector is which third party service (data source) you want to sync to Elasticsearch. See the list of [available connectors](#available-connectors).
90+
The first decision you need to make before deploying a connector is which third party service (data source) you want to sync to {{es}}. See the list of [available connectors](#available-connectors).
9191

9292
Note that each data source will have specific prerequisites you’ll need to meet to authorize the connector to access its data. For example, certain data sources may require you to create an OAuth application, or create a service account. You’ll need to check the [individual connector documentation](connector-reference.md) for these details.

docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md

+13-20
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
applies_to:
3+
stack: ga
4+
serverless: ga
25
mapped_pages:
36
- https://www.elastic.co/guide/en/elasticsearch/reference/current/es-build-connector.html
47
---
@@ -10,22 +13,15 @@ Self-managed connectors were initially known as "connector clients". You might f
1013

1114
::::
1215

13-
1416
Self-managed [Elastic connectors](/reference/ingestion-tools/search-connectors/index.md) are run on your own infrastructure. This means they run outside of your Elastic deployment.
1517

16-
You can run the [connectors service](#es-connectors-deploy-connector-service) from source or from a Docker container.
17-
18-
We also have a quickstart option using **Docker Compose**, to spin up all the required services at once: Elasticsearch, Kibana, and the connectors service. Refer to [Docker Compose quickstart](/reference/ingestion-tools/search-connectors/es-connectors-docker-compose-quickstart.md) for more information.
19-
20-
2118
## Availability and Elastic prerequisites [es-build-connector-prerequisites]
2219

2320
::::{note}
2421
Self-managed connectors currently don’t support Windows. Use this [compatibility matrix](https://www.elastic.co/support/matrix#matrix_os) to check which operating systems are supported by self-managed connectors. Find this information under **self-managed connectors** on that page.
2522

2623
::::
2724

28-
2925
:::::{dropdown} Expand for Elastic prerequisites information
3026
Your Elastic deployment must include the following Elastic services:
3127

@@ -63,17 +59,16 @@ Note the following information regarding support for self-managed connectors:
6359

6460
:::::
6561

62+
## Workflow
6663

67-
::::{admonition} Data source prerequisites
68-
:name: es-build-connector-data-source-prerequisites
69-
70-
The first decision you need to make before deploying a connector is which third party service (data source) you want to sync to Elasticsearch. Note that each data source will have specific prerequisites you’ll need to meet to authorize the connector to access its data. For example, certain data sources may require you to create an OAuth application, or create a service account.
71-
72-
You’ll need to check the individual connector documentation for these details.
73-
74-
::::
75-
64+
In order to set up, configure, and run a connector you’ll be moving between your third-party service, the Elastic UI, and your terminal. At a high-level, the workflow looks like this:
7665

66+
1. Satisfy any data source prerequisites (e.g., create an OAuth application).
67+
2. Create a connector in the UI (or via the API).
68+
3. Deploy the connector service:
69+
- [Option 1: Run with Docker](es-connectors-run-from-docker.md) (recommended)
70+
- [Option 2: Run from source](es-connectors-run-from-source.md)
71+
4. Enter data source configuration details in the UI.
7772

7873
## Deploy the connector service [es-connectors-deploy-connector-service]
7974

@@ -87,16 +82,14 @@ You can run the connector service from source or use Docker:
8782
* Refer to our [Docker Compose quickstart](/reference/ingestion-tools/search-connectors/es-connectors-docker-compose-quickstart.md) for a quick way to spin up all the required services at once.
8883

8984

90-
9185
## Tutorials [es-build-connector-example]
9286

9387
* Follow our [UI-based tutorial](/reference/ingestion-tools/search-connectors/es-postgresql-connector-client-tutorial.md) to learn how run the self-managed connector service and a set up a self-managed connector, **using the UI**.
9488
* Follow our [API-based tutorial](/reference/ingestion-tools/search-connectors/api-tutorial.md) to learn how to set up a self-managed connector **using the** [**connector APIs**](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-connector).
9589

9690
These examples use the PostgreSQL connector but the basic process is the same for all self-managed connectors.
9791

98-
99-
## Connector testing [es-build-connector-testing]
92+
## E2E testing [es-build-connector-testing]
10093

10194
The connector framework enables you to run end-to-end (E2E) tests on your self-managed connectors, against a real data source.
10295

@@ -105,7 +98,7 @@ To avoid tampering with a real Elasticsearch instance, E2E tests run an isolated
10598
E2E tests use **default** configuration values for the connector. Find instructions about testing in each connector’s documentation.
10699

107100

108-
## Connector framework [es-build-connector-framework]
101+
## Build or customize connectors [es-build-connector-framework]
109102

110103
The Elastic connector framework enables you to:
111104

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Scripting languages
22

3-
This section contains the Painless scripting language reference.
3+
:::{note}
4+
This section provides detailed **reference information** about the the Painless scripting language.
45

5-
For an overview of scripting languages in {{es}}, go to [Scripting](docs-content://explore-analyze/scripting.md).
6+
Refer to the [scripting languages overview](docs-content://explore-analyze/scripting.md) in the **Explore and analyze** section for an overview of available scripting languages in {{es}}.
7+
:::

0 commit comments

Comments
 (0)