restore

Documentation

Overview

Copyright 2018 the Velero contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type AddPVCFromPodAction
  • func NewAddPVCFromPodAction(logger logrus.FieldLogger) *AddPVCFromPodAction
  • func (a *AddPVCFromPodAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *AddPVCFromPodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type AddPVFromPVCAction
  • func NewAddPVFromPVCAction(logger logrus.FieldLogger) *AddPVFromPVCAction
  • func (a *AddPVFromPVCAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *AddPVFromPVCAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type JobAction
  • func NewJobAction(logger logrus.FieldLogger) *JobAction
  • func (a *JobAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *JobAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type PVRestorer
• type PodAction
  • func NewPodAction(logger logrus.FieldLogger) *PodAction
  • func (a *PodAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *PodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type ResticRestoreAction
  • func NewResticRestoreAction(logger logrus.FieldLogger, client corev1client.ConfigMapInterface) *ResticRestoreAction
  • func (a *ResticRestoreAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *ResticRestoreAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type Restorer
  • func NewKubernetesRestorer(discoveryHelper discovery.Helper, dynamicFactory client.DynamicFactory, ...) (Restorer, error)
• type Result
• type ServiceAccountAction
  • func NewServiceAccountAction(logger logrus.FieldLogger) *ServiceAccountAction
  • func (a *ServiceAccountAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *ServiceAccountAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type ServiceAction
  • func NewServiceAction(logger logrus.FieldLogger) *ServiceAction
  • func (a *ServiceAction) AppliesTo() (velero.ResourceSelector, error)
  • func (a *ServiceAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
• type VolumeSnapshotterGetter

Types

type AddPVCFromPodAction

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

func NewAddPVCFromPodAction

func NewAddPVCFromPodAction(logger logrus.FieldLogger) *AddPVCFromPodAction

func (*AddPVCFromPodAction) AppliesTo

func (a *AddPVCFromPodAction) AppliesTo() (velero.ResourceSelector, error)

func (*AddPVCFromPodAction) Execute

func (a *AddPVCFromPodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type AddPVFromPVCAction

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

func NewAddPVFromPVCAction

func NewAddPVFromPVCAction(logger logrus.FieldLogger) *AddPVFromPVCAction

func (*AddPVFromPVCAction) AppliesTo

func (a *AddPVFromPVCAction) AppliesTo() (velero.ResourceSelector, error)

func (*AddPVFromPVCAction) Execute

func (a *AddPVFromPVCAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type JobAction

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

func NewJobAction

func NewJobAction(logger logrus.FieldLogger) *JobAction

func (*JobAction) AppliesTo

func (a *JobAction) AppliesTo() (velero.ResourceSelector, error)

func (*JobAction) Execute

func (a *JobAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type PVRestorer

type PVRestorer interface {
	// contains filtered or unexported methods
}

type PodAction

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

func NewPodAction

func NewPodAction(logger logrus.FieldLogger) *PodAction

func (*PodAction) AppliesTo

func (a *PodAction) AppliesTo() (velero.ResourceSelector, error)

func (*PodAction) Execute

func (a *PodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type ResticRestoreAction

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

func NewResticRestoreAction

func NewResticRestoreAction(logger logrus.FieldLogger, client corev1client.ConfigMapInterface) *ResticRestoreAction

func (*ResticRestoreAction) AppliesTo

func (a *ResticRestoreAction) AppliesTo() (velero.ResourceSelector, error)

func (*ResticRestoreAction) Execute

func (a *ResticRestoreAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type Restorer

type Restorer interface {
	// Restore restores the backup data from backupReader, returning warnings and errors.
	Restore(log logrus.FieldLogger,
		restore *api.Restore,
		backup *api.Backup,
		volumeSnapshots []*volume.Snapshot,
		backupReader io.Reader,
		actions []velero.RestoreItemAction,
		snapshotLocationLister listers.VolumeSnapshotLocationLister,
		volumeSnapshotterGetter VolumeSnapshotterGetter,
	) (Result, Result)
}

Restorer knows how to restore a backup.

func NewKubernetesRestorer

func NewKubernetesRestorer(
	discoveryHelper discovery.Helper,
	dynamicFactory client.DynamicFactory,
	resourcePriorities []string,
	namespaceClient corev1.NamespaceInterface,
	resticRestorerFactory restic.RestorerFactory,
	resticTimeout time.Duration,
	resourceTerminatingTimeout time.Duration,
	logger logrus.FieldLogger,
) (Restorer, error)

NewKubernetesRestorer creates a new kubernetesRestorer.

type Result

type Result struct {
	// Velero is a slice of messages related to the operation of Velero
	// itself (for example, messages related to connecting to the
	// cloud, reading a backup file, etc.)
	Velero []string `json:"velero,omitempty"`

	// Cluster is a slice of messages related to restoring cluster-
	// scoped resources.
	Cluster []string `json:"cluster,omitempty"`

	// Namespaces is a map of namespace name to slice of messages
	// related to restoring namespace-scoped resources.
	Namespaces map[string][]string `json:"namespaces,omitempty"`
}

Result is a collection of messages that were generated during execution of a restore. This will typically store either warning or error messages.

type ServiceAccountAction

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

func NewServiceAccountAction

func NewServiceAccountAction(logger logrus.FieldLogger) *ServiceAccountAction

func (*ServiceAccountAction) AppliesTo

func (a *ServiceAccountAction) AppliesTo() (velero.ResourceSelector, error)

func (*ServiceAccountAction) Execute

func (a *ServiceAccountAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type ServiceAction

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

func NewServiceAction

func NewServiceAction(logger logrus.FieldLogger) *ServiceAction

func (*ServiceAction) AppliesTo

func (a *ServiceAction) AppliesTo() (velero.ResourceSelector, error)

func (*ServiceAction) Execute

func (a *ServiceAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

type VolumeSnapshotterGetter

type VolumeSnapshotterGetter interface {
	GetVolumeSnapshotter(name string) (velero.VolumeSnapshotter, error)
}