bbva / raft-badger

Raft backend implementation using BadgerDB

raft-badger

This repository provides the raftbadger package. The package exports the BadgerStore which is an implementation of both a LogStore and StableStore.

It is meant to be used as a backend for the raft package here.

This implementation uses BadgerDB. BadgerDB is a simple persistent key-value store written in pure Go. It has a Log-Structured-Merge (LSM) design and it's meant to be a performant alternative to non-Go based stores like RocksDB.

Documentation

The documentation for this package can be found on Godoc here.

Contributions

Contributions are very welcome, see CONTRIBUTING.md or skim existing tickets to see where you could help out.

License

raft-badger is Open Source and available under the Apache 2 License.

raft-badger's Issues

Please update the import to use Badger V3

Hi,

Since the badger v3 has been released please update the go.mod file

Implementation broken

This implementation is broken using recent versions of https://github.com/hashicorp/raft

Reasoning: On bootstraping raft stores CurrentTerm as the first item in the store, as this implementation doesn't differentiate between conf and logs using prefixes for example, the first call to LastIndex returns the uint64 encoded value of CurrentTerm, therefore it crashes on Raft init.

This implementation is correct https://github.com/markthethomas/raft-badger

How to use?

Thanks for sharing. I can't believe nobody has starred this until me!

I'm not quite sure how to use this with my BadgerDB. Do I use 2 BadgerDB databases, as in one for Raft and one for my data store?

If it's not too much trouble, could you please create a simple distributed BadgerDB example?

Add logging support

VLog garbage collection executions should be traced. It would be nice to use an interface based logger option with multi-level output support. We would have to add a new WithLogger constructor to the store accepting an interface rather than requiring a *log.Logger struct so that logging could be further customized and swapped out other systems.

Module path should be "github.com/BBVA/raft-badger", not "github.com/bbva/raft-badger"

Background

Module path is inconsistent with go import path.
GO111MODULE=on, as doc said, import "github.com/BBVA/raft-badger", then get this error:

go: finding module for package github.com/BBVA/raft-badger
go: downloading github.com/BBVA/raft-badger v1.0.1
go: found github.com/BBVA/raft-badger in github.com/BBVA/raft-badger v1.0.1
go: test1 imports
        github.com/BBVA/raft-badger: github.com/BBVA/[email protected]: parsing go.mod:
        module declares its path as: github.com/bbva/raft-badger
                but was required as: github.com/BBVA/raft-badger 

Solution

Fix the module path:

1. Rename the module path to "github.com/BBVA/raft-badger": https://github.com/BBVA/raft-badger/blob/master/go.mod#L1

module github.com/BBVA/raft-badger
go 1.14
require (
	…
) 

2. Change the doc document to use import "github.com/bbva/raft-badger".