(DOCSP-33941): Fix incorrect spec.memberConfig settings (#1496)

* Fix spec.memberConfig setting

* copy review feedback

* tech review feedback

Author: davidhou17

source/includes/options-k8s-replica-set.yaml

@@ -832,7 +832,46 @@ inherit:
 
 ---
 program: k8sRsConf
-name: spec.clusterSpecList.memberConfig.priority
+name: spec.memberConfig
+type: collection
+directive: setting
+optional: true
+description: |
+  Specification for each MongoDB replica set member deployed from 
+  the |k8s-mdbrsc|.
+
+  The order of the elements in the array must reflect the order of members 
+  in the replica set. For example, the first element of the array affects 
+  the Pod at index ``0``, the second element affects index ``1``, and so on.
+  
+  .. example::
+
+     Consider the following example specification for a 
+     three-member replica set:
+
+     .. code-block:: yaml
+
+        spec:
+          memberConfig:
+            - votes: 1
+              priority: "0.5"
+              tags:
+                tag1: "value1"
+                environment: "prod"
+            - votes: 1
+              priority: "1.5"
+              tags:
+                tag2: "value2"
+                environment: "prod"
+            - votes: 0
+              priority: "0.5"
+              tags:
+                tag2: "value2"
+                environment: "prod"
+
+---
+program: k8sRsConf
+name: spec.memberConfig.priority
 type: string
 directive: setting
 optional: true
@@ -849,7 +888,7 @@ description: |
 
 ---
 program: k8sRsConf
-name: spec.clusterSpecList.memberConfig.tags
+name: spec.memberConfig.tags
 type: map
 directive: setting
 optional: true
@@ -859,7 +898,7 @@ description: |
 
 ---
 program: k8sRsConf
-name: spec.clusterSpecList.memberConfig.votes
+name: spec.memberConfig.votes
 type: number
 directive: setting
 optional: true

source/reference/k8s-operator-multi-cluster-specification.txt

@@ -429,10 +429,66 @@ Optional ``MongoDBMultiCluster`` Resource Settings
 .. _multi-spec-clusterspeclist-memberconfig:
 
 ``spec.clusterSpecList.memberConfig``
-  *Type*: collection 
+  *Type*: collection
 
-  Specification for the MongoDB replica set members in your |multi-cluster|.
+  Specification for each MongoDB replica set and its 
+  members in your |multi-cluster|.
 
+  The order of the elements in the object for each replica set
+  must reflect the order of members in the replica set. For example, 
+  the first element affects the Pod at index ``0``, the second 
+  element affects index ``1``, and so on.
+  
+  .. example::
+
+     Consider the following example specification for a 
+     |multi-cluster| with three replica sets:
+
+     .. code-block:: yaml
+
+        apiVersion: mongodb.com/v1
+        kind: MongoDBMultiCluster
+        metadata:
+          name: multi-replica-set
+        spec:
+          version: 4.4.0-ent
+          type: ReplicaSet
+          duplicateServiceObjects: false
+          credentials: my-credentials
+          opsManager:
+            configMapRef:
+              name: my-project
+          clusterSpecList:
+            - clusterName: cluster1.example.com
+              members: 2
+              memberConfig:
+                  - votes: 1
+                    priority: "0.5"
+                    tags:
+                        tag1: "value1"
+                        environment: "prod"
+                  - votes: 1
+                    priority: "1.5"
+                    tags:
+                          tag2: "value2"
+                          environment: "prod"
+            - clusterName: cluster2.example.com
+              members: 1
+              memberConfig:
+                  - votes: 1
+                    priority: "0.5"
+                    tags:
+                        tag1: "value1"
+                        environment: "prod" 
+            - clusterName: cluster3.example.com
+              members: 1
+              memberConfig:
+                  - votes: 1
+                    priority: "0.5"
+                    tags:
+                        tag1: "value1"
+                        environment: "prod"
+  
 .. _multi-spec-clusterspeclist-memberconfig-priority:
 
 ``spec.clusterSpecList.memberConfig.priority``

source/reference/k8s-operator-specification.txt

@@ -204,9 +204,10 @@ The following settings apply only to replica set resource types:
 
 .. include:: /includes/option/setting-k8sSaConf-spec.featureCompatibilityVersion.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.members.rst
-.. include:: /includes/option/setting-k8sRsConf-spec.clusterSpecList.memberConfig.priority.rst
-.. include:: /includes/option/setting-k8sRsConf-spec.clusterSpecList.memberConfig.tags.rst
-.. include:: /includes/option/setting-k8sRsConf-spec.clusterSpecList.memberConfig.votes.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.memberConfig.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.memberConfig.priority.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.memberConfig.tags.rst
+.. include:: /includes/option/setting-k8sRsConf-spec.memberConfig.votes.rst
 .. include:: /includes/option/setting-k8sRsConf-spec.podSpec.podAntiAffinityTopologyKey.rst
 
 

source/release-notes.txt

@@ -380,10 +380,10 @@ MongoDBMultiCluster Resource
   settings to configure external connectivity settings for |mongodb-multis|. Use these settings to
   :ref:`connect to a Multi-Cluster Resource from outside Kubernetes <multi-cluster-connect-from-outside-k8s>`.
 
-- Adds the :ref:`spec.memberOptions.memberConfig.votes <multi-spec-clusterspeclist-memberconfig-votes>`
-  and :ref:`spec.memberOptions.memberConfig.priority <multi-spec-clusterspeclist-memberconfig-priority>`
+- Adds the :ref:`spec.clusterSpecList.memberConfig.votes <multi-spec-clusterspeclist-memberconfig-votes>`
+  and :ref:`spec.clusterSpecList.memberConfig.priority <multi-spec-clusterspeclist-memberconfig-priority>`
   settings for configuring replica set member votes and member priority for |mongodb-multis|.
-- Adds the :ref:`spec.memberOptions.memberConfig.tags <multi-spec-clusterspeclist-memberconfig-tags>`
+- Adds the :ref:`spec.clusterSpecList.memberConfig.tags <multi-spec-clusterspeclist-memberconfig-tags>`
   setting for adding tags to replica set members in |mongodb-multis|.
 
 - Adds the :ref:`spec.security.authentication.ldap.timeoutMS <multi-spec-security-ldap-timeoutms>`
@@ -393,9 +393,9 @@ MongoDBMultiCluster Resource
 MongoDB Resource
 `````````````````
 
-- Adds the :setting:`spec.memberOptions.memberConfig.votes` and :setting:`spec.memberOptions.memberConfig.priority`
+- Adds the :setting:`spec.memberConfig.votes` and :setting:`spec.memberConfig.priority`
   settings for configuring replica set member votes and member priority.
-- Adds the :setting:`spec.memberOptions.memberConfig.tags` setting for adding tags
+- Adds the :setting:`spec.memberConfig.tags` setting for adding tags
   to replica set members.
 - Adds the :setting:`spec.podSpec.podAffinity` setting to determine whether
   multiple |k8s-mdbrsc| |k8s-pods| must be co-located with other