DOCSP-29503-cross-version-sync (#159)

jason-price-mongodb · jason-price-mongodb · web-flow · commit bc8b09400901 · 2023-10-18T14:10:49.000-07:00
* DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync * DOCSP-29503-cross-version-sync --------- Co-authored-by: jason-price-mongodb <jshfjghsdfgjsdjh@aolsdjfhkjsdhfkjsdf.com>
diff --git a/source/includes/cross-version-sync.rst b/source/includes/cross-version-sync.rst
@@ -0,0 +1,11 @@
+Starting in 1.7.0, ``mongosync`` can perform a cross version migration
+from a lower major version source cluster to a higher major version
+destination cluster. You can migrate up to two major versions ahead. For
+example, you can synchronize a cluster running MongoDB 6.0 with a
+cluster running 7.0.
+
+Cross version migration requires additional preparation and
+configuration when migrating from a pre-6.0 release. To perform a cross
+version migration from a pre-6.0 version of the MongoDB Server using
+``mongosync``, please `contact <https://mongodb.com/contact>`__ your
+account team to inquire about Professional Services.
diff --git a/source/includes/fact-minimum-versions.rst b/source/includes/fact-minimum-versions.rst
@@ -2,6 +2,6 @@ Starting in version 1.2, ``mongosync`` can sync between clusters running
 some older (pre-6.0) releases of MongoDB Server. This feature requires
 additional preparation and configuration in pre-6.0 releases.
 
-If you would like to migrate pre-6.0 versions of MongoDB Server
-using ``mongosync``, please `contact <https://mongodb.com/contact>`__
-your account team to inquire about Professional Services.
+If you would like to migrate pre-6.0 versions of MongoDB Server using
+``mongosync``, please `contact <https://mongodb.com/contact>`__ your
+account team to inquire about Professional Services.
diff --git a/source/includes/fact-reverse-limitation.rst b/source/includes/fact-reverse-limitation.rst
@@ -1,3 +1,3 @@
-The source and destination clusters must have the same number of
-shards. You cannot reverse sync when the clusters have different
-topologies.
+The source and destination clusters must have the same number of shards.
+You cannot reverse sync when the clusters have different topologies or
+major versions.
diff --git a/source/includes/version-sync-limitation.rst b/source/includes/version-sync-limitation.rst
@@ -0,0 +1,4 @@
+In ``mongosync`` versions earlier than 1.7.0, the source and
+destination clusters must run the same MongoDB server version
+and have the same :dbcommand:`Feature Compatibility Version
+<setFeatureCompatibilityVersion>`.
diff --git a/source/quickstart.txt b/source/quickstart.txt
@@ -53,9 +53,11 @@ Follow the instructions below to setup {+c2c-product-name+}.
       The source and destination clusters must be:
       
       - at least MongoDB 6.0.
-      - the same server version
       - at least Feature Compatibility Version 6.0
-      - the same Feature Compatibility Version
+
+      .. include:: /includes/version-sync-limitation.rst
+
+      .. include:: /includes/cross-version-sync.rst
 
       The number of nodes in the destination replica set does not have
       to equal the number of nodes in the source replica set.
diff --git a/source/reference/limitations.txt b/source/reference/limitations.txt
@@ -17,7 +17,7 @@ Limitations
 
    ``mongosync`` does not check for compliance with the documented
    limitations. Please ensure that your application is not affected by
-   the limitations . Running ``mongosync`` in the presence of one of
+   the limitations. Running ``mongosync`` in the presence of one of
    these limitations could lead to undefined behavior on the destination
    cluster.
 
@@ -26,47 +26,53 @@ General Limitations
 
 - The minimum supported server versions are MongoDB 6.0.8 and 7.0.0.
 
-  .. include:: /includes/fact-minimum-versions.rst
+- .. include:: /includes/fact-minimum-versions.rst
 
-- ``mongosync`` does not support MongoDB rapid releases such as 6.1 or
+- ``mongosync`` doesn't support MongoDB rapid releases such as 6.1 or
   6.2. The minimum supported server version is MongoDB 6.0.5.
   For more information on MongoDB versioning, see
   :ref:`release-version-numbers`.
-- The source and destination clusters must have the same major and minor
-  release version, but can have different patch releases.
+- In ``mongosync`` versions earlier than 1.7.0, the source and
+  destination clusters must have the same major and minor release
+  version, but can have different patch releases.
 
-  For example,
+  For example:
+
+  - ``mongosync`` can sync from a MongoDB 6.0.8 source cluster to a
+    destination cluster using MongoDB 6.0.9. This is because the patch
+    releases have the same major version.
+  - ``mongosync`` doesn't support a sync from a MongoDB 6.0.9 source
+    cluster to a destination cluster using MongoDB 7.0.0. This is
+    because the releases have different major versions.
+
+- In ``mongosync`` versions earlier than 1.7.0, the source and
+  destination clusters must have the same :dbcommand:`Feature
+  Compatibility Version <setFeatureCompatibilityVersion>`.
+
+- .. include:: /includes/cross-version-sync.rst
 
-  - ``mongosync`` supports sync from a MongoDB 6.0.8 source cluster to a
-    MongoDB 6.0.9 destination cluster, since these are patch releases 
-    of the same major release.
-  - ``mongosync`` does not support sync from a MongoDB 6.0.9 source cluster to 
-    a MongoDB 7.0.0 destination cluster, since they have different major
-    versions.
 - The minimum supported :dbcommand:`Feature Compatibility Version
   <setFeatureCompatibilityVersion>` is 6.0.
-- The source and destination clusters must have the same Feature
-  Compatibility Version.
 - The destination cluster must be empty.
-- ``mongosync`` does not validate that the clusters or the environment
+- ``mongosync`` doesn't validate that the clusters or the environment
   are properly configured. 
 - Other clients must not write to the destination cluster while
   ``mongosync`` is running.
 - If write blocking is disabled, the client must :ref:`prevent writes
   <c2c-api-start>` to the source cluster before starting the commit
   process.
-- :dbcommand:`applyOps` operations from the source cluster are not
+- :dbcommand:`applyOps` operations from the source cluster aren't
   supported.
-- :ref:`system.* collections <metadata-system-collections>` are not
+- :ref:`system.* collections <metadata-system-collections>` aren't
   replicated.
-- Documents that have dollar (``$``) prefixed field names are not
+- Documents that have dollar (``$``) prefixed field names aren't
   supported. See :ref:`Field Names with Periods and Dollar Signs
   <crud-concepts-dot-dollar-considerations>`.
-- Serverless clusters are not supported.
-- The MongoDB Shared Tier is not supported.
+- Serverless clusters aren't supported.
+- A MongoDB Shared Tier isn't supported.
 - `Queryable Encryption
-  <https://www.mongodb.com/docs/v6.0/core/queryable-encryption/>`__ is
-  not supported.
+  <https://www.mongodb.com/docs/v6.0/core/queryable-encryption/>`__
+  isn't supported.
 - After you replace the ``mongosync`` binary during an upgrade or a
   downgrade, you should drop all non-system databases in the destination
   cluster before starting the new binary. Syncing operations will
@@ -84,14 +90,14 @@ discuss your requirements.
 Unsupported Collection Types
 ----------------------------
 
-- Time-series collections are not supported.
+- Time-series collections aren't supported.
 - Clustered collections with :ref:`expireAfterSeconds
-  <db.createCollection.expireAfterSeconds>` set are not supported.
+  <db.createCollection.expireAfterSeconds>` set aren't supported.
 
 Sharded Clusters
 ----------------
 
-- ``mongosync`` does not support sync from a sharded cluster
+- ``mongosync`` doesn't support sync from a sharded cluster
   to a replica set.
 - Sync from a replica set to a sharded cluster has the following
   limitations:
@@ -107,13 +113,14 @@ Sharded Clusters
     The index must either exist before ``mongosync`` starts or be
     created after the migration is complete and ``mongosync`` has
     stopped.
+
 - Within a collection, the ``_id`` field must be unique across all of
   the shards in the cluster. See :ref:`sharded-clusters-unique-indexes`
   for more details.
 - The :dbcommand:`movePrimary` command cannot be used to reassign the
   primary shard while syncing.
 - There is no replication for zone configuration. ``mongosync``
-  replicates data, it does not inherit zones.
+  replicates data, it doesn't inherit zones.
 - Shards cannot be added or removed while syncing.
 - ``mongosync`` only syncs indexes that exist on all shards. 
 - ``mongosync`` only syncs indexes that have consistent index
@@ -145,9 +152,9 @@ Reversing
 Multiple Clusters
 -----------------
 
-- Syncing multiple source clusters to one destination cluster is not
+- Syncing multiple source clusters to one destination cluster isn't
   supported.
-- Syncing one source cluster to many destination clusters is not
+- Syncing one source cluster to many destination clusters isn't
   supported.
 
 .. _c2c-filtering-limitations:
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -8,6 +8,7 @@ Release Notes
 .. toctree::
    :titlesonly: 
 
+   /release-notes/1.7
    /release-notes/1.6
    /release-notes/1.5
    /release-notes/1.4
diff --git a/source/release-notes/1.2.txt b/source/release-notes/1.2.txt
@@ -17,7 +17,13 @@ Release Notes for ``mongosync`` 1.2
 Migrating Older Versions of MongoDB
 -------------------------------------
 
-.. include:: /includes/fact-minimum-versions.rst
+Starting in version 1.2, ``mongosync`` can sync between clusters running 
+some older (pre-6.0) releases of MongoDB Server. This feature requires
+additional preparation and configuration in pre-6.0 releases.
+
+If you would like to migrate pre-6.0 versions of MongoDB Server
+using ``mongosync``, please `contact <https://mongodb.com/contact>`__
+your account team to inquire about Professional Services.
 
 Guardrails for Unsupported Versions of MongoDB
 ----------------------------------------------
diff --git a/source/release-notes/1.7.txt b/source/release-notes/1.7.txt
@@ -0,0 +1,30 @@
+.. _c2c-release-notes-1.7:
+
+===============================
+Release Notes for mongosync 1.7
+===============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+.. _1.7.0-c2c-release-notes:
+
+1.7.0 Release
+-------------
+
+**Upcoming**
+
+Synchronize Data Between Clusters with Different MongoDB Server Major Versions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/cross-version-sync.rst
+
+Minimum Supported Version
+-------------------------
+
+In 1.7.0, the minimum supported version of MongoDB is 6.0.8.
