Skip to content

Commit 5193381

Browse files
JuliaMongojwilliams-mongo
authored andcommitted
(DOCSP-30094) Reorder the section for upgrading OM version, fix versions (4.4 instead of 4.2, 6.0 instead of 5.0), make other related changes (#1355)
* (DOCSP-30094) Reorder the section for upgrading OM version * Tech review feedback plus scope increase to address two more tickets * Edits * Edits * Edits * Edits * Tech review for FCV * Tech review for FCV * Tech review * Copy review. Ready to merge. * One final nit. Adjusted line wrap
1 parent 37a4b52 commit 5193381

File tree

8 files changed

+62
-52
lines changed

8 files changed

+62
-52
lines changed

source/includes/steps-upgrade-master.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ replacement:
3232
metadata:
3333
name: my-standalone-downgrade
3434
spec:
35-
version: "4.2.2-ent"
35+
version: "4.4.18-ent"
36+
featureCompatibilityVersion: "4.2"
3637
type: Standalone
3738
project: my-project
3839
credentials: my-credentials

source/includes/steps-upgrade-mdb.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ inherit:
55
file: steps-upgrade-master.yaml
66
ref: upgrade-master-version
77
replacement:
8-
method: "Change the resource's |k8s-crd| as shown in the following example:"
8+
method: "Change the settings in the :ref:`k8s-specification` as shown in the following example:"
99
content: |
1010
1111
{{mdb}}

source/om-resources.txt

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,39 @@ Deploy and Configure Ops Manager Resources
1010
Review the |onprem| resource architecture.
1111

1212
:ref:`plan-om-resource`
13-
Review the |onprem| resource considerations and
14-
prerequisites.
13+
Review the |onprem| resource considerations and prerequisites.
1514

1615
:ref:`deploy-om-container`
1716
Use the |k8s-op-short| to deploy an |onprem| instance and encrypt the
18-
connection between the application database's replica set
19-
members.
17+
connection between the application database's replica set members.
2018

2119
:ref:`deploy-om-container-remote-mode`
22-
Use the |k8s-op-short| to configure |onprem| to operate in
23-
**Remote** mode. In Remote mode, the Backup Daemons and managed
24-
MongoDB resources download installation archives from HTTP endpoints
25-
on a web server or S3-compatible file store deployed to your |k8s|
26-
cluster instead of from the Internet.
20+
Use the |k8s-op-short| to configure |onprem| to operate in **Remote** mode.
21+
In Remote mode, the Backup Daemons and managed MongoDB resources download
22+
installation archives from HTTP endpoints on a web server or S3-compatible
23+
file store deployed to your |k8s| cluster instead of from the Internet.
2724

2825
:ref:`deploy-om-container-local-mode`
29-
Use the |k8s-op-short| to configure |onprem| to operate in
30-
**Local** mode. In Local mode, the Backup Daemons and managed
31-
MongoDB resources download installation archives from a |k8s-pv| that
32-
you create for the |onprem| StatefulSet instead of from the Internet.
26+
Use the |k8s-op-short| to configure |onprem| to operate in **Local** mode.
27+
In Local mode, the Backup Daemons and managed MongoDB resources download
28+
installation archives from a |k8s-pv| that you create for the |onprem|
29+
StatefulSet instead of from the Internet.
3330

34-
:ref:`secure-om-db-tls`
35-
Encrypt the connection between the application database replica set
36-
members.
31+
:ref:`meko-upgrade-om-version`
32+
Upgrade the versions of your |onprem| instance and :term:`backing databases`
33+
that the |k8s-op-short| uses to manage your deployment.
3734

3835
:ref:`configure-om-queryable-backups`
39-
Configure queryable backups for |onprem| deployments created with the
40-
|k8s-op-short|.
36+
Configure queryable backups for |onprem| deployments created with the |k8s-op-short|.
4137

4238
:ref:`configure-file-store`
43-
Configure backup snapshot storage for |onprem| resources
44-
created with |k8s-op-short|.
39+
Configure backup snapshot storage for |onprem| resources created with the |k8s-op-short|.
4540

4641
:ref:`configure-kmip-backup-encryption`
4742
Configure |kmip| backup encryption.
4843

4944
:ref:`cert-manager-integration`
50-
Configure automated certificate renewal for |onprem| deployments with
51-
``cert-manager``.
52-
45+
Configure automated certificate renewal for |onprem| deployments with ``cert-manager``.
5346

5447
.. class:: hidden
5548

@@ -61,6 +54,7 @@ Deploy and Configure Ops Manager Resources
6154
/tutorial/deploy-om-container
6255
/tutorial/deploy-om-container-remote-mode
6356
/tutorial/deploy-om-container-local-mode
57+
/tutorial/upgrade-om-version
6458
/tutorial/configure-om-queryable-backups
6559
/tutorial/configure-kmip-backup-encryption
6660
/tutorial/configure-file-store

source/reference/k8s/example-ops-manager.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ spec:
4949
name: om-db-user-secret
5050
key: password
5151
members: 3
52-
version: "4.2.11-ent"
52+
version: "4.4.18-ent"

source/tutorial/edit-deployment.txt

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,21 @@ also modify :term:`standalone <standalone>` processes.
2323
Considerations
2424
--------------
2525

26-
- You can't change individual members of a replica set or
27-
sharded cluster. You can only change the whole set or cluster.
26+
- You can't change individual members of a replica set or sharded cluster.
27+
You can change only the whole set or cluster.
2828

29-
- If a setting isn't available for a MongoDB Kubernetes resource,
30-
you can only make changes using the :opsmgr:`Ops Manager </>` or
31-
:cloudmgr:`Cloud Manager </>` application.
29+
- If a setting isn't available for a MongoDB resource, you can make changes
30+
using only the :opsmgr:`Ops Manager </>` or :cloudmgr:`Cloud Manager </>` application.
3231

3332
- .. include:: /includes/admonitions/fact-unsupported-mongod-options.rst
3433

35-
- There are certain settings you can only configure using the |k8s-op-short|. To
36-
review the list of settings, see
37-
:doc:`/reference/k8s-op-exclusive-settings`.
34+
- You can configure certain settings using only the |k8s-op-short|. To
35+
review the list of settings, see :doc:`/reference/k8s-op-exclusive-settings`.
3836

3937
Prerequisites
4038
-------------
4139

42-
To update a MongoDB |k8s-obj|, you need to have completed the following procedures:
40+
Before you update a MongoDB |k8s-obj|, complete the following procedures:
4341

4442
- :ref:`k8s-install-configure`
4543
- :ref:`create-k8s-credentials`
@@ -56,6 +54,5 @@ Procedure
5654
:hidden:
5755

5856
/tutorial/upgrade-mdb-version
59-
/tutorial/upgrade-om-version
6057
/tutorial/scale-resources
6158
/tutorial/resize-pv-storage

source/tutorial/upgrade-mdb-version.txt

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ Upgrade MongoDB Version and FCV
1212
:depth: 2
1313
:class: singlecol
1414

15-
You can upgrade the major, minor, or feature compatibility versions
16-
of your MongoDB resource. These settings are configured in your
17-
resource's |k8s-crd|.
15+
You can upgrade the major, minor, or feature compatibility versions of
16+
your MongoDB resource. Configure these settings in your :ref:`k8s-specification`.
1817

1918
Overview
2019
--------
@@ -32,16 +31,22 @@ version.
3231
If you update ``spec.version`` to a later version, consider setting
3332
:setting:`spec.featureCompatibilityVersion` to the current working
3433
MongoDB version to give yourself the option to downgrade if
35-
necessary.
36-
37-
To learn more about feature compatibility, see
34+
necessary. To learn more about feature compatibility, see
3835
:dbcommand:`setFeatureCompatibilityVersion` in the MongoDB Server
3936
Documentation.
4037

4138
Procedure
4239
---------
4340

44-
To upgrade the standalone deployment's MongoDB version to
45-
``4.2.2-ent``, complete the following steps:
41+
To upgrade the standalone deployment's MongoDB version from ``4.2.2-ent``
42+
to ``4.4.18-ent``, complete the steps in the following syntactic example.
43+
44+
If you update ``spec.version`` to a later version without setting the
45+
:setting:`spec.featureCompatibilityVersion` to any value, the Feature
46+
Compatibility Version (FCV) upgrades to the **same version** that you specify
47+
in ``spec.version``. However, you can explicitly specify a previous
48+
version for the FCV. The following example illustrates this use case.
49+
It sets ``spec.version`` to ``4.4.18-ent`` and
50+
:setting:`spec.featureCompatibilityVersion` to ``4.2``.
4651

4752
.. include:: /includes/steps/upgrade-mdb.rst

source/tutorial/upgrade-om-version.txt

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Upgrade Ops Manager and Backing Database Versions
1212
:depth: 2
1313
:class: singlecol
1414

15-
Update the major and minor versions of your |onprem| instance and :term:`backing databases` in the :ref:`k8s-om-specification` that |k8s-op-short| uses to manage your deployment.
15+
Update the major and minor versions of your |onprem| instance and :term:`backing databases`
16+
in the :ref:`k8s-om-specification` that the |k8s-op-short| uses to manage your deployment.
1617

1718
Prerequisites
1819
-------------
@@ -21,20 +22,26 @@ Prerequisites
2122

2223
To maintain existing settings and availability, back up the following in your current |onprem| instance:
2324

24-
- Your ``conf-mms.properties`` to a secure location. The ``conf-mms.properties`` stores settings for the |onprem| instance.
25-
- Your ``gen.key`` files to a secure location. The :ref:`gen.key <gen-key>` provides details to encrypt and decrypt |onprem|\s backing databases and user credentials. |onprem| might delete these files as part of the upgrade process.
26-
- Your :ref:`application database <appdb-om-arch>`. If the upgrade fails, you need a current backup to restore your |onprem| instance.
25+
- Your ``conf-mms.properties`` to a secure location. The ``conf-mms.properties``
26+
stores settings for the |onprem| instance.
27+
- Your ``gen.key`` files to a secure location. The :ref:`gen.key <gen-key>`
28+
provides details to encrypt and decrypt |onprem|\'s backing databases
29+
and user credentials. |onprem| might delete these files as part of the upgrade process.
30+
- Your :ref:`application database <appdb-om-arch>`. If the upgrade fails,
31+
you need a current backup to restore your |onprem| instance.
2732

2833
1. Upgrade |onprem| by following the considerations, prerequisites, and procedure in :ref:`upgrade-om`.
2934

30-
2. Reference :ref:`compatible-mdb-versions` to ensure your :term:`backing databases` use a MongoDB version that is compatible with the new |onprem| version.
35+
2. Reference :ref:`compatible-mdb-versions` to ensure your :term:`backing databases`
36+
use a MongoDB version that is compatible with the new |onprem| version.
3137

32-
3. If you need to upgrade your backing databases to a compatible MongoDB version, see :ref:`meko-upgrade-mdb-version`.
38+
3. If you need to upgrade your backing databases to a compatible MongoDB version,
39+
see :ref:`meko-upgrade-mdb-version`.
3340

3441
Procedure
3542
---------
3643

37-
To update |onprem| from 4.0 to 5.0 and the application database to MongoDB
38-
``4.2.11-ent``, complete the following steps:
44+
To update |onprem| from 5.0 to 6.0 and the application database to MongoDB
45+
``4.4.18-ent``, complete the following steps:
3946

4047
.. include:: /includes/steps/upgrade-om.rst

source/upgrade.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Upgrade the |k8s-op-short| from Prior Versions
2222
Migrate your |k8s-op-short| deployments from Ubuntu-based container
2323
images to UBI-based container images.
2424

25+
.. note::
26+
27+
To upgrade the versions of your |onprem| instance and :term:`backing databases`
28+
that the |k8s-op-short| uses to manage your deployment, see :ref:`meko-upgrade-om-version`.
29+
To upgrade the versions of your MongoDB resource, see :ref:`meko-upgrade-mdb-version`.
30+
2531
.. class:: hidden
2632

2733
.. toctree::

0 commit comments

Comments
 (0)