From 1f953f7662dd6e5a1204262f5d81f41a0fd8c98c Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Mon, 21 Apr 2025 23:56:04 -0600 Subject: [PATCH 01/11] DOCSP-32849-add-reference-to-restore-role --- source/reference/api/start.txt | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index c0ca224fc..3caf78c8f 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -142,9 +142,11 @@ Request Body Parameters 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: + to ``"sourceAndDestination"`` and the user must have assigned the + :authrole:`restore` role for both source and destination, see + :ref:`c2c-permissions-and-roles` for more details. To allow the + source cluster to accept writes again, for example after running + migration tests, run the following command: .. code-block:: shell @@ -177,7 +179,9 @@ Request Body Parameters reversed. To reverse sync, the ``enableUserWriteBlocking`` field must be set - to ``sourceAndDestination``. + to ``sourceAndDestination`` and the user must have assigned the + :authrole:`restore` role for both source and destination, see + :ref:`c2c-permissions-and-roles` for more details. This option is not supported for the following configurations: From 0ed73c7db3e20f639d2402d157b43194d4f2bcad Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Tue, 22 Apr 2025 00:10:05 -0600 Subject: [PATCH 02/11] rephrasing --- source/reference/api/start.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 3caf78c8f..07f2fee7a 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -143,10 +143,12 @@ Request Body Parameters To reverse sync, the ``enableUserWriteBlocking`` field must be set to ``"sourceAndDestination"`` and the user must have assigned the - :authrole:`restore` role for both source and destination, see - :ref:`c2c-permissions-and-roles` for more details. To allow the - source cluster to accept writes again, for example after running - migration tests, run the following command: + :authrole:`restore` role for both source and destination. + + For more information, see :ref:`c2c-permissions-and-roles`. + + To allow the source cluster to accept writes again, for example + after running migration tests, run the following command: .. code-block:: shell @@ -180,8 +182,9 @@ Request Body Parameters To reverse sync, the ``enableUserWriteBlocking`` field must be set to ``sourceAndDestination`` and the user must have assigned the - :authrole:`restore` role for both source and destination, see - :ref:`c2c-permissions-and-roles` for more details. + :authrole:`restore` role for both source and destination. + + For more information, see :ref:`c2c-permissions-and-roles`. This option is not supported for the following configurations: From 6767e01c3b70ab9c560b9dbcd482bb2c755f1242 Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Tue, 22 Apr 2025 11:18:17 -0600 Subject: [PATCH 03/11] use-include --- source/includes/fact-permissions-body.rst | 6 +++--- source/reference/api/start.txt | 12 +++++------- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/source/includes/fact-permissions-body.rst b/source/includes/fact-permissions-body.rst index 6ab11098e..9c37f831b 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:`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. diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 07f2fee7a..7149b4318 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -142,10 +142,9 @@ Request Body Parameters before ``canWrite`` is ``true``. To reverse sync, the ``enableUserWriteBlocking`` field must be set - to ``"sourceAndDestination"`` and the user must have assigned the - :authrole:`restore` role for both source and destination. + to ``"sourceAndDestination"``. - For more information, see :ref:`c2c-permissions-and-roles`. + .. include:: /includes/fact-permissions-body.rst To allow the source cluster to accept writes again, for example after running migration tests, run the following command: @@ -181,10 +180,9 @@ Request Body Parameters reversed. To reverse sync, the ``enableUserWriteBlocking`` field must be set - to ``sourceAndDestination`` and the user must have assigned the - :authrole:`restore` role for both source and destination. - - For more information, see :ref:`c2c-permissions-and-roles`. + to ``sourceAndDestination``. + + .. include:: /includes/fact-permissions-body.rst This option is not supported for the following configurations: From c196e61b866ef8c2e941e7f36ecd3aa0920c20b3 Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Tue, 22 Apr 2025 11:26:48 -0600 Subject: [PATCH 04/11] reorder --- source/reference/api/start.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 7149b4318..4474cda26 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -141,11 +141,12 @@ 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"``. - .. include:: /includes/fact-permissions-body.rst + To reverse sync, the user must have assigned the :authrole:`restore` + role for both source and destination and 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: @@ -179,10 +180,11 @@ Request Body Parameters - If set to ``true``, enables the sync operation to be reversed. - To reverse sync, the ``enableUserWriteBlocking`` field must be set - to ``sourceAndDestination``. - .. include:: /includes/fact-permissions-body.rst + + To reverse sync, the user must have assigned the :authrole:`restore` + role for both source and destination and the ``enableUserWriteBlocking`` + field must be set to ``sourceAndDestination``. This option is not supported for the following configurations: From 6b6a8fdeb9e8980c6b9a0e034b62c0f6139e7b18 Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Wed, 23 Apr 2025 10:47:44 -0600 Subject: [PATCH 05/11] Update source/includes/fact-permissions-body.rst Co-authored-by: Jeff Allen --- source/includes/fact-permissions-body.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/includes/fact-permissions-body.rst b/source/includes/fact-permissions-body.rst index 9c37f831b..11a08fba4 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 :ref:`c2c-permissions-and-roles` on the source and destination +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. From 8e17fd09f4a4a2244f9090c23d2fd1002b659b1a Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Wed, 23 Apr 2025 11:03:04 -0600 Subject: [PATCH 06/11] apply-feedback --- source/includes/api/facts/reverse-sync.rst | 3 +++ source/reference/api/start.txt | 12 ++---------- 2 files changed, 5 insertions(+), 10 deletions(-) create mode 100644 source/includes/api/facts/reverse-sync.rst diff --git a/source/includes/api/facts/reverse-sync.rst b/source/includes/api/facts/reverse-sync.rst new file mode 100644 index 000000000..e0dfaabba --- /dev/null +++ b/source/includes/api/facts/reverse-sync.rst @@ -0,0 +1,3 @@ +To reverse sync, the user must have 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/reference/api/start.txt b/source/reference/api/start.txt index 4474cda26..22d04a3d8 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -141,11 +141,7 @@ Request Body Parameters cluster while migration is in progress, and unblocks writes right before ``canWrite`` is ``true``. - .. include:: /includes/fact-permissions-body.rst - - To reverse sync, the user must have assigned the :authrole:`restore` - role for both source and destination and the ``enableUserWriteBlocking`` - field must be set to ``"sourceAndDestination"``. + .. include:: /includes/api/facts/reverse-sync.rst To allow the source cluster to accept writes again, for example after running migration tests, run the following command: @@ -179,12 +175,8 @@ Request Body Parameters - Optional - If set to ``true``, enables the sync operation to be reversed. - - .. include:: /includes/fact-permissions-body.rst - To reverse sync, the user must have assigned the :authrole:`restore` - role for both source and destination and the ``enableUserWriteBlocking`` - field must be set to ``sourceAndDestination``. + .. include:: /includes/api/facts/reverse-sync.rst This option is not supported for the following configurations: From 00f87d42c8f8bdec44efd6eef2ea79830436e7e8 Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Wed, 23 Apr 2025 11:22:57 -0600 Subject: [PATCH 07/11] modify-reference-text-capitalization --- source/includes/fact-permissions-body.rst | 8 ++++---- source/reference/api/start.txt | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/source/includes/fact-permissions-body.rst b/source/includes/fact-permissions-body.rst index 11a08fba4..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 :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. - +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 22d04a3d8..910b12e92 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -35,8 +35,8 @@ Permissions The user specified in the ``mongosync`` connection string must have the required permissions on the source and destination clusters. Refer to -:ref:`c2c-permissions-and-roles` to ensure that the user has the correct -permissions to start the synchronization. +:ref:`user permissions ` to ensure that the +user has the correct permissions to start the synchronization. Multiple ``mongosync`` Instances ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 5d47f0bc73dce7448075f3531804444c0af9c0ec Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Wed, 23 Apr 2025 11:29:26 -0600 Subject: [PATCH 08/11] modify-reference-text-capitalization --- source/reference/api/start.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 910b12e92..cd2bc174b 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -35,8 +35,8 @@ Permissions The user specified in the ``mongosync`` connection string must have the required permissions on the source and destination clusters. Refer to -:ref:`user permissions ` to ensure that the -user has the correct permissions to start the synchronization. +:ref:`` to ensure that the user has the +correct permissions to start the synchronization. Multiple ``mongosync`` Instances ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 3700994982f6f8889e2bd7f3aa9232cdb727ce2f Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Wed, 23 Apr 2025 11:37:46 -0600 Subject: [PATCH 09/11] fix-ref-link --- source/reference/api/start.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index cd2bc174b..22d04a3d8 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -35,8 +35,8 @@ Permissions The user specified in the ``mongosync`` connection string must have the required permissions on the source and destination clusters. Refer to -:ref:`` to ensure that the user has the -correct permissions to start the synchronization. +:ref:`c2c-permissions-and-roles` to ensure that the user has the correct +permissions to start the synchronization. Multiple ``mongosync`` Instances ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 45e08f95897506595b54f92c638c6ddfa6ed298c Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Thu, 24 Apr 2025 11:19:27 -0600 Subject: [PATCH 10/11] rename-file-and-rephrase --- .../facts/{reverse-sync.rst => reverse-sync-requirements.rst} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename source/includes/api/facts/{reverse-sync.rst => reverse-sync-requirements.rst} (63%) diff --git a/source/includes/api/facts/reverse-sync.rst b/source/includes/api/facts/reverse-sync-requirements.rst similarity index 63% rename from source/includes/api/facts/reverse-sync.rst rename to source/includes/api/facts/reverse-sync-requirements.rst index e0dfaabba..d0d8e0e6f 100644 --- a/source/includes/api/facts/reverse-sync.rst +++ b/source/includes/api/facts/reverse-sync-requirements.rst @@ -1,3 +1,3 @@ -To reverse sync, the user must have assigned the :authrole:`restore` +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 From e4c302fbae7838951a12f92083b77ae2fd162a11 Mon Sep 17 00:00:00 2001 From: Mario Morales Date: Thu, 24 Apr 2025 14:55:57 -0600 Subject: [PATCH 11/11] fix-include-path --- source/reference/api/start.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 22d04a3d8..6423d7ef4 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -141,7 +141,7 @@ Request Body Parameters cluster while migration is in progress, and unblocks writes right before ``canWrite`` is ``true``. - .. include:: /includes/api/facts/reverse-sync.rst + .. 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: @@ -176,7 +176,7 @@ Request Body Parameters - If set to ``true``, enables the sync operation to be reversed. - .. include:: /includes/api/facts/reverse-sync.rst + .. include:: /includes/api/facts/reverse-sync-requirements.rst This option is not supported for the following configurations: