(DOCSP-8666): Align sections to create ConfigMap and project secret (#221)

melissamahoney-mongodb · jwilliams-mongo · commit 3cacf477d09f · 2025-04-14T17:11:15.000-05:00
* (DOCSP-8666): Align sections to create ConfigMap and project secret * (DOCSP-8666): Move considerations up * (DOCSP-8666): Tech review * (DOCSP-8666): Tech review 2
diff --git a/source/includes/admonitions/data-url-config-map-external-dbs.rst b/source/includes/admonitions/data-url-config-map-external-dbs.rst
@@ -1,10 +1,10 @@
 .. important::
 
     If you deploy |onprem| with the |k8s-op-short| and |onprem| will 
-    manage MongoDB database resources deployed outside of the |k8s| 
+    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.
 
-    .. seealso:: :ref:`mdb-resource-deployment-locations`
+    .. seealso:: :ref:`mdb-resource-deployment-locations`
diff --git a/source/includes/list-tables/configmap-keys-curl.rst b/source/includes/list-tables/configmap-keys-curl.rst
@@ -0,0 +1,92 @@
+.. list-table::
+   :widths: 20 20 40 20
+   :header-rows: 1
+
+   * - Key
+     - Type
+     - Description
+     - Example
+
+   * - ``<configmap-name>``
+     - string
+     - Name of the |k8s| |k8s-obj|.
+
+       .. include:: /includes/fact-resource-name-char-limit.rst
+
+       .. seealso::
+
+          - :setting:`metadata.name`
+          - |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
+            This name must follow :rfc:`RFC1123 <1123>` naming
+            conventions, using only lowercase alphanumeric
+            characters, '-' or '.', and must start and end with an
+            alphanumeric character.
+
+     - ``myconfigmap``
+
+   * - ``baseUrl``
+     - string
+     - |url| to your |application| including the |fqdn| and port
+       number.
+
+       .. include:: /includes/admonitions/data-url-config-map-external-dbs.rst
+
+       .. note::
+
+          If you're using |cloud-short|, set the ``data.baseUrl`` value
+          to ``https://cloud.mongodb.com``.
+
+     - ``https://ops.example.com:8443``
+
+   * - ``projectName``
+     - string
+     - Label for your |mms|
+       :opsmgr:`Project </tutorial/manage-projects>`.
+
+       The |k8s-op-short| creates the |mms| project if it does
+       not exist. If you omit the ``projectName``, the |k8s-op-short|
+       creates a project with the same name as your |k8s| resource.
+
+       If you need or want to use an existing project, you can find
+       the ``projectName`` by clicking the :guilabel:`All Clusters`
+       link at the top left of the screen, then either search by
+       name in the :guilabel:`Search` box or scroll to find the
+       name in the list. Each card in this list represents the
+       combination of one **Organization** and **Project**.
+
+     - ``Development``
+
+   * - ``orgId``
+     - string
+     - 24 character hex string that uniquely identifies your
+       MongoDB :opsmgr:`Organization </tutorial/manage-organizations>`.
+       You can find the ``orgId`` in your |onprem| |url|:
+
+       1. Click the :guilabel:`Context` menu.
+       2. Select your Organization.
+       3. View the current |url| in your browser and copy the value
+          displayed in the ``<orgId>`` placeholder below:
+
+          | ``https://ops.example.com:8443/``
+          | ``v2#/org/<orgId>/projects``
+
+       .. important::
+
+          This field is *optional*. If you omit the ``orgId``,
+          |onprem| creates an Organization called ``projectName``
+          that contains a project also called ``projectName``.
+
+          You must have the :authrole:`Organization project Creator`
+          role to create a new project
+          *within an existing organization*.
+
+          .. admonition:: Limited to |com| Organizations
+
+             If you set this value, it can be for a |com|
+             organization only. If you try to use an Atlas
+             organization, the |k8s-op-short| may not work as
+             intended.
+
+     - | ``5cc9b333dd3e384a625a6615``
+
+
diff --git a/source/includes/steps-create-k8s-configmap.yaml b/source/includes/steps-create-k8s-configmap.yaml
@@ -5,72 +5,44 @@ inherit:
   file: steps-configure-kubectl-namespace.yaml
   ref: configure-kubectl-namespace
 ---  
-title: "Copy the following example ConfigMap."
+title: "Invoke the following command to create a ConfigMap."
 stepnum: 2
 level: 4
 ref: copy-k8s-configmap
 content: |
 
-  .. literalinclude:: /reference/k8s/example-configmap.yaml
-     :language: yaml
-     :emphasize-lines: 5, 7-9
----
-title: "Open your preferred text editor and paste the example |k8s-configmap| into a new text file."
-stepnum: 3
-level: 4
-ref: paste-k8s-configmap
----
-title: "Update the values in the lines highlighted in the example ConfigMap."
-stepnum: 4
-level: 4
-ref: configure-k8s-configmap
-content: |
-  .. include:: /includes/list-tables/configmap-keys.rst
----
-title: "Save this file with a ``.yaml`` file extension."
-stepnum: 5
-level: 4
-ref: save-k8s-configmap
----
-title: "Invoke the |k8s| command to create your |k8s-configmap|."
-stepnum: 6
-level: 4
-ref: create-k8s-configmap
-content: |
   .. code-block:: sh
 
-      kubectl apply -f <myconfigmap.yaml>
+     kubectl create configmap <configmap-name> \
+       --from-literal="baseUrl=<myOpsManagerURL>" \
+       --from-literal="projectName=<myOpsManagerProjectName>" \ #Optional
+       --from-literal="orgId=<orgID>" #Optional
 
-  .. important::
+  .. include:: /includes/list-tables/configmap-keys-curl.rst
 
-     All subsequent ``kubectl`` commands you invoke must add the
-     ``-n`` option with the :setting:`metadata.namespace` you
-     specified in your |k8s-configmap|.
 ---
-title: "Invoke the |k8s| command to verify your |k8s-configmap|."
-stepnum: 7
+title: "Invoke the following |k8s| command to verify your |k8s-configmap|."
+stepnum: 3
 level: 4
 ref: verify-k8s-configmap
 content: |
   .. code-block:: sh
 
-     kubectl describe configmaps <myconfigmap> -n <metadata.namespace>
-
-  .. admonition:: *Always include the namespace option with* ``kubectl``
-        :class: important
-
-        |kubectl| defaults to an empty namespace if you do not specify
-        the ``-n`` option, resulting in deployment failures. You must
-        specify the value of the ``<metadata.namespace>`` field.
-        The |k8s-op-short|, |k8s-secret|, and |k8s-mdbrsc|\s should
-        run in the same unique namespace.
+     kubectl describe configmaps <configmap-name>
 
   This command returns a ConfigMap description in the shell:
 
   .. code-block:: sh
 
-     Name:           <myconfigmap>
-     Namespace:      <metadata.namespace>
+     Name:           <configmap-name>
+     Namespace:      <namespace>
      Labels:         <none>
      Annotations:    <none>
+
+     Data
+     ====
+     baseUrl:
+     ----
+     <myOpsManagerURL>
+     Events:  <none>
 ...
diff --git a/source/includes/steps-set-configmap-for-tls.yaml b/source/includes/steps-set-configmap-for-tls.yaml
@@ -28,7 +28,7 @@ level: 4
 ref: paste-k8s-configmap-tls
 source:
   file: steps-source-configmap-secure.yaml
-  ref: paste-k8s-configmap
+  ref: paste-k8s-configmap-kubectl
 ---
 title: "Specify the TLS settings"
 stepnum: 4
@@ -72,15 +72,8 @@ ref: save-k8s-configmap
 ---
 stepnum: 6
 level: 4
-ref: reapply-k8s-configmap-tls
-source:
-  file: steps-source-configmap-secure.yaml
-  ref: reapply-k8s-configmap
----
-stepnum: 7
-level: 4
 ref: verify-k8s-configmap-tls
 source:
   file: steps-source-configmap-secure.yaml
-  ref: verify-k8s-configmap
+  ref: verify-k8s-configmap-kubectl
 ...
diff --git a/source/includes/steps-source-configmap-secure.yaml b/source/includes/steps-source-configmap-secure.yaml
@@ -39,6 +39,21 @@ content: |
   b. Paste the highlighted section in the example |k8s-configmap| at
      the end of the project ConfigMap.
 ---
+title: "Add the highlighted section to your project's ConfigMap."
+stepnum: 0
+level: 4
+ref: paste-k8s-configmap-kubectl
+content: |
+  a. Invoke the following command to edit your project's ConfigMap in
+     the default configured editor:
+
+     .. code-block:: sh
+
+        kubectl edit configmaps <my-configmap> -n <namespace>
+
+  b. Paste the highlighted section in the example |k8s-configmap| at
+     the end of the project ConfigMap.
+---
 title: "Save this file with a ``.yaml`` file extension."
 stepnum: 0
 level: 4
@@ -103,6 +118,43 @@ content: |
      Namespace:      <metadata.namespace>
      Labels:         <none>
      Annotations:    <none>
+
+---
+title: "Invoke the |k8s| command to verify your |k8s-configmap|."
+stepnum: 0
+level: 4
+ref: verify-k8s-configmap-kubectl
+content: |
+  .. code-block:: sh
+
+     kubectl describe configmaps <my-configmap> -n <namespace>
+
+  .. admonition:: *Always include the namespace option with* ``kubectl``
+     :class: important
+
+     |kubectl| defaults to an empty namespace if you do not specify the
+     ``-n`` option, resulting in deployment failures. The
+     |k8s-op-short|, |k8s-secret|, and |k8s-mdbrsc|\s should run in the
+     same unique namespace.
+
+  This command returns a ConfigMap description in the shell:
+
+  .. code-block:: sh
+
+     Name:           <my-configmap>
+     Namespace:      <namespace>
+     Labels:         <none>
+     Annotations:    <none>
+
+     Data
+     ====
+     sslMMSCAConfigMap:
+     ----
+     <root-ca-configmap-name>
+     sslRequireValidMMSServerCertificates:
+     ----
+     true
+     Events:  <none>
 ---
 title: "Approve the X.509 client certificates for the agents."
 stepnum: 0
diff --git a/source/tutorial/create-project-using-configmap.txt b/source/tutorial/create-project-using-configmap.txt
@@ -18,6 +18,13 @@ The |k8s-op-full| uses a |k8s| |k8s-configmap| to create or link your
 :ref:`example ConfigMap <example-k8s-configmap>` |yaml| file and apply
 the ConfigMap.
 
+Considerations
+--------------
+
+Starting in |k8s-op-full| version 1.3.0, you can only have one MongoDB
+resource per project. To learn how to deploy a MongoDB resource
+in your project, see :ref:`k8s-deploy-mdb-resources`.
+
 Prerequisites
 -------------
 
@@ -46,13 +53,6 @@ you need to add the CA that signed that custom certificate to the
 
 .. include:: /includes/steps/set-configmap-for-tls.rst
 
-Considerations
---------------
-
-Starting in |k8s-op-full| version 1.3.0, you can only have one MongoDB
-resource per project. To learn how to deploy a MongoDB resource
-in your project, see :ref:`k8s-deploy-mdb-resources`.
-
 Next Steps
 ----------
 
