diff --git a/docs/public/docs/example-2-0-clickhouse-specific.md b/docs/public/docs/example-2-0-clickhouse-specific.md index 5cc2a5e52..4154438e9 100644 --- a/docs/public/docs/example-2-0-clickhouse-specific.md +++ b/docs/public/docs/example-2-0-clickhouse-specific.md @@ -109,12 +109,42 @@ flowchart LR 3. Reconfigure client endpoint: * For Kibana: update your [Kibana configuration](https://www.elastic.co/guide/en/kibana/current/settings.html), so that it points to Quesma Elasticsearch API endpoint mentioned above, instead of Elasticsearch original endpoint. In your Kibana configuration file, replace the `elasticsearch.hosts` value with Quesma's host and port, e.g.: - ```yaml - elasticsearch.hosts: ["http://quesma:8080"] - ``` - or optionally using `ELASTICSEARCH_HOSTS` environment variable. + ```yaml + elasticsearch.hosts: ["http://quesma:8080"] + ``` + or optionally using `ELASTICSEARCH_HOSTS` environment variable. + + If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` * For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property. Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data. + + If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` 5. Restart Kibana/OSD. 6. Add DataViews/Index Patterns: * For Kibana: in order to view your ClickHouse tables in Kibana, you need to create **Data Views** for tables (indexes) from the config. If you're unsure how to do it, follow the [Data Views creation guide](./adding-kibana-dataviews.md) for more information. diff --git a/docs/public/docs/example-2-0.md b/docs/public/docs/example-2-0.md index d51000d19..8d7085a03 100644 --- a/docs/public/docs/example-2-0.md +++ b/docs/public/docs/example-2-0.md @@ -80,12 +80,42 @@ flowchart LR You have now a running Quesma instance running with Elasticsearch API endpoint on port 8080. You can also enable Quesma's admin panel at [localhost:9999](http://localhost:9999/) by adding `-p 9999:9999` to docker run command. 3. Reconfigure client endpoint: * For Kibana: update your [Kibana configuration](https://www.elastic.co/guide/en/kibana/current/settings.html), so that it points to Quesma Elasticsearch API endpoint mentioned above, instead of Elasticsearch original endpoint. In your Kibana configuration file, replace the `elasticsearch.hosts` value with Quesma's host and port, e.g.: - ```yaml - elasticsearch.hosts: ["http://quesma:8080"] - ``` - or optionally use `ELASTICSEARCH_HOSTS` environment variable. + ```yaml + elasticsearch.hosts: ["http://quesma:8080"] + ``` + or optionally using `ELASTICSEARCH_HOSTS` environment variable. + + If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` * For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property. Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data. + + If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` 4. Restart Kibana/OSD. 5. Add DataViews/Index Patterns: * For Kibana: in order to view your Hydrolix tables in Kibana, you need to create **Data Views** for tables (indexes) from the config. If you're unsure how to do it, follow the [Data Views creation guide](./adding-kibana-dataviews.md) for more information. diff --git a/docs/public/docs/example-2-1-hydro-specific.md b/docs/public/docs/example-2-1-hydro-specific.md index f7dc8ccc2..8ec4b724c 100644 --- a/docs/public/docs/example-2-1-hydro-specific.md +++ b/docs/public/docs/example-2-1-hydro-specific.md @@ -104,11 +104,41 @@ flowchart LR You now have a running Quesma instance running with Elasticsearch API endpoint on port 8080. You can also enable Quesma's admin panel at [localhost:9999](http://localhost:9999/) by adding `-p 9999:9999` to docker run command. 3. Reconfigure client endpoint: * For Kibana: update your [Kibana configuration](https://www.elastic.co/guide/en/kibana/current/settings.html), so that it points to Quesma Elasticsearch API endpoint mentioned above, instead of Elasticsearch original endpoint. In your Kibana configuration file, replace the `elasticsearch.hosts` value with Quesma's host and port, e.g.: - ```yaml - elasticsearch.hosts: ["http://quesma:8080"] - ``` - or optionally use `ELASTICSEARCH_HOSTS` environment variable. + ```yaml + elasticsearch.hosts: ["http://quesma:8080"] + ``` + or optionally using `ELASTICSEARCH_HOSTS` environment variable. + + If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` * For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property. + + If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` 4. Restart Kibana/OSD. 5. Add DataViews/Index Patterns: * For Kibana: in order to view your Hydrolix tables in Kibana, you need to create **Data Views** for tables (indexes) from the config. If you're unsure how to do it, follow the [Data Views creation guide](./adding-kibana-dataviews.md) for more information. diff --git a/docs/public/docs/example-2-1.md b/docs/public/docs/example-2-1.md index ff988c329..5cd88a948 100644 --- a/docs/public/docs/example-2-1.md +++ b/docs/public/docs/example-2-1.md @@ -117,12 +117,42 @@ K[Kibana/OSD] --> Q((Quesma)) You have now a running Quesma instance running with Elasticsearch API endpoint on port 8080. You can also enable Quesma's admin panel at [localhost:9999](http://localhost:9999/) by adding `-p 9999:9999` to docker run command. 3. Reconfigure client endpoint: * For Kibana: update your [Kibana configuration](https://www.elastic.co/guide/en/kibana/current/settings.html), so that it points to Quesma Elasticsearch API endpoint mentioned above, instead of Elasticsearch original endpoint. In your Kibana configuration file, replace the `elasticsearch.hosts` value with Quesma's host and port, e.g.: - ```yaml - elasticsearch.hosts: ["http://quesma:8080"] - ``` - or optionally use `ELASTICSEARCH_HOSTS` environment variable. + ```yaml + elasticsearch.hosts: ["http://quesma:8080"] + ``` + or optionally using `ELASTICSEARCH_HOSTS` environment variable. + + If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` * For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property. Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data. + + If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way: + ```yaml + frontendConnectors: + - name: elastic-query + type: elasticsearch-fe-query + config: + listenPort: 8080 + disableAuth: true + - name: elastic-ingest + type: elasticsearch-fe-ingest + config: + listenPort: 8080 + disableAuth: true + ``` 4. Restart Kibana/OSD. 5. Add DataViews/Index Patterns: * For Kibana: in order to view your ClickHouse tables in Kibana, you need to create **Data Views** for tables (indexes) from the config. If you're unsure how to do it, follow the [Data Views creation guide](./adding-kibana-dataviews.md) for more information. diff --git a/docs/public/docs/limitations.md b/docs/public/docs/limitations.md index e990c2c89..b49686b06 100644 --- a/docs/public/docs/limitations.md +++ b/docs/public/docs/limitations.md @@ -67,6 +67,11 @@ Currently not supported future roadmap items: * No partial results for long-running queries. All results are returned in one response once full query is finished * No efficient support for metrics. +## Known bugs + +- Some schema-related endpoints (such as `PUT /:index`) don't support dual-writes: the request is only handled by the ClickHouse/Hydrolix connector and not forwarded to Elastic. A workaround for this problem is to send the request manually directly to Elastic. The status of the bug is tracked on [Quesma's GitHub Issues page](https://github.com/QuesmaOrg/quesma/issues/986). +- The `_count` endpoint does not support tables in non-default [databases](https://clickhouse.com/docs/en/sql-reference/statements/create/database). The status of the bug is tracked on [Quesma's GitHub Issues page](https://github.com/QuesmaOrg/quesma/issues/985). +- `@timestamp` column supports only `DateTime64(3)` type (e.g. `DateTime` type is not supported for that column). The status of the bug is tracked on [Quesma's GitHub Issues page](https://github.com/QuesmaOrg/quesma/issues/988). ## List of supported endpoints @@ -82,6 +87,7 @@ The following endpoints are supported: * Schema: * `GET /:index` * `GET /:index/_mapping` + * `PUT /:index` * `POST /:index/_field_caps` * `POST /:index/_terms_enum` * `POST /:index`