Skip to content

DOCS-14264 increase visibility of clean shutdown requirements #6093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions source/release-notes/4.4-downgrade-replica-set.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,16 @@ privileges.
Prerequisites
-------------

Remove Incompatible Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To downgrade from 4.4 to 4.2, you must remove incompatible features
that are persisted and/or update incompatible configuration settings.

.. |target| replace:: primary

1. Namespace Length
~~~~~~~~~~~~~~~~~~~
```````````````````

Starting in MongoDB 4.4:

Expand Down Expand Up @@ -89,7 +92,7 @@ downgrading the fCV:
.. _4.4-downgrade-feature-compatibility-rs:

2. Downgrade Feature Compatibility Version (fCV)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
````````````````````````````````````````````````

.. tip::

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

3. Remove FCV |newversion| Persisted Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`````````````````````````````````````````````

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

4. Remove |newversion| Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```````````````````````````````

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

Confirm Clean Shutdown
~~~~~~~~~~~~~~~~~~~~~~

When a step prompts you to stop your deployment, ensure your
:binary:`~bin.mongod` instance is
:ref:`shut down <terminate-mongod-processes>`.

Procedure
---------

Expand Down
22 changes: 16 additions & 6 deletions source/release-notes/4.4-downgrade-sharded-cluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,17 @@ Create Backup
Prerequisites
-------------

Remove Incompatible Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To downgrade from |newversion| to |oldversion|, you must remove
incompatible features that are persisted and/or update incompatible
configuration settings.

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

1. Namespace Length
~~~~~~~~~~~~~~~~~~~
```````````````````

Starting in MongoDB 4.4:

Expand Down Expand Up @@ -92,7 +95,7 @@ downgrading the fCV:
.. _4.4-downgrade-feature-compatibility-sharded-cluster:

2. Downgrade Feature Compatibility Version (fCV)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
````````````````````````````````````````````````

.. tip::

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

3. Remove FCV |newversion| Persisted Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`````````````````````````````````````````````

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

4. Remove |newversion| Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```````````````````````````````

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

5. Update Missing Shard Keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
````````````````````````````

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

6. Update Shard Keys That Exceed 512 bytes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``````````````````````````````````````````

.. versionchanged:: 4.4

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

Confirm Clean Shutdown
~~~~~~~~~~~~~~~~~~~~~~

When a step prompts you to stop your deployment, ensure your
:binary:`~bin.mongod` instance is
:ref:`shut down <terminate-mongod-processes>`.

Procedure
---------

Expand Down
17 changes: 13 additions & 4 deletions source/release-notes/4.4-downgrade-standalone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,17 @@ databases. A user with :authrole:`root` role has the required privileges.
Prerequisites
-------------

Remove Incompatible Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To downgrade from |newversion| to |oldversion|, you must remove
incompatible features that are persisted and/or update incompatible
configuration settings. These include:

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

1. Namespace Length
~~~~~~~~~~~~~~~~~~~
```````````````````

Starting in MongoDB 4.4:

Expand Down Expand Up @@ -88,7 +91,7 @@ downgrading the fCV:
.. _4.4-downgrade-feature-compatibility-standalone:

2. Downgrade Feature Compatibility Version (fCV)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
````````````````````````````````````````````````

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

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

3. Remove FCV |newversion| Persisted Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`````````````````````````````````````````````

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

4. Remove |newversion| Features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```````````````````````````````

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

Confirm Clean Shutdown
~~~~~~~~~~~~~~~~~~~~~~

When a step prompts you to stop your deployment, ensure your
:binary:`~bin.mongod` instance is
:ref:`shut down <terminate-mongod-processes>`.

Procedure
---------
Expand Down