(DOCSP-20028) Various minor edits to MEKO (#790)

JuliaMongo · jwilliams-mongo · commit bf4b2d8e66b2 · 2025-04-14T17:11:18.000-05:00
* (DOCSP-20028) Various minor edits to MEKO * Edits * Edits * Edits * Copy review
diff --git a/source/includes/facts/k8s-remove-operator-deployment.rst b/source/includes/facts/k8s-remove-operator-deployment.rst
@@ -1,3 +1,3 @@
 .. code-block:: sh
 
-    kubectl delete deployment/mongodb-enterprise-operator --namespace <namespace>
+    kubectl delete deployment/mongodb-enterprise-operator -n <metadata.namespace>
diff --git a/source/includes/facts/oc-remove-operator-deployment.rst b/source/includes/facts/oc-remove-operator-deployment.rst
@@ -1,3 +1,3 @@
 .. code-block:: sh
 
-    oc delete deployment/mongodb-enterprise-operator --namespace <namespace>
+    oc delete deployment/mongodb-enterprise-operator -n <metadata.namespace>
diff --git a/source/includes/list-tables/configmap-keys.rst b/source/includes/list-tables/configmap-keys.rst
@@ -1,5 +1,5 @@
 .. list-table::
-   :widths: 20 20 40 20
+   :widths: 20 10 50 20
    :header-rows: 1
 
    * - Key
diff --git a/source/includes/list-tables/rs-resource-base-options.rst b/source/includes/list-tables/rs-resource-base-options.rst
@@ -1,5 +1,5 @@
 .. list-table::
-   :widths: 20 20 40 20
+   :widths: 20 10 50 20
    :header-rows: 1
 
    * - Key
diff --git a/source/includes/options-k8s-shared.yaml b/source/includes/options-k8s-shared.yaml
@@ -1189,7 +1189,7 @@ description: |
   .. code-block:: sh
 
      kubectl create secret generic ldap-agent-user \
-     --from-literal="password=<password>" -n <namespace>
+     --from-literal="password=<password>" -n <metadata.namespace>
 
   This secret must contain one key, the value of which matches the
   password of the
@@ -1241,7 +1241,7 @@ description: |
      --from-file=mms-automation-agent-pem=<automation-cert.pem> \
      --from-file=mms-backup-agent-pem=<backup-cert.pem> \
      --from-file=mms-monitoring-agent-pem=<monitoring-cert.pem> \
-     -n <namespace>
+     --namespace=<metadata.namespace>
 
 ---
 program: _shared
diff --git a/source/includes/steps-configure-kubectl-namespace.yaml b/source/includes/steps-configure-kubectl-namespace.yaml
@@ -10,5 +10,5 @@ content: |
 
   .. code-block:: sh
 
-     kubectl config set-context $(kubectl config current-context) --namespace=<namespace>
+     kubectl config set-context $(kubectl config current-context) --namespace=<metadata.namespace>
 ...
diff --git a/source/includes/steps-deploy-k8s-opsmgr-http.yaml b/source/includes/steps-deploy-k8s-opsmgr-http.yaml
@@ -32,7 +32,7 @@ ref: change-k8s-values
 content: |
 
    .. list-table::
-      :widths: 20 20 40 20
+      :widths: 30 10 40 20
       :header-rows: 1
 
       * - Key
@@ -145,7 +145,7 @@ content: |
   settings:
 
   .. list-table::
-    :widths: 20 20 40 20
+    :widths: 30 10 40 20
     :header-rows: 1
 
     * - Key
@@ -191,7 +191,7 @@ content: |
   To configure a snapshot store, configure the following settings:
 
   .. list-table::
-    :widths: 20 20 40 20
+    :widths: 30 10 40 20
     :header-rows: 1
 
     * - Key
@@ -241,7 +241,7 @@ content: |
   To configure a blockstore, configure the following settings:
 
   .. list-table::
-    :widths: 20 20 40 20
+    :widths: 30 10 40 20
     :header-rows: 1
 
     * - Key
diff --git a/source/includes/steps-deploy-k8s-sharded-cluster.yaml b/source/includes/steps-deploy-k8s-sharded-cluster.yaml
@@ -44,7 +44,7 @@ ref: change-k8s-values
 content: |
 
    .. list-table::
-      :widths: 20 20 40 20
+      :widths: 10 20 50 20
       :header-rows: 1
 
       * - Key
diff --git a/source/includes/steps-deploy-k8s-standalone.yaml b/source/includes/steps-deploy-k8s-standalone.yaml
@@ -35,7 +35,7 @@ ref: change-k8s-values
 content: |
 
    .. list-table::
-      :widths: 20 20 40 20
+      :widths: 10 20 50 20
       :header-rows: 1
 
       * - Key
diff --git a/source/includes/steps-enable-external-sharded.yaml b/source/includes/steps-enable-external-sharded.yaml
@@ -82,7 +82,7 @@ content: |
 
   .. code-block:: sh
 
-     kubectl get services -n <namespace>
+     kubectl get services -n <metadata.namespace>
 
   The list output should contain an entry similar to the following:
 
diff --git a/source/includes/steps-enable-external-standalone.yaml b/source/includes/steps-enable-external-standalone.yaml
@@ -83,7 +83,7 @@ content: |
 
   .. code-block:: sh
 
-     kubectl get services -n <namespace>
+     kubectl get services -n <metadata.namespace>
 
   The list output should contain an entry similar to the following:
 
diff --git a/source/includes/steps-install-prereqs.yaml b/source/includes/steps-install-prereqs.yaml
@@ -153,6 +153,6 @@ content: |
 
      .. code-block:: sh
 
-        oc apply -f openshift-pull-secret.yaml -n <namespace>
+        oc apply -f openshift-pull-secret.yaml -n <metadata.namespace>
 
 ...
diff --git a/source/includes/steps-source-configmap-secure.yaml b/source/includes/steps-source-configmap-secure.yaml
@@ -11,7 +11,7 @@ content: |
 
   .. code-block:: sh
 
-     kubectl -n <namespace> create configmap <root-ca-configmap-name> \
+     kubectl -n <metadata.namespace> create configmap <root-ca-configmap-name> \
        --from-file=mms-ca.crt
 
   .. important::
@@ -49,7 +49,7 @@ content: |
 
      .. code-block:: sh
 
-        kubectl edit configmaps <my-configmap> -n <namespace>
+        kubectl edit configmaps <my-configmap> -n <metadata.namespace>
 
   b. Paste the highlighted section in the example |k8s-configmap| at
      the end of the project ConfigMap.
@@ -127,7 +127,7 @@ ref: verify-k8s-configmap-kubectl
 content: |
   .. code-block:: sh
 
-     kubectl describe configmaps <my-configmap> -n <namespace>
+     kubectl describe configmaps <my-configmap> -n <metadata.namespace>
 
   .. admonition:: *Always include the namespace option with* ``kubectl``
      :class: important
diff --git a/source/includes/steps-source-deploy-k8s-resource.yaml b/source/includes/steps-source-deploy-k8s-resource.yaml
@@ -254,7 +254,7 @@ level: 4
 ref: start-k8s-deployment
 content: |
 
-   Invoke the following |k8s| command to create your
+   In any directory, invoke the following |k8s| command to create your
    {{k8sResource}}:
 
    .. code-block:: sh
@@ -268,8 +268,8 @@ level: 4
 ref: restart-k8s-deployment
 content: |
 
-   Invoke the following |k8s| command to update and restart your
-   {{k8sResource}}:
+   In any directory, invoke the following |k8s| command to update and 
+   restart your {k8sResource}}:
 
    .. code-block:: sh
 
