Merge branch 'master' into DOCSP-47695

Author: ltran-mdb2

snooty.toml

@@ -14,12 +14,12 @@ intersphinx = [ "https://www.mongodb.com/docs/atlas/objects.inv",
 
 toc_landing_pages = ["/quickstart",
                      "/installation",
-                     "reference/reference",
+                     "/reference",
                      "/connecting",
                      "/topologies",
                      "/using-mongosync",
                      "/multiple-mongosyncs",
-                     "/release-notes/release-notes",
+                     "/release-notes",
                      "/faq",
                      "/reference/collection-level-filtering",
                      "/reference/verification",
@@ -28,10 +28,10 @@ toc_landing_pages = ["/quickstart",
                     ]
 
 [constants]
-version = "1.11"
-version-previous = "1.10"
-latest-version="1.11.0"
-version-dev = "1.11"
+version = "1.12"
+version-previous = "1.11"
+latest-version="1.12.0"
+version-dev = "1.13"
 c2c-product-name = "Cluster-to-Cluster Sync"
 c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
 mdb-download-center = "`MongoDB Download Center <https://www.mongodb.com/try/download/mongosync>`__"

source/about-mongosync.txt

@@ -129,13 +129,13 @@ call the :ref:`commit <c2c-api-commit>` endpoint.
    You must block writes to the source cluster before you begin the
    the commit process. 
 
-   If you previously set ``enableUserWriteBlocking`` to ``true`` when
-   you used the :ref:`start <c2c-api-start>` endpoint, ``mongosync``
+   If you previously set ``enableUserWriteBlocking`` to ``"sourceAndDestination"`` 
+   when you used the :ref:`start <c2c-api-start>` endpoint, ``mongosync``
    automatically blocks writes on the source cluster when you use the
    ``commit`` endpoint. 
 
-   If you did not set ``enableUserWriteBlocking`` to ``true``, run
-   :dbcommand:`setUserWriteBlockMode` on the source cluster to
+   If you did not set ``enableUserWriteBlocking`` to ``"sourceAndDestination"``, 
+   run :dbcommand:`setUserWriteBlockMode` on the source cluster to
    block writes. 
 
 The ``commit`` endpoint starts the :ref:`COMMITTING <c2c-state-committing>` 

source/includes/fact-older-version-limitations.rst

@@ -28,8 +28,9 @@
 - :ref:`/reverse <c2c-api-reverse>` endpoint is not supported. You can't 
   enable the ``reversible`` option in the :ref:`/start <c2c-api-start>` request.
 
-- You can't set the ``enableUserWriteBlocking`` option to ``true``
-  in the ``/start`` request, so dual write-blocking is not supported. 
+- You can't set the ``enableUserWriteBlocking`` option to
+  ``"sourceAndDestination"`` in the ``/start`` request, so dual write-blocking 
+  is not supported. 
   Destination-only write-blocking is supported. Ensure that no writes are 
   made to the source cluster after you call the ``/commit`` endpoint.
 

source/includes/fact-partial-8.0-support.rst

@@ -15,11 +15,11 @@ If you enable dual write-blocking, ``mongosync`` blocks writes:
 - On the source cluster after you call ``/commit``
 
 To enable dual write-blocking, use :ref:`/start <c2c-api-start>`
-to set ``enableUserWriteBlocking`` to ``true``.
+to set ``enableUserWriteBlocking`` to ``"sourceAndDestination"``.
 
 You can use
 :ref:`/start <c2c-api-start>`
-to set ``enableUserWriteBlocking`` to ``false``.
+to set ``enableUserWriteBlocking`` to ``"none"``.
 
 You cannot enable dual write-blocking or disable
 write-blocking after the sync starts.

source/includes/fact-write-blocking-enable.rst

@@ -1,8 +1,6 @@
 Starting in ``mongosync`` 1.7.0, you can upgrade ``mongosync`` without
-restarting data synchronization operations from the beginning. You can 
-only live upgrade to ``mongosync`` 1.7.3 or later from ``mongosync`` 
-1.7.2 or later.
+restarting data synchronization operations from the beginning.
 
 .. important::
 
-   ``mongosync`` does not support live upgrades to version 1.11.
+   ``mongosync`` does not support live upgrades to version 1.12.

source/includes/live-upgrade.rst

@@ -1,7 +1,7 @@
 .. list-table:: 
    :header-rows: 1
    :stub-columns: 1
-   :widths: 30 14 14 14 
+   :widths: 20 14 14 14 
 
    * -
      - **6.0 Destination** 
@@ -30,5 +30,5 @@
    * - **8.0 Source**
      -
      -
-     -
+     - √
 

source/includes/table-pre-6.0-compatibility.rst

@@ -45,7 +45,7 @@ To use the ``reverse`` endpoint:
   call to the :ref:`/start <c2c-api-start>` API endpoint must set:
 
   - ``reversible`` to ``true``
-  - ``enableUserWriteBlocking`` to ``true``.
+  - ``enableUserWriteBlocking`` to ``"sourceAndDestination"``.
 
 .. note::
 

source/reference/api/reverse.txt

@@ -115,28 +115,33 @@ Request Body Parameters
        .. versionadded:: 1.3.0
 
    * - ``enableUserWriteBlocking``
-     - boolean or string
+     - string or boolean
      - Optional
-     - If set to ``true``, blocks writes on the destination 
-       cluster while the migration is in progress, and unblocks writes right
-       before the :ref:`/progress <c2c-api-progress>` endpoint reports 
-       that ``canWrite`` is ``true``.  Blocks writes on the source
-       cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
-       endpoint.
+     - :gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster, 
+       you cannot set this parameter.
+       
+       Supported options:
+       
+       - ``"sourceAndDestination"``: blocks writes on the destination 
+         cluster while the migration is in progress, and unblocks writes right
+         before the :ref:`/progress <c2c-api-progress>` endpoint reports 
+         that ``canWrite`` is ``true``.  Blocks writes on the source
+         cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
+         endpoint.
 
-       If set to ``false``, no write blocking occurs.
+         You can also use ``true`` for backward compatibility.
 
-       If set to ``"destinationOnly"``, blocks writes on the destination
-       cluster while migration is in progress, and unblocks writes right
-       before ``canWrite`` is ``true``.
+       - ``"none"``: no write blocking occurs. You can also use ``false``
+         for backward compatibility.
 
-       :gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster, 
-       you cannot set ``enableUserWriteBlocking`` to ``true``.
+       - ``"destinationOnly"``: blocks writes on the destination
+         cluster while migration is in progress, and unblocks writes right
+         before ``canWrite`` is ``true``.
 
        To reverse sync, the ``enableUserWriteBlocking`` field must be set
-       to ``true``. To allow the source cluster to accept writes again,
-       for example after running migration tests, run the following
-       command: 
+       to ``"sourceAndDestination"``. To allow the source cluster 
+       to accept writes again, for example after running migration tests, 
+       run the following command: 
 
        .. code-block:: shell 
 

source/reference/api/start.txt

@@ -62,6 +62,10 @@ You might exceed the :term:`oplog window` if you:
 To increase the size of the oplog on the source cluster, use
 :setting:`~replication.oplogSizeMB`. 
 
+.. note::
+
+  ORR is compatible with :ref:`embedded verification<c2c-embedded-verifier>`. 
+
 Learn More 
 ----------
 

source/reference/beta-program-private/orr.txt

@@ -84,12 +84,12 @@ Steps
         destination and unblocks them right before ``canWrite`` is
         set to ``true``.
       - If you start ``mongosync`` with ``enableUserWriteBlocking``
-        set to ``true``, ``mongosync`` blocks all write operations
+        set to ``"sourceAndDestination"``, ``mongosync`` blocks all write operations
         on the destination cluster and unblocks them right before ``canWrite``
         is set to ``true``. ``mongosync`` blocks writes on the source after you call
         ``/commit``.
       - If you start ``mongosync`` with ``enableUserWriteBlocking`` set
-        to ``false``, ensure that you disable writes.
+        to ``"none"``, ensure that you disable writes.
         For example, run the :dbcommand:`setUserWriteBlockMode` command on the
         source cluster:
 

source/reference/cutover-process.txt

@@ -41,7 +41,7 @@ General Limitations
 - Other clients must not write to the destination cluster while
   ``mongosync`` is running.
 - If you want to start the :ref:`commit <c2c-api-commit>`
-  process and you did not set ``enableUserWriteBlocking`` to ``true``
+  process and you did not set ``enableUserWriteBlocking`` to ``"sourceAndDestination"``
   when you used the :ref:`c2c-api-start` endpoint, you
   must :ref:`prevent writes <c2c-api-start>` to the source cluster
   before you start the commit process. 
@@ -200,6 +200,13 @@ cluster.
 
 .. include:: /includes/fact-verifier-limitations
 
+Persistent Query Settings
+-------------------------
+
+``mongosync`` doesn't migrate Persistent Query Settings (PQS), which were
+introduced in MongoDB 8.0. If your source cluster uses PQS, you must 
+:ref:`migrate them manually <c2c-migrate-pqs>`.
+
 .. _c2c-older-version-limitations:
 
 Pre-6.0 Migrations 

source/reference/limitations.txt

@@ -34,8 +34,6 @@ The :ref:`Frequently Asked Questions (FAQ) <c2c-faq>` page addresses questions u
 Compatibility
 -------------
 
-- .. include:: /includes/fact-partial-8.0-support.rst
-
 - .. include:: /includes/fact-minimum-server-version-support.rst
 
   You can migrate data on clusters (source) with versions of MongoDB

source/reference/mongosync.txt

@@ -13,16 +13,15 @@ MongoDB Server Version Compatibility
    :class: singlecol
 
 Before you run {+c2c-product-name+}, consider the following MongoDB server 
-version limitations and requirements: 
-
-- .. include:: /includes/fact-partial-8.0-support.rst
+version limitations and requirements:
 
 - Your source cluster must run one of the following major supported versions: 
 
   - 4.4 (*New in version 1.10.0*)
   - 5.0 (*New in version 1.10.0*)
   - 6.0
   - 7.0
+  - 8.0 (*New in version 1.12.0*)
 
 - ``mongosync`` doesn't support MongoDB rapid releases, such as 6.1 or 6.2.
 
@@ -53,6 +52,10 @@ clusters:
      - 7.0.13
      - 6.0
 
+   * - 8.0
+     - 8.0
+     - 8.0
+
 .. _c2c-sync-different-versions:
 
 Synchronize Data Between Clusters with Different MongoDB Server Major Versions
@@ -73,20 +76,4 @@ destination MongoDB server versions:
 
 .. seealso::
 
-   :ref:`Pre-6.0 Migration Limitations <c2c-older-version-limitations>`
-
-.. _c2c-server-8.0-to-8.0:
-
-Synchronize Data Between Two 8.0 Clusters
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To migrate data between two 8.0 clusters:
-
-- Use :ref:`mongodump` to export data from the source cluster.
-- Use :ref:`mongorestore` to import the data into the destination cluster.
-
-For limitations on using ``mongodump`` and ``mongorestore``, see 
-:ref:`mongorestore-behavior-access-usage`.
-
-Alternatively, you can :ref:`downgrade your 8.0 source cluster <8.0-downgrade>` 
-to 7.0 and then migrate your data into an 8.0 destination cluster.
+   :ref:`Pre-6.0 Migration Limitations <c2c-older-version-limitations>`

source/reference/supported-server-version.txt

@@ -1,5 +1,3 @@
-.. place holder for the release notes TOC
-
 =============
 Release Notes
 =============
@@ -14,11 +12,12 @@ release notes.
 Current Stable Release
 ~~~~~~~~~~~~~~~~~~~~~~
 
-- :ref:`c2c-release-notes-1.11`
+- :ref:`c2c-release-notes-1.12`
 
 Previous Releases
 ~~~~~~~~~~~~~~~~~
 
+- :ref:`c2c-release-notes-1.11`
 - :ref:`c2c-release-notes-1.10`
 - :ref:`c2c-release-notes-1.9`
 - :ref:`c2c-release-notes-1.8`
@@ -37,6 +36,7 @@ Previous Releases
 .. toctree::
    :titlesonly: 
 
+   1.12 </release-notes/1.12>
    1.11 </release-notes/1.11>
    1.10 </release-notes/1.10>
    1.9 </release-notes/1.9>

source/release-notes.txt

@@ -0,0 +1,67 @@
+.. _c2c-release-notes-1.12:
+
+================================
+Release Notes for mongosync 1.12
+================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+This page describes changes and new features introduced in  
+{+c2c-full-product-name+} 1.12.
+
+.. _1.12.0-c2c-release-notes:
+
+1.12.0 Release
+--------------
+
+**February 19, 2025**
+
+MongoDB 8.0 support
+~~~~~~~~~~~~~~~~~~~
+
+{+c2c-full-product-name+} 1.12 adds support for MongoDB 8.0 on the source 
+cluster. However, it does not migrate Persistent Query Settings (PQS), which 
+are new in 8.0. If your source cluster uses PQS, you must :ref:`migrate them 
+manually <c2c-migrate-pqs>`.
+
+For a full list of supported versions, see :ref:`c2c-server-version-compatibility`.
+
+
+``enableUserWriteBlocking`` parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``enableUserWriteBlocking`` parameter in the 
+:ref:`/start <c2c-api-start>` API now accepts the following string options:
+
+- ``"sourceAndDestination"`` for dual write-blocking
+- ``"none"`` for no write-blocking
+
+Use these options instead of the old ``true`` and ``false`` values.
+``enableUserWriteBlocking`` still supports ``true`` and ``false``
+for backward compatibility.
+
+See :ref:`c2c-api-start-params`.
+
+Live Upgrades
+~~~~~~~~~~~~~
+
+:ref:`Live upgrades <c2c-versioning-live-upgrade>` 
+to version 1.12 are not supported.
+
+Other Notes 
+~~~~~~~~~~~
+
+- Added a machine-friendly label to warnings about Persisted Query Settings
+
+Minimum Supported Version
+-------------------------
+
+.. include:: /includes/fact-version-compatibility.rst
+
+.. include:: /includes/migration-upgrade-recommendation.rst

source/release-notes/1.12.txt

@@ -30,7 +30,7 @@ Before you can reverse your sync direction, you must configure
 following parameters:
 
 - ``reversible`` to ``true``
-- ``enableUserWriteBlocking`` to ``true``.
+- ``enableUserWriteBlocking`` to ``"sourceAndDestination"``.
 
 For more information on limitations and requirements of reversing sync,
 see :ref:`c2c-api-reverse`. 

source/reverse-sync.txt

@@ -311,5 +311,5 @@ instance that is running on ``mongosync01Host`` and using ``port
 .. note::
 
    Reverse synchronization is only possible if ``reversible`` and
-   ``enableUserWriteBlocking`` are both set to ``true`` when the
+   ``enableUserWriteBlocking`` are both set to ``"sourceAndDestination"`` when the
    :ref:`start API <c2c-api-start>` initiates ``mongosync``.