snapmeta

Documentation

Overview

Package snapmeta provides Kopia implementations of Persister and Snapshotter.

Index

• Constants
• type Index
  • func (idx Index) AddToIndex(key, indexName string)
  • func (idx Index) GetKeys(indexName string) (ret []string)
  • func (idx Index) IsKeyInIndex(key, indexName string) bool
  • func (idx Index) RemoveFromIndex(key, indexName string)
• type KopiaPersister
  • func NewPersister(baseDir string) (*KopiaPersister, error)
  • func (store *KopiaPersister) Cleanup()
  • func (store *KopiaPersister) ConnectOrCreateFilesystem(path string) error
  • func (store *KopiaPersister) ConnectOrCreateFilesystemWithServer(repoPath, serverAddr string) (*exec.Cmd, error)
  • func (store *KopiaPersister) ConnectOrCreateRepo(repoPath string) error
  • func (store *KopiaPersister) ConnectOrCreateS3(bucketName, pathPrefix string) error
  • func (store *KopiaPersister) ConnectOrCreateS3WithServer(serverAddr, bucketName, pathPrefix string) (*exec.Cmd, error)
  • func (store *KopiaPersister) FlushMetadata() error
  • func (store *KopiaPersister) GetPersistDir() string
  • func (store *KopiaPersister) LoadMetadata() error
• type KopiaSnapshotter
  • func NewSnapshotter(baseDirPath string) (*KopiaSnapshotter, error)
  • func (ks *KopiaSnapshotter) Cleanup()
  • func (ks *KopiaSnapshotter) ConnectOrCreateFilesystem(path string) error
  • func (ks *KopiaSnapshotter) ConnectOrCreateFilesystemWithServer(serverAddr, repoPath string) (*exec.Cmd, error)
  • func (ks *KopiaSnapshotter) ConnectOrCreateRepo(repoPath string) error
  • func (ks *KopiaSnapshotter) ConnectOrCreateS3(bucketName, pathPrefix string) error
  • func (ks *KopiaSnapshotter) ConnectOrCreateS3WithServer(serverAddr, bucketName, pathPrefix string) (*exec.Cmd, error)
  • func (ks *KopiaSnapshotter) CreateSnapshot(ctx context.Context, sourceDir string, opts map[string]string) (snapID string, fingerprint []byte, snapStats *robustness.CreateSnapshotStats, ...)
  • func (ks *KopiaSnapshotter) DeleteSnapshot(ctx context.Context, snapID string, opts map[string]string) error
  • func (ks *KopiaSnapshotter) ListSnapshots(ctx context.Context) ([]string, error)
  • func (ks *KopiaSnapshotter) RestoreSnapshot(ctx context.Context, snapID, restoreDir string, opts map[string]string) (fingerprint []byte, err error)
  • func (ks *KopiaSnapshotter) RestoreSnapshotCompare(ctx context.Context, snapID, restoreDir string, validationData []byte, ...) (err error)
  • func (ks *KopiaSnapshotter) Run(args ...string) (stdout, stderr string, err error)
  • func (ks *KopiaSnapshotter) RunGC(ctx context.Context, opts map[string]string) error
  • func (ks *KopiaSnapshotter) ServerCmd() *exec.Cmd
• type Simple
  • func NewSimple() *Simple
  • func (s *Simple) Delete(key string)
  • func (s *Simple) Load(key string) ([]byte, error)
  • func (s *Simple) Store(key string, val []byte) error

Constants

const (
	// S3BucketNameEnvKey is the environment variable required to connect to a repo on S3.
	S3BucketNameEnvKey = "S3_BUCKET_NAME"
	// EngineModeEnvKey is the environment variable required to switch between basic and server/client model.
	EngineModeEnvKey = "ENGINE_MODE"
	// EngineModeBasic is a constant used to check the engineMode.
	EngineModeBasic = "BASIC"
	// EngineModeServer is a constant used to check the engineMode.
	EngineModeServer = "SERVER"
)

