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.

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

Older-version snapshots and repositories are guaranteed to work with … #7275

Merged
merged 8 commits into from
Jun 12, 2024

Conversation

tan3-netapp
Copy link
Contributor

@tan3-netapp tan3-netapp commented May 30, 2024

…older versions of OpenSearch

Description

Describe what this change achieves.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@@ -449,6 +449,8 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho

Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data in the new cluster.

Older-version snapshots and the repositories that contain them continue to be compatible with older versions of OpenSearch. If you have a repository containing snapshots taken by an old version, you then upgrade to another version and snapshots are taken after that as well. The old snapshots can be restored to a new cluster running the same version.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the submission @tan3-netapp, are there limitations to using older versioned snapshots in newer versions of OpenSearch? Is it restricted to major versions, for example?

Copy link
Contributor Author

@tan3-netapp tan3-netapp May 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made an update here after encountering this issue. What I updated is just a guarantee that older versioned snapshots can always be restored to a new cluster running the same version even if the snapshot repository has been modified by the newer version. (as I put it in the Question 2 in the GitHub issue mentioned above).

Anyway, I've changed my wording. Please have another look. Thanks!

@Naarcha-AWS Naarcha-AWS self-assigned this Jun 3, 2024
@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress backport 2.14 PR: Backport label for 2.14 labels Jun 6, 2024
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jun 11, 2024
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tan3-netapp @Naarcha-AWS Please see my comments/changes and let me know if you have any questions. Thanks!

@@ -447,7 +447,9 @@ We recommend ceasing write requests to a cluster before restoring from a snapsho
1. A write request to the now-deleted alias creates a new index with the same name as the alias.
1. The alias from the snapshot fails to restore due to a naming conflict with the new index.

Snapshots are only forward-compatible by one major version. If you have an old snapshot, you can sometimes restore it into an intermediate cluster, reindex all indexes, take a new snapshot, and repeat until you arrive at your desired version, but you might find it easier to just manually index your data in the new cluster.
Snapshots are only forward-compatible by one major version. Snapshots taken by older OpenSearch versions can continue to be restored by the version of OpenSearch that originally took the snapshot even after a version upgrade. For example - a snapshot taken from OpenSearch 2.11.0 or lower can be used snapshot restores with 2.11.0 clusters even after upgrading to 2.12.0.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirm that my changes to the last sentence retain technical accuracy.

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tan3-netapp! LGTM

@tan3-netapp
Copy link
Contributor Author

@natebower I just added again the part emphasizes that 2.11 snapshots can be snapshot restored to 2.11 clusters. Please have a look again.

@natebower
Copy link
Collaborator

@natebower I just added again the part emphasizes that 2.11 snapshots can be snapshot restored to 2.11 clusters. Please have a look again.

Done 😄

@tan3-netapp
Copy link
Contributor Author

Thanks @natebower! :)

tan3-netapp and others added 6 commits June 12, 2024 21:27
…older versions of OpenSearch

Signed-off-by: tan3-netapp <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>
…hot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>
…hot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>
tan3-netapp and others added 2 commits June 12, 2024 21:27
…hot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit 5ef5170 into opensearch-project:main Jun 12, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 12, 2024
#7275)

* Older-version snapshots and repositories are guaranteed to work with older versions of OpenSearch

Signed-off-by: tan3-netapp <[email protected]>

* Change the wording

Signed-off-by: tan3-netapp <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>

* Add again the part where the 2.11 snapshots can be restored to 2.11 clusters to emphasize

Signed-off-by: tan3-netapp <[email protected]>

* Update _tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: tan3-netapp <[email protected]>

---------

Signed-off-by: tan3-netapp <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 5ef5170)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress backport 2.14 PR: Backport label for 2.14
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants