Skip to content

Commit 5a02fda

Browse files
melissamahoney-mongodbjwilliams-mongo
melissamahoney-mongodb
authored and
jwilliams-mongo
committed
(DOCSP-12675): Update Helm upgrade with error note (#397)
* (DOCSP-12675): Update Helm upgrade with error note * Tech review
1 parent 536976e commit 5a02fda

13 files changed

+126
-20
lines changed

‎source/includes/facts/k8s-remove-operator-deployment.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. code-block:: sh
2+
3+
kubectl delete deployment/mongodb-enterprise-operator --namespace <namespace>

‎source/includes/facts/oc-remove-operator-deployment.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. code-block:: sh
2+
3+
oc delete deployment/mongodb-enterprise-operator --namespace <namespace>

‎source/includes/facts/upgrade-error-helm.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
You might receive the following error when you upgrade the
2+
|k8s-op-short|:
3+
4+
.. code-block:: sh
5+
:copyable: false
6+
7+
Error: UPGRADE FAILED: cannot patch "mongodb-enterprise-operator"
8+
with kind Deployment: Deployment.apps "mongodb-enterprise-operator"
9+
is invalid: ... field is immutable
10+

‎source/includes/facts/upgrade-error.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,3 @@ You might receive the following error when you upgrade the
77
Forbidden: updates to statefulset spec for fields other than
88
'replicas', 'template', and 'updateStrategy' are forbidden
99
10-
If you receive this error, you use the following command to remove the
11-
old |k8s-op-short| deployment:

‎source/includes/steps-helm-master.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,8 @@ replacement:
246246
247247
248248
k8sonlineupgradev161: |
249+
250+
Invoke the following ``helm`` command:
249251
250252
.. code-block:: sh
251253

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ inherit:
1111
ref: install-master-crds
1212
stepnum: 2
1313
replacement:
14-
method: "Upgrade the |k8s-crds| for MongoDB deployments using the following |kubectl| command:"
14+
method: "Upgrade the |k8s-crds| for MongoDB deployments."
1515
content: |
1616
1717
{{kubectl}}
@@ -48,4 +48,18 @@ replacement:
4848
content: |
4949
{{k8sofflineupgradev161}}
5050
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
64+
5165
...

‎source/includes/steps-upgrade-k8s-offline-helm-internet.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ inherit:
1111
ref: install-master-crds
1212
stepnum: 2
1313
replacement:
14-
method: "Upgrade the |k8s-crds| for MongoDB deployments using the following |kubectl| command:"
14+
method: "Upgrade the |k8s-crds| for MongoDB deployments."
1515
content: |
1616
1717
{{kubectl}}
@@ -47,4 +47,18 @@ replacement:
4747
method: "Upgrade to the latest version of the |k8s-op-short|."
4848
content: |
4949
{{k8sofflineupgradev161}}
50+
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
5064
...

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,21 @@ inherit:
4444
ref: helm-master-install
4545
stepnum: 5
4646
replacement:
47-
method: "Upgrade the |k8s-op-short| using the following ``helm`` command:"
47+
method: "Upgrade the |k8s-op-short|."
4848
content: |
4949
{{k8sonlineupgradev161}}
50+
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
5064
...

‎source/includes/steps-upgrade-kubectl.yaml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,24 @@ inherit:
5151
ref: install-master-install
5252
stepnum: 5
5353
replacement:
54-
method: "Install the new version of the |k8s-op-short| using the following
55-
|kubectl| command:"
54+
method: "Upgrade to the new version of the |k8s-op-short|."
5655
content: |
5756
5857
{{kubectl}}
5958
60-
.. include:: /includes/facts/upgrade-error.rst
59+
.. admonition:: Troubleshooting
6160
62-
.. code-block:: sh
61+
.. include:: /includes/facts/upgrade-error.rst
6362
64-
kubectl delete deployment/mongodb-enterprise-operator --namespace <namespace>
63+
To resolve this error:
6564
66-
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
65+
a. Remove the old |k8s-op-short| deployment.
6766
68-
{{kubectl}}
67+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
68+
69+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
70+
71+
b. Repeat the ``kubectl apply`` command to upgrade to the new
72+
version of the |k8s-op-short|.
6973
7074
...

‎source/includes/steps-upgrade-oc.yaml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,25 @@ inherit:
5858
ref: install-master-install
5959
stepnum: 5
6060
replacement:
61-
method: "Install the new version of the |k8s-op-short| using the following
62-
|oc| command:"
61+
method: "Upgrade to the new version of the |k8s-op-short|."
6362

6463
content: |
6564
6665
{{oc}}
6766
68-
.. include:: /includes/facts/upgrade-error.rst
67+
.. admonition:: Troubleshooting
6968
70-
.. code-block:: sh
69+
.. include:: /includes/facts/upgrade-error.rst
7170
72-
oc delete deployment/mongodb-enterprise-operator --namespace
73-
<namespace>
71+
To resolve this error:
7472
75-
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
73+
a. Remove the old |k8s-op-short| deployment.
7674
77-
{{oc}}
75+
.. include:: /includes/facts/oc-remove-operator-deployment.rst
76+
77+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
78+
79+
b. Repeat the ``oc apply`` command to upgrade to the new
80+
version of the |k8s-op-short|.
7881
7982
...

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,18 @@ replacement:
4848
content: |
4949
{{osofflineupgradev161}}
5050
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/oc-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
64+
5165
...

‎source/includes/steps-upgrade-os-offline-helm-internet.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,18 @@ replacement:
4747
method: "Upgrade the latest version of the |k8s-op-short|."
4848
content: |
4949
{{osofflineupgradev161}}
50+
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/oc-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
5064
...

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,17 @@ replacement:
4848
content: |
4949
{{osonlineupgradev161}}
5050
51+
.. admonition:: Troubleshooting
52+
53+
.. include:: /includes/facts/upgrade-error-helm.rst
54+
55+
To resolve this error:
56+
57+
a. Remove the old |k8s-op-short| deployment.
58+
59+
.. include:: /includes/facts/oc-remove-operator-deployment.rst
60+
61+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
62+
63+
b. Repeat the ``helm`` command to upgrade to the new version of the |k8s-op-short|.
5164
...

0 commit comments

Comments
 (0)