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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dbb305f
(DOCSP-39188): Clarify that upgrades must be to one major version ahead
jeff-allen-mongo May 3, 2024
909796d
try new webhook
jeff-allen-mongo May 3, 2024
c22e511
try new webhook
jeff-allen-mongo May 3, 2024
8c57739
try new webhook
jeff-allen-mongo May 3, 2024
9c6a8ab
fix include
jeff-allen-mongo May 3, 2024
ceb41e4
fix include version
jeff-allen-mongo May 3, 2024
965b449
edits
jeff-allen-mongo May 3, 2024
a2bb415
add version info to top-level dump and restore pages
jeff-allen-mongo May 3, 2024
ab929e3
wording
jeff-allen-mongo May 3, 2024
42d13b3
address review feedback
jeff-allen-mongo May 6, 2024
d2a9947
remove unneeded variable
jeff-allen-mongo May 6, 2024
83f7c78
review feedback
jeff-allen-mongo May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions snooty.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ qe = "Queryable Encryption"
version = "100.9.0"
release = "{+version+}"
pgp-version = "{+version+}"
server-version = "7.0"
server-previous-version = "6.0"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
rsa-key = "4B7C549A058F8B6B"
pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F 718D 4B7C 549A 058F 8B6B"
Expand Down
12 changes: 9 additions & 3 deletions source/includes/fact-match-dump-restore-versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@ To change your feature compatibility version, see

.. note::

You can restore the BSON files generated from ``mongodump``
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
Copy link

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.

later than the source deployment. For example, to restore to a
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
Copy link

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.

upgrade your deployment, see the :manual:`upgrade documentation
</release-notes/{+server-version+}-upgrade>`.

This guarantee does not apply to metadata, archive, or oplog replay
files. If you try to restore these files using different
Expand Down
4 changes: 4 additions & 0 deletions source/includes/mongodump-restore-version-link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
You can restore the BSON files generated from ``mongodump`` into MongoDB

This comment was marked as resolved.

Sign in to view

deployments that run the same version or one major version later than
the source deployment. For more information see
:ref:`mongodump-matching-server-version`.
2 changes: 2 additions & 0 deletions source/mongodump.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ a database's contents. ``mongodump`` can export data from:
``mongodump`` can connect to :binary:`~bin.mongod` and
:binary:`~bin.mongos` instances.

.. include:: /includes/mongodump-restore-version-link.rst

Run ``mongodump`` from the system command line, not the
:binary:`~bin.mongo` shell.

Expand Down
2 changes: 2 additions & 0 deletions source/mongodump/mongodump-behavior.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ to authenticate your ``mongodump`` session and to indicate the database
being dumped. For an example of using a different database for
authentication when using ``mongodump``, see :ref:`mongodump-auth-dump`.

.. _mongodump-matching-server-version:

Restore to Matching Server Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 3 additions & 1 deletion source/mongorestore.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ The ``mongorestore`` program loads data from either a binary
database dump created by :binary:`~bin.mongodump` or the standard input
into a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance.

.. include:: /includes/mongodump-restore-version-link.rst

Run ``mongorestore`` from the system command line, not the
:binary:`~bin.mongo` shell.

Expand Down Expand Up @@ -864,4 +866,4 @@ Learn More

Compatibility and Installation </mongorestore/mongorestore-compatibility-and-installation>
Behavior </mongorestore/mongorestore-behavior-access-usage>
Examples </mongorestore/mongorestore-examples>
Examples </mongorestore/mongorestore-examples>