(DOCSP-40128): v1.7.3 release updates (#326)

* (DOCSP-40128): v1.7.3 release notes

* more updates

* fix

* fix

* address review comments

Author: jeff-allen-mongo

source/includes/read-preference-connection-string.rst

@@ -1,4 +1,3 @@
-
-``mongosync`` requires the :readmode:`primary` read preference
-to connect to the source cluster. For more information, see :ref:`connections-read-preference`.
-
+``mongosync`` requires the :readmode:`primary` read preference to
+connect to the source and destination clusters. For more information,
+see :ref:`connections-read-preference`.

source/includes/sharding-perf.rst

@@ -20,10 +20,11 @@ source cluster.
 
 .. important::
 
-   When the source cluster is a sharded cluster, stop the
+   When the source or destination cluster is a sharded cluster, stop the
    balancer and don't run the :dbcommand:`moveChunk` or
-   :dbcommand:`moveRange` commands until ``mongosync`` reaches
-   the collection copy phase.
+   :dbcommand:`moveRange` commands for the entire lifetime of the
+   migration. To stop the balancer, run the :dbcommand:`balancerStop`
+   command and wait for the command to complete.
 
 .. _c2c-sharded-config-single:
 
@@ -177,13 +178,6 @@ Use ``curl`` or another HTTP client to issue the :ref:`start
 The ``start`` command options must be the same for all of the ``mongosync``
 instances.
 
-.. _c2c-sharded-performance:
-
-Performance
------------
-
-.. include:: /includes/sharding-perf
-
 .. _c2c-sharded-progress:
 
 Check Progress

source/multiple-mongosyncs.txt

@@ -71,13 +71,14 @@ Response
 Behavior
 --------
 
-If the ``resume`` request is successful, ``mongosync`` enters the
-``RUNNING`` state.
+- If the ``resume`` request is successful, ``mongosync`` enters the
+  ``RUNNING`` state.
+
+- When you send a ``resume`` request, there may be a delay of up to a
+  few minutes before ``mongosync`` resumes the migration.
 
 Endpoint Protection
 ~~~~~~~~~~~~~~~~~~~
 
 .. |endpoint| replace:: ``resume``
 .. include:: /includes/fact-api-endpoint
-
-

source/reference/api/resume.txt

@@ -57,7 +57,8 @@ General Limitations
 - ``mongosync`` does not support source or destination clusters that 
   are currently upgrading MongoDB versions.
 - ``mongosync`` does not support syncing 
-  `Atlas Search Indexes <https://www.mongodb.com/docs/atlas/atlas-search/create-index/>`__.
+  `Atlas Search Indexes
+  <https://www.mongodb.com/docs/atlas/atlas-search/create-index/>`__.
 
 MongoDB Community Edition
 -------------------------
@@ -118,8 +119,10 @@ Sharded Clusters
      To check for index inconsistencies, see :ref:`Find Inconsistent
      Indexes Across Shards <manage-indexes-find-inconsistent-indexes>`.
 
-- You must stop the balancer on a sharded source cluster until
-  mongosync finishes the collection copy phase.
+- You must stop the balancer on sharded source and destination clusters
+  for the entire lifetime of a migration. To stop the balancer, run the
+  :dbcommand:`balancerStop` command and wait for the command to
+  complete.
 
   .. note::
 
@@ -128,7 +131,7 @@ Sharded Clusters
      finish any in progress chunk migrations.
 
 - You must not run the :dbcommand:`moveChunk` and
-  :dbcommand:`moveRange` commands on the source cluster.
+  :dbcommand:`moveRange` commands on the source or destination clusters.
 - The shard key cannot be :ref:`refined <shard-key-refine>` while
   syncing.
 - The :dbcommand:`reshardCollection` operations from the source cluster

source/reference/limitations.txt

@@ -291,9 +291,9 @@ behavior, see :ref:`read-concern` and :ref:`write-concern`.
 Read Preference
 ~~~~~~~~~~~~~~~
 
-``mongosync`` requires the :readmode:`primary` read preference
-when connecting to the source cluster. For more information, see
-:ref:`connections-read-preference`. 
+``mongosync`` requires the :readmode:`primary` read preference when
+connecting to the source and destination clusters. For more information,
+see :ref:`connections-read-preference`. 
 
 .. _c2c-capped-collections:
 
@@ -380,4 +380,3 @@ Examples
       :copyable: false
 
       { "success": true }
-

source/reference/mongosync.txt

@@ -15,6 +15,62 @@ Release Notes for mongosync 1.7
 Patch Releases
 --------------
 
+.. _1.7.3-c2c-release-notes:
+
+1.7.3 Release
+~~~~~~~~~~~~~
+
+**June 4, 2024**
+
+Issues Fixed:
+
+- Fixed bug introduced in v1.5.0 where mongosync could miss change
+  events when reading documents from a lagging secondary node and the
+  Oplog Rollover Resilience mechanism is enabled.
+
+- Fixed bug introduced in v1.0.0 where the destination may have missing
+  or extra indexes after mongosync is committed. This is an unlikely
+  edge case.
+
+- Fixed bug introduced in v1.0.0 where mongosync may miss change events
+  for a document. This is an unlikely edge case that is only possible if
+  the destination server version is MongoDB 5.0 or earlier.
+
+- Fixed bug introduced in v1.0.0 that could result in size mismatches
+  between source and destination capped collections. This can only
+  affect migrations if all of the following conditions are met:
+  
+  - The source cluster is MongoDB 6.0 or earlier.
+  
+  - The destination cluster is MongoDB 7.0 or later.
+  
+  - A capped collection's size was modified during a migration.
+
+- Fixed bug introduced in v1.0.0 where mongosync ignored the
+  ``changeStreamPreAndPostImages`` field in ``modify`` change events.
+  This could result in a destination collection having a different value
+  for this field compared to its source collection. mongosync now
+  correctly handles this field.
+
+- Mitigated bug introduced in v1.0.0 that could result in missed change
+  events when mongosync is interrupted and resumed. This is an unlikely
+  edge case.
+
+Limitations:
+
+- You must stop the balancer on both the source and destination sharded
+  clusters for the entire lifetime of a migration. If you try to start
+  mongosync while the balancer is still running, it throws an error.
+
+- You must not run the ``moveChunk`` or ``moveRange`` commands on the
+  destination cluster. If you try to run these commands on the source
+  cluster, mongosync throws an error.
+
+- mongosync reads from the destination cluster using the ``primary``
+  read preference. If you try to start mongosync with a different read
+  preference, it throws an error.
+
+
 .. _1.7.2-c2c-release-notes:
 
 1.7.2 Release
@@ -49,7 +105,7 @@ Issues Fixed:
 
   This can only affect migrations where collections are dropped
   or renamed while mongosync is running and the source or
-  destintion cluster runs MongoDB 6.0.0 to 6.0.12 or MongoDB
+  destination cluster runs MongoDB 6.0.0 to 6.0.12 or MongoDB
   7.0.0 or 7.0.3.
 
 - Fixed bug introduced in v1.1.0 that could result in a