Skip to content

Commit 66def09

Browse files
melissamahoney-mongodbmelissamahoney-mongodb
authored
(DOCSP-10838): Changes to Helm installation docs (#312)
* (DOCSP-10838): Changes to Helm installation docs * Tech review * Tech review 2 * Copy review
1 parent 93d8fa2 commit 66def09

17 files changed

+174
-130
lines changed

‎source/includes/install/install-helm-gh.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
If you have not already installed Helm, follow the
2-
instructions on :gh:`GitHub </kubernetes/helm>` to install it.
1+
You can install the |k8s-op-short| with `Helm 3
2+
<https://helm.sh/docs/intro/install/>`_.

‎source/includes/install/install-os-311-helm.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. admonition:: OpenShift 3.11 or earlier
2+
:class: note
3+
4+
If you run OpenShift 3.11 or earlier, you must first manually edit the |k8s-crds| to remove subresources. In each |k8s-crd|, remove the
5+
following option:
6+
7+
.. literalinclude:: /includes/install/upgrade-crds-oc-helm.yaml
8+
:language: yaml
9+
:emphasize-lines: 2-3

‎source/includes/install/upgrade-crds-oc-helm.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
spec:
2+
subresources:
3+
status: {}

‎source/includes/list-tables/os-helm-install-options.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -233,18 +233,3 @@
233233
registry:
234234
initOpsManager: registry.connect.redhat.com/mongodb
235235
-
236-
237-
* - ``subresourceEnabled``
238-
239-
- Creates the CRDs supporting the status subresource. Set to
240-
"false" if you are running OpenShift 3.11 or earlier. Those
241-
versions don't support subresources.
242-
243-
.. example::
244-
245-
.. code-block:: yaml
246-
:emphasize-lines: 1
247-
248-
subresourceEnabled: false
249-
250-
- ``true``

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

Lines changed: 112 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -9,164 +9,207 @@ ref: helm-master-install
99
replacement:
1010
k8sonline: |
1111
12-
Invoke the following ``helm`` and ``kubectl`` commands:
12+
Invoke the following ``helm`` command:
1313
1414
.. code-block:: sh
1515
16-
helm template helm_chart \
17-
--values helm_chart/values.yaml > operator.yaml
18-
kubectl apply -f operator.yaml
16+
helm install <chart-name> helm_chart \
17+
--values helm_chart/values.yaml
1918
2019
.. include:: /includes/install/helm-install-k8s-options.rst
2120
2221
.. note::
2322
24-
You can also pass these values as options when you apply the
23+
Alternatively, you can pass these values as options when you apply the
2524
Helm Chart:
2625
2726
.. code-block:: sh
2827
29-
helm template \
30-
--set namespace=<testNamespace> \
31-
helm_chart \
32-
--values helm_chart/values.yaml > operator.yaml
33-
kubectl apply -f operator.yaml
28+
helm install <chart-name> helm_chart \
29+
--values helm_chart/values.yaml \
30+
--set namespace=<testNamespace>
31+
3432
3533
k8soffline: |
3634
37-
Invoke the following ``helm`` and ``kubectl`` commands:
35+
Invoke the following ``helm`` command:
3836
3937
.. code-block:: sh
4038
41-
helm template \
42-
--set registry.pullPolicy=IfNotPresent \
43-
helm_chart \
44-
--values helm_chart/values.yaml > operator.yaml
45-
kubectl apply -f operator.yaml
39+
helm install <chart-name> helm_chart \
40+
--values helm_chart/values.yaml \
41+
--set registry.pullPolicy=IfNotPresent
4642
4743
.. include:: /includes/install/helm-install-k8s-options.rst
4844
4945
.. note::
5046
51-
You can also pass these values as options when you apply the
47+
Alternatively, you can pass these values as options when you apply the
5248
Helm Chart:
5349
5450
.. code-block:: sh
5551
56-
helm template \
52+
helm install <chart-name> helm_chart \
53+
--values helm_chart/values.yaml \
5754
--set registry.pullPolicy=IfNotPresent \
58-
--set namespace=<testNamespace> \
59-
helm_chart \
60-
--values helm_chart/values.yaml > operator.yaml
61-
kubectl apply -f operator.yaml
62-
63-
osonline: |
55+
--set namespace=<testNamespace>
6456
65-
Invoke the following ``helm`` and ``oc`` commands:
6657
67-
.. code-block:: sh
58+
osonline: |
6859
69-
helm template helm_chart \
70-
--values helm_chart/values-openshift.yaml > operator.yaml
71-
oc apply -f operator.yaml
60+
.. include:: /includes/install/install-os-311-helm.rst
7261
73-
If you run |oc| 3.11 or earlier, add the ``--set subresourceEnabled=false``:
62+
Invoke the following ``helm`` command:
7463
7564
.. code-block:: sh
7665
77-
helm template helm_chart \
78-
--values helm_chart/values.yaml \
79-
--set subresourceEnabled=false > operator.yaml
80-
kubectl apply -f operator.yaml
66+
helm install <chart-name> helm_chart \
67+
--values helm_chart/values-openshift.yaml
8168
8269
.. include:: /includes/install/helm-install-os-options.rst
8370
8471
.. note::
8572
86-
You can also pass these values as options when you apply the
73+
Alternatively, you can pass these values as options when you apply the
8774
Helm Chart:
8875
8976
.. code-block:: sh
9077
91-
helm template \
92-
--set registry.imagePullSecrets=<openshift-pull-secret> \
93-
helm_chart \
94-
--values helm_chart/values-openshift.yaml > operator.yaml
95-
oc apply -f operator.yaml
78+
helm install <chart-name> helm_chart \
79+
--values helm_chart/values-openshift.yaml \
80+
--set registry.imagePullSecrets=<openshift-pull-secret>
9681
9782
osoffline: |
9883
84+
.. include:: /includes/install/install-os-311-helm.rst
85+
86+
Invoke the following ``helm`` command:
87+
9988
.. code-block:: sh
10089
101-
helm template \
90+
helm install <chart-name> helm_chart \
91+
--values helm_chart/values-openshift.yaml \
10292
--set registry.pullPolicy=IfNotPresent \
103-
--set registry.imagePullSecrets=<openshift-pull-secret> \
104-
helm_chart \
105-
--values helm_chart/values-openshift.yaml > operator.yaml
106-
oc apply -f operator.yaml
93+
--set registry.imagePullSecrets=<openshift-pull-secret>
10794
10895
.. include:: /includes/install/helm-install-os-options.rst
10996
11097
.. note::
11198
112-
You can also pass these values as options when you apply the
99+
Alternatively, you can pass these values as options when you apply the
113100
Helm Chart:
114101
115102
.. code-block:: sh
116103
117-
helm template \
104+
helm install <chart-name> helm_chart \
105+
--values helm_chart/values-openshift.yaml \
118106
--set registry.pullPolicy=IfNotPresent \
119107
--set registry.imagePullSecrets=<openshift-pull-secret> \
120-
--set namespace=<testNamespace> \
121-
helm_chart \
122-
--values helm_chart/values-openshift.yaml > operator.yaml
123-
oc apply -f operator.yaml
108+
--set namespace=<testNamespace>
124109
125110
k8sonlineupgrade: |
126111
127112
.. code-block:: sh
128113
129-
helm template helm_chart \
130-
--values helm_chart/values.yaml > operator.yaml
131-
kubectl apply -f operator.yaml
114+
kubectl apply -f crds.yaml
115+
helm upgrade <chart-name> helm_chart \
116+
--values helm_chart/values.yaml
132117
133118
.. include:: /includes/install/helm-install-k8s-options.rst
134119
135120
.. note::
136121
137-
You can also pass these values as options when you apply the
122+
Alternatively, you can pass these values as options when you apply the
138123
Helm Chart:
139124
140125
.. code-block:: sh
141126
142-
helm template \
143-
--set namespace=<testNamespace> \
144-
helm_chart \
145-
--values helm_chart/values.yaml > operator.yaml
146-
kubectl apply -f operator.yaml
127+
kubectl apply -f crds.yaml
128+
helm upgrade <chart-name> helm_chart \
129+
--values helm_chart/values.yaml \
130+
--set namespace=<testNamespace>
131+
132+
k8sofflineupgrade: |
133+
134+
Invoke the following ``kubectl`` and ``helm`` commands:
135+
136+
.. code-block:: sh
137+
138+
kubectl apply -f crds.yaml
139+
helm upgrade <chart-name> helm_chart \
140+
--values helm_chart/values.yaml \
141+
--set registry.pullPolicy=IfNotPresent
142+
143+
.. include:: /includes/install/helm-install-k8s-options.rst
144+
145+
.. note::
146+
147+
Alternatively, you can pass these values as options when you apply the
148+
Helm Chart:
149+
150+
.. code-block:: sh
151+
152+
kubectl apply -f crds.yaml
153+
helm install <chart-name> helm_chart \
154+
--values helm_chart/values.yaml \
155+
--set registry.pullPolicy=IfNotPresent \
156+
--set namespace=<testNamespace>
147157
148158
osonlineupgrade: |
149159
160+
.. include:: /includes/install/install-os-311-helm.rst
161+
162+
Invoke the following |oc| and ``helm`` commands:
163+
150164
.. code-block:: sh
151165
152-
helm template helm_chart \
153-
--values helm_chart/values-openshift.yaml > operator.yaml
154-
oc apply -f operator.yaml
166+
oc apply -f crds.yaml
167+
helm upgrade <chart-name> helm_chart \
168+
--values helm_chart/values-openshift.yaml
155169
156170
.. include:: /includes/install/helm-install-os-options.rst
157171
158172
.. note::
159173
160-
You can also pass these values as options when you apply the
174+
Alternatively, you can pass these values as options when you apply the
161175
Helm Chart:
162176
163177
.. code-block:: sh
164178
165-
helm template \
179+
oc apply -f crds.yaml
180+
helm upgrade <chart-name> helm_chart \
181+
--values helm_chart/values-openshift.yaml \
182+
--set registry.imagePullSecrets=<openshift-pull-secret>
183+
184+
osofflineupgrade: |
185+
186+
.. include:: /includes/install/install-os-311-helm.rst
187+
188+
Invoke the following |oc| and ``helm`` commands:
189+
190+
.. code-block:: sh
191+
192+
oc apply -f crds.yaml
193+
helm upgrade <chart-name> helm_chart \
194+
--values helm_chart/values-openshift.yaml \
195+
--set registry.pullPolicy=IfNotPresent \
196+
--set registry.imagePullSecrets=<openshift-pull-secret>
197+
198+
.. include:: /includes/install/helm-install-os-options.rst
199+
200+
.. note::
201+
202+
Alternatively, you can pass these values as options when you apply the
203+
Helm Chart:
204+
205+
.. code-block:: sh
206+
207+
oc apply -f crds.yaml
208+
helm install <chart-name> helm_chart \
209+
--values helm_chart/values-openshift.yaml \
210+
--set registry.pullPolicy=IfNotPresent \
166211
--set registry.imagePullSecrets=<openshift-pull-secret> \
167-
helm_chart \
168-
--values helm_chart/values-openshift.yaml > operator.yaml
169-
oc apply -f operator.yaml
212+
--set namespace=<testNamespace>
170213
171214
---
172215
title: "Connect to the internet."
@@ -177,7 +220,7 @@ title: "Disconnect from the internet."
177220
level: 4
178221
ref: helm-master-disconnect-internet
179222
---
180-
title: "Add your Openshift Pull Secret to the Openshift Values file"
223+
title: "Add your OpenShift Pull Secret to the OpenShift Values file."
181224
level: 4
182225
ref: helm-master-openshift-pull-secret
183226
content: |

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ replacement:
1111
1212
oc: |
1313
14+
.. include:: /includes/install/install-os-311-helm.rst
15+
16+
Invoke the following |oc| command:
17+
1418
.. code-block:: sh
1519
1620
oc apply -f crds.yaml

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

Lines changed: 1 addition & 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: "Install the |k8s-crds| for MongoDB deployments using the following |oc| command:"
14+
method: "Install the |k8s-crds| for MongoDB deployments."
1515
content: |
1616
1717
{{oc}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ inherit:
5555
ref: helm-master-install
5656
stepnum: 6
5757
replacement:
58-
method: "Install the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
58+
method: "Install the |k8s-op-short| with modified pull policy values."
5959
content: |
6060
6161
{{osoffline}}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ inherit:
3535
ref: helm-master-install
3636
stepnum: 5
3737
replacement:
38-
method: "Install the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
38+
method: "Install the |k8s-op-short| with modified pull policy values."
3939
content: |
4040
4141
{{osoffline}}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ stepnum: 1
77
replacement:
88
method: "Upgrade the latest version of the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
99
content: |
10-
{{k8soffline}}
10+
{{k8sofflineupgrade}}
1111
12-
...
12+
...

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ stepnum: 1
77
replacement:
88
method: "Upgrade the latest version of the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
99
content: |
10-
{{k8soffline}}
11-
...
10+
{{k8sofflineupgrade}}
11+
...

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ inherit:
55
ref: helm-master-install
66
stepnum: 1
77
replacement:
8-
method: "Upgrade the |k8s-op-short| using the following ``helm`` command:"
8+
method: "Upgrade the |k8s-op-short| using the following ``kubectl``
9+
and ``helm`` commands:"
910
content: |
1011
{{k8sonlineupgrade}}
11-
...
12+
...

0 commit comments

Comments
 (0)