From dbb305fb474361f8f5f91664435f2ed48bda6459 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 10:55:59 -0400 Subject: [PATCH 01/12] (DOCSP-39188): Clarify that upgrades must be to one major version ahead --- source/includes/fact-match-dump-restore-versions.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 081a4666..877f6cfe 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -14,9 +14,11 @@ 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 running the same version or one major version + later than the source deployment. To learn about supported upgrade + paths, see the :manual:`upgrade documentation + `. This guarantee does not apply to metadata, archive, or oplog replay files. If you try to restore these files using different From 909796d9d77927b7699f5f516896345ec5268011 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 10:58:58 -0400 Subject: [PATCH 02/12] try new webhook From c22e5114d2adf5ce030806f6f3ed0e250e791e98 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 11:02:42 -0400 Subject: [PATCH 03/12] try new webhook From 8c5773921420170ab6f2e98edc43cae90a51297d Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 11:13:01 -0400 Subject: [PATCH 04/12] try new webhook From 9c6a8ab5e6a48a5c22f7540740aa9e64fa11f200 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 13:25:36 -0400 Subject: [PATCH 05/12] fix include --- source/includes/fact-match-dump-restore-versions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 877f6cfe..2722b9c1 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -18,7 +18,7 @@ To change your feature compatibility version, see MongoDB deployments running the same version or one major version later than the source deployment. To learn about supported upgrade paths, see the :manual:`upgrade documentation - `. + `. This guarantee does not apply to metadata, archive, or oplog replay files. If you try to restore these files using different From ceb41e46f5e43a48c0ec47f65a1ce91054b56ee9 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 15:00:46 -0400 Subject: [PATCH 06/12] fix include version --- snooty.toml | 1 + source/includes/fact-match-dump-restore-versions.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 80a8db27..4067e92f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -26,6 +26,7 @@ qe = "Queryable Encryption" version = "100.9.0" release = "{+version+}" pgp-version = "{+version+}" +server-version = "7.0" pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B" rsa-key = "4B7C549A058F8B6B" pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F 718D 4B7C 549A 058F 8B6B" diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 2722b9c1..3c5d6a02 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -18,7 +18,7 @@ To change your feature compatibility version, see MongoDB deployments running the same version or one major version later than the source deployment. To learn about supported upgrade paths, see the :manual:`upgrade documentation - `. + `. This guarantee does not apply to metadata, archive, or oplog replay files. If you try to restore these files using different From 965b4499bc4658a0249dd54263a489c8fe917403 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 15:28:00 -0400 Subject: [PATCH 07/12] edits --- snooty.toml | 1 + source/includes/fact-match-dump-restore-versions.rst | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/snooty.toml b/snooty.toml index 4067e92f..526670cf 100644 --- a/snooty.toml +++ b/snooty.toml @@ -27,6 +27,7 @@ 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" diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 3c5d6a02..53a9b6c5 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -16,8 +16,12 @@ To change your feature compatibility version, see You can restore the BSON files generated from ``mongodump`` into MongoDB deployments running the same version or one major version - later than the source deployment. To learn about supported upgrade - paths, see the :manual:`upgrade documentation + 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 have upgraded to {+server-previous-version+}-series. To learn + about supported upgrade paths, see the :manual:`upgrade documentation `. This guarantee does not apply to metadata, archive, or oplog replay From a2bb415decab8f7214a6b525a8d96ce0b12f7f3d Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 15:43:06 -0400 Subject: [PATCH 08/12] add version info to top-level dump and restore pages --- source/includes/fact-match-dump-restore-versions.rst | 4 ++-- source/includes/mongodump-restore-version-link.rst | 4 ++++ source/mongodump.txt | 2 ++ source/mongodump/mongodump-behavior.txt | 2 ++ source/mongorestore.txt | 4 +++- 5 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 source/includes/mongodump-restore-version-link.rst diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 53a9b6c5..7b4a78d9 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -20,8 +20,8 @@ To change your feature compatibility version, see 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 have upgraded to {+server-previous-version+}-series. To learn - about supported upgrade paths, see the :manual:`upgrade documentation + you upgrade to {+server-previous-version+}-series. To learn how to + upgrade your deployment, see the :manual:`upgrade documentation `. This guarantee does not apply to metadata, archive, or oplog replay diff --git a/source/includes/mongodump-restore-version-link.rst b/source/includes/mongodump-restore-version-link.rst new file mode 100644 index 00000000..8871a554 --- /dev/null +++ b/source/includes/mongodump-restore-version-link.rst @@ -0,0 +1,4 @@ +You can restore the BSON files generated from ``mongodump`` into MongoDB +deployments running the same version or one major version later than the +source deployment. For more information see +:ref:`mongodump-matching-server-version`. diff --git a/source/mongodump.txt b/source/mongodump.txt index 45d36c63..d5976b8c 100644 --- a/source/mongodump.txt +++ b/source/mongodump.txt @@ -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. diff --git a/source/mongodump/mongodump-behavior.txt b/source/mongodump/mongodump-behavior.txt index fe1ba48c..0b8627b1 100644 --- a/source/mongodump/mongodump-behavior.txt +++ b/source/mongodump/mongodump-behavior.txt @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/mongorestore.txt b/source/mongorestore.txt index d22b984d..75c16c78 100644 --- a/source/mongorestore.txt +++ b/source/mongorestore.txt @@ -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. @@ -864,4 +866,4 @@ Learn More Compatibility and Installation Behavior - Examples \ No newline at end of file + Examples From ab929e369753f238491f9a9115c72a4b5190ff3c Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Fri, 3 May 2024 16:21:19 -0400 Subject: [PATCH 09/12] wording --- source/includes/fact-match-dump-restore-versions.rst | 2 +- source/includes/mongodump-restore-version-link.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 7b4a78d9..19b7dd10 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -15,7 +15,7 @@ To change your feature compatibility version, see .. note:: You can restore the BSON files generated from ``mongodump`` into - MongoDB deployments running the same version or one major version + MongoDB deployments that run the same version or one major version 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 diff --git a/source/includes/mongodump-restore-version-link.rst b/source/includes/mongodump-restore-version-link.rst index 8871a554..7131cdfc 100644 --- a/source/includes/mongodump-restore-version-link.rst +++ b/source/includes/mongodump-restore-version-link.rst @@ -1,4 +1,4 @@ You can restore the BSON files generated from ``mongodump`` into MongoDB -deployments running the same version or one major version later than the -source deployment. For more information see +deployments that run the same version or one major version later than +the source deployment. For more information see :ref:`mongodump-matching-server-version`. From 42d13b3a1cc4d6424512cc8a25b67d91597633d0 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Mon, 6 May 2024 13:40:22 -0400 Subject: [PATCH 10/12] address review feedback --- source/includes/fact-match-dump-restore-versions.rst | 9 +++------ source/includes/mongodump-restore-version-link.rst | 8 +++++--- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index 19b7dd10..ed317ad2 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -15,12 +15,9 @@ To change your feature compatibility version, see .. note:: You can restore the BSON files generated from ``mongodump`` into - MongoDB deployments that run the same version or one major version - 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 + 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 deployment, see the :manual:`upgrade documentation `. diff --git a/source/includes/mongodump-restore-version-link.rst b/source/includes/mongodump-restore-version-link.rst index 7131cdfc..da5c46ed 100644 --- a/source/includes/mongodump-restore-version-link.rst +++ b/source/includes/mongodump-restore-version-link.rst @@ -1,4 +1,6 @@ You can restore the BSON files generated from ``mongodump`` into MongoDB -deployments that run the same version or one major version later than -the source deployment. For more information see -:ref:`mongodump-matching-server-version`. +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 +deployment, see the :manual:`upgrade documentation +`. From d2a9947f331d8519b22483dec22835791f91242d Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Mon, 6 May 2024 13:41:26 -0400 Subject: [PATCH 11/12] remove unneeded variable --- snooty.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index 526670cf..4067e92f 100644 --- a/snooty.toml +++ b/snooty.toml @@ -27,7 +27,6 @@ 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" From 83f7c781eedb7c5ff0b2603546bcae2a5cd84b28 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Mon, 6 May 2024 16:20:14 -0400 Subject: [PATCH 12/12] review feedback --- source/includes/fact-match-dump-restore-versions.rst | 2 +- source/includes/mongodump-restore-version-link.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst index ed317ad2..fd5651ad 100644 --- a/source/includes/fact-match-dump-restore-versions.rst +++ b/source/includes/fact-match-dump-restore-versions.rst @@ -17,7 +17,7 @@ To change your feature compatibility version, see 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 + is not the recommended way to upgrade your deployment. To learn how to upgrade your deployment, see the :manual:`upgrade documentation `. diff --git a/source/includes/mongodump-restore-version-link.rst b/source/includes/mongodump-restore-version-link.rst index da5c46ed..c11e1a3c 100644 --- a/source/includes/mongodump-restore-version-link.rst +++ b/source/includes/mongodump-restore-version-link.rst @@ -1,6 +1,6 @@ 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 +However, restoring files into a newer version deployment is not the +recommended way to upgrade your deployment. To learn how to upgrade your deployment, see the :manual:`upgrade documentation `.