snap

Documentation

Overview

Package snap describes entities that are capable of performing common snapshot operations

Index

• type RepoManager
• type Snapshotter

Types

type RepoManager

type RepoManager interface {
	ConnectOrCreateS3(bucketName, pathPrefix string) error
	ConnectOrCreateFilesystem(path string) error
}

RepoManager is an interface that describes connecting to a repository

type Snapshotter

type Snapshotter interface {
	RepoManager
	CreateSnapshot(sourceDir string) (snapID string, err error)
	RestoreSnapshot(snapID string, restoreDir string) error
	DeleteSnapshot(snapID string) error
	ListSnapshots() ([]string, error)
	Run(args ...string) (stdout, stderr string, err error)
}

Snapshotter is an interface that describes methods for taking, restoring, deleting snapshots, and tracking them by a string snapshot ID.