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

Commit 474fff0

Browse files
authored
DOCSP-47695-remove-live-upgrade (#628)
* DOCSP-47695-remove-live-upgrade * DOCSP-47695-remove-live-upgrade * DOCSP-47695-remove-live-upgrade * DOCSP-47695 adding noindex page * DOCSP-47695 adding noindex page * DOCSP-47695 Maria comment * DOCSP-47695 copy edits
1 parent 075df4d commit 474fff0

File tree

6 files changed

+89
-81
lines changed

6 files changed

+89
-81
lines changed

source/includes/fact-verifier-limitations.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ The embedded verifier has the following limitations:
2424

2525
- .. include:: /includes/fact-verifier-buildIndexes
2626

27-
- .. include:: /includes/fact-verification-support-1.9.0.rst
28-
2927
Unsupported Verification Checks
3028
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3129

source/reference/api/progress.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,6 @@ Behavior
7777
collection copy phase (``estimatedCopiedBytes`` =
7878
``estimatedTotalBytes``).
7979

80-
- When performing a live upgrade from an earlier version to 1.8.0 or
81-
higher, the collection copy data starts over from
82-
``[0 bytes copied / 1 bytes total]``. After a live upgrade,
83-
``/progress`` only reports the progress of data copied after the
84-
upgrade completed.
85-
86-
.. include:: /includes/fact-restart-resume-delay.rst
87-
8880
Endpoint Protection
8981
~~~~~~~~~~~~~~~~~~~
9082

source/reference/live-upgrade.txt

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
:orphan:
2+
3+
.. meta::
4+
:robots: noindex, nosnippet
5+
6+
.. _c2c-live-upgrade:
7+
8+
=============
9+
Live Upgrades
10+
=============
11+
12+
.. default-domain:: mongodb
13+
14+
.. contents:: On this page
15+
:local:
16+
:backlinks: none
17+
:depth: 2
18+
:class: singlecol
19+
20+
.. important::
21+
22+
Starting in version 1.11, ``mongosync`` does not support live upgrades due
23+
to the expanded permissions required for mongosync 1.11. To upgrade to the
24+
most recent version, see :ref:`c2c-release-version-numbers`.
25+
26+
27+
Starting in ``mongosync`` 1.7.0, you can live upgrade ``mongosync`` without
28+
restarting data synchronization operations from the beginning.
29+
30+
After the live upgrade, ``mongosync`` continues operations that were in
31+
progress before the upgrade.
32+
33+
To live upgrade ``mongosync``, perform these steps:
34+
35+
Steps
36+
-----
37+
38+
.. procedure::
39+
:style: normal
40+
41+
.. step:: (Optional) Pause the ``mongosync`` processes
42+
43+
To pause ``mongosync``, run :ref:`c2c-api-pause` on each running
44+
``mongosync`` process.
45+
46+
You can resume the ``mongosync`` processes later from the paused
47+
state, as shown in the final step.
48+
49+
.. tip::
50+
51+
If you don't want to immediately resume data synchronization
52+
operations after live upgrade, consider pausing the
53+
``mongosync`` processes. This is useful if you're coordinating
54+
operations from multiple ``mongosync`` processes.
55+
56+
.. step:: Stop the ``mongosync`` processes
57+
58+
Use your operating system to stop each running ``mongosync``
59+
process. To stop a process, see your operating system
60+
documentation for the specific steps.
61+
62+
.. step:: Download and install the new ``mongosync`` binaries
63+
64+
To download and install the new ``mongosync`` binaries, see
65+
:ref:`download and install mongosync <c2c-install>`.
66+
67+
.. step:: Initialize the ``mongosync`` processes
68+
69+
To initialize the ``mongosync`` processes, see
70+
:ref:`Quickstart <c2c-quickstart>`. During initialization after a
71+
live upgrade, ``mongosync`` updates the persistent metadata.
72+
73+
.. step:: Resume the ``mongosync`` processes
74+
75+
If you paused any ``mongosync`` processes earlier in the optional
76+
first step, run :ref:`c2c-api-resume` on all ``mongosync``
77+
processes.
78+
79+
If a data synchronization operation was already in progress before the
80+
live upgrade, new features added in the latest ``mongosync`` version may
81+
not all be supported after the live upgrade. Performance improvements
82+
and bug fixes are always supported after the live upgrade. For more
83+
information on the new features that might be supported after a live
84+
upgrade, see the :ref:`1.7.0-c2c-release-notes`.

source/reference/versioning.txt

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -58,74 +58,10 @@ released, version 2.0 would no longer receive patch releases. At the
5858
same time, version 1.3 would continue to receive patches until version
5959
1.4 was released.
6060

61-
.. _c2c-versioning-live-upgrade:
61+
Upgrade or Downgrade
62+
~~~~~~~~~~~~~~~~~~~~
6263

63-
Live Upgrade
64-
~~~~~~~~~~~~
65-
66-
.. versionadded:: 1.7.0
67-
68-
.. include:: /includes/live-upgrade.rst
69-
70-
After the live upgrade, ``mongosync`` continues operations that were in
71-
progress before the upgrade.
72-
73-
To live upgrade ``mongosync``, perform these steps:
74-
75-
.. procedure::
76-
:style: normal
77-
78-
.. step:: (Optional) Pause the ``mongosync`` processes
79-
80-
To pause ``mongosync``, run :ref:`c2c-api-pause` on each running
81-
``mongosync`` process.
82-
83-
You can resume the ``mongosync`` processes later from the paused
84-
state, as shown in the final step.
85-
86-
.. tip::
87-
88-
If you don't want to immediately resume data synchronization
89-
operations after live upgrade, consider pausing the
90-
``mongosync`` processes. This is useful if you're coordinating
91-
operations from multiple ``mongosync`` processes.
92-
93-
.. step:: Stop the ``mongosync`` processes
94-
95-
Use your operating system to stop each running ``mongosync``
96-
process. To stop a process, see your operating system
97-
documentation for the specific steps.
98-
99-
.. step:: Download and install the new ``mongosync`` binaries
100-
101-
To download and install the new ``mongosync`` binaries, see
102-
:ref:`download and install mongosync <c2c-install>`.
103-
104-
.. step:: Initialize the ``mongosync`` processes
105-
106-
To initialize the ``mongosync`` processes, see
107-
:ref:`Quickstart <c2c-quickstart>`. During initialization after a
108-
live upgrade, ``mongosync`` updates the persistent metadata.
109-
110-
.. step:: Resume the ``mongosync`` processes
111-
112-
If you paused any ``mongosync`` processes earlier in the optional
113-
first step, run :ref:`c2c-api-resume` on all ``mongosync``
114-
processes.
115-
116-
If a data synchronization operation was already in progress before the
117-
live upgrade, new features added in the latest ``mongosync`` version may
118-
not all be supported after the live upgrade. Performance improvements
119-
and bug fixes are always supported after the live upgrade. For more
120-
information on the new features that might be supported after a live
121-
upgrade, see the :ref:`1.7.0-c2c-release-notes`.
122-
123-
Non-Live Upgrade or Downgrade
124-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125-
126-
If you're using an earlier ``mongosync`` version not supported by the
127-
live upgrade procedure, or you need to downgrade ``mongosync``, perform
128-
these steps:
64+
Use the following steps to upgrade or downgrade ``mongosync``:
12965

13066
- Stop all currently running ``mongosync`` processes.
13167
- Drop all non-system databases in the destination cluster.

source/release-notes/1.11.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Destination-Only Write-Blocking
3030
Live Upgrades
3131
~~~~~~~~~~~~~
3232

33-
:ref:`Live upgrades <c2c-versioning-live-upgrade>`
34-
to version 1.11 are not supported.
33+
Starting in version 1.11.0, ``mongosync`` does not support
34+
:ref:`c2c-live-upgrade`.
3535

3636
Permissions
3737
~~~~~~~~~~~

source/release-notes/1.7.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,6 @@ Live Upgrade
191191

192192
.. include:: /includes/live-upgrade.rst
193193

194-
For details, see :ref:`c2c-versioning-live-upgrade`.
195-
196194
Synchronize Data Between Clusters with Different MongoDB Server Major Versions
197195
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198196

0 commit comments

Comments
 (0)