(DOCSP-10838): Changes to Helm installation docs (#312)

* (DOCSP-10838): Changes to Helm installation docs

* Tech review

* Tech review 2

* Copy review

Author: melissamahoney-mongodb

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

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

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

@@ -0,0 +1,9 @@
+.. admonition:: OpenShift 3.11 or earlier
+   :class: note
+
+   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
+   following option:
+
+   .. literalinclude:: /includes/install/upgrade-crds-oc-helm.yaml
+       :language: yaml
+       :emphasize-lines: 2-3

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

@@ -0,0 +1,3 @@
+spec:
+  subresources:
+    status: {}

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

@@ -233,18 +233,3 @@
              registry:
                initOpsManager: registry.connect.redhat.com/mongodb
      -
-
-   * - ``subresourceEnabled``
-
-     - Creates the CRDs supporting the status subresource. Set to
-       "false" if you are running OpenShift 3.11 or earlier. Those
-       versions don't support subresources.
-
-       .. example::
-
-          .. code-block:: yaml
-             :emphasize-lines: 1
-
-             subresourceEnabled: false
-
-     - ``true``

source/includes/steps-helm-master.yaml

@@ -9,164 +9,207 @@ ref: helm-master-install
 replacement:
   k8sonline: |
 
-    Invoke the following ``helm`` and ``kubectl`` commands:
+    Invoke the following ``helm`` command:
 
     .. code-block:: sh
 
-        helm template helm_chart \
-             --values helm_chart/values.yaml > operator.yaml
-        kubectl apply -f operator.yaml
+        helm install <chart-name> helm_chart \
+             --values helm_chart/values.yaml
 
     .. include:: /includes/install/helm-install-k8s-options.rst
 
     .. note::
 
-        You can also pass these values as options when you apply the
+        Alternatively, you can pass these values as options when you apply the
         Helm Chart:
 
         .. code-block:: sh
 
-          helm template \
-               --set namespace=<testNamespace> \
-          helm_chart \
-               --values helm_chart/values.yaml > operator.yaml
-          kubectl apply -f operator.yaml
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values.yaml \
+               --set namespace=<testNamespace>
+
 
   k8soffline: |
 
-    Invoke the following ``helm`` and ``kubectl`` commands:
+    Invoke the following ``helm`` command:
 
     .. code-block:: sh
 
-       helm template \
-            --set registry.pullPolicy=IfNotPresent \
-       helm_chart \
-            --values helm_chart/values.yaml > operator.yaml
-       kubectl apply -f operator.yaml
+       helm install <chart-name> helm_chart \
+            --values helm_chart/values.yaml \
+            --set registry.pullPolicy=IfNotPresent
 
     .. include:: /includes/install/helm-install-k8s-options.rst
 
     .. note::
 
-       You can also pass these values as options when you apply the
+       Alternatively, you can pass these values as options when you apply the
        Helm Chart:
 
        .. code-block:: sh
 
-          helm template \
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values.yaml \
                --set registry.pullPolicy=IfNotPresent \
-               --set namespace=<testNamespace> \
-          helm_chart \
-               --values helm_chart/values.yaml > operator.yaml
-          kubectl apply -f operator.yaml
-
-  osonline: |
+               --set namespace=<testNamespace>
 
-    Invoke the following ``helm`` and ``oc`` commands:
 
-    .. code-block:: sh
+  osonline: |
 
-       helm template helm_chart \
-            --values helm_chart/values-openshift.yaml > operator.yaml
-       oc apply -f operator.yaml
+    .. include:: /includes/install/install-os-311-helm.rst
 
-    If you run |oc| 3.11 or earlier, add the ``--set subresourceEnabled=false``:
+    Invoke the following ``helm`` command:
 
     .. code-block:: sh
 
-        helm template helm_chart \
-             --values helm_chart/values.yaml \
-             --set subresourceEnabled=false > operator.yaml
-        kubectl apply -f operator.yaml
+       helm install <chart-name> helm_chart \
+            --values helm_chart/values-openshift.yaml
 
     .. include:: /includes/install/helm-install-os-options.rst
 
     .. note::
 
-       You can also pass these values as options when you apply the
+       Alternatively, you can pass these values as options when you apply the
        Helm Chart:
 
        .. code-block:: sh
 
-          helm template \
-               --set registry.imagePullSecrets=<openshift-pull-secret> \
-          helm_chart \
-               --values helm_chart/values-openshift.yaml > operator.yaml
-          oc apply -f operator.yaml
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values-openshift.yaml \
+               --set registry.imagePullSecrets=<openshift-pull-secret> 
 
   osoffline: |
 
+    .. include:: /includes/install/install-os-311-helm.rst
+
+    Invoke the following ``helm`` command:
+
     .. code-block:: sh
 
-       helm template \
+       helm install <chart-name> helm_chart \
+            --values helm_chart/values-openshift.yaml \
             --set registry.pullPolicy=IfNotPresent \
-            --set registry.imagePullSecrets=<openshift-pull-secret> \
-       helm_chart \
-            --values helm_chart/values-openshift.yaml > operator.yaml
-       oc apply -f operator.yaml
+            --set registry.imagePullSecrets=<openshift-pull-secret>
 
     .. include:: /includes/install/helm-install-os-options.rst
 
     .. note::
 
-       You can also pass these values as options when you apply the
+       Alternatively, you can pass these values as options when you apply the
        Helm Chart:
 
        .. code-block:: sh
 
-          helm template \
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values-openshift.yaml \
                --set registry.pullPolicy=IfNotPresent \
                --set registry.imagePullSecrets=<openshift-pull-secret> \
-               --set namespace=<testNamespace> \
-          helm_chart \
-               --values helm_chart/values-openshift.yaml > operator.yaml
-          oc apply -f operator.yaml
+               --set namespace=<testNamespace>
 
   k8sonlineupgrade: |
 
     .. code-block:: sh
 
-        helm template helm_chart \
-             --values helm_chart/values.yaml > operator.yaml
-        kubectl apply -f operator.yaml
+        kubectl apply -f crds.yaml
+        helm upgrade <chart-name> helm_chart \
+             --values helm_chart/values.yaml 
 
     .. include:: /includes/install/helm-install-k8s-options.rst
 
     .. note::
 
-        You can also pass these values as options when you apply the
+        Alternatively, you can pass these values as options when you apply the
         Helm Chart:
 
         .. code-block:: sh
 
-          helm template \
-               --set namespace=<testNamespace> \
-          helm_chart \
-               --values helm_chart/values.yaml > operator.yaml
-          kubectl apply -f operator.yaml
+          kubectl apply -f crds.yaml
+          helm upgrade <chart-name> helm_chart \
+               --values helm_chart/values.yaml \
+               --set namespace=<testNamespace>
+
+  k8sofflineupgrade: |
+
+    Invoke the following ``kubectl`` and ``helm`` commands:
+
+    .. code-block:: sh
+
+       kubectl apply -f crds.yaml
+       helm upgrade <chart-name> helm_chart \
+            --values helm_chart/values.yaml \
+            --set registry.pullPolicy=IfNotPresent
+
+    .. include:: /includes/install/helm-install-k8s-options.rst
+
+    .. note::
+
+       Alternatively, you can pass these values as options when you apply the
+       Helm Chart:
+
+       .. code-block:: sh
+
+          kubectl apply -f crds.yaml
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values.yaml \
+               --set registry.pullPolicy=IfNotPresent \
+               --set namespace=<testNamespace>
 
   osonlineupgrade: |
 
+    .. include:: /includes/install/install-os-311-helm.rst
+
+    Invoke the following |oc| and ``helm`` commands:
+
     .. code-block:: sh
 
-       helm template helm_chart \
-             --values helm_chart/values-openshift.yaml > operator.yaml
-       oc apply -f operator.yaml
+       oc apply -f crds.yaml
+       helm upgrade <chart-name> helm_chart \
+             --values helm_chart/values-openshift.yaml
 
     .. include:: /includes/install/helm-install-os-options.rst
 
     .. note::
 
-       You can also pass these values as options when you apply the
+       Alternatively, you can pass these values as options when you apply the
        Helm Chart:
 
        .. code-block:: sh
 
-          helm template \
+          oc apply -f crds.yaml
+          helm upgrade <chart-name> helm_chart \
+               --values helm_chart/values-openshift.yaml \
+               --set registry.imagePullSecrets=<openshift-pull-secret>
+
+  osofflineupgrade: |
+
+    .. include:: /includes/install/install-os-311-helm.rst
+
+    Invoke the following |oc| and ``helm`` commands:
+
+    .. code-block:: sh
+
+       oc apply -f crds.yaml
+       helm upgrade <chart-name> helm_chart \
+            --values helm_chart/values-openshift.yaml \
+            --set registry.pullPolicy=IfNotPresent \
+            --set registry.imagePullSecrets=<openshift-pull-secret>
+
+    .. include:: /includes/install/helm-install-os-options.rst
+
+    .. note::
+
+       Alternatively, you can pass these values as options when you apply the
+       Helm Chart:
+
+       .. code-block:: sh
+
+          oc apply -f crds.yaml
+          helm install <chart-name> helm_chart \
+               --values helm_chart/values-openshift.yaml \
+               --set registry.pullPolicy=IfNotPresent \
                --set registry.imagePullSecrets=<openshift-pull-secret> \
-          helm_chart \
-               --values helm_chart/values-openshift.yaml > operator.yaml
-          oc apply -f operator.yaml
+               --set namespace=<testNamespace>
 
 ---
 title: "Connect to the internet."
@@ -177,7 +220,7 @@ title: "Disconnect from the internet."
 level: 4
 ref: helm-master-disconnect-internet
 ---
-title: "Add your Openshift Pull Secret to the Openshift Values file"
+title: "Add your OpenShift Pull Secret to the OpenShift Values file."
 level: 4
 ref: helm-master-openshift-pull-secret
 content: |

source/includes/steps-install-master.yaml

@@ -11,6 +11,10 @@ replacement:
 
   oc: |
 
+    .. include:: /includes/install/install-os-311-helm.rst
+
+    Invoke the following |oc| command:
+
     .. code-block:: sh
       
        oc apply -f crds.yaml

source/includes/steps-install-oc.yaml

@@ -11,7 +11,7 @@ inherit:
   ref: install-master-crds
 stepnum: 2
 replacement:
-  method: "Install the |k8s-crds| for MongoDB deployments using the following |oc| command:"
+  method: "Install the |k8s-crds| for MongoDB deployments."
 content: |
 
   {{oc}}

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

@@ -55,7 +55,7 @@ inherit:
   ref: helm-master-install
 stepnum: 6
 replacement:
-  method: "Install the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
+  method: "Install the |k8s-op-short| with modified pull policy values."
 content: |
 
   {{osoffline}}

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

@@ -35,7 +35,7 @@ inherit:
   ref: helm-master-install
 stepnum: 5
 replacement:
-  method: "Install the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
+  method: "Install the |k8s-op-short| with modified pull policy values."
 content: |
 
   {{osoffline}}

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

@@ -7,6 +7,6 @@ stepnum: 1
 replacement:
   method: "Upgrade the latest version of the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
 content: |
-  {{k8soffline}}
+  {{k8sofflineupgrade}}
 
-...
+...