From 5ddd55e64922b63bdaf15a764bd124e3beb344ae Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 16 Dec 2024 16:22:24 -0500 Subject: [PATCH 01/29] (DOCSP-45558) Add section to FAQ page. --- source/faq.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/faq.txt b/source/faq.txt index 260859b7e..ee0678950 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -19,6 +19,13 @@ Support. .. _c2c-faq-read-write-during-sync: +Can I change my ``mongosync`` load level while ``mongosync`` is syncing? +----------------------------------------------------------------------- + +You can adjust the load level of an active ``mongosync`` migration . +This will not reset + + Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From 19cebe442a00fc6c3c491d1f2beafd40b7ad351e Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 16 Dec 2024 15:16:50 -0800 Subject: [PATCH 02/29] (DOCSP-45558) Edits. --- source/faq.txt | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index ee0678950..e5ce4990e 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -22,9 +22,24 @@ Support. Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- -You can adjust the load level of an active ``mongosync`` migration . -This will not reset +You can adjust the load level of an active ``mongosync`` migration by +performing the following steps: +1. Terminate all ``mongosync`` processes. Any in-progress partitions are + ended and then restarted in the next step. + +#. Restart your ``mongosync`` sync with the ``--loadLevel`` option set to your + updated load level: + + .. code-block:: javascript + + mongosync \ + --cluster0 "" \ + --loadLevel + +Any partitions that were in-progress at the time of termiantion are then restarted when the ``mongosync`` processes +are restarted. are restarted after the ``mongosync`` is restarted, but any +complete partitions are retained. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From 7f37ca0f338199f48f4e80b104a3191fccc13335 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 16 Dec 2024 16:09:51 -0800 Subject: [PATCH 03/29] (DOCSP-45558) Edits. --- source/faq.txt | 21 +------ source/reference/configuration.txt | 99 +++++++++++++++++++++++++++++- 2 files changed, 99 insertions(+), 21 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index e5ce4990e..2f66bc2c4 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -17,29 +17,14 @@ This page provides answers to some frequently asked questions we have encountered. If you have additional questions please contact MongoDB Support. -.. _c2c-faq-read-write-during-sync: Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- -You can adjust the load level of an active ``mongosync`` migration by -performing the following steps: - -1. Terminate all ``mongosync`` processes. Any in-progress partitions are - ended and then restarted in the next step. - -#. Restart your ``mongosync`` sync with the ``--loadLevel`` option set to your - updated load level: - - .. code-block:: javascript - - mongosync \ - --cluster0 "" \ - --loadLevel +Yes, you can adjust the load level during a ``mongosync`` migration by +following the steps in :ref:`c2c-update-config`. -Any partitions that were in-progress at the time of termiantion are then restarted when the ``mongosync`` processes -are restarted. are restarted after the ``mongosync`` is restarted, but any -complete partitions are retained. +.. _c2c-faq-read-write-during-sync: Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 6ef83cdb2..a58c03fb2 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -16,6 +16,10 @@ You can configure :ref:`mongosync ` instances at startup using a configuration file. The configuration file contains settings that are the equivalent of ``mongosync`` command line options. +If ``mongosync`` is currently syncing, you can update certain ``mongosync`` configuration settings +by stopping and then re-initializing your ``mongosync`` processes with an updated configuration file. +To learn more, see :ref:`c2c-update-config`. + Configuration File ================== @@ -37,10 +41,13 @@ To use a configuration file, start ``mongosync`` with the .. code-block:: console - $ mongosync --config mongosync.conf + mongosync --config + +Settings +~~~~~~~~ -Options -======= +The following settings can be specified in a configuration file at startup. +To set these settings using the equivalent command line options, see :ref:`c2c-cli-options`. .. note:: @@ -144,3 +151,89 @@ Options To set the ``verbosity`` setting from the command line, see the :option:`--verbosity` option. + +.. _c2c-update-config: + +Reconfigure During Synchronization +================================== + +.. important:: + + You can *not* change the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings after starting your migration. + +You can reconfigure the following configuration options while ``mongosync`` is syncing: + +- :option:`--config` +- :option:`--disableTelemetry` +- :option:`--loadLevel` +- :option:`--logPath` +- :option:`--port` +- :option:`--verbosity` + +To do this, perform the following steps: + +.. If ``mongosync`` is currently syncing, you can reconfigure the fo +.. :option:`--config`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`verbosity` configuration options +.. by performing the following steps: + +.. procedure:: + :style: normal + + .. step:: (Optional) Pause the ``mongosync`` processes + + Run :ref:`c2c-api-pause` on each running ``mongosync`` process. + + You can resume the ``mongosync`` processes later from the paused + state, as shown in the final step. + + .. tip:: + + If you don't want to immediately resume data synchronization + operations after live upgrade, consider pausing the + ``mongosync`` processes. This is useful if you're coordinating + operations from multiple ``mongosync`` processes. + + .. step:: Stop the ``mongosync`` processes + + Use your operating system to stop each running ``mongosync`` process. + To stop a process, see your operating system documentation for the specific steps. + + .. step:: (Optional) Update your configuration file + + If you used the :option:`--config` option to set the path to a configuration file + when you initialized ``mongosync``, update this configuration file with the new value for each setting + that you want to change. + + .. step:: Initialize the ``mongosync`` processes + + If you updated a configuration file in the last step, initialize + the ``mongosync`` processes with the :option:`--config` option + set to the path of the updated configuration file: + + .. code-block:: console + + mongosync --config + + If you did *not* use the :option:`--config` option when you first initialized ``mongosync``, + initialize the ``mongosync`` processes using the updated command line option(s): + + .. code-block:: console + + mongosync \ + --cluster0 "" \ + --cluster1 "" \ + --loadLevel + + To learn more, see :ref:`Initialize mongosync `. + + .. step:: Restart or Resume the ``mongosync`` processes. + + If you paused any ``mongosync`` processes earlier in the optional first step, + run :ref:`c2c-api-resume` on the paused ``mongosync`` processes. + + If you stopped any ``mongosync`` processes without using :ref:`c2c-api-pause`, + run :ref:`c2c-api-start` on the stopped ``mongosync`` processes. + For more detailed instructions, see :ref:`c2c-quickstart-synchronize`. + + ``mongosync`` resumes the sync roughly where it was before you stopped the earlier proceses. + Any partitions that were in progress at the time of termination will restart from the beginning. \ No newline at end of file From 406508b5d841125ad72875f007c6fa11ee15d910 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 17 Dec 2024 10:43:00 -0800 Subject: [PATCH 04/29] (DOCSP-45558) Procedure. --- source/faq.txt | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/source/faq.txt b/source/faq.txt index 2f66bc2c4..acb1c47f3 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -24,7 +24,26 @@ Can I change my ``mongosync`` load level while ``mongosync`` is syncing? Yes, you can adjust the load level during a ``mongosync`` migration by following the steps in :ref:`c2c-update-config`. -.. _c2c-faq-read-write-during-sync: + .. code-block:: javascript + + mongosync \ + --cluster0 "" \ + --loadLevel + +Any partitions that are in-progress at the time of termination are restarted +when you restart ``mongosync``. + +.. 1. Terminate all ``mongosync`` processes. + +.. #. Restart ``mongosync`` with the ``--loadLevel`` option set to the +.. new load level: + +.. .. code-block:: javascript + +.. mongosync \ +.. --cluster0 "" \ +.. --cluster1 "" +.. --loadLevel Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From d80b0b06a101f0845f6988648afb647b462000ef Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 17 Dec 2024 11:14:07 -0800 Subject: [PATCH 05/29] (DOCSP-45558) Edit formatting. --- source/faq.txt | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index acb1c47f3..0a68ac609 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -24,26 +24,25 @@ Can I change my ``mongosync`` load level while ``mongosync`` is syncing? Yes, you can adjust the load level during a ``mongosync`` migration by following the steps in :ref:`c2c-update-config`. + .. code-block:: javascript .. code-block:: javascript mongosync \ --cluster0 "" \ - --loadLevel - -Any partitions that are in-progress at the time of termination are restarted -when you restart ``mongosync``. + --cluster1 "" + --loadLevel +#. Restart the ``mongosync`` processes. -.. 1. Terminate all ``mongosync`` processes. - -.. #. Restart ``mongosync`` with the ``--loadLevel`` option set to the -.. new load level: + If you paused any ``mongosync`` processes earlier in the optional + first step, call the :ref:`c2c-api-resume` endpoint on all ``mongosync`` + processes. -.. .. code-block:: javascript + If you did not pause any ``mongosync`` processes, call the :ref:`c2c-api-start` endpoint on all ``mongosync`` + processes. For more instructions, see :ref:`c2c-quickstart-synchronize`. -.. mongosync \ -.. --cluster0 "" \ -.. --cluster1 "" -.. --loadLevel + ``mongosync`` will resume the sync roughly where it was before you stopped the earlier proceses. + Any partitions that were in progress at the time of termination are restarted + when you restart ``mongosync``. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From 1410832f7966b35624504a5b3e3c70828e404931 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 17 Dec 2024 11:32:51 -0800 Subject: [PATCH 06/29] (DOCSP-45558) Edits. --- source/faq.txt | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 0a68ac609..2d53b4a42 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -21,10 +21,17 @@ Support. Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- -Yes, you can adjust the load level during a ``mongosync`` migration by -following the steps in :ref:`c2c-update-config`. +You can adjust the load level during a ``mongosync`` migration by +performing the following steps: + +1. (Optional) Pause the ``mongosync`` processes by running the :ref:`c2c-api-pause` endpoint + on each running ``mongosync`` process. +#. Terminate the ``mongosync`` processes. + + To stop a running ``mongosync`` process, see your operating system + documentation for the specific steps. +#. Initialize ``mongosync`` with the ``--loadLevel`` option set to the new load level: - .. code-block:: javascript .. code-block:: javascript mongosync \ @@ -33,16 +40,13 @@ following the steps in :ref:`c2c-update-config`. --loadLevel #. Restart the ``mongosync`` processes. - If you paused any ``mongosync`` processes earlier in the optional - first step, call the :ref:`c2c-api-resume` endpoint on all ``mongosync`` - processes. + Call the :ref:`c2c-api-resume` endpoint on all paused ``mongosync`` processes. If you did not pause any ``mongosync`` processes, call the :ref:`c2c-api-start` endpoint on all ``mongosync`` processes. For more instructions, see :ref:`c2c-quickstart-synchronize`. - ``mongosync`` will resume the sync roughly where it was before you stopped the earlier proceses. - Any partitions that were in progress at the time of termination are restarted - when you restart ``mongosync``. + ``mongosync`` resumes the sync roughly where it was before you stopped the earlier proceses. + Any partitions that were in progress at the time of termination will restart from the beginning. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From a850515e378bb626040aaa7b66c7fa5235fdfeb3 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 17 Dec 2024 13:30:07 -0800 Subject: [PATCH 07/29] (DOCSP-45558) edits. --- source/faq.txt | 1 + source/reference/mongosync.txt | 2 ++ 2 files changed, 3 insertions(+) diff --git a/source/faq.txt b/source/faq.txt index 2d53b4a42..c3f067cde 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -17,6 +17,7 @@ This page provides answers to some frequently asked questions we have encountered. If you have additional questions please contact MongoDB Support. +.. _c2c-faq-change-load: Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index d653f3c3c..18092135b 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -141,6 +141,8 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. + To adjust the load level during a migration, see :ref:`c2c-faq-change-load`. + .. include:: /includes/opts/loadlevel-warning.rst .. versionadded:: 1.4 From 30f4c3fc648855e7b03f4d33c6116831fc1a70a4 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Wed, 18 Dec 2024 14:26:34 -0800 Subject: [PATCH 08/29] (DOCSP-45558) Edits. --- source/faq.txt | 7 ++----- source/reference/mongosync.txt | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index c3f067cde..69f09747e 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -25,12 +25,9 @@ Can I change my ``mongosync`` load level while ``mongosync`` is syncing? You can adjust the load level during a ``mongosync`` migration by performing the following steps: -1. (Optional) Pause the ``mongosync`` processes by running the :ref:`c2c-api-pause` endpoint - on each running ``mongosync`` process. -#. Terminate the ``mongosync`` processes. +1. Terminate the ``mongosync`` processes. - To stop a running ``mongosync`` process, see your operating system - documentation for the specific steps. + For directions on how to terminate a process, see your operating system documentation. #. Initialize ``mongosync`` with the ``--loadLevel`` option set to the new load level: .. code-block:: javascript diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 18092135b..91b987517 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -141,7 +141,7 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - To adjust the load level during a migration, see :ref:`c2c-faq-change-load`. + For instructions on how to adjust load level during a migration, see :ref:`c2c-faq-change-load`. .. include:: /includes/opts/loadlevel-warning.rst From 0e8b406d016e7cf8f1af61022eb38b330821278d Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 6 Jan 2025 10:59:03 -0800 Subject: [PATCH 09/29] (DOCSP-45558) Add pause step to FAQ and edit FAQ link. --- source/faq.txt | 34 ++++++++++++++++++++++++++++------ source/reference/mongosync.txt | 2 +- 2 files changed, 29 insertions(+), 7 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 69f09747e..713ecf20e 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -25,23 +25,45 @@ Can I change my ``mongosync`` load level while ``mongosync`` is syncing? You can adjust the load level during a ``mongosync`` migration by performing the following steps: -1. Terminate the ``mongosync`` processes. +1. (Optional) Pause the ``mongosync`` processes. + + To pause ``mongosync``, run :ref:`c2c-api-pause` on each running + ``mongosync`` process. + + You can resume the ``mongosync`` processes later from the paused + state, as shown in the final step. + + .. tip:: + + If you don't want to immediately resume data synchronization + operations after live upgrade, consider pausing the + ``mongosync`` processes. This is useful if you're coordinating + operations from multiple ``mongosync`` processes. + +#. Terminate the ``mongosync`` processes. For directions on how to terminate a process, see your operating system documentation. -#. Initialize ``mongosync`` with the ``--loadLevel`` option set to the new load level: +#. Initialize the ``mongosync`` processes with the :option:`--loadLevel` option set to the new load level: .. code-block:: javascript + ./bin/mongosync \ mongosync \ --cluster0 "" \ - --cluster1 "" + --cluster1 "" \ --loadLevel -#. Restart the ``mongosync`` processes. + + For more detailed instructions, see the :ref:`Quickstart ` guide. +#. Restart or Resume the ``mongosync`` processes. + + If you paused any ``mongosync`` processes earlier in the optional + first step, run :ref:`c2c-api-resume` on all ``mongosync`` processes. Call the :ref:`c2c-api-resume` endpoint on all paused ``mongosync`` processes. - If you did not pause any ``mongosync`` processes, call the :ref:`c2c-api-start` endpoint on all ``mongosync`` - processes. For more instructions, see :ref:`c2c-quickstart-synchronize`. + If you terminated any ``mongosync`` processes without using :ref:`c2c-api-pause`, + use the :ref:`c2c-api-start` endpoint to initiate data synchronization on these ``mongosync`` processes. + For more instructions, see :ref:`c2c-quickstart-synchronize`. ``mongosync`` resumes the sync roughly where it was before you stopped the earlier proceses. Any partitions that were in progress at the time of termination will restart from the beginning. diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 91b987517..4dd8bda0f 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -141,7 +141,7 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - For instructions on how to adjust load level during a migration, see :ref:`c2c-faq-change-load`. + For instructions on how to adjust load level during a migration, see the :ref:`Frequently Asked Questions (FAQ) ` page. .. include:: /includes/opts/loadlevel-warning.rst From b7b537395951e6e3984cc18c23df9909ecebe351 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 6 Jan 2025 16:29:41 -0800 Subject: [PATCH 10/29] (DOCSP-45558) Add update section to configuration page. --- source/faq.txt | 47 ++---------------------------- source/reference/configuration.txt | 4 +++ source/reference/mongosync.txt | 6 +++- 3 files changed, 11 insertions(+), 46 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 713ecf20e..db30d18f5 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -22,51 +22,8 @@ Support. Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- -You can adjust the load level during a ``mongosync`` migration by -performing the following steps: - -1. (Optional) Pause the ``mongosync`` processes. - - To pause ``mongosync``, run :ref:`c2c-api-pause` on each running - ``mongosync`` process. - - You can resume the ``mongosync`` processes later from the paused - state, as shown in the final step. - - .. tip:: - - If you don't want to immediately resume data synchronization - operations after live upgrade, consider pausing the - ``mongosync`` processes. This is useful if you're coordinating - operations from multiple ``mongosync`` processes. - -#. Terminate the ``mongosync`` processes. - - For directions on how to terminate a process, see your operating system documentation. -#. Initialize the ``mongosync`` processes with the :option:`--loadLevel` option set to the new load level: - - .. code-block:: javascript - - ./bin/mongosync \ - mongosync \ - --cluster0 "" \ - --cluster1 "" \ - --loadLevel - - For more detailed instructions, see the :ref:`Quickstart ` guide. -#. Restart or Resume the ``mongosync`` processes. - - If you paused any ``mongosync`` processes earlier in the optional - first step, run :ref:`c2c-api-resume` on all ``mongosync`` processes. - - Call the :ref:`c2c-api-resume` endpoint on all paused ``mongosync`` processes. - - If you terminated any ``mongosync`` processes without using :ref:`c2c-api-pause`, - use the :ref:`c2c-api-start` endpoint to initiate data synchronization on these ``mongosync`` processes. - For more instructions, see :ref:`c2c-quickstart-synchronize`. - - ``mongosync`` resumes the sync roughly where it was before you stopped the earlier proceses. - Any partitions that were in progress at the time of termination will restart from the beginning. +Yes, you can adjust the load level during a ``mongosync`` migration by +performing the steps in :ref:`c2c-update-config`. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index a58c03fb2..dfb212671 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -20,6 +20,10 @@ If ``mongosync`` is currently syncing, you can update certain ``mongosync`` conf by stopping and then re-initializing your ``mongosync`` processes with an updated configuration file. To learn more, see :ref:`c2c-update-config`. +If ``mongosync`` is currently syncing, you can update certain ``mongosync`` configuration settings +by stopping and then re-initializing your ``mongosync`` processes with an updated configuration file. +To learn more, see :ref:`c2c-update-config`. + Configuration File ================== diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 4dd8bda0f..9833c190f 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -107,6 +107,9 @@ Global Options Sets the path to the configuration file. + To change the configuration file while ``mongosync`` is syncing, + see the directions in :ref:`c2c-update-config`. + For more information, see :ref:`c2c-mongosync-config`. .. option:: --disableTelemetry @@ -141,7 +144,8 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - For instructions on how to adjust load level during a migration, see the :ref:`Frequently Asked Questions (FAQ) ` page. + To set the ``loadLevel`` during synchronization, see + :ref:`c2c-update-config`. .. include:: /includes/opts/loadlevel-warning.rst From a154b24b6eb4192ad36fda5a714f6b29ba4f3847 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 6 Jan 2025 16:48:13 -0800 Subject: [PATCH 11/29] (DOCSP-45558) Standardize link to update documentation. --- source/reference/mongosync.txt | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 9833c190f..54337e0f3 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -107,8 +107,7 @@ Global Options Sets the path to the configuration file. - To change the configuration file while ``mongosync`` is syncing, - see the directions in :ref:`c2c-update-config`. + To set the configuration file path while ``mongosync`` is syncing, see :ref:`c2c-update-config`. For more information, see :ref:`c2c-mongosync-config`. @@ -144,8 +143,7 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - To set the ``loadLevel`` during synchronization, see - :ref:`c2c-update-config`. + To set the load level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. .. include:: /includes/opts/loadlevel-warning.rst @@ -158,6 +156,8 @@ Global Options To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. + To set the load level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + .. note:: .. include:: /includes/fact-log-rotation-usr1-signal @@ -179,6 +179,8 @@ Global Options To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. + To set the verbosity level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + .. option:: --version, -v Prints ``mongosync`` version information to stdout. From e66c78e1be3b4734a7fae4f73d45a91228141f76 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Mon, 6 Jan 2025 16:58:07 -0800 Subject: [PATCH 12/29] (DOCSP-45558) Edit. --- source/faq.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/faq.txt b/source/faq.txt index db30d18f5..3333b6f8f 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -23,7 +23,7 @@ Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- Yes, you can adjust the load level during a ``mongosync`` migration by -performing the steps in :ref:`c2c-update-config`. +following the steps in :ref:`c2c-update-config`. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- From c93dc3d19f0437e546ce372e186ae484a7fa40f3 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 10:54:45 -0800 Subject: [PATCH 13/29] (DOCSP-45558) Edits. --- source/faq.txt | 2 -- source/reference/configuration.txt | 19 ++++--------------- 2 files changed, 4 insertions(+), 17 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 3333b6f8f..4884286ad 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -17,8 +17,6 @@ This page provides answers to some frequently asked questions we have encountered. If you have additional questions please contact MongoDB Support. -.. _c2c-faq-change-load: - Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ----------------------------------------------------------------------- diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index dfb212671..9cbee2ed0 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -163,22 +163,11 @@ Reconfigure During Synchronization .. important:: - You can *not* change the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings after starting your migration. + You can *not* change the values of the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings after starting your migration. -You can reconfigure the following configuration options while ``mongosync`` is syncing: - -- :option:`--config` -- :option:`--disableTelemetry` -- :option:`--loadLevel` -- :option:`--logPath` -- :option:`--port` -- :option:`--verbosity` - -To do this, perform the following steps: - -.. If ``mongosync`` is currently syncing, you can reconfigure the fo -.. :option:`--config`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`verbosity` configuration options -.. by performing the following steps: +While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, + :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`verbosity` configuration options +by performing the following steps: .. procedure:: :style: normal From 29bc7bb96495a278f828708f761ae11d026bf1e5 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 12:15:11 -0800 Subject: [PATCH 14/29] (DOCSP-45558) Normalize links. --- source/faq.txt | 6 +++--- source/reference/configuration.txt | 33 ++++++++++++++---------------- source/reference/mongosync.txt | 22 ++++++++++++++------ 3 files changed, 34 insertions(+), 27 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 4884286ad..32a93c3e0 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -17,11 +17,11 @@ This page provides answers to some frequently asked questions we have encountered. If you have additional questions please contact MongoDB Support. -Can I change my ``mongosync`` load level while ``mongosync`` is syncing? ------------------------------------------------------------------------ +Can I change the load level while ``mongosync`` is syncing? +------------------------------------------------------------------------ Yes, you can adjust the load level during a ``mongosync`` migration by -following the steps in :ref:`c2c-update-config`. +following the steps in :ref:`c2c-reconfigure-mid-migration`. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? --------------------------------------------------------------------------------------- diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 9cbee2ed0..c0f5f68be 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -16,13 +16,9 @@ You can configure :ref:`mongosync ` instances at startup using a configuration file. The configuration file contains settings that are the equivalent of ``mongosync`` command line options. -If ``mongosync`` is currently syncing, you can update certain ``mongosync`` configuration settings -by stopping and then re-initializing your ``mongosync`` processes with an updated configuration file. -To learn more, see :ref:`c2c-update-config`. - -If ``mongosync`` is currently syncing, you can update certain ``mongosync`` configuration settings -by stopping and then re-initializing your ``mongosync`` processes with an updated configuration file. -To learn more, see :ref:`c2c-update-config`. +While ``mongosync`` is syncing, you can adjust certain ``mongosync`` settings +by stopping and then re-initializing your ``mongosync`` processes with the updated configuration. +To learn more, see :ref:`c2c-reconfigure-mid-migration`. Configuration File ================== @@ -47,10 +43,11 @@ To use a configuration file, start ``mongosync`` with the mongosync --config -Settings -~~~~~~~~ +Options +======= + +The following settings can be set in a configuration file to configure ``mongosync`` instances at startup. -The following settings can be specified in a configuration file at startup. To set these settings using the equivalent command line options, see :ref:`c2c-cli-options`. .. note:: @@ -156,17 +153,17 @@ To set these settings using the equivalent command line options, see :ref:`c2c-c To set the ``verbosity`` setting from the command line, see the :option:`--verbosity` option. -.. _c2c-update-config: +.. _c2c-reconfigure-mid-migration: -Reconfigure During Synchronization -================================== +Reconfigure ``mongosync`` During Sync +===================================== .. important:: - You can *not* change the values of the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings after starting your migration. + You can't reconfigure the :option:`--cluster0`, :option:`--cluster1`, or :option:`--id` options after starting your migration. While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, - :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`verbosity` configuration options +:option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`--verbosity` options by performing the following steps: .. procedure:: @@ -182,14 +179,14 @@ by performing the following steps: .. tip:: If you don't want to immediately resume data synchronization - operations after live upgrade, consider pausing the + operations after reconfiguration, consider pausing the ``mongosync`` processes. This is useful if you're coordinating operations from multiple ``mongosync`` processes. .. step:: Stop the ``mongosync`` processes Use your operating system to stop each running ``mongosync`` process. - To stop a process, see your operating system documentation for the specific steps. + For the specific steps, see your operating system documentation. .. step:: (Optional) Update your configuration file @@ -219,7 +216,7 @@ by performing the following steps: To learn more, see :ref:`Initialize mongosync `. - .. step:: Restart or Resume the ``mongosync`` processes. + .. step:: Start or Resume the ``mongosync`` processes If you paused any ``mongosync`` processes earlier in the optional first step, run :ref:`c2c-api-resume` on the paused ``mongosync`` processes. diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 54337e0f3..eba837c00 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -107,7 +107,8 @@ Global Options Sets the path to the configuration file. - To set the configuration file path while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + To set the ``--config`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`c2c-mongosync-config`. @@ -120,6 +121,9 @@ Global Options To set the ``--disableTelemetry`` option from a configuration file, see the :setting:`disableTelemetry` setting. + To set the ``--disableTelemetry`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. + For more information, see :ref:`User Data Collection `. @@ -140,10 +144,11 @@ Global Options .. include:: /includes/opts/loadLevel.rst - To set the ``--loadLevel`` option from a configuration file, see the - :setting:`loadLevel` setting. + To set the ``--loadLevel`` option from a configuration file, + see the :setting:`loadLevel` setting. - To set the load level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + To set the ``--loadLevel`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. .. include:: /includes/opts/loadlevel-warning.rst @@ -156,7 +161,8 @@ Global Options To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. - To set the load level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + To set the ``--logPath`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. .. note:: @@ -169,6 +175,9 @@ Global Options To set the ``--port`` option from a configuration file, see the :setting:`port` setting. + To set the ``--port`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. + .. option:: --verbosity .. |verbosity-opt-type| replace:: option @@ -179,7 +188,8 @@ Global Options To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. - To set the verbosity level while ``mongosync`` is syncing, see :ref:`c2c-update-config`. + To set the ``--verbosity`` option while ``mongosync`` is syncing, + see :ref:`c2c-reconfigure-mid-migration`. .. option:: --version, -v From f788814d1ed53ad3f13a139d285ddbcc8274d593 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 12:24:29 -0800 Subject: [PATCH 15/29] (DOCSP-45558) Edit introduction to Optionsgst q --- source/reference/configuration.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index c0f5f68be..6c18288b7 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -46,9 +46,9 @@ To use a configuration file, start ``mongosync`` with the Options ======= -The following settings can be set in a configuration file to configure ``mongosync`` instances at startup. +The following settings can be set in a ``mongosync`` configuration file. -To set these settings using the equivalent command line options, see :ref:`c2c-cli-options`. +To configure these settings using the equivalent command line options, see :ref:`c2c-cli-options`. .. note:: From 002ede1d07c9d11a01ff23b991576730799f7d0b Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 12:24:48 -0800 Subject: [PATCH 16/29] (DOCSP-45558) Edit Settings introduction. --- source/reference/configuration.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 6c18288b7..45c0e07de 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -43,8 +43,8 @@ To use a configuration file, start ``mongosync`` with the mongosync --config -Options -======= +Settings +~~~~~~~~ The following settings can be set in a ``mongosync`` configuration file. From 037dbc3d2864a175b26f05aadf333c2f4f38a8dc Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 12:28:24 -0800 Subject: [PATCH 17/29] (DOCSP-45558) Updates. --- source/reference/configuration.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 45c0e07de..0dd234dbc 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -205,7 +205,7 @@ by performing the following steps: mongosync --config If you did *not* use the :option:`--config` option when you first initialized ``mongosync``, - initialize the ``mongosync`` processes using the updated command line option(s): + initialize the ``mongosync`` processes with the command line options set to their updated values: .. code-block:: console From 63816b62b05e3d72c0945b08d57311f473ca8adc Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 12:42:23 -0800 Subject: [PATCH 18/29] (DOCSP-45558) Make consistent intros to command line opts vs config file settings. --- source/reference/configuration.txt | 9 +++++---- source/reference/mongosync.txt | 4 ++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 0dd234dbc..0c9844bc7 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -20,6 +20,8 @@ While ``mongosync`` is syncing, you can adjust certain ``mongosync`` settings by stopping and then re-initializing your ``mongosync`` processes with the updated configuration. To learn more, see :ref:`c2c-reconfigure-mid-migration`. +.. _c2c-configuration-file: + Configuration File ================== @@ -46,9 +48,9 @@ To use a configuration file, start ``mongosync`` with the Settings ~~~~~~~~ -The following settings can be set in a ``mongosync`` configuration file. +The following settings can be set in a configuration file to configure ``mongosync`` at startup. -To configure these settings using the equivalent command line options, see :ref:`c2c-cli-options`. +To configure these settings from the command line, see :ref:`c2c-cli-options`. .. note:: @@ -191,8 +193,7 @@ by performing the following steps: .. step:: (Optional) Update your configuration file If you used the :option:`--config` option to set the path to a configuration file - when you initialized ``mongosync``, update this configuration file with the new value for each setting - that you want to change. + when you first initialized ``mongosync``, update this configuration file with the new value for each setting. .. step:: Initialize the ``mongosync`` processes diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index eba837c00..868ad400b 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -71,6 +71,10 @@ For more information on how to format your connection strings, see Command Line Options -------------------- +The following command line options can be set to configure ``mongosync`` at startup. + +To set these options from a configuration file, see :ref:`c2c-configuration-file`. + .. |opt-term| replace:: option Global Options From 59878c1e1df8bde431b7e452f3daee46009697db Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 13:25:57 -0800 Subject: [PATCH 19/29] (DOCSP-45558) Edit wording. --- source/reference/configuration.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 0c9844bc7..65196480f 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -16,9 +16,8 @@ You can configure :ref:`mongosync ` instances at startup using a configuration file. The configuration file contains settings that are the equivalent of ``mongosync`` command line options. -While ``mongosync`` is syncing, you can adjust certain ``mongosync`` settings -by stopping and then re-initializing your ``mongosync`` processes with the updated configuration. -To learn more, see :ref:`c2c-reconfigure-mid-migration`. +After starting a migration, you can reconfigure certain ``mongosync`` options by following the +steps in :ref:`c2c-reconfigure-mid-migration`. .. _c2c-configuration-file: From c2ca328924a5be88107e51374fde6937bf60407b Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 13:35:25 -0800 Subject: [PATCH 20/29] (DOCSP-45558) Shorten sentence. --- source/reference/configuration.txt | 4 ++-- source/reference/mongosync.txt | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 65196480f..ee926c1f1 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -47,9 +47,9 @@ To use a configuration file, start ``mongosync`` with the Settings ~~~~~~~~ -The following settings can be set in a configuration file to configure ``mongosync`` at startup. +The following settings can be set from a configuration file to configure ``mongosync`` at startup. -To configure these settings from the command line, see :ref:`c2c-cli-options`. +To set these settings from the command line, see :ref:`c2c-cli-options`. .. note:: diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 868ad400b..c4cec2223 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -71,7 +71,7 @@ For more information on how to format your connection strings, see Command Line Options -------------------- -The following command line options can be set to configure ``mongosync`` at startup. +The following options can be set from the command line to configure ``mongosync`` at startup. To set these options from a configuration file, see :ref:`c2c-configuration-file`. @@ -111,7 +111,7 @@ Global Options Sets the path to the configuration file. - To set the ``--config`` option while ``mongosync`` is syncing, + To set the ``--config`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`c2c-mongosync-config`. @@ -125,7 +125,7 @@ Global Options To set the ``--disableTelemetry`` option from a configuration file, see the :setting:`disableTelemetry` setting. - To set the ``--disableTelemetry`` option while ``mongosync`` is syncing, + To set the ``--disableTelemetry`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`User Data Collection @@ -151,7 +151,7 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - To set the ``--loadLevel`` option while ``mongosync`` is syncing, + To set the ``--loadLevel`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. .. include:: /includes/opts/loadlevel-warning.rst @@ -165,7 +165,7 @@ Global Options To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. - To set the ``--logPath`` option while ``mongosync`` is syncing, + To set the ``--logPath`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. .. note:: @@ -179,7 +179,7 @@ Global Options To set the ``--port`` option from a configuration file, see the :setting:`port` setting. - To set the ``--port`` option while ``mongosync`` is syncing, + To set the ``--port`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. .. option:: --verbosity @@ -192,7 +192,7 @@ Global Options To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. - To set the ``--verbosity`` option while ``mongosync`` is syncing, + To set the ``--verbosity`` option during synchronization, see :ref:`c2c-reconfigure-mid-migration`. .. option:: --version, -v From fa4626b0517457464b583f89dfe68e5ce60161b0 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 13:45:00 -0800 Subject: [PATCH 21/29] (DOCSP-45558) updates. --- source/faq.txt | 4 ++-- source/reference/configuration.txt | 8 ++++---- source/reference/mongosync.txt | 12 ++++++------ 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 32a93c3e0..78f1ebd6c 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -18,9 +18,9 @@ encountered. If you have additional questions please contact MongoDB Support. Can I change the load level while ``mongosync`` is syncing? ------------------------------------------------------------------------- +----------------------------------------------------------- -Yes, you can adjust the load level during a ``mongosync`` migration by +Yes, you can adjust the load level during synchronization by following the steps in :ref:`c2c-reconfigure-mid-migration`. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index ee926c1f1..1a31ec452 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -16,7 +16,7 @@ You can configure :ref:`mongosync ` instances at startup using a configuration file. The configuration file contains settings that are the equivalent of ``mongosync`` command line options. -After starting a migration, you can reconfigure certain ``mongosync`` options by following the +During a migration, you can reconfigure certain ``mongosync`` options by following the steps in :ref:`c2c-reconfigure-mid-migration`. .. _c2c-configuration-file: @@ -156,14 +156,14 @@ To set these settings from the command line, see :ref:`c2c-cli-options`. .. _c2c-reconfigure-mid-migration: -Reconfigure ``mongosync`` During Sync -===================================== +Reconfigure During Migration +============================ .. important:: You can't reconfigure the :option:`--cluster0`, :option:`--cluster1`, or :option:`--id` options after starting your migration. -While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, +During a migration, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`--verbosity` options by performing the following steps: diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index c4cec2223..23e8ed620 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -111,7 +111,7 @@ Global Options Sets the path to the configuration file. - To set the ``--config`` option during synchronization, + To set the ``--config`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`c2c-mongosync-config`. @@ -125,7 +125,7 @@ Global Options To set the ``--disableTelemetry`` option from a configuration file, see the :setting:`disableTelemetry` setting. - To set the ``--disableTelemetry`` option during synchronization, + To set the ``--disableTelemetry`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`User Data Collection @@ -151,7 +151,7 @@ Global Options To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - To set the ``--loadLevel`` option during synchronization, + To set the ``--loadLevel`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. .. include:: /includes/opts/loadlevel-warning.rst @@ -165,7 +165,7 @@ Global Options To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. - To set the ``--logPath`` option during synchronization, + To set the ``--logPath`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. .. note:: @@ -179,7 +179,7 @@ Global Options To set the ``--port`` option from a configuration file, see the :setting:`port` setting. - To set the ``--port`` option during synchronization, + To set the ``--port`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. .. option:: --verbosity @@ -192,7 +192,7 @@ Global Options To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. - To set the ``--verbosity`` option during synchronization, + To set the ``--verbosity`` option during a migration, see :ref:`c2c-reconfigure-mid-migration`. .. option:: --version, -v From 32b580a5c4666f6451e1be52f7eb56bf4736a7cc Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 14:09:06 -0800 Subject: [PATCH 22/29] (DOCSP-45558) Edits. --- source/faq.txt | 2 +- source/reference/configuration.txt | 6 +++--- source/reference/mongosync.txt | 32 +++++++++++++++--------------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/source/faq.txt b/source/faq.txt index 78f1ebd6c..d20c0c26b 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -20,7 +20,7 @@ Support. Can I change the load level while ``mongosync`` is syncing? ----------------------------------------------------------- -Yes, you can adjust the load level during synchronization by +Yes, you can adjust the cluster workload level during a migration by following the steps in :ref:`c2c-reconfigure-mid-migration`. Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing? diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 1a31ec452..1ee0c9ef7 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -156,14 +156,14 @@ To set these settings from the command line, see :ref:`c2c-cli-options`. .. _c2c-reconfigure-mid-migration: -Reconfigure During Migration -============================ +Reconfigure ``mongosync`` During Synchronization +================================================ .. important:: You can't reconfigure the :option:`--cluster0`, :option:`--cluster1`, or :option:`--id` options after starting your migration. -During a migration, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, +While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`--verbosity` options by performing the following steps: diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 23e8ed620..01a97bd1a 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -122,11 +122,11 @@ Global Options .. include:: /includes/opts/disableTelemetry - To set the ``--disableTelemetry`` option from a configuration file, - see the :setting:`disableTelemetry` setting. + To disable telemetry data collection during a migration, + see :ref:`c2c-reconfigure-mid-migration`. - To set the ``--disableTelemetry`` option during a migration, - see :ref:`c2c-reconfigure-mid-migration`. + To set the ``--disableTelemetry`` option from a configuration file, + see the :setting:`disableTelemetry` setting. For more information, see :ref:`User Data Collection `. @@ -147,13 +147,13 @@ Global Options *Type*: integer .. include:: /includes/opts/loadLevel.rst + + To change the load level during a migration, + see :ref:`c2c-reconfigure-mid-migration`. To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. - To set the ``--loadLevel`` option during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - .. include:: /includes/opts/loadlevel-warning.rst .. versionadded:: 1.4 @@ -162,12 +162,12 @@ Global Options .. include:: /includes/opts/logPath.rst + To change the path to the log directory during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. - To set the ``--logPath`` option during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - .. note:: .. include:: /includes/fact-log-rotation-usr1-signal @@ -176,12 +176,12 @@ Global Options .. include:: /includes/opts/port.rst + To change the port during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + To set the ``--port`` option from a configuration file, see the :setting:`port` setting. - To set the ``--port`` option during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - .. option:: --verbosity .. |verbosity-opt-type| replace:: option @@ -189,11 +189,11 @@ Global Options .. include:: /includes/opts/verbosity.rst + To change the verbosity level during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. - - To set the ``--verbosity`` option during a migration, - see :ref:`c2c-reconfigure-mid-migration`. .. option:: --version, -v From 83a6717b0405d476430328da8877ebc11cc55368 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 14:15:35 -0800 Subject: [PATCH 23/29] (DOCSP-45558) Edit. --- source/reference/mongosync.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index 01a97bd1a..f7972c8ae 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -111,7 +111,7 @@ Global Options Sets the path to the configuration file. - To set the ``--config`` option during a migration, + To set the configuration file path during a migration, see :ref:`c2c-reconfigure-mid-migration`. For more information, see :ref:`c2c-mongosync-config`. From 9df28f29b1560d8fd3d2b07d6b7d03b07f45a05b Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 14:19:08 -0800 Subject: [PATCH 24/29] (DOCSP-45558) Edit important admonition. --- source/reference/configuration.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 1ee0c9ef7..526d0ed2b 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -161,7 +161,7 @@ Reconfigure ``mongosync`` During Synchronization .. important:: - You can't reconfigure the :option:`--cluster0`, :option:`--cluster1`, or :option:`--id` options after starting your migration. + You can't adjust the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings during a migration. While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`--verbosity` options From 8cf96eded05f1bf750fb0d347a4f266202494585 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 16:15:05 -0800 Subject: [PATCH 25/29] (DOCSP-45558) @jwilson-mdb Review changes. --- source/reference/configuration.txt | 8 +++---- source/reference/mongosync.txt | 34 +++++++++++++++--------------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 526d0ed2b..14a745aed 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -16,7 +16,7 @@ You can configure :ref:`mongosync ` instances at startup using a configuration file. The configuration file contains settings that are the equivalent of ``mongosync`` command line options. -During a migration, you can reconfigure certain ``mongosync`` options by following the +During a migration, you can reconfigure certain ``mongosync`` settings by following the steps in :ref:`c2c-reconfigure-mid-migration`. .. _c2c-configuration-file: @@ -47,9 +47,9 @@ To use a configuration file, start ``mongosync`` with the Settings ~~~~~~~~ -The following settings can be set from a configuration file to configure ``mongosync`` at startup. +You can configure the following ``mongosync`` settings using a configuration file. -To set these settings from the command line, see :ref:`c2c-cli-options`. +To configure ``mongosync`` from the command line, see :ref:`c2c-cli-options`. .. note:: @@ -214,7 +214,7 @@ by performing the following steps: --cluster1 "" \ --loadLevel - To learn more, see :ref:`Initialize mongosync `. + For more information, see :ref:`Initialize mongosync `. .. step:: Start or Resume the ``mongosync`` processes diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt index f7972c8ae..9e72c49b8 100644 --- a/source/reference/mongosync.txt +++ b/source/reference/mongosync.txt @@ -71,9 +71,9 @@ For more information on how to format your connection strings, see Command Line Options -------------------- -The following options can be set from the command line to configure ``mongosync`` at startup. +You can configure the following ``mongosync`` options using the command line. -To set these options from a configuration file, see :ref:`c2c-configuration-file`. +To configure ``mongosync`` from a configuration file, see :ref:`c2c-configuration-file`. .. |opt-term| replace:: option @@ -122,12 +122,12 @@ Global Options .. include:: /includes/opts/disableTelemetry - To disable telemetry data collection during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - To set the ``--disableTelemetry`` option from a configuration file, see the :setting:`disableTelemetry` setting. + To disable telemetry data collection during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + For more information, see :ref:`User Data Collection `. @@ -147,13 +147,13 @@ Global Options *Type*: integer .. include:: /includes/opts/loadLevel.rst - - To change the load level during a migration, - see :ref:`c2c-reconfigure-mid-migration`. To set the ``--loadLevel`` option from a configuration file, see the :setting:`loadLevel` setting. + To change the load level during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + .. include:: /includes/opts/loadlevel-warning.rst .. versionadded:: 1.4 @@ -162,12 +162,12 @@ Global Options .. include:: /includes/opts/logPath.rst - To change the path to the log directory during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - To set the ``--logPath`` option from a configuration file, see the :setting:`logPath` setting. + To change the path to the log directory during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + .. note:: .. include:: /includes/fact-log-rotation-usr1-signal @@ -176,12 +176,12 @@ Global Options .. include:: /includes/opts/port.rst - To change the port during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - To set the ``--port`` option from a configuration file, see the :setting:`port` setting. + To change the port during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + .. option:: --verbosity .. |verbosity-opt-type| replace:: option @@ -189,12 +189,12 @@ Global Options .. include:: /includes/opts/verbosity.rst - To change the verbosity level during a migration, - see :ref:`c2c-reconfigure-mid-migration`. - To set the ``--verbosity`` option from a configuration file, see the :setting:`verbosity` setting. + To change the verbosity level during a migration, + see :ref:`c2c-reconfigure-mid-migration`. + .. option:: --version, -v Prints ``mongosync`` version information to stdout. From a2d39936e95c3e2829b41900060d16bf5f99df3d Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Tue, 7 Jan 2025 16:29:09 -0800 Subject: [PATCH 26/29] (DOCSP-45558) Add command line options to configuration intro. --- source/reference/configuration.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 14a745aed..db749d955 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -13,7 +13,8 @@ Configuration :class: singlecol You can configure :ref:`mongosync ` instances at startup -using a configuration file. The configuration file contains settings that are +by using :reF:`command line options ` or a configuration file. +The configuration file specifies values for settings that are the equivalent of ``mongosync`` command line options. During a migration, you can reconfigure certain ``mongosync`` settings by following the From 5d64f55966b44c247a9158108c58f01b2dc7ee1c Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Wed, 8 Jan 2025 12:52:08 -0800 Subject: [PATCH 27/29] (DOCSP-45558) Fix subtitle underline. --- source/reference/configuration.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index db749d955..1202e10d7 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -46,7 +46,7 @@ To use a configuration file, start ``mongosync`` with the mongosync --config Settings -~~~~~~~~ +-------- You can configure the following ``mongosync`` settings using a configuration file. From 9382d4af026121436521e7b82a3f15e0eac201d4 Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Wed, 8 Jan 2025 12:53:57 -0800 Subject: [PATCH 28/29] (DOCSP-45558) Fix subtitle underline. --- source/reference/configuration.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 1202e10d7..1fc01c756 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -23,7 +23,7 @@ steps in :ref:`c2c-reconfigure-mid-migration`. .. _c2c-configuration-file: Configuration File -================== +------------------ You can write most ``mongosync`` :ref:`command line options ` to a YAML file. The @@ -46,7 +46,7 @@ To use a configuration file, start ``mongosync`` with the mongosync --config Settings --------- +~~~~~~~~ You can configure the following ``mongosync`` settings using a configuration file. @@ -158,7 +158,7 @@ To configure ``mongosync`` from the command line, see :ref:`c2c-cli-options`. .. _c2c-reconfigure-mid-migration: Reconfigure ``mongosync`` During Synchronization -================================================ +------------------------------------------------ .. important:: From 7f8ea57e35c7571aedb19bdef38acf65ff90f0cf Mon Sep 17 00:00:00 2001 From: Elyse Foreman Date: Fri, 10 Jan 2025 10:59:08 -0800 Subject: [PATCH 29/29] (DOCSP-45558) @FGasper Review changes. --- source/reference/configuration.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/reference/configuration.txt b/source/reference/configuration.txt index 1fc01c756..043face49 100644 --- a/source/reference/configuration.txt +++ b/source/reference/configuration.txt @@ -162,7 +162,8 @@ Reconfigure ``mongosync`` During Synchronization .. important:: - You can't adjust the :setting:`cluster0`, :setting:`cluster1`, or :setting:`id` settings during a migration. + Only the following settings can be adjusted during a migration. + Other settings **must** remain unchanged between ``mongosync`` restarts. While ``mongosync`` is syncing, you can reconfigure the :option:`--config`, :option:`--disableTelemetry`, :option:`--loadLevel`, :option:`--logPath`, :option:`--port`, and :option:`--verbosity` options