Skip to content

Commit 6e81388

Browse files
(DOCSP-30392): Clarify node priority behavior for elections (#3513)
* (DOCSP-30392): Clarify node priority behavior for elections * formatting * removed old version changed * wording * minimalism * wording * remove extra info about priority * tweaks * wording * address review feedback * typos and clarifications * add hyphen: * clarify behaviors * standardize terminology node > member * wording
1 parent bf9f67f commit 6e81388

File tree

2 files changed

+26
-24
lines changed

2 files changed

+26
-24
lines changed

source/core/replica-set-elections.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ Replica set members send heartbeats (pings) to each other every two
6868
seconds. If a heartbeat does not return within 10 seconds, the other
6969
members mark the delinquent member as inaccessible.
7070

71+
.. _rs-election-priority:
72+
7173
Member Priority
7274
~~~~~~~~~~~~~~~
7375

source/reference/replica-configuration.txt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -335,43 +335,43 @@ Replica Set Configuration Fields
335335

336336
.. rsconf:: members[n].priority
337337

338-
.. versionchanged:: 3.6
339-
340-
Starting in MongoDB 3.6, arbiters have the priority ``0``. If an
341-
arbiter has a priority of ``1``, MongoDB 3.6 reconfigures the
342-
arbiter to have a priority of ``0``.
343-
344338
*Optional*.
345339

346340
*Type*: Number between 0 and 1000 for primary/secondary; 0 or 1 for arbiters.
347341

348342
*Default*: 1.0 for primary/secondary; 0 for arbiters.
349343

350-
A number that indicates the relative eligibility of a member to
351-
become a :term:`primary`.
344+
A number that indicates the relative likelihood of a replica set
345+
member to become the :term:`primary`.
352346

353-
Specify higher values to make a member *more* eligible to become
354-
:term:`primary`, and lower values to make the member *less*
355-
eligible. A member with a :rsconf:`members[n].priority` of ``0`` is
356-
ineligible to become primary.
347+
- To increase the likelihood that a member becomes the primary,
348+
specify a higher ``priority`` value for that member.
357349

358-
.. include:: /includes/fact-rs-nonzero-priority-vote-restriction.rst
350+
- To decrease the likelihood that a member becomes the primary,
351+
specify a lower ``priority`` value for that member.
359352

360-
Changing the balance of priority in a replica set will trigger
361-
one or more elections. If a lower priority secondary is elected
362-
over a higher priority secondary, replica set members will
363-
continue to call elections until the highest priority available
364-
member becomes primary.
353+
Changing a member's priority triggers one or more elections. The
354+
election algorithm makes a best-effort attempt to elect the
355+
highest-priority member the primary. However, a lower-priority
356+
member may become the primary even if a higher-priority secondary
357+
is available.
358+
359+
If a lower-priority member becomes the primary, the server
360+
continues to periodically call elections until the
361+
highest-priority replica set member is the primary. The frequency
362+
at which the elections occur depends on the difference in priority
363+
between the elected member and the highest-priority member.
364+
365+
A member with a priority of ``0`` cannot become the primary.
365366

366-
Members with :rsconf:`~members[n].priority` of ``0`` can
367-
acknowledge write operations issued with :ref:`write-concern`.
368-
For write operations issued with :writeconcern:`"majority"` write
369-
concern, the member must also be a voting member (i.e.
370-
:rsconf:`~members[n].votes` is greater than ``0``).
367+
Non-voting members (meaning members that have
368+
:rsconf:`~members[n].votes` set to ``0``) must have a priority of
369+
``0``.
371370

372371
.. seealso::
373372

374-
:ref:`Replica Set Elections <replica-set-elections>`.
373+
- :ref:`Replica Set Elections <replica-set-elections>`
374+
- :ref:`rs-election-priority`
375375

376376
.. rsconf:: members[n].tags
377377

0 commit comments

Comments
 (0)