Skip to content

Commit 6bf5e4e

Browse files
JuliaMongojwilliams-mongo
authored andcommitted
(DOSP-17749) (DOCSP-14906) update the upgrade instructions with "removal of spec.project", remove obsolete note from om reconciliation (#764)
* Added an upgrade step about removal of spec.project * Make all step IDs unique to fix the build * Fix the build, missed space * Fixing the build * Build * Build, still * Trying to fix the build still * Added a link to relnotes * Removed a note for the om reconcilliation that is no longer accurate
1 parent 6dc8a90 commit 6bf5e4e

10 files changed

+66
-18
lines changed

source/images/multi-cluster-arch.svg

Lines changed: 1 addition & 1 deletion
Loading

source/includes/steps-install-master.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,5 +96,18 @@ content: |
9696
definition:
9797
9898
{{command}}
99+
---
100+
title: "If you are upgrading the Operator to version 1.13.0 or later, specify the :setting:`spec.opsManager.configMapRef.name` or the :setting:`spec.cloudManager.configMapRef.name` settings:"
101+
level: 4
102+
ref: remove-project-spec
103+
content: |
104+
105+
1. Open the :ref:`k8s-specification` in the editor of your choice.
106+
#. Search for the deprecated :setting:`spec.project` setting and remove it.
107+
#. Add the value to the :setting:`spec.opsManager.configMapRef.name`
108+
setting or the
109+
:setting:`spec.cloudManager.configMapRef.name` setting and save
110+
the specification.
99111
112+
To learn more, see :ref:`Changes to the MongoDB Resource <ent_op-1.13.0-mdb-resource>`.
100113
...

source/includes/steps-upgrade-k8s-offline-helm-host.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,23 @@ replacement:
3030
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
3131
--type merge
3232
---
33+
ref: remove-project-spec-k8s-offline-helm
34+
stepnum: 4
35+
inherit:
36+
file: steps-install-master.yaml
37+
ref: remove-project-spec
38+
---
3339
ref: upgrade-customize-chart
3440
inherit:
3541
file: steps-helm-master.yaml
3642
ref: helm-master-customize-chart
37-
stepnum: 4
43+
stepnum: 5
3844
---
3945
ref: helm-k8s-offline-host
4046
inherit:
4147
file: steps-helm-master.yaml
4248
ref: helm-master-install
43-
stepnum: 5
49+
stepnum: 6
4450
replacement:
4551
method: "Upgrade to the latest version of the |k8s-op-short|."
4652
content: |

source/includes/steps-upgrade-k8s-online-helm.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,23 @@ replacement:
3030
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
3131
--type merge
3232
---
33+
ref: remove-project-spec-k8s-online-helm
34+
stepnum: 4
35+
inherit:
36+
file: steps-install-master.yaml
37+
ref: remove-project-spec
38+
---
3339
ref: upgrade-customize-chart
3440
inherit:
3541
file: steps-helm-master.yaml
3642
ref: helm-master-customize-chart
37-
stepnum: 4
43+
stepnum: 5
3844
---
3945
ref: helm-k8s-online-ug
4046
inherit:
4147
file: steps-helm-master.yaml
4248
ref: helm-master-install
43-
stepnum: 5
49+
stepnum: 6
4450
replacement:
4551
method: "Upgrade the |k8s-op-short|."
4652
content: |

source/includes/steps-upgrade-kubectl.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,18 @@ replacement:
4040
kubectl patch opsmanagers/<opsmgr-resource-metadata.name> \
4141
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
4242
--type merge
43-
43+
---
44+
ref: remove-project-spec-kubectl
45+
stepnum: 5
46+
inherit:
47+
file: steps-install-master.yaml
48+
ref: remove-project-spec
4449
---
4550
ref: upgrade-kubectl-upgrade
4651
inherit:
4752
file: steps-install-master.yaml
4853
ref: install-master-install
49-
stepnum: 5
54+
stepnum: 6
5055
replacement:
5156
method: "Upgrade to the new version of the |k8s-op-short|."
5257
content: |

source/includes/steps-upgrade-oc.yaml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,17 @@ replacement:
4747
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
4848
--type merge
4949
---
50+
ref: remove-project-spec-oc-generic
51+
stepnum: 5
52+
inherit:
53+
file: steps-install-master.yaml
54+
ref: remove-project-spec
55+
---
5056
ref: upgrade-oc-upgrade
5157
inherit:
5258
file: steps-install-master.yaml
5359
ref: install-master-install
54-
stepnum: 5
60+
stepnum: 6
5561
replacement:
5662
method: "Upgrade to the new version of the |k8s-op-short|."
5763

source/includes/steps-upgrade-os-offline-helm-host.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,23 @@ replacement:
3030
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
3131
--type merge
3232
---
33+
ref: remove-project-spec-oc-offline
34+
stepnum: 4
35+
inherit:
36+
file: steps-install-master.yaml
37+
ref: remove-project-spec
38+
---
3339
ref: upgrade-customize-chart
3440
inherit:
3541
file: steps-helm-master.yaml
3642
ref: helm-master-customize-chart
37-
stepnum: 4
43+
stepnum: 5
3844
---
3945
ref: helm-os-offline-host
4046
inherit:
4147
file: steps-helm-master.yaml
4248
ref: helm-master-install
43-
stepnum: 5
49+
stepnum: 6
4450
replacement:
4551
method: "Upgrade to the latest version of the |k8s-op-short|."
4652
content: |

source/includes/steps-upgrade-os-online-helm.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,23 @@ replacement:
3030
--patch '{"spec": {"security": {"tls": {"ca": "<ca-configmap>"}}}}' \
3131
--type merge
3232
---
33+
ref: remove-proj-spec-oc
34+
stepnum: 4
35+
inherit:
36+
file: steps-install-master.yaml
37+
ref: remove-project-spec
38+
---
3339
ref: upgrade-customize-chart
3440
inherit:
3541
file: steps-helm-master.yaml
3642
ref: helm-master-customize-chart
37-
stepnum: 4
43+
stepnum: 5
3844
---
3945
ref: helm-os-online-ug
4046
inherit:
4147
file: steps-helm-master.yaml
4248
ref: helm-master-install
43-
stepnum: 5
49+
stepnum: 6
4450
replacement:
4551
method: "Upgrade the |k8s-op-short|."
4652
content: |

source/release-notes.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ Changes
7171
certificates. Changes to these ConfigMaps and secrets now trigger a
7272
reconciliation of the related resource.
7373

74+
.. _ent_op-1.13.0-mdb-resource:
75+
7476
``MongoDB`` Resource
7577
````````````````````
7678

source/tutorial/om-arch.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ changes to the ``MongoDBOpsManager`` |k8s-crd|.
160160
least three |k8s-pods|.
161161

162162
- Each Pod runs one {+mdbagent+} instance. Each {+mdbagent+} starts a
163-
|mongod| instance on its pod.
163+
|mongod| instance on its Pod.
164164
- The |k8s-op-short| mounts the ``<om_resource_name>-db-config``
165165
Secret to each Pod. The {+mdbagent+} uses this secret to
166166
configure the Application Database replica set.
@@ -179,11 +179,9 @@ changes to the ``MongoDBOpsManager`` |k8s-crd|.
179179
restart because the connection string to the Application Database
180180
changes.
181181

182-
Changes to the following ``MongoDBOpsManager``
183-
|k8s-custom-resource| collections don't trigger a rolling upgrade:
184-
185-
- :opsmgrkube:`spec.backup <spec.backup.enabled>`
186-
- :opsmgrkube:`spec.applicationDatabase`
182+
Changes to the :opsmgrkube:`spec.backup <spec.backup.enabled>`
183+
``MongoDBOpsManager`` |k8s-custom-resource| collection don't
184+
trigger a rolling upgrade.
187185

188186
4. The |k8s-op-short| invokes |onprem| APIs to create an admin user.
189187
The |k8s-op-short| saves this admin user's credentials in the

0 commit comments

Comments
 (0)