Skip to content

Commit 3a279a1

Browse files
(DOCSP-18363): refactor upgrade troubleshooting (#736)
1 parent 2380a93 commit 3a279a1

8 files changed

+71
-87
lines changed

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

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

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

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

source/includes/steps-upgrade-kubectl.yaml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,4 @@ content: |
5353
5454
{{kubectl}}
5555
56-
.. admonition:: Troubleshooting
57-
58-
.. include:: /includes/facts/upgrade-error.rst
59-
60-
To resolve this error:
61-
62-
a. Remove the old |k8s-op-short| deployment.
63-
64-
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
65-
66-
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
67-
68-
b. Repeat the ``kubectl apply`` command to upgrade to the new
69-
version of the |k8s-op-short|.
70-
7156
...

source/includes/steps-upgrade-oc.yaml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,19 +59,4 @@ content: |
5959
6060
{{oc}}
6161
62-
.. admonition:: Troubleshooting
63-
64-
.. include:: /includes/facts/upgrade-error.rst
65-
66-
To resolve this error:
67-
68-
a. Remove the old |k8s-op-short| deployment.
69-
70-
.. include:: /includes/facts/oc-remove-operator-deployment.rst
71-
72-
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
73-
74-
b. Repeat the ``oc apply`` command to upgrade to the new
75-
version of the |k8s-op-short|.
76-
7762
...

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

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

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

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

source/includes/troubleshoot-k8s.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To troubleshoot your |k8s-op-short|, see
2-
:ref:`review-k8s-op-logs`.
1+
To troubleshoot your |k8s-op-short|, see :ref:`review-k8s-op-logs`
2+
and other :ref:`troubleshooting topics <k8s-troubleshooting>`.
33

4-
.. include:: /includes/admonitions/fact-remove-k8s-resources-first.rst
4+
.. include:: /includes/admonitions/fact-remove-k8s-resources-first.rst

source/reference/troubleshooting.txt

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -719,3 +719,71 @@ To check whether a MongoDB binary folder is present:
719719
`copy the MongoDB archive
720720
<../tutorial/deploy-om-container-local-mode.html#copy-the-mongodb-archive-to-the-onprem-persistent-volume>`__
721721
into the |onprem| Persistent Volume for each deployed |onprem| replica set.
722+
723+
Upgrade Fails Using ``kubectl`` or ``oc``
724+
-----------------------------------------
725+
726+
.. include:: /includes/facts/upgrade-error.rst
727+
728+
To resolve this error:
729+
730+
a. Remove the old |k8s-op-short| deployment.
731+
732+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
733+
734+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
735+
736+
b. Repeat the ``kubectl apply`` command to upgrade to the new
737+
version of the |k8s-op-short|.
738+
739+
Upgrade Fails Using Helm Charts
740+
-------------------------------
741+
742+
.. include:: /includes/facts/upgrade-error-helm.rst
743+
744+
To resolve this error:
745+
746+
a. Remove the old |k8s-op-short| deployment.
747+
748+
.. include:: /includes/facts/k8s-remove-operator-deployment.rst
749+
750+
.. include:: /includes/admonitions/remove-op-no-affect-mdb.rst
751+
752+
b. Repeat the ``helm`` command to upgrade to the new version of the
753+
|k8s-op-short|.
754+
755+
Two Operator Instances After an Upgrade
756+
---------------------------------------
757+
758+
After you upgrade from |k8s-op-short| version 1.10 or earlier to a
759+
version 1.11 or later, your |k8s| cluster might have two instances of
760+
the |k8s-op-short| deployed.
761+
762+
Use the ``get pods`` command to view your |k8s-op-short| pods:
763+
764+
.. note::
765+
766+
If you deployed the |k8s-op-short| to OpenShift, replace the
767+
``kubectl`` commands in this section with ``oc`` commands.
768+
769+
.. code-block:: sh
770+
771+
kubectl get pods
772+
773+
If the response contains both an ``enterprise-operator`` and a
774+
``mongodb-enterprise-operator`` pod, your cluster has two |k8s-op-short|
775+
instances:
776+
777+
.. code-block:: sh
778+
:copyable: false
779+
780+
NAME READY STATUS RESTARTS AGE
781+
enterprise-operator-767884c9b4-ltkln 1/1 Running 0 122m
782+
mongodb-enterprise-operator-6d69686679-9fzs7 1/1 Running 0 68m
783+
784+
You can safely remove the ``enterprise-operator`` deployment. Run the
785+
following command to remove it:
786+
787+
.. code-block:: sh
788+
789+
kubectl delete deployment/enterprise-operator

0 commit comments

Comments
 (0)