diff --git a/source/includes/api/facts/reverse-sync-requirements.rst b/source/includes/api/facts/reverse-sync-requirements.rst new file mode 100644 index 000000000..d0d8e0e6f --- /dev/null +++ b/source/includes/api/facts/reverse-sync-requirements.rst @@ -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``. \ No newline at end of file diff --git a/source/includes/fact-permissions-body.rst b/source/includes/fact-permissions-body.rst index 6ab11098e..463c3f317 100644 --- a/source/includes/fact-permissions-body.rst +++ b/source/includes/fact-permissions-body.rst @@ -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 ` 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. diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index c0ca224fc..6423d7ef4 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -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 @@ -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: