Skip to content

Commit 1d79313

Browse files
committed
Changes the order of deployment options and adds steps as sub-headings
1 parent c528a67 commit 1d79313

File tree

1 file changed

+58
-58
lines changed

1 file changed

+58
-58
lines changed

serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.mdx

Lines changed: 58 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ To use connector clients, you must deploy the connector service so your connecto
9898
The source code is hosted in the `elastic/connectors` repository.
9999

100100
You have two deployment options:
101+
- Run with [Docker](#run-with-docker) (recommended)
101102
- Run from [source](#run-from-source)
102-
- Run with [Docker](#run-with-docker)
103103

104104
<DocCallOut title="">
105105
You'll need the following values handy to update your `config.yml` file:
@@ -109,63 +109,9 @@ You have two deployment options:
109109
- `service_type`: Original data source type. Printed to the screen when you create a new connector.
110110
</DocCallOut>
111111

112-
### Run from source
113-
114-
This is a good option if you're comfortable working with Python and want to iterate quickly locally.
115-
First, you need to clone the `elastic/connectors` repository.
116-
117-
Follow these steps:
118-
119-
- Clone or fork the repository locally with the following command:
120-
```shell
121-
git clone https://github.com/elastic/connectors
122-
```
123-
- Open the `config.yml.example` file in the `connectors` repository and rename it to `config.yml`.
124-
- Update the following settings to match your environment:
125-
126-
* `elasticsearch.host`
127-
* `elasticsearch.api_key`
128-
* `connector id`
129-
* `service_type`
130-
131-
Your configuration file should look like this:
132-
133-
```yaml
134-
elasticsearch.host: <ELASTICSEARCH_ENDPOINT>
135-
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>
136-
137-
connectors:
138-
-
139-
connector_id: <CONNECTOR_ID_FROM_UI>
140-
service_type: <SERVICE-NAME> # sharepoint_online (example)
141-
api_key: <CONNECTOR_API_KEY> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
142-
```
143-
144-
<DocCallOut title="Tip">
145-
Learn more about the `config.yml` file in the [repo docs](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
146-
</DocCallOut>
147-
148-
**Run the connector service**
149-
150-
Once you've configured the connector code, you can run the connector service.
151-
152-
In your terminal or IDE:
153-
154-
- `cd` into the root of your `elastic/connectors` clone/fork.
155-
- Run the following commands to compile and run the connector service:
156-
157-
```shell
158-
make install
159-
make run
160-
```
161-
162-
The connector service should now be running in your terminal. If the connection to your ((es)) instance was successful, the **Configure your connector** step will be activated in the project's UI.
163-
164-
Here we're working locally. In a production setup, you'll deploy the connector service to your own infrastructure.
165-
166112
### Run with Docker
167113

168-
You can also deploy connector clients using Docker.
114+
You can deploy connector clients using Docker.
169115
Follow these instructions.
170116

171117
**Step 1: Download sample configuration file**
@@ -220,7 +166,61 @@ Find all available Docker images in the [official Elastic Docker registry](https
220166
Each individual connector client reference contain instructions for deploying specific connectors using Docker.
221167
</DocCallOut>
222168

223-
## Enter data source details in UI
169+
### Run from source
170+
171+
Running from source requires cloning the repository and running the code locally.
172+
Use this approach if you're actively customizing connectors.
173+
174+
Follow these steps:
175+
176+
- Clone or fork the repository locally with the following command:
177+
```shell
178+
git clone https://github.com/elastic/connectors
179+
```
180+
- Open the `config.yml.example` file in the `connectors` repository and rename it to `config.yml`.
181+
- Update the following settings to match your environment:
182+
183+
* `elasticsearch.host`
184+
* `elasticsearch.api_key`
185+
* `connector id`
186+
* `service_type`
187+
188+
Your configuration file should look like this:
189+
190+
```yaml
191+
elasticsearch.host: <ELASTICSEARCH_ENDPOINT>
192+
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>
193+
194+
connectors:
195+
-
196+
connector_id: <CONNECTOR_ID_FROM_UI>
197+
service_type: <SERVICE-NAME> # sharepoint_online (example)
198+
api_key: <CONNECTOR_API_KEY> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
199+
```
200+
201+
<DocCallOut title="Tip">
202+
Learn more about the `config.yml` file in the [repo docs](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
203+
</DocCallOut>
204+
205+
**Run the connector service**
206+
207+
Once you've configured the connector code, you can run the connector service.
208+
209+
In your terminal or IDE:
210+
211+
- `cd` into the root of your `elastic/connectors` clone/fork.
212+
- Run the following commands to compile and run the connector service:
213+
214+
```shell
215+
make install
216+
make run
217+
```
218+
219+
The connector service should now be running in your terminal. If the connection to your ((es)) instance was successful, the **Configure your connector** step will be activated in the project's UI.
220+
221+
Here we're working locally. In a production setup, you'll deploy the connector service to your own infrastructure.
222+
223+
## Step 3: Enter data source details in UI
224224

225225
Once the connector service is running, it's time to head back to the UI to finalize the connector configuration.
226226
You should now see the **Configure your connector** step in your project's UI.
@@ -235,7 +235,7 @@ For example, the Sharepoint Online connector requires the following details abou
235235
- **Secret value**
236236
- **Comma-separated list of tables**
237237

238-
## Connect to an index
238+
## Step 4: Connect to an index
239239

240240
Once you've entered the data source details, you need to connect to an index.
241241
This is the final step in your project's UI, before you can run a sync.

0 commit comments

Comments
 (0)