@@ -83,10 +83,74 @@ released, version 2.0 would no longer receive patch releases. At the
8383same time, version 1.3 would continue to receive patches until version
84841.4 was released.
8585
86- Upgrade and Downgrade
87- ~~~~~~~~~~~~~~~~~~~~~
86+ .. _c2c-versioning-live-upgrade:
8887
89- To upgrade, or downgrade ``mongosync``:
88+ Live Upgrade
89+ ~~~~~~~~~~~~
90+
91+ .. versionadded:: 1.7.0
92+
93+ .. include:: /includes/live-upgrade.rst
94+
95+ After the live upgrade, ``mongosync`` continues operations that were in
96+ progress before the upgrade.
97+
98+ To live upgrade ``mongosync``, perform these steps:
99+
100+ .. procedure::
101+ :style: normal
102+
103+ .. step:: (Optional) Pause the ``mongosync`` processes
104+
105+ To pause ``mongosync``, run :ref:`c2c-api-pause` on each running
106+ ``mongosync`` process.
107+
108+ You can resume the ``mongosync`` processes later from the paused
109+ state, as shown in the final step.
110+
111+ .. tip::
112+
113+ If you don't want to immediately resume data synchronization
114+ operations after live upgrade, consider pausing the
115+ ``mongosync`` processes. This is useful if you're coordinating
116+ operations from multiple ``mongosync`` processes.
117+
118+ .. step:: Stop the ``mongosync`` processes
119+
120+ Use your operating system to stop each running ``mongosync``
121+ process. To stop a process, see your operating system
122+ documentation for the specific steps.
123+
124+ .. step:: Download and install the new ``mongosync`` binaries
125+
126+ To download and install the new ``mongosync`` binaries, see
127+ :ref:`download and install mongosync <c2c-install>`.
128+
129+ .. step:: Initialize the ``mongosync`` processes
130+
131+ To initialize the ``mongosync`` processes, see the :ref:`mongosync
132+ examples <c2c-mongosync-examples>`. During initialization after a
133+ live upgrade, ``mongosync`` updates the persistent metadata.
134+
135+ .. step:: Resume the ``mongosync`` processes
136+
137+ If you paused any ``mongosync`` processes earlier in the optional
138+ first step, run :ref:`c2c-api-resume` on all ``mongosync``
139+ processes.
140+
141+ If a data synchronization operation was already in progress before the
142+ live upgrade, new features added in the latest ``mongosync`` version may
143+ not all be supported after the live upgrade. Performance improvements
144+ and bug fixes are always supported after the live upgrade. For more
145+ information on the new features that might be supported after a live
146+ upgrade, see the :ref:`1.7.0-c2c-release-notes`.
147+
148+ Non-Live Upgrade or Downgrade
149+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150+
151+ If you're using an earlier ``mongosync`` version not supported by the
152+ live upgrade procedure, or you need to downgrade ``mongosync``, perform
153+ these steps:
90154
91155- Stop all currently running ``mongosync`` processes.
92156- Drop all non-system databases in the destination cluster.
0 commit comments