snapshotter

type Driver interface {
	// CreateSnapshot creates a volume snapshot for a pvc.
	CreateSnapshot(opts ...Option) (snapName, namespace, driverName string, err error)
	// DeleteSnapshot removes a snapshot.
	DeleteSnapshot(name, namespace string, retain bool) error
	// SnapshotStatus returns a status for a snapshot.
	SnapshotStatus(name, namespace string) (SnapshotInfo, error)
	// RestoreVolumeClaim creates a persistent volume claim from a provided snapshot.
	RestoreVolumeClaim(opts ...Option) (*v1.PersistentVolumeClaim, error)
	// RestoreStatus returns the status of a restore operation
	RestoreStatus(pvcName, namespace string) (RestoreInfo, error)
	// CancelRestore cancels a restore operation
	CancelRestore(pvcName, namespace string) error
	// Upload objects to cloud
	UploadSnapshotObjects(backupLocation *storkapi.BackupLocation, snapshotInfoList []SnapshotInfo, objectPath, objectName string) error
	// Download objects from cloud
	DownloadSnapshotObjects(backupLocation *storkapi.BackupLocation, objectPath string) ([]SnapshotInfo, error)
	// Delete objects in cloud
	DeleteSnapshotObject(backupLocation *storkapi.BackupLocation, objectPath string) error
	// Recreate snapshot resources before doing snapshot restore
	RecreateSnapshotResources(snapshotInfo SnapshotInfo, snapshotDriverName, namespace string, retain bool) (SnapshotInfo, error)
	// Retain local snapshots if required
	RetainLocalSnapshots(backupLocation *storkapi.BackupLocation, snapshotDriverName, snapshotClassName, namespace, pvcUID, objectPath string, retain bool) error
	// Restore from local snapshot if present
	RestoreFromLocalSnapshot(backupLocation *storkapi.BackupLocation, pvc *v1.PersistentVolumeClaim, snapshotDriverName, pvcUID, backupUID, objectPath, namespace string) (bool, error)
	// Cleanup resources if restore from localsnapshot fails
	CleanUpRestoredResources(backupLocation *storkapi.BackupLocation, pvc *v1.PersistentVolumeClaim, pvcUID, backupUID, objectPath, namespace string) error
}

type Option func(opts *Options) error

type Options struct {
	// Name is a snapshot name.
	Name string
	// Namespace is a snapshot namespace.
	Namespace string
	// PVCName is a persistent volume claim name to make snapshot from or restore to.
	PVCName string
	// PVCName is a persistent volume claim namespace to make snapshot from or restore to.
	PVCNamespace string
	// PVC is a persistent volume claim spec to restore snapshot to.
	PVC v1.PersistentVolumeClaim
	// RestoreNamespace is the namespace to which a snapshot should be restored to.
	RestoreNamespace string
	// SnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot.
	SnapshotClassName string
	// RestoreSnapshotName is the name of the snapshot from which restore will be performed
	RestoreSnapshotName string
	// Annotations are the annotations that can be applied on the snapshot related objects
	Annotations map[string]string
	// Labels are the labels that can be applied on the snapshot related objects
	Labels map[string]string
}

type RestoreInfo struct {
	// Status provides the current status of snapshot
	Status Status
	// Reason provides additional context to the status of the snapshot
	Reason string
	// VolumeName is the name of the volume being restored
	VolumeName string
	// Size is the size of the PVC being restored
	Size uint64
}

type SnapshotInfo struct {
	// Status provides the current status of snapshot
	Status Status
	// Reason provides additional context to the status of the snapshot
	Reason string
	// Size is the actual size of the snapshot
	Size uint64
	// Class defines the driver specific snapshot attributes
	Class interface{}
	// SnapshotRequest is the original driver specific snapshot request
	SnapshotRequest interface{}
	// Content is the actual volume snapshot of a volume
	Content interface{}
}

type Snapshotter interface {
	// Driver returns the driver based on the provided name
	Driver(name string) (Driver, error)
}

type Status string