47b744f1c0
ipfs-cluster-service now has a migration subcommand that upgrades
persistant state snapshots with an out-of-date format version to the
newest version of raft state. If all cluster members shutdown with
consistent state, upgrade ipfs-cluster, and run the state upgrade command,
the new version of cluster will be compatible with persistent storage.
ipfs-cluster now validates its persistent state upon loading it and exits
with a clear error in the case the state format version is not up to date.
Raft snapshotting is enforced on all shutdowns and the json backup is no
longer run. This commit makes use of recent changes to libp2p-raft
allowing raft states to implement their own marshaling strategies. Now
mapstate handles the logic for its (de)serialization. In the interest of
supporting various potential upgrade formats the state serialization
begins with a varint (right now one byte) describing the version.
Some go tests are modified and a go test is added to cover new ipfs-cluster
raft snapshot reading functions. Sharness tests are added to cover the
state upgrade command.
37 lines
1.1 KiB
Go
37 lines
1.1 KiB
Go
// Package state holds the interface that any state implementation for
|
|
// IPFS Cluster must satisfy.
|
|
package state
|
|
|
|
// State represents the shared state of the cluster and it
|
|
import (
|
|
"io"
|
|
|
|
cid "github.com/ipfs/go-cid"
|
|
"github.com/ipfs/ipfs-cluster/api"
|
|
)
|
|
|
|
// State is used by the Consensus component to keep track of
|
|
// objects which objects are pinned. This component should be thread safe.
|
|
type State interface {
|
|
// Add adds a pin to the State
|
|
Add(api.Pin) error
|
|
// Rm removes a pin from the State
|
|
Rm(*cid.Cid) error
|
|
// List lists all the pins in the state
|
|
List() []api.Pin
|
|
// Has returns true if the state is holding information for a Cid
|
|
Has(*cid.Cid) bool
|
|
// Get returns the information attacthed to this pin
|
|
Get(*cid.Cid) api.Pin
|
|
// Snapshot writes a snapshot of the state to a writer
|
|
Snapshot(w io.Writer) error
|
|
// Restore restores an outdated state to the current version
|
|
Restore(r io.Reader) error
|
|
// Return the version of this state
|
|
GetVersion() int
|
|
// Marshal serializes the state to a byte slice
|
|
Marshal() ([]byte, error)
|
|
// Unmarshal deserializes the state from marshaled bytes
|
|
Unmarshal([]byte) error
|
|
}
|