vault: Index | Files

package snapshot

import ""

The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents:

meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files

The integrity information is automatically created and checked, and a failure there just looks like an error to the caller.

snapshot manages the interactions between Consul and Raft in order to take and restore snapshots for disaster recovery. The internal format of a snapshot is simply a tar file, as described in archive.go.


Package Files

archive.go snapshot.go

func Restore Uses

func Restore(logger log.Logger, in io.Reader, r *raft.Raft) error

Restore takes the snapshot from the reader and attempts to apply it to the given Raft instance.

func RestoreWithSealer Uses

func RestoreWithSealer(logger log.Logger, in io.Reader, r *raft.Raft, sealer Sealer) error

func Verify Uses

func Verify(in io.Reader) (*raft.SnapshotMeta, error)

Verify takes the snapshot from the reader and verifies its contents.

func WriteToTempFile Uses

func WriteToTempFile(logger log.Logger, in io.Reader, metadata *raft.SnapshotMeta) (*os.File, func(), error)

func WriteToTempFileWithSealer Uses

func WriteToTempFileWithSealer(logger log.Logger, in io.Reader, metadata *raft.SnapshotMeta, sealer Sealer) (*os.File, func(), error)

type Sealer Uses

type Sealer interface {
    Seal(context.Context, []byte) ([]byte, error)
    Open(context.Context, []byte) ([]byte, error)

Sealer is used to seal and open the SHASUM file inside the archive.

type Snapshot Uses

type Snapshot struct {
    // contains filtered or unexported fields

Snapshot is a structure that holds state about a temporary file that is used to hold a snapshot. By using an intermediate file we avoid holding everything in memory.

func New Uses

func New(logger log.Logger, r *raft.Raft) (*Snapshot, error)

New takes a state snapshot of the given Raft instance into a temporary file and returns an object that gives access to the file as an io.Reader. You must arrange to call Close() on the returned object or else you will leak a temporary file.

func NewWithSealer Uses

func NewWithSealer(logger log.Logger, r *raft.Raft, sealer Sealer) (*Snapshot, error)

func (*Snapshot) Close Uses

func (s *Snapshot) Close() error

Close closes the snapshot and removes any temporary storage associated with it. You must arrange to call this whenever NewSnapshot() has been called successfully. This is safe to call on a nil snapshot.

func (*Snapshot) Index Uses

func (s *Snapshot) Index() uint64

Index returns the index of the snapshot. This is safe to call on a nil snapshot, it will just return 0.

func (*Snapshot) Read Uses

func (s *Snapshot) Read(p []byte) (n int, err error)

Read passes through to the underlying snapshot file. This is safe to call on a nil snapshot, it will just return an EOF.

func (*Snapshot) Size Uses

func (s *Snapshot) Size() (int64, error)

Size returns the file size of the snapshot archive.

Package snapshot imports 15 packages (graph). Updated 2019-09-18. Refresh now. Tools for package owners.