Skip to content
This repository was archived by the owner on Nov 7, 2025. It is now read-only.

Commit abf9298

Browse files
avelanariusavelanarius
authored
Add "Known bugs" section, add mention about disableAuth (#987)
1 parent e2a481c commit abf9298

File tree

5 files changed

+142
-16
lines changed

5 files changed

+142
-16
lines changed

‎docs/public/docs/example-2-0-clickhouse-specific.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,42 @@ flowchart LR
109109

110110
3. Reconfigure client endpoint:
111111
* 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.:
112-
```yaml
113-
elasticsearch.hosts: ["http://quesma:8080"]
114-
```
115-
or optionally using `ELASTICSEARCH_HOSTS` environment variable.
112+
```yaml
113+
elasticsearch.hosts: ["http://quesma:8080"]
114+
```
115+
or optionally using `ELASTICSEARCH_HOSTS` environment variable.
116+
117+
If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way:
118+
```yaml
119+
frontendConnectors:
120+
- name: elastic-query
121+
type: elasticsearch-fe-query
122+
config:
123+
listenPort: 8080
124+
disableAuth: true
125+
- name: elastic-ingest
126+
type: elasticsearch-fe-ingest
127+
config:
128+
listenPort: 8080
129+
disableAuth: true
130+
```
116131
* For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property.
117132
Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data.
133+
134+
If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way:
135+
```yaml
136+
frontendConnectors:
137+
- name: elastic-query
138+
type: elasticsearch-fe-query
139+
config:
140+
listenPort: 8080
141+
disableAuth: true
142+
- name: elastic-ingest
143+
type: elasticsearch-fe-ingest
144+
config:
145+
listenPort: 8080
146+
disableAuth: true
147+
```
118148
5. Restart Kibana/OSD.
119149
6. Add DataViews/Index Patterns:
120150
* 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.

‎docs/public/docs/example-2-0.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,42 @@ flowchart LR
8080
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.
8181
3. Reconfigure client endpoint:
8282
* 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.:
83-
```yaml
84-
elasticsearch.hosts: ["http://quesma:8080"]
85-
```
86-
or optionally use `ELASTICSEARCH_HOSTS` environment variable.
83+
```yaml
84+
elasticsearch.hosts: ["http://quesma:8080"]
85+
```
86+
or optionally using `ELASTICSEARCH_HOSTS` environment variable.
87+
88+
If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way:
89+
```yaml
90+
frontendConnectors:
91+
- name: elastic-query
92+
type: elasticsearch-fe-query
93+
config:
94+
listenPort: 8080
95+
disableAuth: true
96+
- name: elastic-ingest
97+
type: elasticsearch-fe-ingest
98+
config:
99+
listenPort: 8080
100+
disableAuth: true
101+
```
87102
* For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property.
88103
Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data.
104+
105+
If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way:
106+
```yaml
107+
frontendConnectors:
108+
- name: elastic-query
109+
type: elasticsearch-fe-query
110+
config:
111+
listenPort: 8080
112+
disableAuth: true
113+
- name: elastic-ingest
114+
type: elasticsearch-fe-ingest
115+
config:
116+
listenPort: 8080
117+
disableAuth: true
118+
```
89119
4. Restart Kibana/OSD.
90120
5. Add DataViews/Index Patterns:
91121
* 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.

‎docs/public/docs/example-2-1-hydro-specific.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,41 @@ flowchart LR
104104
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.
105105
3. Reconfigure client endpoint:
106106
* 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.:
107-
```yaml
108-
elasticsearch.hosts: ["http://quesma:8080"]
109-
```
110-
or optionally use `ELASTICSEARCH_HOSTS` environment variable.
107+
```yaml
108+
elasticsearch.hosts: ["http://quesma:8080"]
109+
```
110+
or optionally using `ELASTICSEARCH_HOSTS` environment variable.
111+
112+
If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way:
113+
```yaml
114+
frontendConnectors:
115+
- name: elastic-query
116+
type: elasticsearch-fe-query
117+
config:
118+
listenPort: 8080
119+
disableAuth: true
120+
- name: elastic-ingest
121+
type: elasticsearch-fe-ingest
122+
config:
123+
listenPort: 8080
124+
disableAuth: true
125+
```
111126
* For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property.
127+
128+
If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way:
129+
```yaml
130+
frontendConnectors:
131+
- name: elastic-query
132+
type: elasticsearch-fe-query
133+
config:
134+
listenPort: 8080
135+
disableAuth: true
136+
- name: elastic-ingest
137+
type: elasticsearch-fe-ingest
138+
config:
139+
listenPort: 8080
140+
disableAuth: true
141+
```
112142
4. Restart Kibana/OSD.
113143
5. Add DataViews/Index Patterns:
114144
* 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.

‎docs/public/docs/example-2-1.md‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,42 @@ K[Kibana/OSD] --> Q((Quesma))
117117
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.
118118
3. Reconfigure client endpoint:
119119
* 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.:
120-
```yaml
121-
elasticsearch.hosts: ["http://quesma:8080"]
122-
```
123-
or optionally use `ELASTICSEARCH_HOSTS` environment variable.
120+
```yaml
121+
elasticsearch.hosts: ["http://quesma:8080"]
122+
```
123+
or optionally using `ELASTICSEARCH_HOSTS` environment variable.
124+
125+
If you use Elasticsearch/Kibana without authentication, please modify the `frontendConnectors` section in the following way:
126+
```yaml
127+
frontendConnectors:
128+
- name: elastic-query
129+
type: elasticsearch-fe-query
130+
config:
131+
listenPort: 8080
132+
disableAuth: true
133+
- name: elastic-ingest
134+
type: elasticsearch-fe-ingest
135+
config:
136+
listenPort: 8080
137+
disableAuth: true
138+
```
124139
* For OpenSearchDashboards: modify [`opensearch_dashboards.yml` file](https://opensearch.org/docs/latest/install-and-configure/configuring-dashboards/) and change `opensearch.hosts` property.
125140
Also, make sure to update the Elasticsearch/OpenSearch endpoint configuration for any clients ingesting data.
141+
142+
If you use OpenSearch/OpenSearchDashboards without authentication, please modify the `frontendConnectors` section in the following way:
143+
```yaml
144+
frontendConnectors:
145+
- name: elastic-query
146+
type: elasticsearch-fe-query
147+
config:
148+
listenPort: 8080
149+
disableAuth: true
150+
- name: elastic-ingest
151+
type: elasticsearch-fe-ingest
152+
config:
153+
listenPort: 8080
154+
disableAuth: true
155+
```
126156
4. Restart Kibana/OSD.
127157
5. Add DataViews/Index Patterns:
128158
* 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.

‎docs/public/docs/limitations.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ Currently not supported future roadmap items:
6767
* No partial results for long-running queries. All results are returned in one response once full query is finished
6868
* No efficient support for metrics.
6969

70+
## Known bugs
71+
72+
- 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).
73+
- 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).
74+
- `@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).
7075

7176
## List of supported endpoints
7277

@@ -82,6 +87,7 @@ The following endpoints are supported:
8287
* Schema:
8388
* `GET /:index`
8489
* `GET /:index/_mapping`
90+
* `PUT /:index`
8591
* `POST /:index/_field_caps`
8692
* `POST /:index/_terms_enum`
8793
* `POST /:index`

0 commit comments

Comments
 (0)