From f6451cef19d6b7712bf66a12f76ab62e072c83f1 Mon Sep 17 00:00:00 2001 From: Andrii Rodionov Date: Fri, 12 Jul 2024 12:40:18 +0200 Subject: [PATCH] Clarify CP Leadership Priority option (#1168) Addressing the support team request, and clarifying that the `cp-member-priority` option is not taken into account during the leader election. --------- Co-authored-by: Oliver Howell --- docs/modules/cp-subsystem/pages/configuration.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/cp-subsystem/pages/configuration.adoc b/docs/modules/cp-subsystem/pages/configuration.adoc index ac6c2fb8c..c168939a7 100644 --- a/docs/modules/cp-subsystem/pages/configuration.adoc +++ b/docs/modules/cp-subsystem/pages/configuration.adoc @@ -120,7 +120,7 @@ you should xref:cp-subsystem:management.adoc#destroying-a-cp-group-by-force[dest Some CP members are better leadership candidates than others. For example, members in your primary data center make better leaders because of the reduced latency between clients and the leader. Whereas, members under high load are not good candidates because they are more likely to suffer from downtime. To ensure the availability of the CP subsystem, you can configure CP members with a priority rating, using the <> option. -Initially, any CP member with any priority can become a leader. But, the leadership rebalancing task periodically transfers the leadership from CP members with the lowest priorities to those with higher priorities within each CP group. Eventually, all CP group leaders are CP members with high priorities. +Initially, any CP member with any priority can become a leader (`cp-member-priority` is not therefore taken into account during the leader election processes). But, the backgound leadership rebalancing task periodically transfers the leadership from CP members with the lowest priorities to those with higher priorities within each CP group. Eventually, all CP group leaders are CP members with high priorities. NOTE: Only CP members that are part of a CP group can become leaders. CP members that are not in a CP group do not participate in the leadership rebalancing task. For example, you start a cluster with the CP group size set to three and three CP members with priority 0. Later, you promote a new CP member with priority 100. Even though it has a higher priority, the new CP member never becomes a leader because the CP group is full. The new CP member is eligible for leadership only when a CP member leaves the CP group and the new CP member takes the previous member's place.