raft

Documentation

Index

• type Commit
• type KV
• type KVStore
  • func NewKVStore(snapshotter *snap.Snapshotter, badger *badger.DB, client *client.Http, ...) (*KVStore, error)
  • func (s *KVStore) GetSnapshot() ([]byte, error)
  • func (s *KVStore) Propose(k string, v string, agent string)
  • func (s *KVStore) ProposeEtcd(k string, v string, agent string)
  • func (s *KVStore) ProposeObject(k string, v string, agent string)
  • func (s *KVStore) ProposeSecret(k string, v string, agent string)
• type RaftNode
  • func NewRaftNode(raftnode *RaftNode, keys *keys.Keys, TLSConfig *tls.Config, id uint64, ...) (*RaftNode, <-chan *Commit, <-chan error, <-chan *snap.Snapshotter)
  • func (rc *RaftNode) IsIDRemoved(_ uint64) bool
  • func (rc *RaftNode) Process(ctx context.Context, m raftpb.Message) error
  • func (rc *RaftNode) ReportSnapshot(id uint64, status raft.SnapshotStatus)
  • func (rc *RaftNode) ReportUnreachable(id uint64)

Types

type Commit

type Commit struct {
	// contains filtered or unexported fields
}

type KV

type KV struct {
	Key      string
	Val      string
	Category string
	Agent    string
}

type KVStore

type KVStore struct {
	EtcdC       chan KV
	ObjectsC    chan KV
	ConfChangeC chan<- raftpb.ConfChange // channel for proposing updates
	Agent       string
	// contains filtered or unexported fields
}

a key-value store backed by raft

func NewKVStore

func NewKVStore(snapshotter *snap.Snapshotter, badger *badger.DB, client *client.Http, proposeC chan<- string, commitC <-chan *Commit, errorC <-chan error, etcdC chan KV, objectsC chan KV) (*KVStore, error)

func (*KVStore) GetSnapshot

func (s *KVStore) GetSnapshot() ([]byte, error)

func (*KVStore) Propose

func (s *KVStore) Propose(k string, v string, agent string)

func (*KVStore) ProposeEtcd

func (s *KVStore) ProposeEtcd(k string, v string, agent string)

func (*KVStore) ProposeObject

func (s *KVStore) ProposeObject(k string, v string, agent string)

func (*KVStore) ProposeSecret

func (s *KVStore) ProposeSecret(k string, v string, agent string)

type RaftNode

type RaftNode struct {
	Peers []string // raft peer URLs

	TLSConfig *tls.Config
	// contains filtered or unexported fields
}

A key-value stream backed by raft

func NewRaftNode

func NewRaftNode(raftnode *RaftNode, keys *keys.Keys, TLSConfig *tls.Config, id uint64, peers *node.Nodes, join bool, getSnapshot func() ([]byte, error), proposeC <-chan string,
	confChangeC <-chan raftpb.ConfChange) (*RaftNode, <-chan *Commit, <-chan error, <-chan *snap.Snapshotter)

newRaftNode initiates a raft instance and returns a committed log entry channel and error channel. Proposals for log updates are sent over the provided the proposal channel. All log entries are replayed over the commit channel, followed by a nil message (to indicate the channel is current), then new log entries. To shutdown, close proposeC and read errorC.

func (*RaftNode) IsIDRemoved

func (rc *RaftNode) IsIDRemoved(_ uint64) bool

func (*RaftNode) Process

func (rc *RaftNode) Process(ctx context.Context, m raftpb.Message) error

func (*RaftNode) ReportSnapshot

func (rc *RaftNode) ReportSnapshot(id uint64, status raft.SnapshotStatus)

func (*RaftNode) ReportUnreachable

func (rc *RaftNode) ReportUnreachable(id uint64)