@@ -307,8 +307,8 @@ ref: check-k8s-deployment
 content: |
   The |k8s-op-short| creates the MongoDB resources and requests the
   |k8s| |certauth| to approve the database host's certificates. Run the
-  following command to verify that the certificates are pending
-  approval:
+  following command in any directory to verify that the certificates
+  are pending approval:
 
   .. code-block:: sh
 
@@ -341,7 +341,7 @@ level: 4
 ref: create-k8s-configmap
 content: |
 
-  Invoke the |k8s| command to update your |k8s-configmap|:
+  In any directory, invoke the |k8s| command to update your |k8s-configmap|:
 
   .. code-block:: sh
 
@@ -354,7 +354,7 @@ level: 4
 ref: verify-k8s-configmap
 content: |
 
-  Invoke the |k8s| command to verify your |k8s-configmap|:
+  In any directory, invoke the |k8s| command to verify your |k8s-configmap|:
 
   .. code-block:: sh
 
diff --git a/source/reference/known-issues.txt b/source/reference/known-issues.txt
@@ -52,7 +52,7 @@ following command:
 
 .. code-block:: sh
 
-   kubectl get pods -n <namespace>
+   kubectl get pods -n <metadata.namespace>
 
 A response like the following indicates that all of your |mongos| Pods
 are ``READY``:
