Update cluster SBR documentation on lease and how it works #6257
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Aaronontheweb
approved these changes
Nov 16, 2022
| @@ -262,10 +262,60 @@ akka.cluster.split-brain-resolver.lease-majority { | |||
| } | |||
| ``` | |||
|
|
|||
| A `Lease` is a type of distributed lock implementation. | |||
| A `Lease` is a type of distributed lock implementation to decide which nodes are allowed to survive. Only one SBR instance can acquire the lease to make the decision to remain up. The other side will not be able to acquire the lease and will therefore down itself. | |||
There was a problem hiding this comment.
Lease can also be used for other things like Akka.Cluster.Sharding and ClusterSingleton hand-over too - so I would add " in on the context of SBRs, the leader who acquires the Lease gets to make downing decisions for the entire cluster"
|
|
||
| ### How Split Brain Resolver Works | ||
|
|
||
| * The SBR actor subscribes itself to all cluster events from the event bus during actor `PreStart`. |
There was a problem hiding this comment.
I'll see about turning this into a diagram in a separate PR
Aaronontheweb
added
docs
akka-coordination
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes