Skip to content

Commit 580a727

Browse files
committed
Clean up connectors
1 parent ae9d483 commit 580a727

File tree

2 files changed

+18
-31
lines changed

2 files changed

+18
-31
lines changed

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ mapped_pages:
77

88
# Search connectors
99

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

1412

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).
13+
:::{note}
14+
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).
1715
:::
1816

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.
17+
_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}}.
18+
19+
Each connector extracts the original files, records, or objects; and transforms them into documents within {{es}}.
2020

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.
21+
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.
2222

2323
## Available connectors
2424

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

3030

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

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

8785
### Data source prerequisites
8886

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).
87+
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).
9188

9289
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

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,15 @@ Self-managed connectors were initially known as "connector clients". You might f
1010

1111
::::
1212

13-
1413
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.
1514

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-
2115
## Availability and Elastic prerequisites [es-build-connector-prerequisites]
2216

2317
::::{note}
2418
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.
2519

2620
::::
2721

28-
2922
:::::{dropdown} Expand for Elastic prerequisites information
3023
Your Elastic deployment must include the following Elastic services:
3124

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

6457
:::::
6558

59+
## Workflow
6660

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-
61+
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:
7662

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

7870
## Deploy the connector service [es-connectors-deploy-connector-service]
7971

@@ -87,16 +79,14 @@ You can run the connector service from source or use Docker:
8779
* 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.
8880

8981

90-
9182
## Tutorials [es-build-connector-example]
9283

9384
* 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**.
9485
* 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).
9586

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

98-
99-
## Connector testing [es-build-connector-testing]
89+
## E2E testing [es-build-connector-testing]
10090

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

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

10797

108-
## Connector framework [es-build-connector-framework]
98+
## Build or customize connectors [es-build-connector-framework]
10999

110100
The Elastic connector framework enables you to:
111101

0 commit comments

Comments
 (0)