(DOCSP-5380): remove namespace from yaml files (#171)

* (DOCSP-5380): remove namespace from yaml files

* (DOCSP-5380): copy review feedback

Author: jwilliams-mongo

source/includes/admonitions/note-namespace-match-configmap.rst

@@ -0,0 +1,11 @@
+.. admonition:: Value must match namespace and name of ConfigMap
+  :class: note
+
+  This value *must* match the namespace in which you created the 
+  |onprem| :ref:`project ConfigMap <create-k8s-project>`.
+
+  If this |k8s-mdbrsc| is in a different |k8s-ns| than the
+  :ref:`project ConfigMap <create-k8s-project>`, you should
+  set this value to the namespace *and* name of the
+  ConfigMap in this format:
+  ``<metadata.namespace>/<metadata.name>``

source/includes/admonitions/note-namespace-match-secret.rst

@@ -0,0 +1,11 @@
+.. admonition:: Value must use namespace and name of Secret
+   :class: note
+
+   This value *must* match the namespace in which you created the 
+   secret and the ``name`` value you provided for your |mms| 
+   |k8s| :ref:`Secret <create-k8s-credentials>`.
+
+   If this |k8s-obj| is in a different |k8s-ns| than the
+   Secret, you should set this value to the namespace *and*
+   name of the Secret in this format:
+   ``<namespace>/<name>``

source/includes/check-resource-status.rst

@@ -3,7 +3,7 @@ command:
 
 .. code-block:: sh
 
-   kubectl get mdb <resource-name> -n <namespace> -o yaml -w
+   kubectl get mdb <resource-name> -o yaml -w
 
 The ``-w`` flag means "watch". With the "watch" flag set, the output
 refreshes immediately when something changes until the status phase

source/includes/code-examples/yaml-files/example-replica-set.yaml

@@ -4,8 +4,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -25,8 +23,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -49,8 +45,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -76,8 +70,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -103,8 +95,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -133,8 +123,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -161,8 +149,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -192,8 +178,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -219,8 +203,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   members: 3
   version: 4.2.1
@@ -246,8 +228,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-replica-set>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
   members: 3
   version: 4.2.1
   opsManager:
@@ -266,7 +246,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-secure-replica-set>
-  namespace: <configMap.metadata.namespace>
 spec:
   members: 4
   version: 4.2.1

source/includes/code-examples/yaml-files/example-sharded-cluster.yaml

@@ -4,8 +4,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -28,8 +26,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -55,8 +51,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -85,8 +79,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -115,8 +107,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -148,8 +138,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -179,8 +167,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -213,8 +199,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -243,8 +227,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -273,8 +255,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-secure-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   shardCount: 2
   mongodsPerShardCount: 3
@@ -297,7 +277,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-secure-sharded-cluster>
-  namespace: <configMap.metadata.namespace>
 spec:
   shardCount: 3
   mongodsPerShardCount: 3

source/includes/code-examples/yaml-files/example-standalone.yaml

@@ -4,8 +4,6 @@ apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: <my-standalone>
-  namespace: <configMap.metadata.namespace>
-             # Must match metadata.namespace in ConfigMap file
 spec:
   version: 4.2.1
   opsManager:

source/includes/list-table-configmap-keys.rst

@@ -22,22 +22,6 @@
 
      - ``myconfigmap``
 
-   * - ``metadata.namespace``
-     - string
-     - Scope of object names. Used to limit what can be managed to
-       a subset of all |k8s-objs|. The default value is ``mongodb``.
-
-       .. important::
-          The |k8s-op-short|, |k8s-secret|, and |k8s-mdbrsc|\s
-          *must* be created in the same |k8s-ns|.
-
-       .. seealso::
-
-          - :setting:`metadata.namespace`
-          - |k8s| documentation on |k8s-nss|
-
-     - ``mongodb``
-
    * - ``data.projectName``
      - string
      - Label for your |mms|

source/includes/list-tables/configmap-keys.rst

@@ -22,22 +22,6 @@
 
      - ``myconfigmap``
 
-   * - ``metadata.namespace``
-     - string
-     - Scope of object names. Used to limit what can be managed to
-       a subset of all |k8s-objs|. The default value is ``mongodb``.
-
-       .. important::
-          The |k8s-op-short|, |k8s-secret|, and |k8s-mdbrsc|\s
-          *must* be created in the same |k8s-ns|.
-
-       .. seealso::
-
-          - :setting:`metadata.namespace`
-          - |k8s| documentation on |k8s-nss|
-
-     - ``mongodb``
-
    * - ``data.projectName``
      - string
      - Label for your |mms|

source/includes/list-tables/rs-resource-base-options.rst

@@ -19,22 +19,6 @@
 
      - ``myproject``
 
-   * - :setting:`metadata.namespace`
-     - string
-     - Scope of object names. |k8s| |k8s-ns| where this
-       |k8s-mdbrsc| and other |k8s-objs| are created.
-
-       Using two different namespaces allows you to delete your
-       standalone or all of the resources in the namespace without
-       affecting your |k8s-op-short|.
-
-       .. seealso::
-
-          - :setting:`metadata.namespace`
-          - |k8s| documentation on |k8s-nss|
-
-     - ``mongodb``
-
    * - :setting:`spec.members`
      - integer
      - Number of members of the :term:`replica set`.
@@ -61,18 +45,7 @@
        :setting:`spec.cloudManager.configMapRef.name` setting is an
        alias for this setting and can be used in its place.
 
-       .. admonition:: Value must match namespace and name of ConfigMap
-          :class: note
-
-          This value *must* match the value you provided for
-          :setting:`metadata.name` in your |onprem|
-          :ref:`project ConfigMap <create-k8s-project>`.
-
-          If this |k8s-mdbrsc| is in a different |k8s-ns| than the
-          :ref:`project ConfigMap <create-k8s-project>`, you should
-          set this value to the namespace *and* name of the
-          ConfigMap in this format:
-          ``<metadata.namespace>/<metadata.name>``
+       .. include:: /includes/admonitions/note-namespace-match-configmap.rst
 
        .. include:: /includes/k8s/fact-k8s-operator-manages-configmap.rst
 
@@ -86,17 +59,7 @@
        authentication credentials for the |k8s-op-short| to
        communicate with |onprem|.
 
-       .. admonition:: Value must use namespace and name of Secret
-          :class: note
-
-          This value *must* match the value you provided for
-          :setting:`namespace` and `name` for your |mms| |k8s|
-          :ref:`Secret <create-k8s-credentials>`.
-
-          If this |k8s-obj| is in a different |k8s-ns| than the
-          Secret, you should set this value to the namespace *and*
-          name of the Secret in this format:
-          ``<namespace>/<name>``
+       .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
        .. include:: /includes/k8s/fact-k8s-operator-manages-secret.rst
 

source/includes/options-k8s-shared.yaml

@@ -119,18 +119,7 @@ description: |
   configuration. The :setting:`spec.cloudManager.configMapRef.name`
   setting is an alias for this setting and can be used in its place.
 
-  .. admonition:: Value must match namespace and name of ConfigMap
-     :class: note
-
-     This value *must* match the value you provided for
-     :setting:`metadata.name` in your |com|
-     :ref:`project ConfigMap <create-k8s-project>`.
-
-     If this |k8s-mdbrsc| is in a different |k8s-ns| than the
-     :ref:`project ConfigMap <create-k8s-project>`, you should
-     set this value to the namespace *and* name of the
-     ConfigMap in this format:
-     ``<namespace>/<name>``
+  .. include:: /includes/admonitions/note-namespace-match-configmap.rst
 
   .. include:: /includes/k8s/fact-k8s-operator-manages-configmap.rst
 
@@ -162,16 +151,7 @@ description: |
   <create-k8s-secret>` as |mms| |api| authentication credentials for
   the |k8s-op-short| to communicate with |com|.
 
-  .. admonition:: Value must use namespace and name of Secret
-     :class: note
-
-     This value *must* match the value you provided for
-     :setting:`namespace` and `name` for your |mms| |k8s| :ref:`Secret
-     <create-k8s-credentials>`.
-
-     If this |k8s-obj| is in a different |k8s-ns| than the Secret, you
-     should set this value to the namespace *and* name of the Secret in
-     this format: ``<namespace>/<name>``
+  .. include:: /includes/admonitions/note-namespace-match-secret.rst
 
   .. include:: /includes/k8s/fact-k8s-operator-manages-secret.rst