Update snapshot documentation with storage_type option #1749
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: ariamarble <armarble@amazon.com>
ariamarble
added
4 - Doc Review
Naarcha-AWS
approved these changes
Oct 27, 2022
Signed-off-by: ariamarble <armarble@amazon.com>
4 tasks
andrross
reviewed
Oct 27, 2022
There was a problem hiding this comment.
This feature will be experimental in 2.4, similar to segment replication.
We'll want the same caveats here, as well as instructions for enabling the feature flag. I don't know if it's right to have this parameter added to the main documentation for snapshot restore while it is experimental, given the hoops a user has to jump through to enable it.
| @@ -343,6 +343,7 @@ Setting | Description | |||
| `rename_replacement` | If you want to rename indices as you restore them, use this option to specify the replacement pattern. Use `$0` to include the entire matching index name, `$1` to include the content of the first capture group, etc. | |||
| `index_settings` | If you want to change index settings on restore, specify them here. | |||
| `ignore_index_settings` | Rather than explicitly specifying new settings with `index_settings`, you can ignore certain index settings in the snapshot and use the cluster defaults on restore. | |||
| `storage_type` | `local` indicates that all snapshot metadata and index data will be downloaded to local storage. <br /><br > `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 and cached as necessary to service queries. At least one node in the cluster must be configured with the [search role]({{site.url}}{{site.baseurl}}/security-plugin/access-control/users-roles/) in order to restore a snapshot using the type `remote_snapshot`. <br /><br > Defaults to `local`. | |||
There was a problem hiding this comment.
Roles in the security plugin are a different concept. The only existing documentation I've found for configuring the node roles is in the ML plugin. I haven't found any documentation around the built-in node roles (cluster_manager, data, ingest, etc) that would be appropriate to link here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: ariamarble armarble@amazon.com
Description
New option update
Issues Resolved
#1684
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.