Skip to content

Commit 1e4f64c

Browse files
metacosmcsviri
authored andcommitted
docs: improve wording
1 parent d29f51b commit 1e4f64c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/documentation/features.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -685,12 +685,13 @@ for this feature.
685685

686686
## Leader Election
687687

688-
In general operators are deployed with single instance running, or a single active instance running. That means
689-
if multiple instances are deployed only one of the should process the events. This is achieved by configuring leader
690-
election. Leader election will make sure only one instance of the operator is processing events, other instances will
691-
start event sources, where those will populate the caches - this is beneficial for the case the instance becomes the
692-
leader it will start reconcile immediately, and don't have to wait until the event sources are started and
693-
caches are populated.
688+
Operators are generally deployed with a single running or active instance. However, it is
689+
possible to deploy multiple instances in such a way that only one, called the "leader", processes the
690+
events. This is achieved via a mechanism called "leader election". While all the instances are
691+
running, and even start their event sources to populate the caches, only the leader will process
692+
the events. This means that should the leader change for any reason, for example because it
693+
crashed, the other instances are already warmed up and ready to pick up where the previous
694+
leader left off should one of them become elected leader.
694695

695696
See sample configuration in the [E2E test](https://github.com/java-operator-sdk/java-operator-sdk/blob/144947d89323f1c65de6e86bd8b9a6a8ffe714ff/sample-operators/leader-election/src/main/java/io/javaoperatorsdk/operator/sample/LeaderElectionTestOperator.java#L26-L30)
696697
.

0 commit comments

Comments
 (0)