podvolume

Documentation

Index

• Constants
• func GetPvbRepositoryType(pvb *velerov1api.PodVolumeBackup) string
• func GetPvrRepositoryType(pvr *velerov1api.PodVolumeRestore) string
• func GetSnapshotIdentifier(podVolumeBackups *velerov1api.PodVolumeBackupList) map[string][]repository.SnapshotIdentifier
• func GetVolumeBackupsForPod(podVolumeBackups []*velerov1api.PodVolumeBackup, pod *corev1api.Pod, ...) map[string]string
• type Backupper
• type BackupperFactory
  • func NewBackupperFactory(repoLocker *repository.RepoLocker, repoEnsurer *repository.Ensurer, ...) BackupperFactory
• type PVCBackupSummary
  • func NewPVCBackupSummary() *PVCBackupSummary
• type RestoreData
• type Restorer
• type RestorerFactory
  • func NewRestorerFactory(repoLocker *repository.RepoLocker, repoEnsurer *repository.Ensurer, ...) RestorerFactory
• type Tracker
  • func NewTracker() *Tracker
  • func (t *Tracker) Has(namespace, name string) bool
  • func (t *Tracker) OptedoutByPod(namespace, name string) (bool, string)
  • func (t *Tracker) Optout(pod *corev1api.Pod, volumeName string)
  • func (t *Tracker) Take(pod *corev1api.Pod, volumeName string)
  • func (t *Tracker) TakenForPodVolume(pod *corev1api.Pod, volume string) (bool, string)
  • func (t *Tracker) Track(pod *corev1api.Pod, volumeName string)

Constants

const (
	// PVCNameAnnotation is the key for the annotation added to
	// pod volume backups when they're for a PVC.
	PVCNameAnnotation = "velero.io/pvc-name"

	// DefaultVolumesToFsBackup specifies whether pod volume backup should be used, by default, to
	// take backup of all pod volumes.
	DefaultVolumesToFsBackup = false
)

Functions

func GetPvbRepositoryType

func GetPvbRepositoryType(pvb *velerov1api.PodVolumeBackup) string

GetPvbRepositoryType returns the repositoryType according to the PVB information

func GetPvrRepositoryType

func GetPvrRepositoryType(pvr *velerov1api.PodVolumeRestore) string

GetPvrRepositoryType returns the repositoryType according to the PVR information

func GetSnapshotIdentifier

func GetSnapshotIdentifier(podVolumeBackups *velerov1api.PodVolumeBackupList) map[string][]repository.SnapshotIdentifier

GetSnapshotIdentifier returns the snapshots represented by SnapshotIdentifier for the given PVBs

func GetVolumeBackupsForPod

func GetVolumeBackupsForPod(podVolumeBackups []*velerov1api.PodVolumeBackup, pod *corev1api.Pod, sourcePodNs string) map[string]string

GetVolumeBackupsForPod returns a map, of volume name -> snapshot id, of the PodVolumeBackups that exist for the provided pod.

Types

type Backupper

type Backupper interface {
	// BackupPodVolumes backs up all specified volumes in a pod.
	BackupPodVolumes(backup *velerov1api.Backup, pod *corev1api.Pod, volumesToBackup []string, resPolicies *resourcepolicies.Policies, log logrus.FieldLogger) ([]*velerov1api.PodVolumeBackup, *PVCBackupSummary, []error)
	WaitAllPodVolumesProcessed(log logrus.FieldLogger) []*velerov1api.PodVolumeBackup
}

Backupper can execute pod volume backups of volumes in a pod.

type BackupperFactory

type BackupperFactory interface {
	// NewBackupper returns a pod volumes backupper for use during a single Velero backup.
	NewBackupper(context.Context, *velerov1api.Backup, string) (Backupper, error)
}

BackupperFactory can construct pod volumes backuppers.

func NewBackupperFactory

func NewBackupperFactory(
	repoLocker *repository.RepoLocker,
	repoEnsurer *repository.Ensurer,
	crClient ctrlclient.Client,
	pvbInformer ctrlcache.Informer,
	log logrus.FieldLogger,
) BackupperFactory

type PVCBackupSummary

type PVCBackupSummary struct {
	Backedup map[string]*corev1api.PersistentVolumeClaim
	Skipped  map[string]*skippedPVC
	// contains filtered or unexported fields
}

PVCBackupSummary is a summary for which PVCs are skipped, which are backed up after each execution of the Backupper The scope should be within one pod, so the volume name is the key for the maps

func NewPVCBackupSummary

func NewPVCBackupSummary() *PVCBackupSummary

type RestoreData

type RestoreData struct {
	Restore                         *velerov1api.Restore
	Pod                             *corev1api.Pod
	PodVolumeBackups                []*velerov1api.PodVolumeBackup
	SourceNamespace, BackupLocation string
}

type Restorer

type Restorer interface {
	// RestorePodVolumes restores all annotated volumes in a pod.
	RestorePodVolumes(RestoreData, *volume.RestoreVolumeInfoTracker) []error
}

Restorer can execute pod volume restores of volumes in a pod.

type RestorerFactory

type RestorerFactory interface {
	// NewRestorer returns a pod volumes restorer for use during a single Velero restore.
	NewRestorer(context.Context, *velerov1api.Restore) (Restorer, error)
}

RestorerFactory can construct pod volumes restorers.

func NewRestorerFactory

func NewRestorerFactory(repoLocker *repository.RepoLocker,
	repoEnsurer *repository.Ensurer,
	kubeClient kubernetes.Interface,
	crClient ctrlclient.Client,
	pvrInformer ctrlcache.Informer,
	log logrus.FieldLogger) RestorerFactory

type Tracker

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

Tracker keeps track of persistent volume claims that have been handled via pod volume backup.

func NewTracker

func NewTracker() *Tracker

func (*Tracker) Has

func (t *Tracker) Has(namespace, name string) bool

Has returns true if the PVC with the specified namespace and name has been tracked.

func (*Tracker) OptedoutByPod

func (t *Tracker) OptedoutByPod(namespace, name string) (bool, string)

OptedoutByPod returns true if the PVC with the specified namespace and name has been opted out by the pod. The second return value is the name of the pod which has the annotation that opted out the volume/pvc

func (*Tracker) Optout

func (t *Tracker) Optout(pod *corev1api.Pod, volumeName string)

Optout indicates a volume from a pod has been opted out by pod's annotation

func (*Tracker) Take

func (t *Tracker) Take(pod *corev1api.Pod, volumeName string)

Take indicates a volume from a pod has been taken by pod volume backup.

func (*Tracker) TakenForPodVolume

func (t *Tracker) TakenForPodVolume(pod *corev1api.Pod, volume string) (bool, string)

TakenForPodVolume returns true and the PVC's name if the pod volume with the specified name uses a PVC and that PVC has been taken by pod volume backup.

func (*Tracker) Track

func (t *Tracker) Track(pod *corev1api.Pod, volumeName string)

Track indicates a volume from a pod should be snapshotted by pod volume backup.