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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddPVCFromPodAction ¶ added in v1.0.0
type AddPVCFromPodAction struct {
// contains filtered or unexported fields
}
func NewAddPVCFromPodAction ¶ added in v1.0.0
func NewAddPVCFromPodAction(logger logrus.FieldLogger) *AddPVCFromPodAction
func (*AddPVCFromPodAction) AppliesTo ¶ added in v1.0.0
func (a *AddPVCFromPodAction) AppliesTo() (velero.ResourceSelector, error)
func (*AddPVCFromPodAction) Execute ¶ added in v1.0.0
func (a *AddPVCFromPodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type AddPVFromPVCAction ¶ added in v1.0.0
type AddPVFromPVCAction struct {
// contains filtered or unexported fields
}
func NewAddPVFromPVCAction ¶ added in v1.0.0
func NewAddPVFromPVCAction(logger logrus.FieldLogger) *AddPVFromPVCAction
func (*AddPVFromPVCAction) AppliesTo ¶ added in v1.0.0
func (a *AddPVFromPVCAction) AppliesTo() (velero.ResourceSelector, error)
func (*AddPVFromPVCAction) Execute ¶ added in v1.0.0
func (a *AddPVFromPVCAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type ChangeStorageClassAction ¶ added in v1.0.1
type ChangeStorageClassAction struct {
// contains filtered or unexported fields
}
ChangeStorageClassAction updates a PV or PVC's storage class name if a mapping is found in the plugin's config map.
func NewChangeStorageClassAction ¶ added in v1.0.1
func NewChangeStorageClassAction( logger logrus.FieldLogger, configMapClient corev1client.ConfigMapInterface, storageClassClient storagev1client.StorageClassInterface, ) *ChangeStorageClassAction
NewChangeStorageClassAction is the constructor for ChangeStorageClassAction.
func (*ChangeStorageClassAction) AppliesTo ¶ added in v1.0.1
func (a *ChangeStorageClassAction) AppliesTo() (velero.ResourceSelector, error)
AppliesTo returns the resources that ChangeStorageClassAction should be run for.
func (*ChangeStorageClassAction) Execute ¶ added in v1.0.1
func (a *ChangeStorageClassAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
Execute updates the item's spec.storageClassName if a mapping is found in the config map for the plugin.
type JobAction ¶ added in v1.0.0
type JobAction struct {
// contains filtered or unexported fields
}
func NewJobAction ¶ added in v0.6.0
func NewJobAction(logger logrus.FieldLogger) *JobAction
func (*JobAction) AppliesTo ¶ added in v1.0.0
func (a *JobAction) AppliesTo() (velero.ResourceSelector, error)
func (*JobAction) Execute ¶ added in v1.0.0
func (a *JobAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type PVRestorer ¶ added in v0.9.0
type PVRestorer interface {
// contains filtered or unexported methods
}
type PodAction ¶ added in v1.0.0
type PodAction struct {
// contains filtered or unexported fields
}
func NewPodAction ¶ added in v0.6.0
func NewPodAction(logger logrus.FieldLogger) *PodAction
func (*PodAction) AppliesTo ¶ added in v1.0.0
func (a *PodAction) AppliesTo() (velero.ResourceSelector, error)
func (*PodAction) Execute ¶ added in v1.0.0
func (a *PodAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type Request ¶ added in v1.0.1
type Request struct {
*velerov1api.Restore
Log logrus.FieldLogger
Backup *velerov1api.Backup
PodVolumeBackups []*velerov1api.PodVolumeBackup
VolumeSnapshots []*volume.Snapshot
BackupReader io.Reader
}
type ResticRestoreAction ¶ added in v1.0.0
type ResticRestoreAction struct {
// contains filtered or unexported fields
}
func NewResticRestoreAction ¶ added in v0.9.0
func NewResticRestoreAction(logger logrus.FieldLogger, client corev1client.ConfigMapInterface, podVolumeBackupClient velerov1client.PodVolumeBackupInterface) *ResticRestoreAction
func (*ResticRestoreAction) AppliesTo ¶ added in v1.0.0
func (a *ResticRestoreAction) AppliesTo() (velero.ResourceSelector, error)
func (*ResticRestoreAction) Execute ¶ added in v1.0.0
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(req Request,
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 ¶ added in v1.0.0
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 ¶ added in v1.0.0
type ServiceAccountAction struct {
// contains filtered or unexported fields
}
func NewServiceAccountAction ¶ added in v0.10.1
func NewServiceAccountAction(logger logrus.FieldLogger) *ServiceAccountAction
func (*ServiceAccountAction) AppliesTo ¶ added in v1.0.0
func (a *ServiceAccountAction) AppliesTo() (velero.ResourceSelector, error)
func (*ServiceAccountAction) Execute ¶ added in v1.0.0
func (a *ServiceAccountAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type ServiceAction ¶ added in v1.0.0
type ServiceAction struct {
// contains filtered or unexported fields
}
func NewServiceAction ¶ added in v0.6.0
func NewServiceAction(logger logrus.FieldLogger) *ServiceAction
func (*ServiceAction) AppliesTo ¶ added in v1.0.0
func (a *ServiceAction) AppliesTo() (velero.ResourceSelector, error)
func (*ServiceAction) Execute ¶ added in v1.0.0
func (a *ServiceAction) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)
type VolumeSnapshotterGetter ¶ added in v1.0.0
type VolumeSnapshotterGetter interface {
GetVolumeSnapshotter(name string) (velero.VolumeSnapshotter, error)
}
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.