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

(DOCSP-39188): Clarify that restores can be at most one major version ahead #150

Merged
merged 12 commits into from
May 8, 2024

Conversation

jeff-allen-mongo
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo commented May 3, 2024

DESCRIPTION

Clarify that target clusters for restores can be at most one major version ahead of the source cluster.

STAGING

JIRA

https://jira.mongodb.org/browse/DOCSP-39188

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=66354744b67dbf804ac09b70

(not sure what these errors are, but I'm fairly confident this PR did not introduce them)

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

Copy link
Contributor

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

Thanks for these updates, @jeff-allen-mongo! This one LGTM.

Thanks,
Joe

Copy link

@mvankeulen94 mvankeulen94 left a comment

Choose a reason for hiding this comment

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

Apologies for the confusion. The issue I'd like to solve for is to make sure that users know where our recommended upgrade procedures are. The BSON claims currently being made aren't wrong, but we don't want users to be tempted to try to use dump and restore as a way to circumvent our standard upgrade procedures. Thanks!

into MongoDB deployments running the same or newer version
as the source deployment.
You can restore the BSON files generated from ``mongodump`` into
MongoDB deployments that run the same version or one major version

Choose a reason for hiding this comment

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

Sorry, to clarify, it's possible to restore BSON files across multiple versions - we can keep lines 17-19 as they are.

MongoDB {+server-version+} deployment from a source deployment that
is lower than MongoDB {+server-previous-version+}, you must
successively upgrade the major release of the source deployment until
you upgrade to {+server-previous-version+}-series. To learn how to

Choose a reason for hiding this comment

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

After lines 17-19, we can say something like the following:
"For recommendations on how to safely upgrade or downgrade your MongoDB deployment, see the upgrade documentation".

The issue isn't that the current claims on BSON are wrong, but ideally we don't want to push users to try to use this instead of our standard upgrade procedures.

@@ -0,0 +1,4 @@
You can restore the BSON files generated from ``mongodump`` into MongoDB

This comment was marked as resolved.

Copy link
Collaborator Author

@jeff-allen-mongo jeff-allen-mongo left a comment

Choose a reason for hiding this comment

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

@mvankeulen94 thanks for the feedback! I adjusted the copy to focus more on clarifying that dump / restore should not be used to upgrade a deployment. Could you take another look?

Copy link

@mvankeulen94 mvankeulen94 left a comment

Choose a reason for hiding this comment

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

Just a couple minor wording changes, thanks!
I'll also flag this to TAR engineering & TS so they're aware that these changes are being made.

You can restore the BSON files generated from ``mongodump`` into
MongoDB deployments running the same or newer version as the source
deployment. However, restoring files into a newer version deployment
is not a suitable way to upgrade your deployment. To learn how to

Choose a reason for hiding this comment

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

"a suitable" -> "the recommended"

You can restore the BSON files generated from ``mongodump`` into MongoDB
deployments running the same or newer version as the source deployment.
However, restoring files into a newer version deployment is not a
suitable way to upgrade your deployment. To learn how to upgrade your

Choose a reason for hiding this comment

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

"a suitable" -> "the recommended"

@jeff-allen-mongo
Copy link
Collaborator Author

Thanks @mvankeulen94! Made the suggested edits.

Copy link

@mvankeulen94 mvankeulen94 left a comment

Choose a reason for hiding this comment

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

looks great, thank you!

@jeff-allen-mongo jeff-allen-mongo merged commit 23e6e6c into mongodb:master May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants