raft-badger
This repository provides a storage backend for the excellent raft package from Hashicorp. Raft is a distributed consensus protocol. Distributed consensus has many practical applications, ranging from fault-tolerant databases to clock synchronization to things like Google's PageRank.
This package exports the BadgerStore, which is an implementation of both a LogStore and StableStore (interfaces used by the raft package for reading/writing logs as part of its consensus protocol).
installation
go get -u github.com/markthethomas/raft-badgerusage
Create a new BadgerStore and pass it to Raft when setting up.
//...
var logStore raft.LogStore
var stableStore raft.StableStore
myPath := filepath.Join(s.RaftDir) // replace this with what you're actually using
badgerDB, err := raftbadgerdb.NewBadgerStore(myPath)
if err != nil {
return fmt.Errorf("error creating new badger store: %s", err)
}
logStore = badgerDB
stableStore = badgerDB
r, err := raft.NewRaft(config, (*fsm)(s), logStore, stableStore, snapshots, transport)
//...developing
To run tests, run:
go test -cover -coverprofile=coverage.out .To view coverage, run:
go tool cover -html=coverage.outTo run the benchmark, run:
go test -race -bench .motivation
This package is meant to be used with the raft package from Hashicorb. This package borrows heavily from the excellent raft-boltdb package, also from Hashicorp. I wanted to learn about Badger and similar tools and needed to use Raft + a durable backend.
misc.
- raft-badger uses prefix keys to "bucket" logs and config, avoiding the need for multiple badger database files for each type of k/v raft sets
- encodes/decodes the raft Log types using Go's gob for efficient encoding/decoding of keys See more at https://blog.golang.org/gobs-of-data.
- images used are from the raft website and the badger repository, respectively
- thanks to the authors of the excellent raft-boltdb package for providing patterns to follow in satisfying the requisite raft interfaces
🙌 - curious to learn more about the raft protocol? check out the raft website. There's also a beginner's guide at Free Code Camp
todo
- support custom badger options
- explore other encodings besides
gob - add more examples of use with raft