(DOCSP-44175) Fixes important nested components in MEKO docs (#1898) (#1901)

sarahsimpers · web-flow · commit ee852855cfe6 · 2024-10-07T12:37:21.000-04:00
diff --git a/source/includes/admonitions/data-url-config-map-external-dbs-nested.rst b/source/includes/admonitions/data-url-config-map-external-dbs-nested.rst
@@ -0,0 +1,6 @@
+:gold:`IMPORTANT:` If you deploy |onprem| with the |k8s-op-short| and 
+|onprem| will manage MongoDB database resources deployed **outside** of
+the |k8s| cluster it's deployed to, you must set ``data.baseUrl`` to
+the same value of the :opsmgrkube:`spec.configuration.mms.centralUrl
+<spec.configuration>` setting in the |onprem| resource specification.
+To learn more, see :ref:`mdb-resource-deployment-locations`.
diff --git a/source/includes/admonitions/fact-k8s-operator-manages-configmap-nested.rst b/source/includes/admonitions/fact-k8s-operator-manages-configmap-nested.rst
@@ -0,0 +1,2 @@
+:gold:`IMPORTANT:` The |k8s-op-short| tracks any changes to the
+ConfigMap and reconciles the state of the |k8s-mdbrsc|.
diff --git a/source/includes/admonitions/fact-k8s-operator-manages-secret-nested.rst b/source/includes/admonitions/fact-k8s-operator-manages-secret-nested.rst
@@ -0,0 +1,2 @@
+:gold:`IMPORTANT:` The |k8s-op-short| tracks any changes to the Secret
+and reconciles the state of the |k8s-mdbrsc|.
diff --git a/source/includes/admonitions/note-k8s-supported-in-om4-nested.rst b/source/includes/admonitions/note-k8s-supported-in-om4-nested.rst
@@ -0,0 +1,6 @@
+You can use the |k8s-op-short| to deploy MongoDB resources with
+|cloud-short| and with |onprem| version 6.0.x or later.
+     
+You can use the :atlas:`Atlas Operator </reference/atlas-operator/ak8so-quick-start/>`
+to deploy MongoDB resources to |service|.
+
diff --git a/source/includes/admonitions/ubi-8-min-db-versions-nested.rst b/source/includes/admonitions/ubi-8-min-db-versions-nested.rst
@@ -0,0 +1,4 @@
+:gold:`IMPORTANT:` Ensure that you choose a :ref:`compatible MongoDB
+Server version <k8s-mdb-version-compatibility>`. Compatible versions
+differ depending on the base image that the MongoDB database resource
+uses.
diff --git a/source/includes/list-tables/configmap-keys-curl.rst b/source/includes/list-tables/configmap-keys-curl.rst
@@ -55,7 +55,7 @@
        identifies your
        |com| :opsmgr:`Organization </tutorial/manage-organizations>`.
 
-       .. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
+       .. include:: /includes/admonitions/note-k8s-supported-in-om4-nested.rst
 
        Specify an :opsmgr:`existing Organization
        </tutorial/manage-organizations/#create-organization>`:
@@ -76,7 +76,7 @@
      - |url| to your |application| including the |fqdn| and port
        number.
 
-       .. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
+       .. include:: /includes/admonitions/data-url-config-map-external-dbs-nested.rst
 
        If you're using |cloud-short|, set the ``data.baseUrl`` value
        to ``https://cloud.mongodb.com``.
diff --git a/source/includes/list-tables/configmap-keys.rst b/source/includes/list-tables/configmap-keys.rst
@@ -66,7 +66,7 @@
           You must have the :opsmgr:`Organization Project Creator </reference/user-roles/#Organization Project Creator>`
           role to create a new project *within an existing organization*.
 
-          .. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
+          .. include:: /includes/admonitions/note-k8s-supported-in-om4-nested.rst
 
        If you provide an empty string as your ``orgId``, |k8s-op-short| 
        creates an organization with the same name as your project.
@@ -78,7 +78,7 @@
      - |url| to your |application| including the |fqdn| and port
        number.
 
-       .. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
+       .. include:: /includes/admonitions/data-url-config-map-external-dbs-nested.rst
 
        If you're using |cloud-short|, set the ``data.baseUrl`` value
        to ``https://cloud.mongodb.com``.
diff --git a/source/includes/list-tables/resource-keys-internal-x509.rst b/source/includes/list-tables/resource-keys-internal-x509.rst
@@ -16,9 +16,7 @@
      - Use this setting to enable
        :manual:`X.509 internal cluster authentication </tutorial/configure-x509-member-authentication#x509-internal-authentication>`.
 
-       .. important::
-
-          Once internal cluster authentication is enabled, it can't
-          be disabled.
+       :gold:`IMPORTANT:` Once internal cluster authentication is
+       enabled, it can't be disabled.
 
      - ``X509``
diff --git a/source/includes/list-tables/rs-multi-cluster-base-options.rst b/source/includes/list-tables/rs-multi-cluster-base-options.rst
@@ -25,7 +25,7 @@
        The format should be ``X.Y.Z`` for the Community edition and
        ``X.Y.Z-ent`` for the Enterprise edition.
 
-       .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
+       .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
        To learn more about MongoDB versioning, see
        :ref:`release-version-numbers` in the MongoDB Manual.
@@ -43,7 +43,7 @@
        
        .. include:: /includes/admonitions/note-namespace-match-configmap.rst
 
-       .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap.rst
+       .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap-nested.rst
 
      - ``<my-project>``
 
@@ -98,7 +98,7 @@
 
        .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
-       .. include:: /includes/admonitions/fact-k8s-operator-manages-secret.rst
+       .. include:: /includes/admonitions/fact-k8s-operator-manages-secret-nested.rst
 
      - ``<mycredentials>``
 
diff --git a/source/includes/list-tables/rs-resource-base-options.rst b/source/includes/list-tables/rs-resource-base-options.rst
@@ -31,7 +31,7 @@
        The format should be ``X.Y.Z`` for the Community edition and
        ``X.Y.Z-ent`` for the Enterprise edition.
 
-       .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
+       .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
        To learn more about MongoDB versioning, see
        :ref:`release-version-numbers` in the MongoDB Manual.
@@ -49,7 +49,7 @@
        
        .. include:: /includes/admonitions/note-namespace-match-configmap.rst
 
-       .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap.rst
+       .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap-nested.rst
 
      - ``<myconfigmap>``
 
@@ -62,7 +62,7 @@
 
        .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
-       .. include:: /includes/admonitions/fact-k8s-operator-manages-secret.rst
+       .. include:: /includes/admonitions/fact-k8s-operator-manages-secret-nested.rst
 
      - ``<mycredentials>``
 
diff --git a/source/includes/steps-add-database-user.yaml b/source/includes/steps-add-database-user.yaml
@@ -51,11 +51,9 @@ content: |
      - The subject line of the x509 client certificate signed
        by the |k8s| |certauth| (Kube CA).
 
-       .. important::
-
-          The username must comply with the
-          `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__
-          LDAPv3 Distinguished Name standard.
+       :gold:`IMPORTANT:` The username must comply with the
+       `RFC 2253 <https://tools.ietf.org/html/rfc2253>`__
+       LDAPv3 Distinguished Name standard.
 
        To get the subject line of the X.509 certificate, run the
        following command:
diff --git a/source/includes/steps-deploy-k8s-opsmgr-http.yaml b/source/includes/steps-deploy-k8s-opsmgr-http.yaml
@@ -131,7 +131,7 @@ content: |
           ``X.Y.Z-ubi8`` for the :product:`Enterprise edition
           </mongodb-enterprise-advanced>`.
 
-          .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
+          .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
           To learn more about MongoDB versioning, see
           :ref:`release-version-numbers` in the MongoDB Manual.
diff --git a/source/includes/steps-deploy-k8s-opsmgr-https.yaml b/source/includes/steps-deploy-k8s-opsmgr-https.yaml
@@ -221,7 +221,7 @@ content: |
           </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
+          .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
           To learn more about MongoDB versioning, see
           :ref:`release-version-numbers` in the MongoDB Manual.
diff --git a/source/includes/steps-deploy-k8s-sharded-cluster.yaml b/source/includes/steps-deploy-k8s-sharded-cluster.yaml
@@ -89,7 +89,7 @@ content: |
           The format should be ``X.Y.Z`` for the Community edition and
           ``X.Y.Z-ent`` for the Enterprise edition.
 
-          .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
+          .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
           To learn more about MongoDB versioning, see
           :ref:`release-version-numbers` in the MongoDB Manual.
@@ -104,7 +104,7 @@ content: |
 
           .. include:: /includes/admonitions/note-namespace-match-configmap.rst
 
-          .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap.rst
+          .. include:: /includes/admonitions/fact-k8s-operator-manages-configmap-nested.rst
 
         - ``<myproject>``
 
@@ -117,7 +117,7 @@ content: |
 
           .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
-          .. include:: /includes/admonitions/fact-k8s-operator-manages-secret.rst
+          .. include:: /includes/admonitions/fact-k8s-operator-manages-secret-nested.rst
 
         - ``<mycredentials>``
 
diff --git a/source/includes/steps-deploy-k8s-standalone.yaml b/source/includes/steps-deploy-k8s-standalone.yaml
@@ -62,7 +62,7 @@ content: |
           The format should be ``X.Y.Z`` for the Community edition and
           ``X.Y.Z-ent`` for the Enterprise edition.
 
-          .. include:: /includes/admonitions/ubi-8-min-db-versions.rst
+          .. include:: /includes/admonitions/ubi-8-min-db-versions-nested.rst
 
           To learn more about MongoDB versioning, see
           :ref:`release-version-numbers` in the MongoDB Manual.
@@ -89,7 +89,7 @@ content: |
 
           .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
-          .. include:: /includes/admonitions/fact-k8s-operator-manages-secret.rst
+          .. include:: /includes/admonitions/fact-k8s-operator-manages-secret-nested.rst
 
         - ``<mycredentials>``
 
diff --git a/source/includes/steps-set-configmap-for-client-x509.yaml b/source/includes/steps-set-configmap-for-client-x509.yaml
@@ -58,10 +58,8 @@ content: |
         - Forces the Operator to require a valid |tls| certificate
           from |mms|.
 
-          .. important::
-
-             The value must be enclosed in single quotes or the
-             operator will throw an error.
+          :gold:`IMPORTANT:` The value must be enclosed in single
+          quotes or the operator will throw an error.
 
         - ``'true'``
 
diff --git a/source/includes/steps-set-configmap-for-internal-x509.yaml b/source/includes/steps-set-configmap-for-internal-x509.yaml
@@ -59,10 +59,8 @@ content: |
         - Forces the Operator to require a valid |tls| certificate
           from |mms|.
 
-          .. important::
-
-             The value must be enclosed in single quotes or the
-             operator will throw an error.
+          :gold:`IMPORTANT:` The value must be enclosed in single
+          quotes or the operator will throw an error.
 
         - ``'true'``
 
diff --git a/source/includes/steps-set-configmap-for-tls.yaml b/source/includes/steps-set-configmap-for-tls.yaml
@@ -59,10 +59,8 @@ content: |
         - Forces the Operator to require a valid |tls| certificate
           from |mms|.
 
-          .. important::
-
-             The value must be enclosed in single quotes or the
-             operator will throw an error.
+          :gold:`IMPORTANT:` The value must be enclosed in single
+          quotes or the operator will throw an error.
         - ``'true'``
 ---
 title: "Save your updated ConfigMap."

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+:gold:`IMPORTANT:` The \|k8s-op-short\| tracks any changes to the
	`2`	`+ConfigMap and reconciles the state of the \|k8s-mdbrsc\|.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+:gold:`IMPORTANT:` The \|k8s-op-short\| tracks any changes to the Secret
	`2`	`+and reconciles the state of the \|k8s-mdbrsc\|.`