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 8, 2023
1 parent ddd372d commit e480b20
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
SlimCluster is a library aimed to help with building NET services that need to be clustered (share state and need to coordinate work).
Such clustered services can be hosted in Kubernetes, Azure App Service, AWS, GCP, containers or IaaS - does not matter, as long as the Nodes have access to the same network and IP protocol.

The goal for SlimCluster is to provide all the relevant clustering features, (slim) abstraction over a cluster representation and implement algorithms that you can readily use without having to reimplement it. That way buiding a clustered service becomes easy, and the developer can focus on the business process at hand.
The goal for SlimCluster is to provide all the relevant clustering features, (slim) abstraction over a cluster representation and implement algorithms that you can readily use without having to reimplement it. That way buiding a clustered service becomes easy, and the developer can focus on the business problem at hand.

Think about building the next distributed next stream processing system (Flink), database (MongoDb) or messaging system (Kafka) in .NET. All of these have to solve a common problem - the need to know and maintain the cluster members, coordinate work, replicate state and elect the leader for the relevant shard/partition. SlimCluster is there to help with the foundations.

# Configuration

Expand All @@ -38,7 +40,7 @@ Cluster membership is all about knowing what members (nodes) form the cluster:
- observe members joining or leaving a cluster,
- keeping a list of all the active members.

[IClusterMembership](../src/SlimCluster.Membership/IClusterMembership.cs) (can be injected) allows to:
The [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).
Expand Down

0 comments on commit e480b20

Please sign in to comment.