Skip to content

Commit 3ad92b7

Browse files
committed
(DOCSP-30023) Edited memberConfig.priority in MongoDB Database Resource Specification and Multi-Kubernates-Cluster Resource Specification to match.
1 parent 5283a62 commit 3ad92b7

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -635,7 +635,7 @@ inherit:
635635
program: _shared
636636
file: options-k8s-shared.yaml
637637
---
638-
program: k8sRsConf
638+
program: k8sRsConf
639639
name: spec.security.authentication.ldap.caConfigMapRef
640640
inherit:
641641
name: spec.security.authentication.ldap.caConfigMapRef
@@ -837,9 +837,13 @@ type: string
837837
directive: setting
838838
optional: true
839839
description: |
840-
Number that indicates the relative eligibility of a MongoDB replica set member to become a `primary <https://www.mongodb.com/docs/manual/reference/glossary/#std-term-primary>`__.
840+
Number that indicates the relative eligibility of an application database replica set member to become a `primary <https://www.mongodb.com/docs/manual/reference/glossary/#std-term-primary>`__.
841+
842+
* To increase eligibility for a replica set member to become primary, specify a higher value.
843+
844+
* To decrease eligibility for a replica set member to become primary, specify a lower value.
841845
842-
Specify a higher value to make a member more eligible to become primary, and lower values to make the member less eligible. For example, a member with a ``spec.clusterSpecList.memberConfig.priority`` of ``"1.5"`` is more likely than ``"0.5"`` to become a primary. A priority of ``"0"`` is ineligible to become primary. For more details, see `Member Priority <https://www.mongodb.com/docs/manual/core/replica-set-elections/#voting-members>`__.
846+
For example, a member with a ``spec.clusterSpecList.memberConfig.priority``` of ``"1.5"`` is more likely than ``"0.5"`` to become a primary. A priority of ``"0"`` is ineligible to become primary. To learn more, see :manual:`Member Priority </core/replica-set-elections/#voting-members>`.
843847
844848
---
845849
program: k8sRsConf
@@ -849,7 +853,7 @@ directive: setting
849853
optional: true
850854
description: |
851855
Map of :manual:`replica set tags </tutorial/configure-replica-set-tag-sets/>` for directing
852-
read and write operations to specific members of your MongoDB replica set.
856+
read and write operations to specific members of your application replica set.
853857
854858
---
855859
program: k8sRsConf

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -428,26 +428,30 @@ Optional ``MongoDBMultiCluster`` Resource Settings
428428
.. _multi-spec-clusterspeclist-memberconfig:
429429

430430
``spec.clusterSpecList.memberConfig``
431-
*Type*: collection
431+
*Type*: collection
432432

433433
Specification for the MongoDB replica set members in your |multi-cluster|.
434434

435435
.. _multi-spec-clusterspeclist-memberconfig-priority:
436436

437437
``spec.clusterSpecList.memberConfig.priority``
438438
*Type*: string
439+
440+
Number that indicates the relative eligibility of an application database replica set member to become a `primary <https://www.mongodb.com/docs/manual/reference/glossary/#std-term-primary>`__.
439441

440-
Number that indicates the relative eligibility of a MongoDB replica set member to become a `primary <https://www.mongodb.com/docs/manual/reference/glossary/#std-term-primary>`__.
442+
* To increase eligibility for a replica set member to become primary, specify a higher value.
443+
444+
* To decrease eligibility for a replica set member to become primary, specify a lower value.
441445

442-
Specify a higher value to make a member more eligible to become primary, and lower values to make the member less eligible. For example, a member with a ``spec.clusterSpecList.memberConfig.priority`` of ``"1.5"`` is more likely than ``"0.5"`` to become a primary. A priority of ``"0"`` is ineligible to become primary. For more details, see `Member Priority <https://www.mongodb.com/docs/manual/core/replica-set-elections/#voting-members>`__.
446+
For example, a member with a ``spec.clusterSpecList.memberConfig.priority``` of ``"1.5"`` is more likely than ``"0.5"`` to become a primary. A priority of ``"0"`` is ineligible to become primary. To learn more, see :manual:`Member Priority </core/replica-set-elections/#voting-members>`.
443447

444448
.. _multi-spec-clusterspeclist-memberconfig-tags:
445449

446450
``spec.clusterSpecList.memberConfig.tags``
447451
*Type*: map
448452

449453
Map of :manual:`replica set tags </tutorial/configure-replica-set-tag-sets/>` for directing
450-
read and write operations to specific members of your MongoDB replica set.
454+
read and write operations to specific members of your application replica set.
451455

452456
.. _multi-spec-clusterspeclist-memberconfig-votes:
453457

0 commit comments

Comments
 (0)