-
Notifications
You must be signed in to change notification settings - Fork 501
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.
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
[DOC] Searchable Snapshot Feature #1684
Comments
Closing with PR #1749 |
Left a comment on the PR right as it was being merged, but I think we'll want to model this documentation similar to segment replication. Specifically this should be a stand-alone page with all the experimental feature caveats. We should probably wait until the feature is fully ready in a subsequent release before updating the main "restore snapshot" documentation with the new parameter. |
We'll work on breaking this off into it's own section |
@ariamarble Here's a rough draft of the content I had in mind. I don't have a strong opinion as to exactly how it should be structured or what page it should be on. Searchable snapshots
A searchable snapshot index is an index where data is read from a snapshot repository on-demand at search time, rather than downloading all index data 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. Create an indexCreating a searchable snapshot index is done by specifying the
Listing indexesTo determine if an index is a searchable snapshot index, look for the
Potential use cases
Known limitations
|
Created PR - #1795 - with my early rough draft. I will incorporate these changes into that PR. |
What do you want to do?
Tell us about your request.
We would like to develop the documentation for the initial experimental release of the searchable snapshot feature in OpenSearch 2.4. The feature design proposal is here: opensearch-project/OpenSearch#3895
What other resources are available?
The searchable snapshot feature consists primarily of two API changes:
I've included some thoughts on the documentation about these two areas below:
Snapshot Restore API
A new parameter will be introduced in the snapshot restore API:
storage_type
.local
orremote_snapshot
.local
is the default if not specified, and indicates that all snapshot metadata and index data will be downloaded to local instance storage.remote_snapshot
indicates that snapshot metadata will be downloaded to the cluster but the remote repository will remain the authoritative store of the index data. Data will be downloaded on-demand as necessary to service queries. At least one node in the cluster must be configured for thesearch
role in order to restore a snapshot of typeremote_snapshot
.Node Role
This feature adds a new
search
role to the list of possible node roles. I can't seem to find existing documentation about all the existing build-in roles (data
,cluster_manager
,ingest
, andremote_cluster_client
), but here is a example documentation on a dynamic role added by a plugin.The text was updated successfully, but these errors were encountered: