Skip to content

Commit

Permalink
docs(priority-election): fix the property key (#4716)
Browse files Browse the repository at this point in the history
  • Loading branch information
diasonti authored Dec 5, 2024
1 parent ae46ab2 commit 24286f3
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ It aims to achieve a more uniform leader distribution by assigning each node a p

## Configuration

Enable priority election by setting `zeebe.broker.raft.enablePriorityElection = "true"` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_RAFT_ENABLEPRIORITYELECTION="true"`.
Enable priority election by setting `zeebe.broker.cluster.raft.enablePriorityElection=true` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_CLUSTER_RAFT_ENABLEPRIORITYELECTION=true`.

If you are using the fixed partitioning scheme (experimental), you may need [additional configuration](fixed-partitioning.md#priority-election).

## Limitations

With priority election enabled, election latency and thus failover time increases.

The result of leader election is not deterministic and priority election can only increase the chance of having a
The result of a leader election is not deterministic, and priority election can only increase the chance of having a
uniform leader distribution, not guarantee it.

Factors such as high load can prevent high priority nodes from becoming the leader.
Factors such as high load can prevent high-priority nodes from becoming the leader.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ It aims to achieve a more uniform leader distribution by assigning each node a p

## Configuration

Enable priority election by setting `zeebe.broker.raft.enablePriorityElection = "true"` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_RAFT_ENABLEPRIORITYELECTION="true"`.
Enable priority election by setting `zeebe.broker.cluster.raft.enablePriorityElection=true` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_CLUSTER_RAFT_ENABLEPRIORITYELECTION=true`.

If you are using the fixed partitioning scheme (experimental), you may need [additional configuration](fixed-partitioning.md#priority-election).

## Limitations

With priority election enabled, election latency and thus failover time increases.

The result of leader election is not deterministic and priority election can only increase the chance of having a
The result of a leader election is not deterministic, and priority election can only increase the chance of having a
uniform leader distribution, not guarantee it.

Factors such as high load can prevent high priority nodes from becoming the leader.
Factors such as high load can prevent high-priority nodes from becoming the leader.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ It aims to achieve a more uniform leader distribution by assigning each node a p

## Configuration

Enable priority election by setting `zeebe.broker.raft.enablePriorityElection = "true"` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_RAFT_ENABLEPRIORITYELECTION="true"`.
Enable priority election by setting `zeebe.broker.cluster.raft.enablePriorityElection=true` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_CLUSTER_RAFT_ENABLEPRIORITYELECTION=true`.

If you are using the fixed partitioning scheme (experimental), you may need [additional configuration](fixed-partitioning.md#priority-election).

## Limitations

With priority election enabled, election latency and thus failover time increases.

The result of leader election is not deterministic and priority election can only increase the chance of having a
The result of a leader election is not deterministic, and priority election can only increase the chance of having a
uniform leader distribution, not guarantee it.

Factors such as high load can prevent high priority nodes from becoming the leader.
Factors such as high load can prevent high-priority nodes from becoming the leader.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ It aims to achieve a more uniform leader distribution by assigning each node a p

## Configuration

Enable priority election by setting `zeebe.broker.raft.enablePriorityElection = "true"` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_RAFT_ENABLEPRIORITYELECTION="true"`.
Enable priority election by setting `zeebe.broker.cluster.raft.enablePriorityElection=true` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_CLUSTER_RAFT_ENABLEPRIORITYELECTION=true`.

If you are using the fixed partitioning scheme (experimental), you may need [additional configuration](fixed-partitioning.md#priority-election).

## Limitations

With priority election enabled, election latency and thus failover time increases.

The result of leader election is not deterministic and priority election can only increase the chance of having a
The result of a leader election is not deterministic, and priority election can only increase the chance of having a
uniform leader distribution, not guarantee it.

Factors such as high load can prevent high priority nodes from becoming the leader.
Factors such as high load can prevent high-priority nodes from becoming the leader.
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ It aims to achieve a more uniform leader distribution by assigning each node a p

## Configuration

Enable priority election by setting `zeebe.broker.raft.enablePriorityElection = "true"` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_RAFT_ENABLEPRIORITYELECTION="true"`.
Enable priority election by setting `zeebe.broker.cluster.raft.enablePriorityElection=true` in your config or
by setting the equivalent environment variable `ZEEBE_BROKER_CLUSTER_RAFT_ENABLEPRIORITYELECTION=true`.

If you are using the fixed partitioning scheme (experimental), you may need [additional configuration](fixed-partitioning.md#priority-election).

## Limitations

With priority election enabled, election latency and thus failover time increases.

The result of leader election is not deterministic and priority election can only increase the chance of having a
The result of a leader election is not deterministic, and priority election can only increase the chance of having a
uniform leader distribution, not guarantee it.

Factors such as high load can prevent high priority nodes from becoming the leader.
Factors such as high load can prevent high-priority nodes from becoming the leader.

0 comments on commit 24286f3

Please sign in to comment.