add env var documentation for elasticsearch (#898)

hasura · Feb 13, 2025 · 671a9c0 · 671a9c0
1 parent 3b3729d
commit 671a9c0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/data-sources/connect-to-a-source.mdx b/docs/data-sources/connect-to-a-source.mdx
@@ -71,6 +71,18 @@ it requires:
 | `USERNAME`          | `default`           | The database username.                                    |
 | `PASSWORD`          | `default`           | The database password.                                    |
 
+</TabItem>
+<TabItem value="Elasticsearch" label="Elasticsearch">
+
+| ENV                           | Example                                                        | Description                                                                                                                                                                |
+| ----------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ELASTICSEARCH_URL`           | `https://example.es.gcp.cloud.es.io:9200`                      | The comma-separated list of Elasticsearch host addresses for connection (Use `local.hasura.dev` instead of `localhost` if your connector is running on your local machine) |
+| `ELASTICSEARCH_USERNAME`      | `default`                                                      | The username for authenticating to the Elasticsearch cluster                                                                                                               |
+| `ELASTICSEARCH_PASSWORD`      | `default`                                                      | The password for the Elasticsearch user account                                                                                                                            |
+| `ELASTICSEARCH_API_KEY`       | `ABCzYWk0NEI0aDRxxxxxxxxxx1k6LWVQa2gxMUpRTUstbjNwTFIzbGoyUQ==` | The Elasticsearch API key for authenticating to the Elasticsearch cluster                                                                                                  |
+| `ELASTICSEARCH_CA_CERT_PATH`  | `/etc/connector/cacert.pem`                                    | The path to the Certificate Authority (CA) certificate for verifying the Elasticsearch server's SSL certificate                                                            |
+| `ELASTICSEARCH_INDEX_PATTERN` | `hasura*`                                                      | The pattern for matching Elasticsearch indices, potentially including wildcards, used by the connector                                                                     |
+
 </TabItem>
 
 </Tabs>

diff --git a/docs/reference/connectors/elasticsearch/index.mdx b/docs/reference/connectors/elasticsearch/index.mdx
@@ -54,7 +54,8 @@ project.
 
 If you've ended up here and aren't concerned about tweaking your configuration, and rather are looking to get started
 with Elasticsearch and Hasura DDN as quickly as possible, check out our
-[Elasticsearch tutorial](/how-to-build-with-ddn/with-elasticsearch.mdx).
+[Elasticsearch tutorial](/how-to-build-with-ddn/with-elasticsearch.mdx) or
+[learn how to connect](/data-sources/connect-to-a-source.mdx) to an Elasticsearch instance.
 
 :::