(DOCSP-29890) Updates docs for new appDB Docker image repo and tags. (#1343)

* (DOCSP-29890) Changes -ent Helm tag suffix to -ubi8.

* Adds new environment variables.

* Revises per tech review.

* Updates MDB version in examples, creates an include, adds note to upgrade doc.

* Updates Ubuntu-to-ubi migration doc.

* Adds link.

* De-emphasizes using Ubuntu images.

* Edits per tech and copy reviews.

* Revises per tech review.

Author: erabil-mdb

source/includes/facts/fact-must-migrate-specified-appdb.rst

@@ -6,7 +6,7 @@ MongoDB version for the :opsmgr:`Application Database
 </core/system-overview/#application-database>` in the required
 :opsmgrkube:`spec.applicationDatabase.version` setting.
 For the list of supported MongoDB versions, see the
-:qr-mdb:`container registry </mongodb-enterprise-appdb-database?tab=tags>`.
+:qr-mdb:`container registry </mongodb-enterprise-server?tab=tags>`.
 
 You must migrate the Application Database to the latest available
 enterprise edition of MongoDB if your ``MongoDBOpsManager`` custom

source/includes/facts/fact-which-appdb-version.rst

@@ -1,4 +1,3 @@
 For best results, use the
-:qr-mdb:`latest available enterprise MongoDB version </mongodb-enterprise-appdb-database?tab=tags>`
-that is :ref:`compatible <k8s-onprem-version-compatibility>` with your
+:qr-mdb:`latest available enterprise MongoDB version </mongodb-enterprise-server?tab=tags>` that is :ref:`compatible <k8s-onprem-version-compatibility>` with your
 |onprem| version.

source/includes/steps-configure-cert-manager-integration.yaml

@@ -273,7 +273,7 @@ content: |
               certsSecretPrefix: appdb
               tls:
                 ca: ca-issuer
-            version: 6.0.0
+            version: 6.0.0-ubi8
           replicas: 1
           security:
             certsSecretPrefix: mdb

source/includes/steps-configure-filesystem-store.yaml

@@ -89,7 +89,7 @@ content: |
                             mountPath: /snapshot_store  
           applicationDatabase:
             members: 3
-            version: 5.0.7-ent
+            version: 5.0.7-ubi8
 
 ---
 title: "Apply changes to your |onprem| deployment."

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

@@ -122,7 +122,7 @@ content: |
           should run.
 
           The format should be ``X.Y.Z`` for the Community edition and
-          ``X.Y.Z-ent`` for the :product:`Enterprise edition
+          ``X.Y.Z-ubi8`` for the :product:`Enterprise edition
           </mongodb-enterprise-advanced>`.
 
           .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
@@ -380,7 +380,7 @@ content: |
           members: 3
           phase: Running
           type: ReplicaSet
-          version: "4.2.11-ent"
+          version: "4.4.5-ubi8"
        backup:
         lastTransition: "2020-04-01T09:57:42Z"
         message: The MongoDB object <namespace>/<oplogresourcename> 
@@ -501,7 +501,7 @@ content: |
           members: 3
           phase: Running
           type: ReplicaSet
-          version: "4.2.11-ent"
+          version: "4.4.5-ubi8"
        backup:
         lastTransition: "2020-04-01T09:57:42Z"
         message: The MongoDB object <namespace>/<oplogresourcename> 
@@ -583,7 +583,7 @@ content: |
          members: 3
          phase: Running
          type: ReplicaSet
-         version: "4.2.11-ent"
+         version: "4.4.5-ubi8"
        backup:
          lastTransition: "2020-04-01T10:00:53Z"
          phase: Running

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

@@ -244,9 +244,10 @@ content: |
           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>`.
+          The format should be
+          ``X.Y.Z-ubi8`` for the :product:`Enterprise edition
+          </mongodb-enterprise-advanced>` and ``X.Y.Z`` for the Community edition.
+          Do not add the ``-ubi8`` tag suffix to the Community edition image because the |k8s-op-short| adds the tag suffix automatically.
 
           .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
 
@@ -540,7 +541,7 @@ content: |
           members: 3
           phase: Running
           type: ReplicaSet
-          version: "4.2.0"
+          version: "4.4.5-ubi8"
        backup:
         lastTransition: "2020-04-01T09:57:42Z"
         message: The MongoDB object <namespace>/<oplogresourcename>
@@ -575,7 +576,7 @@ content: |
           members: 3
           phase: Running
           type: ReplicaSet
-          version: "4.2.11-ent"
+          version: "4.4.5-ubi8"
         opsManager:
           lastTransition: "2019-12-06T18:23:26Z"
           message: The MongoDB object namespace/oplogdbname doesn't exist
@@ -697,7 +698,7 @@ content: |
             members: 3
             phase: Running
             type: ReplicaSet
-            version: "4.2.11-ent"
+            version: "4.4.5-ubi8"
           opsManager:
             lastTransition: "2019-12-06T18:23:26Z"
             message: The MongoDB object namespace/oplogdbname doesn't exist
@@ -775,7 +776,7 @@ content: |
          members: 3
          phase: Running
          type: ReplicaSet
-         version: "4.2.11-ent"
+         version: "4.4.5-ubi8"
        opsManager:
          lastTransition: "2019-12-06T17:46:32Z"
          phase: Running

source/includes/steps-migrate-specified-to-new-appdb-v.yaml

@@ -11,7 +11,7 @@ content: |
   a. Locate the :opsmgrkube:`spec.applicationDatabase.version`
      setting.
   b. Specify the :qr-mdb:`latest available enterprise MongoDB version
-     </mongodb-enterprise-appdb-database?tab=tags>`
+     </mongodb-enterprise-server?tab=tags>`
      that is :ref:`compatible <k8s-onprem-version-compatibility>` with your
      |onprem| version.
 
@@ -31,7 +31,7 @@ content: |
       backup:
         enabled: false
       applicationDatabase:
-        version: 5.0.0-ent
+        version: 5.0.0-ubi8
          members: 3
 
 ---

source/includes/steps-migrate-unspecified-to-new-appdb-v.yaml

@@ -23,7 +23,7 @@ content: |
   a. Locate the :opsmgrkube:`spec.applicationDatabase.version`
      setting.
   b. Specify the :qr-mdb:`latest available enterprise MongoDB version
-     </mongodb-enterprise-appdb-database?tab=tags>`
+     </mongodb-enterprise-server?tab=tags>`
      that is :ref:`compatible <k8s-onprem-version-compatibility>` with your
      |onprem| version.
 
@@ -43,7 +43,7 @@ content: |
       backup:
         enabled: false
       applicationDatabase:
-        version: 4.4.4-ent
+        version: 4.4.4-ubi8
          members: 3
 
 ---

source/includes/summary-1-20-suffix-change.rst

@@ -0,0 +1,5 @@
+In |k8s-op-short| 1.20, the :qr-mdb:`container registry </mongodb-enterprise-server?tab=tags>` changed for the :term:`application database` image and the images use a new tag suffix. When you :ref:`upgrade the Kubernetes Operator <upgrade-k8s-operator>`, the |k8s-op-short| automatically updates the earlier suffix, ``-ent``, for all images that reference the new container registry to ``-ubi8`` or the suffix set in :ref:`mdb-image-type` or :ref:`mongodb-image-type`.
+
+For example, the |k8s-op-short| changes ``quay.io/mongodb/mongodb-enterprise-server:4.4.5-ent`` to ``quay.io/mongodb/mongodb-enterprise-server:4.4.5-ubi8``.
+
+To stop the |k8s-op-short| from automatically updating the suffix, set :ref:`old-suffix` or :ref:`old-suffix-helm` to ``true``. For example, you might want to stop the automatic suffix change if you're mirroring this image from your own repository.

source/reference/helm-operator-settings.txt

@@ -210,6 +210,41 @@ managedSecurityContext
             # If running OpenShift (Cloud, Minishift, etc.), set this to true.
             managedSecurityContext: true
 
+.. _old-suffix-helm:
+
+mongodb.appdbAssumeOldFormat
+----------------------------
+
+.. include:: /includes/summary-1-20-suffix-change.rst
+
+The default value is ``false``, which automatically updates the image suffix.
+
+.. example::
+
+   .. code-block:: yaml
+
+      mongodb:
+        appdbAssumeOldFormat: false
+
+.. _mongodb-image-type:
+
+mongodb.imageType
+-----------------
+
+The suffix of the :term:`application database` image. 
+
+.. include:: /includes/summary-1-20-suffix-change.rst
+
+The default is ``ubi8``. We recommend using only ``ubi`` images for consistency, but if you need to, you can change this setting to ``ubuntu2204``.
+
+.. example::
+
+   .. code-block:: yaml
+
+      mongodb:
+        imageType: ubi8
+
+
 multiCluster.clusterClientTimeout
 ---------------------------------
 

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

@@ -108,7 +108,7 @@ resources.
    *Required*. Version of MongoDB installed on the |onprem|
    :opsmgr:`Application Database </core/system-overview/#application-database>`.
    You must specify a compatible enterprise MongoDB version based on the tag in the
-   :qr-mdb:`container registry </mongodb-enterprise-appdb-database?tab=tags>`.
+   :qr-mdb:`container registry </mongodb-enterprise-server?tab=tags>`. For example, ``6.0.0-ubi8``. Starting in |k8s-op-short| version 1.20, tags no longer end in ``-ent``.  
 
    .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
 

source/reference/k8s/example-ops-manager.yaml

@@ -49,4 +49,4 @@ spec:
     name: om-db-user-secret
     key: password
    members: 3
-   version: "4.4.18-ent"
+   version: "4.4.5-ubi8"

source/reference/k8s/example-opsmgr-https.yaml

@@ -24,7 +24,7 @@ spec:
 
   applicationDatabase:
     members: 3
-    version: "4.4.0-ent"
+    version: "4.4.0-ubi8"
     security:
       certsSecretPrefix: <prefix> # Required. Text to prefix to the 
                                   # name of the secret that contains the Application

source/reference/k8s/example-status-om-running-local-mode.yaml

@@ -4,7 +4,7 @@ status:
     members: 3
     phase: Running
     type: ReplicaSet
-    version: "4.2.11-ent"
+    version: "4.4.5-ubi8"
   backup:
     phase: ""
   opsManager:

source/reference/known-issues.txt

@@ -230,7 +230,7 @@ similar to the following example.
 
    applicationDatabase:
      # The version specified must match the one in the image provided in the `mongod` field
-     version: 4.4.11-ent
+     version: 4.4.11-ubi8
      members: 3
      podSpec:
        podTemplate:

source/reference/kubectl-operator-settings.txt

@@ -467,6 +467,60 @@ MANAGED_SECURITY_CONTEXT
                         - name: MANAGED_SECURITY_CONTEXT
                           value: true
 
+.. _old-suffix:
+
+MDB_APPDB_ASSUME_OLD_FORMAT
+---------------------------
+
+.. include:: /includes/summary-1-20-suffix-change.rst
+
+The default value is ``false``, which automatically updates the image suffix. 
+
+.. example::
+
+   .. code-block:: yaml
+      :linenos:
+      
+      spec:
+        template:
+          spec:
+            serviceAccountName: mongodb-enterprise-operator
+            containers:
+              - name: mongodb-enterprise-operator
+                image: <operatorVersionUrl>
+                imagePullPolicy: <policyChoice>
+                env:
+                  - name: MDB_APPDB_ASSUME_OLD_FORMAT
+                    value: false
+
+.. _mdb-image-type:
+
+MDB_IMAGE_TYPE
+--------------
+
+The suffix of the :term:`application database` image. 
+
+.. include:: /includes/summary-1-20-suffix-change.rst
+
+The default is ``-ubi8``. We recommend using only ``ubi`` images for consistency, but if you need to, you can change this setting to ``-ubuntu2204``.
+
+.. example::
+
+   .. code-block:: yaml
+      :linenos:
+      
+      spec:
+        template:
+          spec:
+            serviceAccountName: mongodb-enterprise-operator
+            containers:
+              - name: mongodb-enterprise-operator
+                image: <operatorVersionUrl>
+                imagePullPolicy: <policyChoice>
+                env:
+                  - name: MDB_IMAGE_TYPE
+                    value: ubi8
+
 MONGODB_ENTERPRISE_DATABASE_IMAGE
 ---------------------------------
 

source/tutorial/migrate-k8s-images.txt

@@ -77,7 +77,6 @@ and reapplying the configuration each time to migrate the images
 separately:
 
 - ``AGENT_IMAGE``
-- ``APPDB_IMAGE_REPOSITORY``
 - ``INIT_DATABASE_IMAGE_REPOSITORY``
 - ``INIT_OPS_MANAGER_IMAGE_REPOSITORY``
 - ``MONGODB_ENTERPRISE_DATABASE_IMAGE``

source/tutorial/om-arch.txt

@@ -63,7 +63,7 @@ version for the Application Database using the
 :opsmgrkube:`spec.applicationDatabase.version` setting. The version
 that you specify in this setting must correspond to the tag in the
 :qr-mdb:`container registry 
-</mongodb-enterprise-appdb-database?tab=tags>`. Each {+mdbagent+} 
+</mongodb-enterprise-server?tab=tags>`. Each {+mdbagent+} 
 starts the Application Database with the specified version on its Pod 
 in the StatefulSet.
 

source/tutorial/plan-k8s-op-container-images.txt

@@ -36,8 +36,8 @@ To view all available versions for each image, see the following links.
        </mongodb-agent-ubi?tab=tags&tag=latest>`
      - {+mdbagent+} image.
 
-   * - :qr-mdb:`mongodb-enterprise-appdb-database-ubi 
-       </mongodb-enterprise-appdb-database-ubi?tab=tags&tag=latest>`
+   * - :qr-mdb:`mongodb-enterprise-server 
+       </mongodb-enterprise-server?tab=tags&tag=latest>`
      - The Enterprise MongoDB image used for the Application Database.
 
    * - :qr-mdb:`mongodb-enterprise-init-appdb-ubi 

source/tutorial/upgrade-k8s-operator.txt

@@ -17,6 +17,10 @@ Upgrade the |k8s-op|
 The following procedure outlines how to upgrade the |k8s-op-short|
 to its latest version. 
 
+.. note::
+   
+   .. include:: /includes/summary-1-20-suffix-change.rst
+
 Upgrade using |k8s|
 -------------------
 
@@ -76,4 +80,3 @@ The following steps depend on how your environment is configured:
       .. include:: /includes/steps/upgrade-os-offline-helm-host.rst
 
 .. include:: /includes/troubleshoot-k8s.rst
-