Skip to content

Commit 2acdb39

Browse files
jwilliams-mongojwilliams-mongo
authored
(DOCSP-12512): Put note to the Operator upgrade instructions (#384)
* (DOCSP-12512): Put note to the Operator upgrade instructions * (DOCSP-12512): tech and copy review feedback * (DOCSP-12512): fix step numbering
1 parent 0b267be commit 2acdb39

28 files changed

+463
-434
lines changed

‎source/includes/admonitions/remove-op-no-affect-mdb.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. note::
2+
3+
Removing the |k8s-op-short| deployment doesn’t affect the lifecycle
4+
of your MongoDB resources.

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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+
Forbidden: updates to statefulset spec for fields other than
8+
'replicas', 'template', and 'updateStrategy' are forbidden
9+
10+
If you receive this error, you use the following command to remove the
11+
old |k8s-op-short| deployment:

‎source/includes/install/upgrade-k8s-operator-v161.rst

Lines changed: 0 additions & 84 deletions
This file was deleted.

‎source/includes/install/upgrade-k8s-operator.rst

Lines changed: 57 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,86 @@
11
The following steps depend on how your environment is configured:
22

33
.. tabs::
4+
5+
.. tab:: Kubernetes
46

5-
tabs:
6-
- id: vank8sup
7-
name: Kubernetes
8-
content: |
9-
10-
.. tabs::
11-
12-
tabs:
13-
- id: kubectlup
14-
name: Online using kubectl
15-
content: |
7+
.. tabs::
8+
9+
.. tab:: Online using kubectl
10+
:tabid: kubectlup
1611

17-
.. _upgrade-k8s-operator-kubectl:
18-
19-
.. include:: /includes/steps/upgrade-kubectl.rst
20-
21-
- id: helmonlinek8sup
22-
name: Online using Helm
23-
content: |
24-
25-
.. _upgrade-k8s-operator-helm:
26-
27-
.. include:: /includes/steps/upgrade-k8s-online-helm.rst
28-
29-
- id: helmofflinek8sup
30-
name: Offline using Helm and Docker
31-
content: |
32-
33-
To upgrade the |k8s-op-short| on a host not connected to the
34-
Internet, you have two options, you can download the
35-
|k8s-op-short| files from either:
36-
37-
.. note that these tabs contain the same content but I don't think that's intended. separated the includes out to prepare for corrections.
12+
.. _upgrade-k8s-operator-kubectl:
3813

39-
.. tabs::
14+
.. include:: /includes/steps/upgrade-kubectl.rst
4015

41-
tabs:
42-
- id: internetk8up
43-
name: The Internet
44-
content: |
16+
.. tab:: Online using Helm
17+
:tabid: helmonlinek8sup
4518

46-
.. include:: /includes/steps/upgrade-k8s-offline-helm-internet.rst
19+
.. _upgrade-k8s-operator-helm:
4720

21+
.. include:: /includes/steps/upgrade-k8s-online-helm.rst
22+
23+
.. tab:: Offline using Helm and Docker
24+
:tabid: helmofflinek8sup
4825

49-
- id: hostk8sup
50-
name: Another Host
51-
content: |
26+
To upgrade the |k8s-op-short| on a host not connected to the
27+
Internet, you have two options, you can download the
28+
|k8s-op-short| files from either:
5229

53-
.. include:: /includes/steps/upgrade-k8s-offline-helm-host.rst
30+
.. note that these tabs contain the same content but I don't
31+
think that's intended. separated the includes out to
32+
prepare for corrections.
5433
55-
- id: osup
56-
name: OpenShift
57-
content: |
34+
.. tabs::
5835

59-
.. tabs::
36+
.. tab:: The Internet
37+
:tabid: internetk8sup
6038

61-
tabs:
62-
- id: ocup
63-
name: Online using oc
64-
content: |
39+
.. include:: /includes/steps/upgrade-k8s-offline-helm-internet.rst
40+
41+
.. tab:: Another Host
42+
:tabid: hostk8sup
6543

66-
.. _upgrade-k8s-operator-oc:
44+
.. include:: /includes/steps/upgrade-k8s-offline-helm-host.rst
6745

68-
.. include:: /includes/steps/upgrade-oc.rst
46+
.. tab:: OpenShift
47+
:tabid: osup
6948

49+
.. tabs::
50+
51+
.. tab:: Online using oc
52+
:tabid: ocup
7053

71-
- id: helmonlineosup
72-
name: Online using Helm
73-
content: |
54+
.. _upgrade-k8s-operator-oc:
7455

75-
.. _upgrade-operator-helm-oc:
56+
.. include:: /includes/steps/upgrade-oc.rst
7657

77-
.. include:: /includes/steps/upgrade-os-online-helm.rst
58+
.. tab:: Online using Helm
59+
:tabid: helmonlineosup
7860

79-
- id: helmofflineosup
80-
name: Offline using Helm and Docker
81-
content: |
61+
.. _upgrade-operator-helm-oc:
8262

83-
.. note that these tabs contain the same content but I don't think that's intended. separated the includes out to prepare for corrections.
63+
.. include:: /includes/steps/upgrade-os-online-helm.rst
64+
65+
.. tab:: Offline using Helm and Docker
66+
:tabid: helmofflineosup
8467

85-
To upgrade the |k8s-op-short| on a host not connected to the
86-
Internet, you have two options, you can download the
87-
|k8s-op-short| files from either:
68+
.. note that these tabs contain the same content but I don't think that's intended. separated the includes out to prepare for corrections.
8869
89-
.. tabs::
70+
To upgrade the |k8s-op-short| on a host not connected to the
71+
Internet, you have two options, you can download the
72+
|k8s-op-short| files from either:
9073

91-
tabs:
92-
- id: internetosup
93-
name: The Internet
94-
content: |
74+
.. tabs::
9575

96-
.. include:: /includes/steps/upgrade-os-offline-helm-internet.rst
76+
.. tab:: The Internet
77+
:tabid: internetosup
9778

98-
- id: hostosup
99-
name: Another Host
100-
content: |
79+
.. include:: /includes/steps/upgrade-os-offline-helm-internet.rst
80+
81+
.. tab:: Another Host
82+
:tabid: hostosup
10183

102-
.. include:: /includes/steps/upgrade-os-offline-helm-host.rst
84+
.. include:: /includes/steps/upgrade-os-offline-helm-host.rst
10385

104-
.. include:: /includes/troubleshoot-k8s.rst
86+
.. include:: /includes/troubleshoot-k8s.rst

‎source/includes/install/upgrade-k8s-operator_old.rst

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
The following steps depend on how your environment is configured:
2+
3+
.. tabs::
4+
5+
tabs:
6+
- id: vank8sup
7+
name: Kubernetes
8+
content: |
9+
10+
.. tabs::
11+
12+
tabs:
13+
- id: kubectlup
14+
name: Online using kubectl
15+
content: |
16+
17+
.. _upgrade-k8s-operator-kubectl:
18+
19+
.. include:: /includes/steps/upgrade-kubectl.rst
20+
21+
- id: helmonlinek8sup
22+
name: Online using Helm
23+
content: |
24+
25+
.. _upgrade-k8s-operator-helm:
26+
27+
.. include:: /includes/steps/upgrade-k8s-online-helm.rst
28+
29+
- id: helmofflinek8sup
30+
name: Offline using Helm and Docker
31+
content: |
32+
33+
To upgrade the |k8s-op-short| on a host not connected to the
34+
Internet, you have two options, you can download the
35+
|k8s-op-short| files from either:
36+
37+
.. note that these tabs contain the same
38+
content but I don't think that's intended.
39+
separated the includes out to prepare for
40+
corrections.
41+
42+
.. tabs::
43+
44+
tabs:
45+
- id: internetk8up
46+
name: The Internet
47+
content: |
48+
49+
.. include:: /includes/steps/upgrade-k8s-offline-helm-internet.rst
50+
51+
52+
- id: hostk8sup
53+
name: Another Host
54+
content: |
55+
56+
.. include:: /includes/steps/upgrade-k8s-offline-helm-host.rst
57+
58+
- id: osup
59+
name: OpenShift
60+
content: |
61+
62+
.. tabs::
63+
64+
tabs:
65+
- id: ocup
66+
name: Online using oc
67+
content: |
68+
69+
.. _upgrade-k8s-operator-oc:
70+
71+
.. include:: /includes/steps/upgrade-oc.rst
72+
73+
74+
- id: helmonlineosup
75+
name: Online using Helm
76+
content: |
77+
78+
.. _upgrade-operator-helm-oc:
79+
80+
.. include:: /includes/steps/upgrade-os-online-helm.rst
81+
82+
- id: helmofflineosup
83+
name: Offline using Helm and Docker
84+
content: |
85+
86+
.. note that these tabs contain the same content but I don't think that's intended. separated the includes out to prepare for corrections.
87+
88+
To upgrade the |k8s-op-short| on a host not connected to the
89+
Internet, you have two options, you can download the
90+
|k8s-op-short| files from either:
91+
92+
.. tabs::
93+
94+
tabs:
95+
- id: internetosup
96+
name: The Internet
97+
content: |
98+
99+
.. include:: /includes/steps/upgrade-os-offline-helm-internet.rst
100+
101+
- id: hostosup
102+
name: Another Host
103+
content: |
104+
105+
.. include:: /includes/steps/upgrade-os-offline-helm-host.rst
106+
107+
.. include:: /includes/troubleshoot-k8s.rst

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

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,4 @@ content: |
7373
7474
{{command}}
7575
76-
---
77-
ref: upgrade-remove-old
78-
title: "Remove the old version of the |k8s-op-short|."
79-
level: 4
80-
content: |
81-
Before you install the new version of the Operator, you must remove
82-
the old version.
83-
84-
{{command}}
85-
86-
Deleting the Operator deployment doesn't affect the
87-
lifecycle of your MongoDB resources.
88-
8976
...

0 commit comments

Comments
 (0)