Skip to content

Commit 07ace31

Browse files
authored
DOCS-14264 increase visibility of clean shutdown requirements (#6093)
1 parent 1b9dc0e commit 07ace31

File tree

3 files changed

+43
-14
lines changed

3 files changed

+43
-14
lines changed

source/release-notes/4.4-downgrade-replica-set.txt

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,16 @@ privileges.
4242
Prerequisites
4343
-------------
4444

45+
Remove Incompatible Features
46+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47+
4548
To downgrade from 4.4 to 4.2, you must remove incompatible features
4649
that are persisted and/or update incompatible configuration settings.
4750

4851
.. |target| replace:: primary
4952

5053
1. Namespace Length
51-
~~~~~~~~~~~~~~~~~~~
54+
```````````````````
5255

5356
Starting in MongoDB 4.4:
5457

@@ -89,7 +92,7 @@ downgrading the fCV:
8992
.. _4.4-downgrade-feature-compatibility-rs:
9093

9194
2. Downgrade Feature Compatibility Version (fCV)
92-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95+
````````````````````````````````````````````````
9396

9497
.. tip::
9598

@@ -134,7 +137,7 @@ For more information on the returned ``featureCompatibilityVersion``
134137
value, see :ref:`view-fcv`.
135138

136139
3. Remove FCV |newversion| Persisted Features
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140+
`````````````````````````````````````````````
138141

139142
The following steps are necessary only if fCV has ever been set to
140143
|newfcv|.
@@ -153,7 +156,7 @@ Compound Hashed Indexes
153156
.. |binary| replace:: any replica set member
154157

155158
4. Remove |newversion| Features
156-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159+
```````````````````````````````
157160

158161
Remove all persisted features that use |newversion| features. These
159162
include but are not limited to:
@@ -165,6 +168,13 @@ include but are not limited to:
165168
- :method:`Unhide <db.collection.unhideIndex()>` or :method:`drop
166169
<db.collection.dropIndex()>` hidden indexes.
167170

171+
Confirm Clean Shutdown
172+
~~~~~~~~~~~~~~~~~~~~~~
173+
174+
When a step prompts you to stop your deployment, ensure your
175+
:binary:`~bin.mongod` instance is
176+
:ref:`shut down <terminate-mongod-processes>`.
177+
168178
Procedure
169179
---------
170180

source/release-notes/4.4-downgrade-sharded-cluster.txt

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,17 @@ Create Backup
3636
Prerequisites
3737
-------------
3838

39+
Remove Incompatible Features
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41+
3942
To downgrade from |newversion| to |oldversion|, you must remove
4043
incompatible features that are persisted and/or update incompatible
4144
configuration settings.
4245

4346
.. |target| replace:: :binary:`~bin.mongos` instance
4447

4548
1. Namespace Length
46-
~~~~~~~~~~~~~~~~~~~
49+
```````````````````
4750

4851
Starting in MongoDB 4.4:
4952

@@ -92,7 +95,7 @@ downgrading the fCV:
9295
.. _4.4-downgrade-feature-compatibility-sharded-cluster:
9396

9497
2. Downgrade Feature Compatibility Version (fCV)
95-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
````````````````````````````````````````````````
9699

97100
.. tip::
98101

@@ -145,7 +148,7 @@ For more information on the returned ``featureCompatibilityVersion``
145148
value, see :ref:`view-fcv`.
146149

147150
3. Remove FCV |newversion| Persisted Features
148-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151+
`````````````````````````````````````````````
149152

150153
The following steps are necessary only if fCV has ever been set to
151154
|newfcv|.
@@ -182,7 +185,7 @@ Compound Hashed Shard Keys
182185
the data into the cluster.
183186

184187
4. Remove |newversion| Features
185-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
188+
```````````````````````````````
186189

187190
Remove all persisted features that use |newversion| features. These
188191
include but are not limited to:
@@ -198,7 +201,7 @@ include but are not limited to:
198201
.. |binary| replace:: any :binary:`~bin.mongod`/:binary:`~bin.mongos` instance
199202

200203
5. Update Missing Shard Keys
201-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
204+
````````````````````````````
202205

203206
In MongoDB 4.4, shard key fields can be :ref:`missing from documents
204207
<shard-key-missing>` in a sharded collection.
@@ -232,7 +235,7 @@ must perform the update within a transaction or as a retryable
232235
write. For details, see :ref:`shard-key-missing-set`.
233236

234237
6. Update Shard Keys That Exceed 512 bytes
235-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238+
``````````````````````````````````````````
236239

237240
.. versionchanged:: 4.4
238241

@@ -242,6 +245,13 @@ write. For details, see :ref:`shard-key-missing-set`.
242245
512-byte size limit to be within the 512 byte size limit. To update
243246
a document's shard key value, see :ref:`update-shard-key`.
244247

248+
Confirm Clean Shutdown
249+
~~~~~~~~~~~~~~~~~~~~~~
250+
251+
When a step prompts you to stop your deployment, ensure your
252+
:binary:`~bin.mongod` instance is
253+
:ref:`shut down <terminate-mongod-processes>`.
254+
245255
Procedure
246256
---------
247257

source/release-notes/4.4-downgrade-standalone.txt

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,17 @@ databases. A user with :authrole:`root` role has the required privileges.
4141
Prerequisites
4242
-------------
4343

44+
Remove Incompatible Features
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
4447
To downgrade from |newversion| to |oldversion|, you must remove
4548
incompatible features that are persisted and/or update incompatible
4649
configuration settings. These include:
4750

4851
.. |target| replace:: :binary:`~bin.mongod` instance
4952

5053
1. Namespace Length
51-
~~~~~~~~~~~~~~~~~~~
54+
```````````````````
5255

5356
Starting in MongoDB 4.4:
5457

@@ -88,7 +91,7 @@ downgrading the fCV:
8891
.. _4.4-downgrade-feature-compatibility-standalone:
8992

9093
2. Downgrade Feature Compatibility Version (fCV)
91-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94+
````````````````````````````````````````````````
9295

9396
To downgrade the ``featureCompatibilityVersion`` of your standalone:
9497

@@ -97,7 +100,7 @@ To downgrade the ``featureCompatibilityVersion`` of your standalone:
97100
#. .. include:: /includes/4.4-downgrade-fcv.rst
98101

99102
3. Remove FCV |newversion| Persisted Features
100-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103+
`````````````````````````````````````````````
101104

102105
The following steps are necessary only if fCV has ever been set to
103106
|newfcv|.
@@ -116,7 +119,7 @@ Compound Hashed Indexes
116119
.. |binary| replace:: the :binary:`~bin.mongod` instance
117120

118121
4. Remove |newversion| Features
119-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122+
```````````````````````````````
120123

121124
Remove all persisted features that use |newversion| features. These
122125
include but are not limited to:
@@ -128,6 +131,12 @@ include but are not limited to:
128131
- :method:`Unhide <db.collection.unhideIndex()>` or :method:`drop
129132
<db.collection.dropIndex()>` hidden indexes.
130133

134+
Confirm Clean Shutdown
135+
~~~~~~~~~~~~~~~~~~~~~~
136+
137+
When a step prompts you to stop your deployment, ensure your
138+
:binary:`~bin.mongod` instance is
139+
:ref:`shut down <terminate-mongod-processes>`.
131140

132141
Procedure
133142
---------

0 commit comments

Comments
 (0)