DOCSP-5002 - Refactor upgrade for v0.11 (#25)

* DOCSP-5002 - Refactor upgrade for v0.11

* DOCSP-5002 - Clean up build errors and simplify version caveats.

* DOCSP-5002 - Clarify versions.

* DOCSP-5002 - Copy review edits.

Author: jdestefano-mongo

conf.py

@@ -38,7 +38,8 @@
     'fixed_only',
     'tabs',
     'icon',
-    'source_constants'
+    'source_constants',
+    'xmlrole'
 ]
 
 templates_path = ['.templates']
@@ -138,6 +139,7 @@
     '.. |kdc| replace:: :abbr:`KDC (Key Distribution Center)`',
     '.. |kmip| replace:: :abbr:`KMIP (Key Management Interoperability)`',
     '.. |kms| replace:: :abbr:`KMS (Key Management Service)`',
+    '.. |kubectl| replace:: :xml:`<mono><link target="https://kubernetes.io/docs/reference/kubectl/kubectl/">kubectl</link></mono>`',
     '.. |ldaps| replace:: :abbr:`LDAPS (Secure Lightweight Directory Access Protocol)`',
     '.. |ldap| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`',
     '.. |mms-full| replace:: :opsmgr:`MongoDB Ops Manager </>`',

source/includes/toc-installation.yaml

@@ -0,0 +1,14 @@
+file: /tutorial/install-k8s-operator
+description:
+  Install the |k8s-op-full|.
+---
+file: /tutorial/upgrade-k8s-operator
+description: |
+  Follow this upgrade procedure if you are running version 0.10 or
+  later.
+---
+file: /tutorial/upgrade-k8s-operator-v9-and-earlier
+description:
+  Follow this upgrade procedure if you are running version 0.9 or
+  earlier.
+...

source/includes/upgrade-k8s-operator.rst

@@ -0,0 +1,138 @@
+1. Change to the directory in which you cloned the |k8s-op-short|
+   repository. The following steps depend on how your environment is
+   configured:
+
+.. tabs::
+
+   tabs:
+     - id: kubectl
+       name: Online using kubectl
+       content: |
+
+         .. _upgrade-k8s-operator-kubectl:
+
+         2. Upgrade the |k8s-crds| for MongoDB deployments using the
+            following |kubectl| command:
+
+            .. code-block:: sh
+
+               kubectl apply -f crds.yaml
+
+         #. If you use `OpenShift <https://www.openshift.com/>`__ as
+            your |k8s| orchestrator, you need to allow OpenShift to
+            manage the Security Context for the |k8s-op-short|.
+
+            Change the ``MANAGED_SECURITY_CONTEXT`` value as described
+            in the next step.
+
+         #. You can edit the Operator |yaml| file to further customize
+            your Operator before upgrading it.
+
+            a. Open your ``mongodb-enterprise.yaml`` in your preferred
+               text editor.
+
+            #. You may need to add one or more of the following
+               options:
+
+               .. include:: /includes/list-table-k8s-kubectl-install-options.rst
+
+               .. note::
+
+                  Any values enclosed in single or double quotes
+                  *require* those quotes. Include the quotes when
+                  setting these values.
+
+         #. Upgrade the |k8s-op-short| using the following
+            |kubectl| command:
+
+            .. code-block:: sh
+
+               kubectl apply -f mongodb-enterprise.yaml
+
+         To troubleshoot your |k8s-op-short|, see
+         :ref:`review-k8s-op-logs`.
+
+         .. include:: /includes/fact-remove-k8s-resources-first.rst
+
+     - id: helmonline
+       name: Online using Helm
+       content: |
+
+         .. _upgrade-k8s-operator-helm:
+
+         2. Upgrade the latest version of the |k8s-op-short| using the
+            following ``helm`` command:
+
+            .. code-block:: sh
+
+               helm template public/helm_chart > operator.yaml
+               kubectl apply -f operator.yaml 
+
+            You can customize your Chart before installing it by using
+            the ``--set`` option. For this Chart, you may need to add
+            one or more of the following options:
+
+            .. include:: /includes/list-table-k8s-helm-install-options-online.rst
+
+         To troubleshoot your |k8s-op-short|, see
+         :ref:`review-k8s-op-logs`.
+
+         .. include:: /includes/fact-remove-k8s-resources-first.rst
+
+     - id: helmoffline
+       name: Offline using Helm and Docker
+       content: |
+
+         To upgrade the |k8s-op-short| on a host not connected to the
+         Internet, you have two options, you can download the
+         |k8s-op-short| files from either:
+
+         .. tabs::
+
+            tabs:
+              - id: internet
+                name: The Internet
+                content: |
+
+                  2. Upgrade the latest version of the |k8s-op-short|
+                     with modified pull policy values using the
+                     following ``helm`` command:
+
+                     .. code-block:: sh
+
+                        helm template --set registry.pullPolicy=IfNotPresent \
+                          public/helm_chart > operator.yaml
+                        kubectl apply -f operator.yaml 
+
+                     You can further customize your Chart before
+                     installing it by using the ``--set`` option. For
+                     this Chart, you may need to add one or more of the
+                     following options:
+
+                     .. include:: /includes/list-table-k8s-helm-install-options-offline.rst
+
+                  To troubleshoot your |k8s-op-short|, see
+                  :ref:`review-k8s-op-logs`.
+
+                  .. include:: /includes/fact-remove-k8s-resources-first.rst
+
+              - id: host
+                name: Another Host
+                content: |
+
+                  2. Upgrade the latest version of the |k8s-op-short|
+                     with modified pull policy values using the
+                     following ``helm`` command:
+
+                     .. code-block:: sh
+
+                        helm template --set registry.pullPolicy=IfNotPresent \
+                          public/helm_chart > operator.yaml
+                        kubectl apply -f operator.yaml 
+
+                     You can further customize your Chart before
+                     installing it by using the ``--set`` option. For
+                     this Chart, you may need to add one or more of the
+                     following options:
+
+                     .. include:: /includes/list-table-k8s-helm-install-options-offline.rst

source/installation.txt

@@ -0,0 +1,26 @@
+:noprevnext:
+
+============
+Installation
+============
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. include:: /includes/toc/dfn-list-installation.rst
+
+.. include:: /includes/toc/installation.rst
+
+.. class:: hidden
+
+   .. toctree::
+      :titlesonly:
+
+      /tutorial/install-k8s-operator
+      /tutorial/upgrade-k8s-operator
+      /tutorial/upgrade-k8s-operator-v9-and-earlier