(DOCSP-8462): AppDB support for offline mode (#183)

* (DOCSP-8462): AppDB support for offline mode

* (DOCSP-8462): Copy & tech review

* (DOCSP-8462): Source constant, version fixes

* (DOCSP-8462): Final copy review

Author: melissamahoney-mongodb

conf.py

@@ -61,7 +61,10 @@
     'k8s-op-short': 'Kubernetes Operator',
     'aagent': 'MongoDB Agent or legacy Automation Agent',
     'aagents': 'MongoDB Agents or legacy Automation Agents',
-    'mdbagent': 'MongoDB Agent'
+    'mdbagent': 'MongoDB Agent',
+    'bndl-version': '4.2.2',
+    'bndl-version-val': '``4.2.2-ent``'
+
 }
 
 rst_epilog = '\n'.join([

snooty.toml

@@ -4,3 +4,5 @@ name = "k8s-operator"
 aagent = "MongoDB Agent or legacy Automation Agent"
 aagents = "MongoDB Agents or legacy Automation Agents"
 k8s-op-short = "Kubernetes Operator"
+bndl-version = "4.2.2"
+bndl-version-val = "``4.2.2-ent``"

source/includes/admonitions/note-deploy-om-offline.rst

@@ -0,0 +1,7 @@
+.. admonition:: Deploy Ops Manager Resource Offline
+   :class: note
+
+   To deploy |onprem| inside |k8s| without an Internet connection,
+   omit this setting or leave the value empty. The |k8s-op-short|
+   installs the :ref:`bundled MongoDB Enterprise
+   <app-db-offline>` version {+bndl-version+} by default. 

source/includes/steps-deploy-k8s-opsmgr.yaml

@@ -188,15 +188,19 @@ content: |
 
       * - | ``spec``
           | ``.applicationDatabase``
-          | ``.``:setting:`~spec.version`
+          | ``.``:opsmgrkube:`~spec.applicationDatabase.version`
         - string
-        - Version of MongoDB that the :ref:`mms-application-database`
+        - *Optional*.
+          
+          Version of MongoDB that the :ref:`mms-application-database`
           should run.
           
           The format should be ``X.Y.Z`` for the Community edition and
           ``X.Y.Z-ent`` for the :product:`Enterprise edition 
           </mongodb-enterprise-advanced>`.
 
+          .. include:: /includes/admonitions/note-deploy-om-offline.rst
+
           To learn more about MongoDB versioning, see see
           :ref:`release-version-numbers` in the MongoDB Manual.
         - ``4.0.7``

source/reference/k8s-operator-om-specification.txt

@@ -92,19 +92,24 @@ resources.
    :opsmgr:`Global Owner </reference/user-roles/#global-automation-admin-role>`
    role.      
 
+.. opsmgrkube:: spec.applicationDatabase.members
+
+   *Type*: integer
+
+   *Required*. Number of members in the :opsmgr:`Application Database
+   </core/system-overview/#application-database>` replica set.
+
+Optional |onprem| Resource Settings
+-----------------------------------
+
+|onprem| resources can use the following settings:
+
 .. opsmgrkube:: spec.applicationDatabase
 
    *Type*: collection
 
-   *Required*. |onprem| :opsmgr:`Application Database </core/system-overview/#application-database>` 
+   |onprem| :opsmgr:`Application Database </core/system-overview/#application-database>` 
    resource definition. 
-
-   The following settings from the 
-   :ref:`replica set <replica-set-settings>` resource specification are
-   required:
-
-   - ``spec.applicationDatabase.``:setting:`~spec.members`
-   - ``spec.applicationDatabase.``:setting:`~spec.version`
 
    The following settings from the  
    :ref:`replica set <replica-set-settings>` resource specification are
@@ -124,7 +129,7 @@ resources.
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.podAffinity`
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.podAntiAffinityTopologyKey`
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.nodeAffinity`
-
+   - :opsmgrkube:`spec.applicationDatabase.version`
 
    Do not use the following settings from the  
    :ref:`replica set <replica-set-settings>` resource specification:
@@ -135,10 +140,23 @@ resources.
    - :setting:`spec.opsManager.configMapRef.name` 
    - :setting:`spec.credentials`
 
-Optional |onprem| Resource Settings
------------------------------------
+.. opsmgrkube:: spec.applicationDatabase.version
 
-|onprem| resources can use the following settings:
+   *Type*: number
+
+   Version of MongoDB that is installed on the |onprem|
+   :opsmgr:`Application Database
+   </core/system-overview/#application-database>`.
+
+   Default value is {+bndl-version-val+}.
+
+   .. include:: /includes/admonitions/note-deploy-om-offline.rst
+
+   .. note::
+
+      If you update this value to a later version, consider setting
+      :setting:`spec.featureCompatibilityVersion` to give yourself the
+      option to downgrade if necessary.
 
 .. opsmgrkube:: spec.backup.enabled
 

source/release-notes.txt

@@ -41,11 +41,12 @@ MongoDB Resource Changes
 |onprem| Resource Changes (Beta Release)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Adds offline mode support for the application database. Bundles 
-  MongoDB Enterprise version 4.2.2 with the application database image.
-  Internet access is not required to install the application database if
-  :opsmgrkube:`spec.applicationDatabase.version` is set to ``4.2.2-ent`` 
-  or omitted.
+- Adds :ref:`offline mode support <app-db-offline>` for the Application
+  Database. Bundles MongoDB Enterprise version 4.2.2 with the
+  Application Database image. Internet access is not required to install
+  the application database if
+  :opsmgrkube:`spec.applicationDatabase.version` is set to ``4.2.2-ent``
+  or omitted. 
 - Renames the ``spec.clusterName`` setting to 
   :opsmgrkube:`spec.clusterDomain`.
 - |onprem| images for versions 4.2.6 and 4.2.7 are available.

source/tutorial/plan-om-resource.txt

@@ -138,6 +138,26 @@ different user:
 2. :manual:`Add a new user </reference/method/db.createUser/>` to
    the database using the ``mongo`` shell.
 
+.. _app-db-offline:
+
+Offline Deployments
++++++++++++++++++++
+
+The |k8s-op-short| bundles MongoDB Enterprise version {+bndl-version+}
+with the :opsmgr:`Application Database
+</core/system-overview/#application-database>` image to enable offline
+deployments of |onprem| resources.  
+
+To deploy |onprem| inside |k8s| without an Internet connection, omit the
+:opsmgrkube:`spec.applicationDatabase.version` setting or leave the
+value empty. 
+
+When you upgrade the |k8s-op-short|, the Application
+Database performs a rolling upgrade for new patch releases of MongoDB,
+such as from ``4.2.2-ent`` to ``4.2.3-ent``. However, the Application
+Database does not automatically upgrade between major versions,
+such as from ``4.2.2-ent`` to ``4.4.0-ent``.
+
 .. _om-rsrc-backup:
 
 Backup