Types

type Index

type Index map[string]map[string]struct{}

Index is a map of index name to the keys associated with that index name.

func (Index) AddToIndex

func (idx Index) AddToIndex(key, indexName string)

AddToIndex adds a key to the index of the given name.

func (Index) GetKeys

func (idx Index) GetKeys(indexName string) (ret []string)

GetKeys returns the list of keys associated with the given index name.

func (Index) IsKeyInIndex

func (idx Index) IsKeyInIndex(key, indexName string) bool

IsKeyInIndex will return true if the given index name contains the provided key.

func (Index) RemoveFromIndex

func (idx Index) RemoveFromIndex(key, indexName string)

RemoveFromIndex removes a key from the index of the given name.

type KopiaPersister

type KopiaPersister struct {
	*Simple
	// contains filtered or unexported fields
}

KopiaPersister implements robustness.Persister.

func NewPersister

func NewPersister(baseDir string) (*KopiaPersister, error)

NewPersister returns a Kopia based Persister. ConnectOrCreateRepo must be invoked to enable the interface.

func (*KopiaPersister) Cleanup

func (store *KopiaPersister) Cleanup()

Cleanup cleans up the local temporary files used by a KopiaMetadata.

func (*KopiaPersister) ConnectOrCreateFilesystem

func (store *KopiaPersister) ConnectOrCreateFilesystem(path string) error

ConnectOrCreateFilesystem implements the RepoManager interface, connects to a repo in the filesystem or attempts to create one if connection is unsuccessful.

func (*KopiaPersister) ConnectOrCreateFilesystemWithServer

func (store *KopiaPersister) ConnectOrCreateFilesystemWithServer(repoPath, serverAddr string) (*exec.Cmd, error)

ConnectOrCreateFilesystemWithServer implements the RepoManager interface, creates a server connects it a repo in the filesystem and creates a client to perform operations.

func (*KopiaPersister) ConnectOrCreateRepo

func (store *KopiaPersister) ConnectOrCreateRepo(repoPath string) error

ConnectOrCreateRepo makes the Persister ready for use.

func (*KopiaPersister) ConnectOrCreateS3

func (store *KopiaPersister) ConnectOrCreateS3(bucketName, pathPrefix string) error

ConnectOrCreateS3 implements the RepoManager interface, connects to a repo in an S3 bucket or attempts to create one if connection is unsuccessful.

func (*KopiaPersister) ConnectOrCreateS3WithServer

func (store *KopiaPersister) ConnectOrCreateS3WithServer(serverAddr, bucketName, pathPrefix string) (*exec.Cmd, error)

ConnectOrCreateS3WithServer implements the RepoManager interface, creates a server connects it a repo in an S3 bucket and creates a client to perform operations.

func (*KopiaPersister) FlushMetadata

func (store *KopiaPersister) FlushMetadata() error

FlushMetadata implements the DataPersister interface, flushing the local metadata on the target test repo's snapshots to the metadata Kopia repository as a snapshot create.

func (*KopiaPersister) GetPersistDir

func (store *KopiaPersister) GetPersistDir() string

GetPersistDir returns the path to the directory that will be persisted as a snapshot to the kopia repository.

func (*KopiaPersister) LoadMetadata

func (store *KopiaPersister) LoadMetadata() error

LoadMetadata implements the DataPersister interface, restores the latest snapshot from the kopia repository and decodes its contents, populating its metadata on the snapshots residing in the target test repository.

type KopiaSnapshotter

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

KopiaSnapshotter wraps the functionality to connect to a kopia repository with the fswalker WalkCompare.

func NewSnapshotter

func NewSnapshotter(baseDirPath string) (*KopiaSnapshotter, error)

NewSnapshotter returns a Kopia based Snapshotter. ConnectOrCreateRepo must be invoked to enable the interface.

func (*KopiaSnapshotter) Cleanup

func (ks *KopiaSnapshotter) Cleanup()

Cleanup should be called before termination.

