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
@@ -82,20 +82,19 @@ You'll need to check the [individual connector documentation](#available-connect
82
82
## Initial setup in UI
83
83
84
84
In your project's UI, go to **((es)) → Connectors**.
85
-
Read the high-level instructions under **Create a connector** to make sure you understand the process.
86
85
Follow these steps:
87
86
88
87
1. Select **Create a connector**.
89
88
2. Choose a third-party service from the list of connector types.
90
89
3. Add a name and optional description to identify the connector.
91
90
4. Copy the `connector_id`, `service_type`, and `elasticsearch.host` values printed to the screen.
92
91
You'll need to update these values in your [`config.yml`](https://github.com/elastic/connectors/blob/main/config.yml) file.
93
-
5.Make a note of your **((es)) endpoint** and **API key** values. You can create a new API key under **Security → API keys**.
94
-
6. Run the connector code using one of the [options](#deploy-self-managed-connector) documented on this page.
92
+
5.Navigate to **Elasticsearch → Home**, and make a note of your **((es)) endpoint** and **API key** values. You can create a new API key by clicking on **New** in the **API key** section.
93
+
6. Run the connector code either from source or with Docker, following the instructions below.
95
94
96
95
## Deploy your self-managed connector
97
96
98
-
To use connector clients, you must deploy the connector service so your connector can talk to your ((es)) instance.
97
+
To use connector clients, you must deploy the connector service so your connector can talk to your ((es)) instance.
99
98
The source code is hosted in the `elastic/connectors` repository.
100
99
101
100
You have two deployment options:
@@ -104,8 +103,8 @@ You have two deployment options:
104
103
105
104
<DocCallOuttitle="">
106
105
You'll need the following values handy to update your `config.yml` file:
107
-
-`elasticsearch.host`: Your ((es)) endpoint. Find this in the **Get started** step in the UI.
108
-
-`elasticsearch.api_key`: Your ((es)) API key. You can create API keys under **Security → API keys**. Once you connector is running, you'll be able to create a new API key that is limited to only access the connector's index.
106
+
-`elasticsearch.host`: Your ((es)) endpoint. Printed to the screen when you create a new connector.
107
+
-`elasticsearch.api_key`: Your ((es)) API key. You can create API keys by navigating to **Home**, and clicking **New** in the **API key** section. Once your connector is running, you'll be able to create a new API key that is limited to only access the connector's index.
109
108
-`connector_id`: Unique id for your connector. Printed to the screen when you create a new connector.
110
109
-`service_type`: Original data source type. Printed to the screen when you create a new connector.
111
110
</DocCallOut>
@@ -121,8 +120,26 @@ Follow these steps:
121
120
```shell
122
121
git clone https://github.com/elastic/connectors
123
122
```
124
-
- Create a `config.yml` configuration file by copying this [example](https://github.com/elastic/connectors/blob/main/config.yml.example).
125
-
- Replace the values for `host` (your ((es)) endpoint), `api_key`, `connector_id`, and `service_type`.
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:
api_key: <CONNECTOR_API_KEY> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
142
+
```
126
143
127
144
<DocCallOut title="Tip">
128
145
Learn more about the `config.yml` file in the [repo docs](https://github.com/elastic/connectors/blob/main/docs/CONFIG.md).
@@ -142,7 +159,7 @@ In your terminal or IDE:
142
159
make run
143
160
```
144
161
145
-
The connector service should now be running in your terminal. Your project's UI will let you know that the connector has successfully connected to your ((es)) instance.
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.
146
163
147
164
Here we're working locally. In a production setup, you'll deploy the connector service to your own infrastructure.
148
165
@@ -163,11 +180,12 @@ Change the `--output` argument value to the path where you want to save the conf
163
180
164
181
**Step 2: Update the configuration file for your self-managed connector**
165
182
166
-
Update the following settings to match your environment:
183
+
- Update the following settings to match your environment:
0 commit comments