Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eatonphil/goraft
A basic Raft implementation in Go.
https://github.com/eatonphil/goraft
Last synced: 21 days ago
JSON representation
A basic Raft implementation in Go.
- Host: GitHub
- URL: https://github.com/eatonphil/goraft
- Owner: eatonphil
- Created: 2022-10-02T01:06:24.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-24T07:43:01.000Z (8 months ago)
- Last Synced: 2024-10-13T04:12:46.193Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 84 KB
- Stars: 202
- Watchers: 5
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# goraft
A minimal implementation of Raft in Go. [Demo video](https://www.youtube.com/watch?v=cIR8RoN2LDU).
This blog post [walks through the code](https://notes.eatonphil.com/2023-05-25-raft.html).
NOT FOR PRODUCTION USE.
Things that are missing:
* Client serial identifier for each message (maybe the most obvious missing function/actual bug)
* Search for "session" in [Diego Ongaro's thesis](https://web.stanford.edu/~ouster/cgi-bin/papers/OngaroPhD.pdf) for more details.
* Snapshotting/checkpointing and associated state transfer
* Configuration change protocol
* Rigged up to Jepsen
* Surely much else
## Stress
Not particularly aggressive yet but does basic correctness and stress
testing.
Read more about the details of what it tests [in the
README](./cmd/stress/README.md).
```console
$ cd cmd/stress
$ go run main.go util.go
```
With the `go-deadlock` package turned off and the default `sync`
package on, I get throughput of around 20k-40k entries/second with
this stress test.
# Distributed Key-Value Store API
Try out the builtin distributed key-value API.
```console
$ cd cmd/kvapi && go build
$ rm *.dat
```
## Terminal 1
```console
$ ./kvapi --node 1 --http :2021 --cluster "0,:3030;1,:3031;2,:3032"
```
## Terminal 2
```console
$ ./kvapi --node 1 --http :2021 --cluster "0,:3030;1,:3031;2,:3032"
```
## Terminal 3
```console
$ ./kvapi --node 2 --http :2021 --cluster "0,:3030;1,:3031;2,:3032"
```
## Terminal 4
Remember that requests will go through the leader (except for if we
turn that off in the `/get` request). So you'll have to try sending a
message to each server until you find the leader.
To set a key:
```console
$ curl http://localhost:2020/set?key=y&value=hello
```
To get a key:
```console
$ curl http://localhost:2020/get\?key\=y
```
# References
* [In Search of an Understandable Consensus Algorithm](https://raft.github.io/raft.pdf): The Raft paper.
* [raft.tla](https://github.com/ongardie/raft.tla/blob/master/raft.tla): Diego Ongaro's TLA+ spec for Raft.
* Jon Gjengset's [Students' Guide to Raft](https://thesquareplanet.com/blog/students-guide-to-raft/)
* Jack Vanlightly's [Detecting Bugs in Data Infrastructure using Formal Methods (TLA+ Series Part 1)](https://medium.com/splunk-maas/detecting-bugs-in-data-infrastructure-using-formal-methods-704fde527c58): An intro to TLA+.
And useful implementations I looked at for inspiration and clarity.
* Hashicorp's [Raft implementation](https://github.com/hashicorp/raft) in Go: Although it's often quite complicated to learn from since it actually is intended for production.
* Eli Bendersky's [Raft implementation](https://github.com/eliben/raft) in Go: Although it gets confusing because it uses negative numbers for terms whereas the paper does not.
* Jing Yang's [Raft implementation](https://github.com/ditsing/ruaft) in Rust.