relab / gorums

Gorums simplify fault-tolerant quorum-based protocols
MIT License
138 stars 14 forks source link

doc: revise and augment user guide #1

Open meling opened 7 years ago

meling commented 7 years ago

Make progression of different examples ranging from

  1. Simple gRPC example
  2. Load balancing accessing two distinct services
  3. Distributed storage with simple majority quorums (both single-writer and multi-writer)
  4. Distributed storage with byzantine quorums
  5. Advanced protocol: Paxos with majority quorum??
  6. Advanced quorum functions with correctables (can we use EPaxos as an example, or could we do something else?)
  7. Advanced quorum functions with per_node_arg and custom_return_type

(consider splitting this issue into a separate issue for each example.)

meling commented 7 years ago

The examples above should also describe how to organize your repos, and how to use the vendor folder. Moreover, we should also describe an advanced example where you want to extend Gorums as a library like was done for the Raft implementation (@s111).

meling commented 7 years ago

The load balancing example can benefit from this blog post. Perhaps we could specify a bachelor thesis for implementing the various LB alternatives described in the blog post.