From 40fb13d018208f611fd5045904535d4c8b82d951 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 14 Feb 2024 15:41:52 -0500 Subject: [PATCH 1/4] DOCSP-32690 multiple mongosync endpoint note --- source/includes/api/facts/multiple-mongosync-endpoints.rst | 3 +++ source/multiple-mongosyncs.txt | 3 ++- source/reference/api/commit.txt | 4 ++++ source/reference/api/pause.txt | 4 ++++ source/reference/api/resume.txt | 4 ++++ source/reference/api/reverse.txt | 4 ++++ source/reference/api/start.txt | 4 ++++ 7 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 source/includes/api/facts/multiple-mongosync-endpoints.rst diff --git a/source/includes/api/facts/multiple-mongosync-endpoints.rst b/source/includes/api/facts/multiple-mongosync-endpoints.rst new file mode 100644 index 000000000..831bdf1bc --- /dev/null +++ b/source/includes/api/facts/multiple-mongosync-endpoints.rst @@ -0,0 +1,3 @@ +When you configure multiple ``mongosync`` +instances, you must send identical API endpoint commands to each +``mongosync`` instance. \ No newline at end of file diff --git a/source/multiple-mongosyncs.txt b/source/multiple-mongosyncs.txt index f24743a10..dab2b84dd 100644 --- a/source/multiple-mongosyncs.txt +++ b/source/multiple-mongosyncs.txt @@ -44,6 +44,8 @@ the source cluster. You must use the same version of ``mongosync`` between all instances. For a replica set source, you can only use one ``mongosync`` instance. +.. include:: /includes/api/facts/multiple-mongosync-endpoints + To configure multiple ``mongosync`` instances: #. :ref:`Verify cluster configuration ` @@ -147,7 +149,6 @@ To configure multiple ``mongosync`` instances: Consider designating a range of ports to simplify scripting {+c2c-product-name+} operations. - .. _c2c-sharded-start: Start Multiple ``mongosync`` Instances diff --git a/source/reference/api/commit.txt b/source/reference/api/commit.txt index 3f60b4bf7..cb690a44a 100644 --- a/source/reference/api/commit.txt +++ b/source/reference/api/commit.txt @@ -75,6 +75,10 @@ Before using the ``commit`` endpoint: When ``lagTimeSeconds`` is ``0``, the source and destination clusters are in a consistent state. +.. note:: + + .. include:: /includes/api/facts/multiple-mongosync-endpoints + Request ------- diff --git a/source/reference/api/pause.txt b/source/reference/api/pause.txt index f7ec62ffc..f36933ac4 100644 --- a/source/reference/api/pause.txt +++ b/source/reference/api/pause.txt @@ -24,6 +24,10 @@ Requirement To use the ``pause`` endpoint, ``mongosync`` must be in the ``RUNNING`` state. +.. note:: + + .. include:: /includes/api/facts/multiple-mongosync-endpoints + Request ------- diff --git a/source/reference/api/resume.txt b/source/reference/api/resume.txt index b05276729..9e9c7194e 100644 --- a/source/reference/api/resume.txt +++ b/source/reference/api/resume.txt @@ -25,6 +25,10 @@ Requirement To use the ``resume`` endpoint, ``mongosync`` must be in the ``PAUSED`` state. +.. note:: + + .. include:: /includes/api/facts/multiple-mongosync-endpoints + Request ------- diff --git a/source/reference/api/reverse.txt b/source/reference/api/reverse.txt index f2c7ea00a..10d9f09bd 100644 --- a/source/reference/api/reverse.txt +++ b/source/reference/api/reverse.txt @@ -52,6 +52,10 @@ To use the ``reverse`` endpoint: - .. include:: /includes/fact-reverse-limitation.rst - .. include:: /includes/fact-permissions-body.rst +.. note:: + + .. include:: /includes/api/facts/multiple-mongosync-endpoints + .. _c2c-validate-unique-index: Validate Unique Indexes diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 1aa043322..301c759f5 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -60,6 +60,10 @@ Ensure that you use this configured ``mongosync`` user in the connection strings for the :setting:`cluster0` or :setting:`cluster1` settings when you start ``mongosync``. +.. note:: + + .. include:: /includes/api/facts/multiple-mongosync-endpoints + Request ------- From 0a4091da18f59f863e09d309e61be2c9c7212d50 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 14 Feb 2024 16:07:28 -0500 Subject: [PATCH 2/4] DOCSP-32690 splitting up notes --- source/reference/api/commit.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/reference/api/commit.txt b/source/reference/api/commit.txt index cb690a44a..296635155 100644 --- a/source/reference/api/commit.txt +++ b/source/reference/api/commit.txt @@ -60,8 +60,6 @@ Before using the ``commit`` endpoint: - Use the :ref:`progress ` endpoint to confirm the following values: - - ``state: "RUNNING"`` - - ``canCommit: true`` - ``lagTimeSeconds`` is near ``0`` (*Recommended, but not required*) .. note:: lagTimeSeconds @@ -75,6 +73,9 @@ Before using the ``commit`` endpoint: When ``lagTimeSeconds`` is ``0``, the source and destination clusters are in a consistent state. + - ``state: "RUNNING"`` + - ``canCommit: true`` + .. note:: .. include:: /includes/api/facts/multiple-mongosync-endpoints From d2db70d2b8474bde388ff945243f0462aff11468 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Tue, 20 Feb 2024 12:39:22 -0500 Subject: [PATCH 3/4] DOCSP-32690 adding links to multiple mongosyncs sections --- source/reference/api/commit.txt | 2 ++ source/reference/api/pause.txt | 3 +++ source/reference/api/resume.txt | 3 +++ source/reference/api/reverse.txt | 3 +++ source/reference/api/start.txt | 3 +++ 5 files changed, 14 insertions(+) diff --git a/source/reference/api/commit.txt b/source/reference/api/commit.txt index 296635155..871418bf7 100644 --- a/source/reference/api/commit.txt +++ b/source/reference/api/commit.txt @@ -80,6 +80,8 @@ Before using the ``commit`` endpoint: .. include:: /includes/api/facts/multiple-mongosync-endpoints + For more information, see :ref:`c2c-sharded-commit`. + Request ------- diff --git a/source/reference/api/pause.txt b/source/reference/api/pause.txt index f36933ac4..9b4f6f295 100644 --- a/source/reference/api/pause.txt +++ b/source/reference/api/pause.txt @@ -28,6 +28,9 @@ state. .. include:: /includes/api/facts/multiple-mongosync-endpoints + For more information, see :ref:`Pause Multiple Mongosyncs + `. + Request ------- diff --git a/source/reference/api/resume.txt b/source/reference/api/resume.txt index 9e9c7194e..45f9e87cb 100644 --- a/source/reference/api/resume.txt +++ b/source/reference/api/resume.txt @@ -29,6 +29,9 @@ state. .. include:: /includes/api/facts/multiple-mongosync-endpoints + For more information, see :ref:`Resume Multiple Mongosyncs + `. + Request ------- diff --git a/source/reference/api/reverse.txt b/source/reference/api/reverse.txt index 10d9f09bd..07f8d7e9a 100644 --- a/source/reference/api/reverse.txt +++ b/source/reference/api/reverse.txt @@ -56,6 +56,9 @@ To use the ``reverse`` endpoint: .. include:: /includes/api/facts/multiple-mongosync-endpoints + For more information, see :ref:`Reverse Multiple Mongosyncs + `. + .. _c2c-validate-unique-index: Validate Unique Indexes diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 301c759f5..d03fe6855 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -64,6 +64,9 @@ you start ``mongosync``. .. include:: /includes/api/facts/multiple-mongosync-endpoints + For more information, see :ref:`Start Multiple Mongosyncs + `. + Request ------- From c396a98074dd28f94cd97af452bb34ff32f27f97 Mon Sep 17 00:00:00 2001 From: Lauren Tran Date: Wed, 21 Feb 2024 13:38:20 -0500 Subject: [PATCH 4/4] DOCSP-32690 tech edits --- source/includes/api/facts/multiple-mongosync-endpoints.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/api/facts/multiple-mongosync-endpoints.rst b/source/includes/api/facts/multiple-mongosync-endpoints.rst index 831bdf1bc..cc351e32b 100644 --- a/source/includes/api/facts/multiple-mongosync-endpoints.rst +++ b/source/includes/api/facts/multiple-mongosync-endpoints.rst @@ -1,3 +1,3 @@ -When you configure multiple ``mongosync`` -instances, you must send identical API endpoint commands to each +When you configure multiple ``mongosync`` instances to sync between +sharded clusters, you must send identical API endpoint commands to each ``mongosync`` instance. \ No newline at end of file