Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

DOCSP-32849-add-reference-to-restore-role #737

Merged
merged 11 commits into from
Apr 28, 2025
3 changes: 3 additions & 0 deletions source/includes/api/facts/reverse-sync-requirements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
To reverse sync, the user must be assigned the :authrole:`restore`
role for both source and destination and the ``enableUserWriteBlocking``
field must be set to ``sourceAndDestination``.
8 changes: 4 additions & 4 deletions source/includes/fact-permissions-body.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The user specified in the ``mongosync`` connection string must have the
required permissions on the source and destination clusters. The
permissions vary depending on your environment and if you want to
modify write-blocking settings or use reverse sync.

required :ref:`user permissions <c2c-permissions-and-roles>` on the
source and destination clusters. The permissions vary depending on your
environment and if you want to modify write-blocking settings or use
reverse sync.
13 changes: 6 additions & 7 deletions source/reference/api/start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ Request Body Parameters
cluster while migration is in progress, and unblocks writes right
before ``canWrite`` is ``true``.

To reverse sync, the ``enableUserWriteBlocking`` field must be set
to ``"sourceAndDestination"``. To allow the source cluster
to accept writes again, for example after running migration tests,
run the following command:
.. include:: /includes/api/facts/reverse-sync-requirements.rst

To allow the source cluster to accept writes again, for example
after running migration tests, run the following command:

.. code-block:: shell

Expand Down Expand Up @@ -175,9 +175,8 @@ Request Body Parameters
- Optional
- If set to ``true``, enables the sync operation to be
reversed.

To reverse sync, the ``enableUserWriteBlocking`` field must be set
to ``sourceAndDestination``.

.. include:: /includes/api/facts/reverse-sync-requirements.rst

This option is not supported for the following configurations:

Expand Down