@@ -99,13 +99,13 @@ Run the following command to scale down:
 
 .. code-block:: sh
 
-   kubectl scale deployment mongodb-enterprise-operator --replicas=0 -n <namespace>
+   kubectl scale deployment mongodb-enterprise-operator --replicas=0 -n <metadata.namespace>
      
 Run the following command to scale up:
 
 .. code-block:: sh
 
-   kubectl scale deployment mongodb-enterprise-operator --replicas=1 -n <namespace>
+   kubectl scale deployment mongodb-enterprise-operator --replicas=1 -n <metadata.namespace>
 
 
 .. _k8s-private-cluster-on-gke:
diff --git a/source/reference/troubleshooting.txt b/source/reference/troubleshooting.txt
@@ -24,7 +24,7 @@ invoke one of the following commands:
 
   .. code-block:: sh
 
-     kubectl get <resource-name> -n <namespace> -o yaml
+     kubectl get <resource-name> -n <metadata.namespace> -o yaml
 
   - The ``status.applicationDatabase.phase`` field displays the
     Application Database resource deployment status.
@@ -46,7 +46,7 @@ invoke one of the following commands:
 
   .. code-block:: sh
 
-     kubectl get mdb <resource-name> -n <namespace> -o yaml
+     kubectl get mdb <resource-name> -n <metadata.namespace> -o yaml
 
   The ``status.phase`` field displays the MongoDB resource deployment
   status.
@@ -215,7 +215,7 @@ To view all |k8s-mdbrsc| specifications in the provided
 
 .. code-block:: shell
 
-   kubectl get mdb -n <namespace>
+   kubectl get mdb -n <metadata.namespace>
 
 .. example::
 
@@ -224,7 +224,7 @@ To view all |k8s-mdbrsc| specifications in the provided
 
    .. code-block:: shell
 
-      kubectl get mdb dublin -n <namespace> -o yaml
+      kubectl get mdb dublin -n <metadata.namespace> -o yaml
 
    This returns the following response:
 
diff --git a/source/tutorial/create-operator-credentials.txt b/source/tutorial/create-operator-credentials.txt
@@ -40,12 +40,6 @@ To create credentials for the |k8s-op-short|, you must:
 1. Have or create an |onprem|
    :opsmgr:`Organization </tutorial/manage-organizations>`.
 
-   .. note::
-
-      Unlike earlier |k8s-op-short| versions, use the Operator to
-      create your |mms| project. The Operator adds additional metadata
-      to Projects that it creates to help manage the deployments.
-
 #. Have or generate a
    :ref:`Programmatic API Key <create-org-app-api-key>`.
 
@@ -70,16 +64,14 @@ To create your |k8s| secret:
    .. code-block:: sh
 
       kubectl -n <metadata.namespace> \
-        create secret generic <myCredentials> \
+        create secret generic <mycredentials> \
         --from-literal="publicKey=<publicKey>" \
         --from-literal="privateKey=<privateKey>"
 
-   .. note::
-
-      The ``-n`` flag limits the |k8s-ns| to which this secret
-      applies. All MongoDB |k8s| resources must be in the same
-      namespace with the |k8s-secrets| and |k8s-configmaps|. The
-      |k8s-op-short| does not use either the secrets or ConfigMaps.
+   The ``-n`` flag limits the |k8s-ns| to which this secret applies.
+   All MongoDB |k8s| resources must exist in the same namespace as the
+   |k8s-secrets| and |k8s-configmaps|. The |k8s-op-short| doesn't use
+   either the secrets or ConfigMaps.
 
    .. note::
 
@@ -91,13 +83,13 @@ To create your |k8s| secret:
 
    .. code-block:: sh
 
-      kubectl describe secrets/<myCredentials> -n <metadata.namespace>
+      kubectl describe secrets/<mycredentials> -n <metadata.namespace>
 
    This command returns a secret description in the shell:
 
    .. code-block:: sh
 
-      Name:         <myCredentials>
+      Name:         <mycredentials>
       Namespace:    <metadata.namespace>
       Labels:       <none>
       Annotations:  <none>
