Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
Signed-off-by: Tomasz Maruszak <maruszaktomasz@gmail.com>
  • Loading branch information
zarusz committed Sep 6, 2023
1 parent 8fcec93 commit ddd372d
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Configuration](#configuration)
- [Cluster Membership](#cluster-membership)
- [SWIM Membership](#swim-membership)
- [Static Membership](#static-membership)
- [Cluster Consensus](#cluster-consensus)
- [Raft Consensus](#raft-consensus)
- [Logs](#logs)
Expand All @@ -28,6 +29,8 @@ ToDo

# Cluster Membership

Package: [SlimCluster.Membership](https://www.nuget.org/packages/SlimCluster.Membership)

Cluster membership is all about knowing what members (nodes) form the cluster:

- which nodes are alive, healthy, and what is their address (IP/Port),
Expand All @@ -37,21 +40,38 @@ Cluster membership is all about knowing what members (nodes) form the cluster:

[IClusterMembership](../src/SlimCluster.Membership/IClusterMembership.cs) (can be injected) allows to:

- understand the current (self) member information
- understand what other members form the cluster (Id, Address)
- understand the current (self) member information,
- understand what other members form the cluster (Id, Address).

SlimCluster has the SWIM membership algorithm implemented as one of the options.
SlimCluster has the [SWIM membership](#swim-membership) algorithm implemented as one of the options.

## SWIM Membership

Package: [SlimCluster.Membership.Swim](https://www.nuget.org/packages/SlimCluster.Membership.Swim)

ToDo

## Static Membership

Package: [SlimCluster.Membership](https://www.nuget.org/packages/SlimCluster.Membership)

If the members of the cluster are known then you do not need to run a membership algorithm:

- The node names (or IP address) are known and fixed,
- Perhaps there is an external framework (or middleware) that tracks the node names (or IP address).

ToDo:

# Cluster Consensus

Package: [SlimCluster.Consensus](https://www.nuget.org/packages/SlimCluster.Consensus)

Consensus allows to coordinate the nodes that form the cluster. It helps to manage a common understanding of reality (cluster state) and replicate that state in case of node failures. Consensus typically requres a node to be designated as the leader that performs the coordination of work and state replication.

## Raft Consensus

Package: [SlimCluster.Consensus.Raft](https://www.nuget.org/packages/SlimCluster.Consensus.Raft)

Raft consensus algorithm is one of the newer algorithms that has become popular due to its simplicity and flexibility.
The [Raft paper](https://raft.github.io/raft.pdf) is an excelent source to undersand more details and about the algorithm parameters that can be fine tuned in SlimCluster.

Expand Down

0 comments on commit ddd372d

Please sign in to comment.