(DOCSP-38470) Adding |mdbagent|, {+monitoring-agent+} and {+appdb+} constants (#1737)

* Added the new constants

* Modified monitoring agent instances

* Updated {+appdb+} instances

Author: euniceadam-mdb

snooty.toml

@@ -34,6 +34,7 @@ toc_landing_pages = [
 [constants]
 aagent = "MongoDB Agent or legacy Automation Agent"
 aagents = "MongoDB Agents or legacy Automation Agents"
+appdb = "Application Database"
 k8s-op-short = "Kubernetes Operator"
 k8s-api-version = "v1.26"
 k8s-crds = "`CustomResourceDefinitions <https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/>`__"
@@ -46,6 +47,7 @@ mdbagent = "MongoDB Agent"
 mdb-ent-db = "MongoDB Enterprise Database"
 mdb-support = "`MongoDB Support <https://support.mongodb.com/welcome>`__"
 mdb-version = "7.0.0"
+monitoring-agent = "Monitoring Agent"
 version = "1.25"
 dl-version = "1.25.0"
 

source/includes/facts/fact-disable-tls.rst

@@ -1,6 +1,6 @@
 |k8s-op-short| version :ref:`1.15.1 <ent_op-1.15.1>` fixes an issue 
 that prevented the |k8s-op-short| upgrade when managing a 
-TLS-enabled Application Database whose TLS certificate is stored in an 
+TLS-enabled {+appdb+} whose TLS certificate is stored in an 
 :k8sdocs:`Opaque </concepts/configuration/secret/#opaque-secrets>` 
 secret.
 

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

@@ -1,5 +1,5 @@
 Before upgrading your |k8s-op| to v1.11.0 or later,
-migrate the Application Database
+migrate the {+appdb+}
 of any deployed ``MongoDBOpsManager`` custom resources
 to one of the supported enterprise MongoDB editions. You specify the
 MongoDB version for the :opsmgr:`Application Database
@@ -8,11 +8,11 @@ MongoDB version for the :opsmgr:`Application Database
 For the list of supported MongoDB versions, see the
 :qr-mdb:`container registry </mongodb-enterprise-server?tab=tags>`.
 
-You must migrate the Application Database to the latest available
+You must migrate the {+appdb+} to the latest available
 enterprise edition of MongoDB if your ``MongoDBOpsManager`` custom
 resource uses:
 
-- A bundled version of MongoDB for the Application Database. In this case,
+- A bundled version of MongoDB for the {+appdb+}. In this case,
   the :opsmgrkube:`spec.applicationDatabase.version` setting is not
   specified, or its value is empty.
 - Any other enterprise MongoDB version specified in the :opsmgrkube:`spec.applicationDatabase.version` setting.

source/includes/facts/fact-om-in-multi-clusters-summary-of-diffs.rst

@@ -15,33 +15,33 @@ These procedures are the same as the procedures for deploying |onprem| in single
 
   .. include:: /includes/admonitions/note-om-external-connectivity-multi-cluster.rst
 
-- **Deploy Ops Manager and the Application Database on the central cluster.**
+- **Deploy Ops Manager and the {+appdb+} on the central cluster.**
 
-  You can choose to deploy |onprem| and the Application Database only on the central cluster,
+  You can choose to deploy |onprem| and the {+appdb+} only on the central cluster,
   using the same procedure as for single MongoDB resources |k8s| clusters. To learn more,
   see :ref:`Deploy an Ops Manager instance on the central cluster with TLS encryption <deploy-om-container>`.
 
-- **Deploy Ops Manager on the central cluster and the Application Database on selected member clusters.**
+- **Deploy Ops Manager on the central cluster and the {+appdb+} on selected member clusters.**
 
   You can choose to deploy |onprem| on the central cluster and the Application
   Database on a subset of selected member clusters, to increase the
-  Application Database's resilience and availability in |onprem|. Configure
+  {+appdb+}'s resilience and availability in |onprem|. Configure
   the following settings in the |onprem| CRD:
 
   - Use :opsmgrkube:`topology <spec.applicationDatabase.topology>` to specify the ``MultiCluster`` value.
 
   - Specify the :opsmgrkube:`clusterSpecList <spec.applicationDatabase.clusterSpecList>` and
     include in it the :opsmgrkube:`clusterName <spec.applicationDatabase.clusterSpecList.clusterName>`
-    of each selected |k8s| member cluster on which you want to deploy the Application Database, and the
+    of each selected |k8s| member cluster on which you want to deploy the {+appdb+}, and the
     number of :opsmgrkube:`members <spec.applicationDatabase.clusterSpecList.members>`
     (MongoDB nodes) in each |k8s| member cluster.
 
   .. note::
 
-     If you deploy the Application Database on selected member clusters in
+     If you deploy the {+appdb+} on selected member clusters in
      your |multi-cluster|, you must include the central cluster and
      member clusters in the same service mesh configuration. This enables
-     bi-directional communication from |onprem| to the Application Database.
+     bi-directional communication from |onprem| to the {+appdb+}.
 
   To learn more, see :ref:`Deploy Ops Manager <deploy-om-container>`,
   review the |multi-cluster| example and specify ``MultiCluster`` for

source/includes/facts/ldap-considerations-multi-cluster.rst

@@ -1,7 +1,7 @@
 - To configure |ldap| in |k8s-crds|, use the parameters under the
   :setting:`spec.security.authentication.ldap` and other
   :ref:`security LDAP settings <security-settings>` specific to the
-  MongoDB Agent, from the |k8s-op-short| MongoDB resource specification.
+  {+mdbagent+}, from the |k8s-op-short| MongoDB resource specification.
   The procedures in this section describe the required settings and
   provide examples of |ldap| configuration.
 

source/includes/facts/ldap-considerations.rst

@@ -1,7 +1,7 @@
 - To configure |ldap| in |k8s-crds|, use the parameters under the
   :setting:`spec.security.authentication.ldap` and other
   :ref:`security LDAP settings <security-settings>` specific to the
-  MongoDB Agent, from the |k8s-op-short| MongoDB resource specification.
+  {+mdbagent+}, from the |k8s-op-short| MongoDB resource specification.
   The procedures in this section describe the required settings and
   provide examples of LDAP configuration.
 

source/includes/list-tables/crd-logging-configuration.rst

@@ -11,7 +11,7 @@
      - :setting:`spec.agent.startupOptions`
 
    * - MongoDB
-     - Monitoring agent logs
+     - {+monitoring-agent+} logs
      - Ops Manager API or UI
 
    * - MongoDB
@@ -30,19 +30,19 @@
      - Readiness Probe
      - `Container Environment Variables <https://www.mongodb.com/docs/kubernetes-operator/master/reference/kubectl-operator-settings/#readiness-probe-logger-max-size>`__
 
-   * - Application Database
+   * - {+appdb+}
      - MongoDB Logs
      - :opsmgrkube:`spec.applicationDatabase.agent.logRotate`
 
-   * - Application Database
+   * - {+appdb+}
      - Automation Agent Logs
      - :opsmgrkube:`spec.applicationDatabase.agent.startupOptions`
 
-   * - Application Database
-     - Monitoring agent logs
+   * - {+appdb+}
+     - {+monitoring-agent+} logs
      - Forwarded to ``stdout`` only (kubectl logs). 
        Managed and stored in the |k8s| control plane.
 
-   * - Application Database
+   * - {+appdb+}
      - Audit logs
      - :opsmgrkube:`spec.applicationDatabase.agent.logRotate.includeAuditLogsWithMongoDBLogs`

source/includes/list-tables/default-k8s-object-permissions.rst

@@ -63,7 +63,7 @@
      - Require the following permissions:
 
        - ``get``, ``list``, ``watch``. The |k8s-op-short| queries the
-         Application Database Pods to get information about its state.
+         {+appdb+} Pods to get information about its state.
 
    * - Namespaces
      - Require the following permissions:

source/includes/op-setting-descs/appdb-image-repository.rst

@@ -1,2 +1,2 @@
 |url| of the repository from which the |k8s-op-short| downloads
-the Application Database image.
+the {+appdb+} image.

source/includes/op-setting-descs/init-appdb-image-repository.rst

@@ -1,3 +1,3 @@
 |url| of the repository from which the ``initContainer`` image that
-contains the Application Database start-up scripts and the readiness
+contains the {+appdb+} start-up scripts and the readiness
 probe is downloaded.

source/includes/prereqs/mdbagent-reqs.rst

@@ -1,4 +1,4 @@
-- Your project's MongoDB Agent. For the MongoDB Agent certificate, 
+- Your project's {+mdbagent+}. For the {+mdbagent+} certificate, 
   ensure that you meet the following requirements:
 
   - The Common Name in the |tls| certificate is not empty.

source/includes/prereqs/secure-om-resource.rst

@@ -12,7 +12,7 @@
      * - DNS Names
        - Ensure that you add |san-dns|\s or Subject Names
          for each |k8s-pod| that hosts a member of the 
-         Application Database replica set. The |san-dns| for each pod
+         {+appdb+} replica set. The |san-dns| for each pod
          must use the following format:
 
          .. code-block:: sh

source/includes/setting-k8sSaConf-spec.agent.startupOptions.rst

@@ -5,7 +5,7 @@
 
    {+mdbagent+} settings with which you want to start MongoDB database resource.
 
-   You must provide MongoDB Agent settings as key-value pairs. The values
+   You must provide {+mdbagent+} settings as key-value pairs. The values
    must be strings.
 
    For a list of supported {+mdbagent+} settings, see:

source/includes/setting-k8sScConf-spec.configSrv.agent.startupOptions.rst

@@ -5,7 +5,7 @@
 
    {+mdbagent+} settings with which you want to start each :term:`config server` member.
 
-   You must provide MongoDB Agent settings as key-value pairs. The values
+   You must provide {+mdbagent+} settings as key-value pairs. The values
    must be strings.
 
    For a list of supported {+mdbagent+} settings, see:

source/includes/setting-k8sScConf-spec.mongos.agent.startupOptions.rst

@@ -5,7 +5,7 @@
 
    {+mdbagent+} settings with which you want to start each |mongos| instance.
 
-   You must provide MongoDB Agent settings as key-value pairs. The values
+   You must provide {+mdbagent+} settings as key-value pairs. The values
    must be strings.
 
    For a list of supported {+mdbagent+} settings, see:

source/includes/setting-k8sScConf-spec.shard.agent.startupOptions.rst

@@ -5,7 +5,7 @@
 
    {+mdbagent+} settings with which you want to start each :manual:`sharded cluster </reference/glossary/#std-term-sharded-cluster>` shard member.
 
-   You must provide MongoDB Agent settings as key-value pairs. The values
+   You must provide {+mdbagent+} settings as key-value pairs. The values
    must be strings.
 
    For a list of supported {+mdbagent+} settings, see:

source/includes/steps-deploy-k8s-multi-cluster-replica-set-ldap.yaml

@@ -60,7 +60,7 @@ content: |
   For a full list of LDAP settings, see security settings in the |k8s-op-short|
   :ref:`MongoDBMultiCluster resource specification <multi-cluster-specification>`.
   Also see the :setting:`spec.security.authentication.agents.automationUserName`
-  setting for the MongoDB Agent user in your LDAP-enabled |k8s-op-short|
+  setting for the {+mdbagent+} user in your LDAP-enabled |k8s-op-short|
   deployment.
 
 ---

source/includes/steps-deploy-k8s-om-multi-https.rst

@@ -288,7 +288,7 @@
 
 .. step:: Prepare TLS certificates.
 
-   In this step, you enable |tls| for the Application Database and the |application|.
+   In this step, you enable |tls| for the {+appdb+} and the |application|.
    If you don't want to use TLS, remove the following fields from the ``MongoDBOpsManager``
    resources:
 
@@ -312,8 +312,8 @@
       generation step and put the keys and certificates  into the following files:
 
       - ``certs/ca.crt`` - |certauth| certificates. These are not necessary when using trusted certificates.
-      - ``certs/appdb.key`` - private key for the Application Database.
-      - ``certs/appdb.crt`` - certificate for the Application Database.
+      - ``certs/appdb.key`` - private key for the {+appdb+}.
+      - ``certs/appdb.crt`` - certificate for the {+appdb+}.
       - ``certs/om.key`` - private key for |onprem|.
       - ``certs/om.crt`` - certificate for |onprem|.
 
@@ -343,7 +343,7 @@
 
       Deploying this way shows that a single |k8s| cluster deployment is
       a special case of a multi-|k8s| cluster deployment on a single |k8s| member cluster.
-      You can start deploying the |application| and the Application Database
+      You can start deploying the |application| and the {+appdb+}
       on as many |k8s| clusters as necessary from the beginning, and don't
       have to start with the deployment with only a single member |k8s| cluster.
 
@@ -356,7 +356,7 @@
 
    c. Wait for the |k8s-op-short| to pick up the work and reach the
       ``status.applicationDatabase.phase=Pending`` state. Wait for both the
-      Application Database and |onprem| deployments to complete.
+      {+appdb+} and |onprem| deployments to complete.
 
       .. io-code-block::
          :copyable: true
@@ -373,12 +373,12 @@
    d. Deploy |onprem|. The |k8s-op-short| deploys |onprem| by performing
       the following steps. It:
 
-      - Deploys the Application Database's replica set nodes and waits
+      - Deploys the {+appdb+}'s replica set nodes and waits
         for the MongoDB processes in the replica set to start running.
-      - Deploys the |application| instance with the Application Database's
+      - Deploys the |application| instance with the {+appdb+}'s
         connection string and waits for it to become ready.
-      - Adds the Monitoring {+mdbagent+} containers to each Application Database's Pod.
-      - Waits for both the |application| and the Application Database Pods to start running.
+      - Adds the Monitoring {+mdbagent+} containers to each {+appdb+}'s Pod.
+      - Waits for both the |application| and the {+appdb+} Pods to start running.
 
       .. io-code-block::
          :copyable: true
@@ -395,7 +395,7 @@
       Now that you have deployed a single-member cluster in a :ref:`multi-cluster mode <mode-multi-or-single>`,
       you can reconfigure this deployment to span more than one |k8s| cluster.
 
-   e. On the second member cluster, deploy two additional Application Database
+   e. On the second member cluster, deploy two additional {+appdb+}
       replica set members and one additional instance of the |application|:
 
       .. literalinclude:: /includes/code-examples/ops-manager-multi-cluster/code_snippets/0320_ops_manager_add_second_cluster.sh

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

@@ -150,7 +150,7 @@ content: |
         - string
         - *Optional*.
 
-          The type of the |k8s| deployment for the Application Database.
+          The type of the |k8s| deployment for the {+appdb+}.
           If omitted, the default is ``SingleCluster``.
 
           If you specify ``MultiCluster``, the |k8s-op-short| ignores
@@ -160,7 +160,7 @@ content: |
 
           Instead, you must specify the :opsmgrkube:`clusterSpecList <spec.applicationDatabase.clusterSpecList>`
           and include in it the :opsmgrkube:`clusterName <spec.applicationDatabase.clusterSpecList.clusterName>`
-          of each selected |k8s| member cluster on which you want to deploy the Application Database, and
+          of each selected |k8s| member cluster on which you want to deploy the {+appdb+}, and
           the number of :opsmgrkube:`members <spec.applicationDatabase.clusterSpecList.members>`
           (MongoDB nodes) in each |k8s| cluster.
 
@@ -435,7 +435,7 @@ content: |
 
   The |k8s-op-short| reconciles the resources in the following order:
 
-  1. Application Database.
+  1. {+appdb+}.
   #. |onprem|.
   #. Backup.
 

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

@@ -234,15 +234,15 @@ content: |
         - string
         - *Optional*.
 
-          The type of the |k8s| deployment for the Application Database.
+          The type of the |k8s| deployment for the {+appdb+}.
           If omitted, the default is ``SingleCluster``.
 
           If you specify ``MultiCluster``, the |k8s-op-short| ignores values
           that you set for the :setting:`spec.applicationDatabase.members <spec.members>` field, if specified.
           Instead, you must specify the :opsmgrkube:`clusterSpecList <spec.applicationDatabase.clusterSpecList>`
           and include in it the :opsmgrkube:`clusterName <spec.applicationDatabase.clusterSpecList.clusterName>`
           of each selected |k8s| member cluster on which you want to deploy the
-          Application Database, and the number of :opsmgrkube:`members <spec.applicationDatabase.clusterSpecList.members>`
+          {+appdb+}, and the number of :opsmgrkube:`members <spec.applicationDatabase.clusterSpecList.members>`
           (MongoDB nodes) in each |k8s| cluster.
 
           .. note::
@@ -280,7 +280,7 @@ content: |
 
           The |k8s-op-short| mounts the |certauth| you add using the
           :opsmgrkube:`spec.applicationDatabase.security.tls.ca` setting to
-          both the |onprem| and the Application Database Pods.
+          both the |onprem| and the {+appdb+} Pods.
 
 ---
 title: "Configure Backup settings."
@@ -536,7 +536,7 @@ content: |
 
   The |k8s-op-short| reconciles the resources in the following order:
 
-  1. Application Database.
+  1. {+appdb+}.
   #. |onprem|.
   #. Backup.
 

source/includes/steps-migrate-to-new-tls-format.yaml

@@ -44,7 +44,7 @@ content: |
   For more information, see the prerequisites in the |k8s-op-short|
   |tls| tutorials:
 
-  - :ref:`secure-om-db-tls` for Application Database resources
+  - :ref:`secure-om-db-tls` for {+appdb+} resources
   - :ref:`deploy-om-container` for |onprem| resources
   - :ref:`k8s-secure-resources` for database resources
 
@@ -58,7 +58,7 @@ content: |
   following fields, as appropriate, to reference the new |tls| secrets
   you created in the previous step:
 
-  - Application Database |tls| secrets: :opsmgrkube:`applicationDatabase.security.certsSecretPrefix`
+  - {+appdb+} |tls| secrets: :opsmgrkube:`applicationDatabase.security.certsSecretPrefix`
   - |onprem| |tls| secrets: :opsmgrkube:`security.certsSecretPrefix`
   - Database resource |tls| secrets: :setting:`security.security.certsSecretPrefix`
   

source/includes/steps-multi-cluster-source.yaml

@@ -884,13 +884,13 @@ content: |
     .. include:: /includes/prereqs/san-format-multi-cluster.rst
 
 ---
-title: "Generate one TLS certificate for your project's MongoDB Agents."
+title: "Generate one TLS certificate for your project's {+mdbagent+}s."
 stepnum: 0
 level: 4
 ref: generate-tls-agents
 content: |
 
-  For the MongoDB Agent |tls| certificate:
+  For the {+mdbagent+} |tls| certificate:
 
   - The Common Name in the |tls| certificate must not be empty.
 

source/includes/steps-recover-k8s-om-multi-appdb-deployments.yaml

@@ -82,11 +82,11 @@ content: |
      kubectl get om -o yaml -w
 
   Once the central cluster reaches a ``Running`` state, you can 
-  re-scale the Application Database to your desired 
+  re-scale the {+appdb+} to your desired 
   distribution of member clusters.
 
   At this point, the newly restored |k8s-op-short| should pick up management of
-  the existing Application Database.
+  the existing {+appdb+}.
   
   - The :ref:`ConfigMap <create-k8s-project>` used to create the initial project.
 
@@ -99,7 +99,7 @@ content: |
 
   .. note::
   
-     If the Application Database replica set has lost some nodes and is
+     If the {+appdb+} replica set has lost some nodes and is
      unable to form a voting majority, :ref:`forcibly reconfigure the replica set <recover-appdb-forced-reconfig>`.
      This adds new replica set nodes that will form a voting majority allowing
      the replica set to elect a primary.