diff --git a/source/tutorial/deploy-om-container-local-mode.txt b/source/tutorial/deploy-om-container-local-mode.txt
@@ -71,7 +71,7 @@ Prerequisites
 
   .. code-block:: sh
 
-     kubectl apply -f <opsmgr-resource>.yaml -n <namespace>
+     kubectl apply -f <opsmgr-resource>.yaml -n <metadata.namespace>
 
 Procedure
 ---------
diff --git a/source/tutorial/install-k8s-operator.txt b/source/tutorial/install-k8s-operator.txt
@@ -94,7 +94,7 @@ following command and verify the output:
 
 .. code-block:: sh
 
-   kubectl describe deployments mongodb-enterprise-operator -n <namespace>
+   kubectl describe deployments mongodb-enterprise-operator -n <metadata.namespace>
 
 By default, deployments exist in the ``mongodb`` namespace. If the 
 following error message appears, ensure you use the correct 
diff --git a/source/tutorial/modify-resource-image.txt b/source/tutorial/modify-resource-image.txt
@@ -78,7 +78,7 @@ To create a volume mount for a MongoDB database resource:
 
    .. code-block:: sh
 
-      kubectl apply -f <database-resource-conf>.yaml -n <namespace>
+      kubectl apply -f <database-resource-conf>.yaml -n <metadata.namespace>
 
 Tune MongoDB Kubernetes Resource Docker Images with an InitContainer
 --------------------------------------------------------------------
@@ -136,7 +136,7 @@ To tune Docker images for a MongoDB database resource container:
 
    .. code-block:: sh
 
-      kubectl apply -f <database-resource-conf>.yaml -n <namespace>
+      kubectl apply -f <database-resource-conf>.yaml -n <metadata.namespace>
 
 |k8s| adds a privileged InitContainer to each |k8s-pod| that the
 |k8s-op-short| creates using the |k8s-mdbrsc| definition.
@@ -152,7 +152,7 @@ Open a shell session to a running container in your database resource
    .. code-block:: sh
       :copyable: false
 
-      > kubectl exec -n <namespace> -it <pod-name> -- cat /proc/sys/net/ipv4/tcp_keepalive_time
+      > kubectl exec -n <metadata.namespace> -it <pod-name> -- cat /proc/sys/net/ipv4/tcp_keepalive_time
 
 
       > 120
diff --git a/source/tutorial/plan-om-resource.txt b/source/tutorial/plan-om-resource.txt
@@ -257,7 +257,8 @@ To disable backup after you enabled it:
 
    .. code-block:: sh
 
-      kubectl delete statefulset <metadata.name>-backup-daemon -n <namespace>
+      kubectl delete statefulset <metadata.name> -backup-daemon \
+       -n <metadata.namespace>
 
 .. important::
 
@@ -386,7 +387,8 @@ Prerequisites
 
    .. code-block:: sh
 
-      kubectl config set-context $(kubectl config current-context) --namespace=<namespace>
+      kubectl config set-context $(kubectl config current-context) \
+        -n <metadata.namespace>
 
 #. :doc:`Install </tutorial/install-k8s-operator>` the |k8s-op| 1.6.x or
    later.
diff --git a/source/tutorial/set-scope-k8s-operator.txt b/source/tutorial/set-scope-k8s-operator.txt
@@ -264,7 +264,7 @@ instructions for your preferred installation method.
 
                .. code-block:: sh
 
-                  helm template --set namespace=<namespace> \
+                  helm template --set namespace=<metadata.namespace> \
                   helm_chart --show-only templates/database-roles.yaml | kubectl
                   apply -f -
 
@@ -420,7 +420,7 @@ instructions for your preferred installation method.
 
                .. code-block:: sh
 
-                  helm template --set namespace=<namespace> \
+                  helm template --set namespace=<metadata.namespace> \
                   helm_chart --show-only templates/database-roles.yaml | oc
                   apply -f -
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`.. code-block:: sh`
`2`	`2`
`3`		`- kubectl delete deployment/mongodb-enterprise-operator --namespace <namespace>`
	`3`	`+ kubectl delete deployment/mongodb-enterprise-operator -n <metadata.namespace>`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`.. code-block:: sh`
`2`	`2`
`3`		`- oc delete deployment/mongodb-enterprise-operator --namespace <namespace>`
	`3`	`+ oc delete deployment/mongodb-enterprise-operator -n <metadata.namespace>`