func (*KopiaSnapshotter) ConnectOrCreateFilesystem

func (ks *KopiaSnapshotter) ConnectOrCreateFilesystem(path string) error

ConnectOrCreateFilesystem TBD: remove this.

func (*KopiaSnapshotter) ConnectOrCreateFilesystemWithServer

func (ks *KopiaSnapshotter) ConnectOrCreateFilesystemWithServer(serverAddr, repoPath string) (*exec.Cmd, error)

ConnectOrCreateFilesystemWithServer TBD: remove this.

func (*KopiaSnapshotter) ConnectOrCreateRepo

func (ks *KopiaSnapshotter) ConnectOrCreateRepo(repoPath string) error

ConnectOrCreateRepo makes the Snapshotter ready for use.

func (*KopiaSnapshotter) ConnectOrCreateS3

func (ks *KopiaSnapshotter) ConnectOrCreateS3(bucketName, pathPrefix string) error

ConnectOrCreateS3 TBD: remove this.

func (*KopiaSnapshotter) ConnectOrCreateS3WithServer

func (ks *KopiaSnapshotter) ConnectOrCreateS3WithServer(serverAddr, bucketName, pathPrefix string) (*exec.Cmd, error)

ConnectOrCreateS3WithServer TBD: remove this.

func (*KopiaSnapshotter) CreateSnapshot

func (ks *KopiaSnapshotter) CreateSnapshot(ctx context.Context, sourceDir string, opts map[string]string) (snapID string, fingerprint []byte, snapStats *robustness.CreateSnapshotStats, err error)

CreateSnapshot is part of Snapshotter.

func (*KopiaSnapshotter) DeleteSnapshot

func (ks *KopiaSnapshotter) DeleteSnapshot(ctx context.Context, snapID string, opts map[string]string) error

DeleteSnapshot is part of Snapshotter.

func (*KopiaSnapshotter) ListSnapshots

func (ks *KopiaSnapshotter) ListSnapshots(ctx context.Context) ([]string, error)

ListSnapshots is part of Snapshotter.

func (*KopiaSnapshotter) RestoreSnapshot

func (ks *KopiaSnapshotter) RestoreSnapshot(ctx context.Context, snapID, restoreDir string, opts map[string]string) (fingerprint []byte, err error)

RestoreSnapshot restores the snapshot with the given ID to the provided restore directory. It returns fingerprint verification data of the restored snapshot directory.

func (*KopiaSnapshotter) RestoreSnapshotCompare

func (ks *KopiaSnapshotter) RestoreSnapshotCompare(ctx context.Context, snapID, restoreDir string, validationData []byte, reportOut io.Writer, opts map[string]string) (err error)

RestoreSnapshotCompare restores the snapshot with the given ID to the provided restore directory, then verifies the data that has been restored against the provided fingerprint validation data.

func (*KopiaSnapshotter) Run

func (ks *KopiaSnapshotter) Run(args ...string) (stdout, stderr string, err error)

Run is part of Snapshotter.

func (*KopiaSnapshotter) RunGC

func (ks *KopiaSnapshotter) RunGC(ctx context.Context, opts map[string]string) error

RunGC is part of Snapshotter.

func (*KopiaSnapshotter) ServerCmd

func (ks *KopiaSnapshotter) ServerCmd() *exec.Cmd

ServerCmd returns the server command.

type Simple

type Simple struct {
	Data map[string][]byte `json:"data"`
}

Simple is a snapstore implementation that stores snapshot metadata as a byte slice in a map in memory. A Simple should not be copied.

func NewSimple

func NewSimple() *Simple

NewSimple instantiates a new Simple snapstore and returns its pointer.

func (*Simple) Delete

func (s *Simple) Delete(key string)

Delete implements the Storer interface Delete method.

func (*Simple) Load

func (s *Simple) Load(key string) ([]byte, error)

Load implements the Storer interface Load method.

func (*Simple) Store

func (s *Simple) Store(key string, val []byte) error

Store implements the Storer interface Store method.