generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 623
Add documentation changes for shallow snapshot v2 #8207
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
Merged
Naarcha-AWS
merged 10 commits into
opensearch-project:main
from
anshu1106:documentation-snapshotv2
Sep 11, 2024
Merged
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
164085f
Add documentation changes for shallow snapshot
7381c80
Merge branch 'main' into documentation-snapshotv2
Naarcha-AWS 7f777f9
Update create-repository.md
Naarcha-AWS bf0437f
Apply suggestions from code review
Naarcha-AWS 86e790b
Apply suggestions from code review
Naarcha-AWS 600bc74
Update snapshot-interoperability.md
Naarcha-AWS 2fc13e8
Merge branch 'main' into documentation-snapshotv2
Naarcha-AWS 1e72b2a
Apply suggestions from code review
Naarcha-AWS 124b014
Apply suggestions from code review
Naarcha-AWS 38aab0c
Apply suggestions from code review
Naarcha-AWS File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,7 @@ PUT /_snapshot/snap_repo | |
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| Once enabled, all requests using the [Snapshot API]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/) will remain the same for all snapshots. After the setting is enabled, we recommend not disabling the setting. Doing so could affect data durability. | ||
| Once enabled, all requests using the [Snapshot API]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/) will remain the same for all snapshots. After the setting is enabled, we recommend not disabling the setting. Doing so could affect data durability. | ||
|
|
||
| ## Considerations | ||
|
|
||
|
|
@@ -37,3 +37,39 @@ Consider the following before using shallow copy snapshots: | |
| - All nodes in the cluster must use OpenSearch 2.10 or later to take advantage of shallow copy snapshots. | ||
| - The `incremental` file count and size between the current snapshot and the last snapshot is `0` when using shallow copy snapshots. | ||
| - Searchable snapshots are not supported inside shallow copy snapshots. | ||
|
|
||
| # Shallow Snapshot v2 (OpenSearch 2.17+) | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Starting with OpenSearch version 2.17, the shallow snapshot feature has been improved with a new version called shallow snapshot v2. This improvement aims to make snapshot operations more efficient and scalable by introducing the following enhancements: | ||
|
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Global: Should all instances of "Shallow snapshot v2" be |
||
| * Deterministic Snapshot Operations: Shallow snapshot v2 makes snapshot operations more deterministic, ensuring consistent and predictable behavior. | ||
| * Minimized Cluster State Updates: The improvement minimizes the number of cluster state updates required during snapshot operations, reducing overhead and improving performance. | ||
| * Scalability: Shallow snapshot v2 allows snapshot operations to scale independently of the number of shards in the cluster, enabling better performance and efficiency for large datasets. | ||
|
|
||
| ## Enabling Shallow Snapshot v2 | ||
|
|
||
| To enable the shallow snapshot v2, you need to set two repository settings: | ||
|
|
||
| 1. remote_store_index_shallow_copy: Set this to true to enable the existing shallow snapshot feature. | ||
| 2. shallow_snapshot_v2: Set this to true to enable the shallow snapshot v2 improvement. | ||
|
|
||
| Here's an example of how to create a repository with both settings enabled: | ||
|
|
||
| ```bash | ||
| PUT /_snapshot/snap_repo | ||
| { | ||
| "type": "s3", | ||
| "settings": { | ||
| "bucket": "test-bucket", | ||
| "base_path": "daily-snaps", | ||
| "remote_store_index_shallow_copy": true, | ||
| "shallow_snapshot_v2": true | ||
| } | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| ## Limitations and Caveats | ||
|
|
||
| * Shallow snapshot v2 only work for remote-backed indexes. | ||
| * All nodes in the cluster must use OpenSearch 2.17 or later to take advantage of shallow snapshot v2. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.