Skip to content

Commit

Permalink
Update known limitations for kNN based indexes
Browse files Browse the repository at this point in the history
Signed-off-by: Kunal Kotwani <[email protected]>
  • Loading branch information
kotwanikunal authored Aug 30, 2024
1 parent 67682f2 commit a9d3b78
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,5 @@ The following are known limitations of the searchable snapshots feature:
- Many remote object stores charge on a per-request basis for retrieval, so users should closely monitor any costs incurred.
- Searching remote data can impact the performance of other queries running on the same node. We recommend that users provision dedicated nodes with the `search` role for performance-critical applications.
- For better search performance, consider [force merging]({{site.url}}{{site.baseurl}}/api-reference/index-apis/force-merge/) indexes into a smaller number of segments before taking a snapshot. For the best performance, at the cost of using compute resources prior to snapshotting, force merge your index into one segment.
- We recommend configuring a maximum ratio of remote data to local disk cache size using the `cluster.filecache.remote_data_ratio` setting. A ratio of 5 is a good starting point for most workloads to ensure good query performance. If the ratio is too large, then there may not be sufficient disk space to handle the search workload. For more details on the maximum ratio of remote data, see issue [#11676](https://github.com/opensearch-project/OpenSearch/issues/11676).
- We recommend configuring a maximum ratio of remote data to local disk cache size using the `cluster.filecache.remote_data_ratio` setting. A ratio of 5 is a good starting point for most workloads to ensure good query performance. If the ratio is too large, then there may not be sufficient disk space to handle the search workload. For more details on the maximum ratio of remote data, see issue [#11676](https://github.com/opensearch-project/OpenSearch/issues/11676).
- kNN native-engine based indexes utilizing `faiss` and `nmslib` are incompatible with searchable snapshots.

Check failure on line 112 in _tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'kNN'. Raw Output: {"message": "[OpenSearch.SubstitutionsError] Use 'k-NN' instead of 'kNN'.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md", "range": {"start": {"line": 112, "column": 3}}}, "severity": "ERROR"}

0 comments on commit a9d3b78

Please sign in to comment.