Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Searchable Snapshots GA release #3462

Merged
merged 9 commits into from
Apr 11, 2023
+6 −47
Merged

Add documentation for Searchable Snapshots GA release #3462

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
803c936
Add documentation for Searchable Snapshots GA release
ariamarble Mar 15, 2023
2c93c85
Merge branch 'main' of https://github.com/opensearch-project/document…
ariamarble Apr 5, 2023
644e577
SS updates
ariamarble Apr 5, 2023
ae8a5f5
Merge branch 'main' of https://github.com/opensearch-project/document…
ariamarble Apr 10, 2023
d8bf891
content update
ariamarble Apr 10, 2023
619b45c
Apply suggestions from doc review
ariamarble Apr 10, 2023
844c1cc
Update _tuning-your-cluster/availability-and-recovery/snapshots/searc…
ariamarble Apr 10, 2023
fdcb1d1
Apply suggestions from editorial review
ariamarble Apr 11, 2023
1252981
Update _tuning-your-cluster/availability-and-recovery/snapshots/searc…
ariamarble Apr 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions _tuning-your-cluster/availability-and-recovery/snapshots/searchable_snapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ redirect_from:

# Searchable snapshots

Searchable snapshots is an experimental feature released in OpenSearch 2.4. Therefore, we do not recommend the use of this feature in a production environment. For updates on progress, follow us on [GitHub](https://github.com/opensearch-project/OpenSearch/issues/3739). If you have any feedback please [submit a new issue](https://github.com/opensearch-project/OpenSearch/issues/new/choose).
{: .warning }

A searchable snapshot is an index where data is read from a [snapshot repository]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore/#register-repository) on demand at search time rather than all index data being downloaded to cluster storage at restore time. Because the index data remains in the snapshot format in the repository, searchable snapshot indexes are inherently read-only. Any attempt to write to a searchable snapshot index will result in an error.
ariamarble marked this conversation as resolved.
Show resolved Hide resolved

To enable the searchable snapshots feature, reference the following steps.
Expand All @@ -36,18 +33,7 @@ The flag is toggled using a new jvm parameter that is set either in `OPENSEARCH_
```json
export OPENSEARCH_JAVA_OPTS="-Dopensearch.experimental.feature.searchable_snapshot.enabled=true"
ariamarble marked this conversation as resolved.
Show resolved Hide resolved
```
- Option 3: For developers using Gradle, update run.gradle by adding the following lines:

```json
testClusters {
runTask {
testDistribution = 'archive'
if (numZones > 1) numberOfZones = numZones
if (numNodes > 1) numberOfNodes = numNodes
systemProperty 'opensearch.experimental.feature.searchable_snapshot.enabled', 'true'
}
}
```
- Option 3: Enable with the request body parameter.

- Finally, create a node in your opensearch.yml file and define the node role as `search`:

Expand Down