(DOCSP-18726) Helm Charts Installation (#859)

* first commit, to be continued

* Interim commit, to be continued

* removing the step about cd to directory, as not needed

* Build issues

* fixing build errors

* Fixing warnings

* warnings

* Made changes to the updgrade commands

* Changed the syntax for setting the namespace

* First round of copy review, to be continued

* Fixing the build

* Finish including copy and tech review comments from the first round. Ready for a review by John W

* One more change, ready for a review

* Addressed a few more comments from Rodrigo

* Halfway through the copy review, to be continued

* Added copy review

* Ready for a review

* Restaging

* Address comment from Rodrigo in steps-helm-master

* Tech review

* indentation

* Remaining edits: removed 1.7.1 steps from upgrades, removed update crd steps from upgrades, removed step 2 from plan-considerations topic as not relevant. Ready for the tech review by Mircea

Author: JuliaMongo

conf.py

@@ -245,6 +245,7 @@
     'k8sdocs': ('https://kubernetes.io/docs%s', ''),
     'v1.2': ('https://www.mongodb.com/docs/kubernetes-operator/v1.2%s', ''),
     'github' : ('https://github.com%s', ''),
+    'github-raw' : ('https://raw.githubusercontent.com%s', ''),
     'mdb-github' : ('https://mongodb.github.io%s', ''),
     'gopkg' : ('https://godoc.org%s',''),
     'npmjs' : ('https://www.npmjs.com/package%s',''),

source/includes/code-examples/yaml-files/example-watch-namespaces-env-helm.yaml

@@ -5,5 +5,7 @@
 
       # Operator with name `mongodb-enterprise-operator-qa-envs` will
       # watch ns-dev, ns-qa and ns-uat namespaces
-      helm install mongodb-operator helm_chart --set operator.watchNamespace="ns-dev\,ns-qa\,ns-uat" mongodb-enterprise-operator-qa-envs
+
+      helm install mongodb-enterprise-operator-qa-envs mongodb/enterprise-operator \
+        --set operator.watchNamespace="ns-dev\,ns-qa\,ns-uat"
 

source/includes/code-examples/yaml-files/example-watch-one-namespace-helm.yaml

@@ -4,5 +4,6 @@
       :emphasize-lines: 2
 
       # Watch one namespace
-      helm install mongodb-operator helm_chart --set operator.watchNamespace='namespace-to-watch' <...>
+      helm install enterprise-operator mongodb/enterprise-operator \
+        --set operator.watchNamespace='namespace-to-watch' <...>
 

source/includes/code-examples/yaml-files/example-watch-two-namespaces-helm.yaml

@@ -4,5 +4,6 @@
       :emphasize-lines: 2
 
       # Watch both namespace-a and namespace-b
-      helm install mongodb-operator helm_chart --set operator.watchNamespace="namespace-a\,namespace-b"
+      helm install enterprise-operator mongodb/enterprise-operator \
+        --set operator.watchNamespace="namespace-a\,namespace-b"
 

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

@@ -11,4 +11,5 @@ content: |
   .. code-block:: sh
 
      kubectl config set-context $(kubectl config current-context) --namespace=<metadata.namespace>
+
 ...

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

@@ -1,7 +1,13 @@
 ---
-title: "Change to the directory in which you cloned the repository."
 level: 4
-ref: helm-master-cd
+ref: install-helm-charts
+title: "Add the :mdb-github:`MongoDB Helm Charts for Kubernetes </helm-charts>` repository to Helm."
+content: |
+
+  .. code-block:: sh
+
+     helm repo add mongodb https://mongodb.github.io/helm-charts
+
 ---
 title: "Customize your Helm Chart before upgrading it."
 level: 4
@@ -18,57 +24,63 @@ ref: helm-master-install
 replacement:
   k8sonline: |
 
-    Invoke the following ``helm`` command:
+    Install :mdb-github:`MongoDB Helm Charts for Kubernetes </helm-charts>`.
+    The following command installs the |k8s-crds| and the |k8s-op-short|
+    in the current namespace named ``default``.
 
     .. code-block:: sh
 
-        helm install <chart-name> helm_chart \
-             --values helm_chart/values.yaml
+       helm install enterprise-operator mongodb/enterprise-operator
 
     To learn about optional |k8s-op-short| installation settings, see
     :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
-  k8soffline: |
-
-    Invoke the following ``helm`` command:
+    You can specify a different namespace with:
 
     .. code-block:: sh
 
-       helm install <chart-name> helm_chart \
-            --values helm_chart/values.yaml \
-            --set registry.pullPolicy=IfNotPresent
+       helm install enterprise-operator mongodb/enterprise-operator --namespace mongodb [--create-namespace]
+
+  k8soffline: |
 
+    Install :mdb-github:`MongoDB Helm Charts for Kubernetes </helm-charts>`
+    and set the value of ``registry.pullPolicy`` to ``IfNotPresent``.
     To learn about optional |k8s-op-short| installation settings, see
     :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
-  osonline: |
+    .. code-block:: sh
 
-    .. include:: /includes/install/install-os-311-helm.rst
+       helm install enterprise-operator mongodb/enterprise-operator \
+         --set registry.pullPolicy='IfNotPresent'
 
-    Invoke the following ``helm`` command:
+  osonline: |
+
+    Install :mdb-github:`MongoDB Helm Charts for Kubernetes </helm-charts>`:
 
     .. code-block:: sh
 
-       helm install <chart-name> helm_chart \
-            --values helm_chart/values-openshift.yaml
+       helm install enterprise-operator mongodb/enterprise-operator \
+         --values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
 
-    To learn about optional |k8s-op-short| installation settings, see
-    :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
+    Use the :github-raw:`values-openshift.yaml </mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`
+    settings. To learn about optional |k8s-op-short| installation settings,
+    see :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
   osoffline: |
 
-    .. include:: /includes/install/install-os-311-helm.rst
-
-    Invoke the following ``helm`` command:
+    Install :mdb-github:`MongoDB Helm Charts for Kubernetes </helm-charts>`:
 
     .. code-block:: sh
 
-       helm install <chart-name> helm_chart \
-            --values helm_chart/values-openshift.yaml \
-            --set registry.pullPolicy=IfNotPresent \
-            --set registry.imagePullSecrets=<openshift-pull-secret>
+       helm install enterprise-operator mongodb/enterprise-operator \
+         --set registry.pullPolicy='IfNotPresent' \
+         --set registry.imagePullSecrets='<openshift-pull-secret>' \
+         --values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
 
-    To learn about optional |k8s-op-short| installation settings, see
+    Use the :github-raw:`values-openshift.yaml </mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`
+    settings, ``registry.pullPolicy=IfNotPresent``, and
+    ``registry.imagePullSecrets=<openshift-pull-secret>``. To learn
+    about optional |k8s-op-short| installation settings, see
     :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
   k8sonlineupgrade: |
@@ -77,86 +89,50 @@ replacement:
 
     .. code-block:: sh
 
-        helm upgrade <chart-name> helm_chart \
-             --values helm_chart/values.yaml
-
-
-  k8sonlineupgradev161: |
-    
-    Invoke the following ``helm`` command:
-
-    .. code-block:: sh
-
-        helm upgrade <chart-name> helm_chart \
-             --values helm_chart/values.yaml
+        helm upgrade enterprise-operator mongodb/enterprise-operator
 
   k8sofflineupgrade: |
 
-    Invoke the following ``helm`` command to upgrade with modified pull
-    policy values: 
-
-    .. code-block:: sh
-
-       helm upgrade <chart-name> helm_chart \
-            --values helm_chart/values.yaml \
-            --set registry.pullPolicy=IfNotPresent
-
-  k8sofflineupgradev161: |
-
-    Invoke the following ``helm`` command to upgrade with modified pull
-    policy values: 
+    Invoke the following ``helm upgrade`` command.
+    Use the ``registry.pullPolicy=IfNotPresent`` setting. To learn
+    about optional |k8s-op-short| installation settings, see
+    :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
     .. code-block:: sh
 
-       helm upgrade <chart-name> helm_chart \
-            --values helm_chart/values.yaml \
-            --set registry.pullPolicy=IfNotPresent
+       helm upgrade enterprise-operator mongodb/enterprise-operator \
+         --set registry.pullPolicy='IfNotPresent'
 
   osonlineupgrade: |
 
-    .. include:: /includes/install/install-os-311-helm.rst
-
-    Invoke the following ``helm`` command:
-
-    .. code-block:: sh
-
-       helm upgrade <chart-name> helm_chart \
-             --values helm_chart/values-openshift.yaml
-
-  osonlineupgradev161: |
-
-    Invoke the following ``helm`` command:
+    Invoke the following ``helm upgrade`` command.
+    Use :github-raw:`values-openshift.yaml </mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>` settings. To learn
+    about optional |k8s-op-short| installation settings, see
+    :ref:`Operator Helm Installation Settings<meko-op-install-settings-helm>`.
 
     .. code-block:: sh
 
-       helm upgrade <chart-name> helm_chart \
-             --values helm_chart/values-openshift.yaml
+       helm upgrade enterprise-operator mongodb/enterprise-operator \
+         --values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
 
   osofflineupgrade: |
 
-    .. include:: /includes/install/install-os-311-helm.rst
 
-    Invoke the following ``helm`` command with
-    modified pull policy values:
+    Invoke the following ``helm upgrade`` command:
 
     .. code-block:: sh
 
-       helm upgrade <chart-name> helm_chart \
-            --values helm_chart/values-openshift.yaml \
-            --set registry.pullPolicy=IfNotPresent \
-            --set registry.imagePullSecrets=<openshift-pull-secret>
-
-  osofflineupgradev161: |
-
-    Invoke the following ``helm`` command with
-    modified pull policy values:
+       helm upgrade enterprise-operator mongodb/enterprise-operator \
+           --set registry.pullPolicy='IfNotPresent' \
+           --set registry.imagePullSecrets='<openshift-pull-secret>' \
+           --values https://raw.githubusercontent.com/mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml
 
-    .. code-block:: sh
+    Use the :github-raw:`values-openshift.yaml </mongodb/helm-charts/main/charts/enterprise-operator/values-openshift.yaml>`
+    settings, ``registry.pullPolicy=IfNotPresent``, and
+    ``registry.imagePullSecrets=<openshift-pull-secret>``. To learn
+    about optional |k8s-op-short| installation settings, see
+    :ref:`Operator Helm Installation Settings <meko-op-install-settings-helm>`.
 
-       helm upgrade <chart-name> helm_chart \
-            --values helm_chart/values-openshift.yaml \
-            --set registry.pullPolicy=IfNotPresent \
-            --set registry.imagePullSecrets=<openshift-pull-secret>
 ---
 title: "Connect to the internet."
 level: 4
@@ -165,24 +141,6 @@ ref: helm-master-connect-internet
 title: "Disconnect from the internet."
 level: 4
 ref: helm-master-disconnect-internet
----
-title: "Add your OpenShift Pull Secret to the OpenShift Values file."
-level: 4
-ref: helm-master-openshift-pull-secret
-content: |
-
-  Add the name of your ``<openshift-pull-secret>`` to the
-  ``registry.imagePullSecrets`` setting in the
-  ``helm_chart/values-openshift.yaml`` file.
-  To learn more, see the ``registry.imagePullSecrets`` setting in the
-  :doc:`Helm installation settings </reference/helm-operator-settings>`.
-
-  .. code-block:: sh
-     :emphasize-lines: 3
-
-     registry:
-     # The pull secret must be specified
-       imagePullSecrets: <openshift-pull-secret>
 
 ---
 title: "Export the |k8s-op-short| images as ``.tar`` archive files:"

source/includes/steps-configure-kubectl-namespace.yaml

@@ -41,13 +41,19 @@ content: |
   {{quayimport}}
 
   {{versions}}
+---
+ref: helm-k8s-online-install
+inherit:
+  file: steps-helm-master.yaml
+  ref: install-helm-charts
+stepnum: 5
 
 ---
 ref: helm-k8s-offline-install-host
 inherit:
   file: steps-helm-master.yaml
   ref: helm-master-install
-stepnum: 5
+stepnum: 6
 replacement:
   method: "Install the |k8s-op-short| with modified pull policy values using the following ``helm`` command:"
 content: |

source/includes/steps-helm-master.yaml

@@ -1,17 +1,18 @@
 ---
-ref: helm-k8s-online-cd
+ref: helm-k8s-online-install
 inherit:
   file: steps-helm-master.yaml
-  ref: helm-master-cd
+  ref: install-helm-charts
 stepnum: 1
+
 ---
-ref: helm-k8s-online-install
+ref: helm-k8s-online-install-crds
 inherit:
   file: steps-helm-master.yaml
   ref: helm-master-install
 stepnum: 2
 replacement:
-  method: "Install the |k8s-op-short| using the following ``helm`` command:"
+  method: "Install the |k8s-op-short|:"
 content: |
 
   {{k8sonline}}