WIP: rest of the stuff

node/config/def.go

@@ -2,6 +2,9 @@ package config
 
 import (
 	"encoding"
+	hraft "github.com/hashicorp/raft"
+	"github.com/libp2p/go-libp2p/core/peer"
+	"io/ioutil"
 	"os"
 	"strconv"
 	"time"
@@ -99,6 +102,7 @@ func DefaultFullNode() *FullNode {
 				ColdStoreFullGCFrequency: 7,
 			},
 		},
+		Raft: *DefaultClusterRaftConfig(),
 	}
 }
 
@@ -274,3 +278,35 @@ func (dur Duration) MarshalText() ([]byte, error) {
 	d := time.Duration(dur)
 	return []byte(d.String()), nil
 }
+
+var (
+	DefaultDataSubFolder        = "raft"
+	DefaultWaitForLeaderTimeout = 15 * time.Second
+	DefaultCommitRetries        = 1
+	DefaultNetworkTimeout       = 100 * time.Second
+	DefaultCommitRetryDelay     = 200 * time.Millisecond
+	DefaultBackupsRotate        = 6
+	DefaultDatastoreNamespace   = "/r" // from "/raft"
+)
+
+func DefaultClusterRaftConfig() *ClusterRaftConfig {
+	var cfg ClusterRaftConfig
+	cfg.DataFolder = "" // empty so it gets omitted
+	cfg.InitPeerset = []peer.ID{}
+	cfg.WaitForLeaderTimeout = DefaultWaitForLeaderTimeout
+	cfg.NetworkTimeout = DefaultNetworkTimeout
+	cfg.CommitRetries = DefaultCommitRetries
+	cfg.CommitRetryDelay = DefaultCommitRetryDelay
+	cfg.BackupsRotate = DefaultBackupsRotate
+	cfg.DatastoreNamespace = DefaultDatastoreNamespace
+	cfg.RaftConfig = hraft.DefaultConfig()
+
+	// These options are imposed over any Default Raft Config.
+	cfg.RaftConfig.ShutdownOnRemove = false
+	cfg.RaftConfig.LocalID = "will_be_set_automatically"
+
+	// Set up logging
+	cfg.RaftConfig.LogOutput = ioutil.Discard
+	//cfg.RaftConfig.Logger = &hcLogToLogger{}
+	return &cfg
+}

node/config/doc_gen.go

@@ -117,6 +117,82 @@ without existing payment channels with available funds will fail instead
 of automatically performing on-chain operations.`,
 		},
 	},
+	"ClusterRaftConfig": []DocField{
+		{
+			Name: "HostShutdown",
+			Type: "bool",
+
+			Comment: `config.Saver
+
+will shutdown libp2p host on shutdown. Useful for testing`,
+		},
+		{
+			Name: "DataFolder",
+			Type: "string",
+
+			Comment: `A folder to store Raft's data.`,
+		},
+		{
+			Name: "InitPeerset",
+			Type: "[]peer.ID",
+
+			Comment: `InitPeerset provides the list of initial cluster peers for new Raft
+peers (with no prior state). It is ignored when Raft was already
+initialized or when starting in staging mode.`,
+		},
+		{
+			Name: "WaitForLeaderTimeout",
+			Type: "time.Duration",
+
+			Comment: `LeaderTimeout specifies how long to wait for a leader before
+failing an operation.`,
+		},
+		{
+			Name: "NetworkTimeout",
+			Type: "time.Duration",
+
+			Comment: `NetworkTimeout specifies how long before a Raft network
+operation is timed out`,
+		},
+		{
+			Name: "CommitRetries",
+			Type: "int",
+
+			Comment: `CommitRetries specifies how many times we retry a failed commit until
+we give up.`,
+		},
+		{
+			Name: "CommitRetryDelay",
+			Type: "time.Duration",
+
+			Comment: `How long to wait between retries`,
+		},
+		{
+			Name: "BackupsRotate",
+			Type: "int",
+
+			Comment: `BackupsRotate specifies the maximum number of Raft's DataFolder
+copies that we keep as backups (renaming) after cleanup.`,
+		},
+		{
+			Name: "DatastoreNamespace",
+			Type: "string",
+
+			Comment: `Namespace to use when writing keys to the datastore`,
+		},
+		{
+			Name: "RaftConfig",
+			Type: "*hraft.Config",
+
+			Comment: `A Hashicorp Raft's configuration object.`,
+		},
+		{
+			Name: "Tracing",
+			Type: "bool",
+
+			Comment: `Tracing enables propagation of contexts across binary boundaries.`,
+		},
+	},
 	"Common": []DocField{
 		{
 			Name: "API",
@@ -372,6 +448,12 @@ see https://docs.filecoin.io/mine/lotus/miner-configuration/#using-filters-for-f
 			Name: "Chainstore",
 			Type: "Chainstore",
 
+			Comment: ``,
+		},
+		{
+			Name: "Raft",
+			Type: "ClusterRaftConfig",
+
 			Comment: ``,
 		},
 	},

node/config/types.go

@@ -1,7 +1,10 @@
 package config
 
 import (
+	hraft "github.com/hashicorp/raft"
 	"github.com/ipfs/go-cid"
+	"github.com/libp2p/go-libp2p/core/peer"
+	"time"
 
 	"github.com/filecoin-project/lotus/chain/types"
 	"github.com/filecoin-project/lotus/storage/sealer"
@@ -27,6 +30,7 @@ type FullNode struct {
 	Wallet     Wallet
 	Fees       FeeConfig
 	Chainstore Chainstore
+	Raft       ClusterRaftConfig
 }
 
 // // Common
@@ -590,3 +594,37 @@ type Wallet struct {
 type FeeConfig struct {
 	DefaultMaxFee types.FIL
 }
+
+// ClusterRaftConfig allows to configure the Raft Consensus component for the node cluster.
+type ClusterRaftConfig struct {
+	// will shutdown libp2p host on shutdown. Useful for testing
+	HostShutdown bool
+	// A folder to store Raft's data.
+	DataFolder string
+	// InitPeerset provides the list of initial cluster peers for new Raft
+	// peers (with no prior state). It is ignored when Raft was already
+	// initialized or when starting in staging mode.
+	InitPeerset []peer.ID
+	// LeaderTimeout specifies how long to wait for a leader before
+	// failing an operation.
+	WaitForLeaderTimeout time.Duration
+	// NetworkTimeout specifies how long before a Raft network
+	// operation is timed out
+	NetworkTimeout time.Duration
+	// CommitRetries specifies how many times we retry a failed commit until
+	// we give up.
+	CommitRetries int
+	// How long to wait between retries
+	CommitRetryDelay time.Duration
+	// BackupsRotate specifies the maximum number of Raft's DataFolder
+	// copies that we keep as backups (renaming) after cleanup.
+	BackupsRotate int
+	// Namespace to use when writing keys to the datastore
+	DatastoreNamespace string
+
+	// A Hashicorp Raft's configuration object.
+	RaftConfig *hraft.Config
+
+	// Tracing enables propagation of contexts across binary boundaries.
+	Tracing bool
+}