v1

package
v0.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2019 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=velero.io

Index

Constants

View Source 
const (
	// DefaultNamespace is the Kubernetes namespace that is used by default for
	// the Velero server and API objects.
	DefaultNamespace = "velero"

	// ResourcesDir is a top-level directory expected in backups which contains sub-directories
	// for each resource type in the backup.
	ResourcesDir = "resources"

	// MetadataDir is a top-level directory expected in backups which contains
	// files that store metadata about the backup, such as the backup version.
	MetadataDir = "metadata"

	// RestoreLabelKey is the label key that's applied to all resources that
	// are created during a restore. This is applied for ease of identification
	// of restored resources. The value will be the restore's name.
	//
	// This label is DEPRECATED as of v0.10 and will be removed entirely as of
	// v1.0 and replaced with RestoreNameLabel ("velero.io/restore-name").
	RestoreLabelKey = "velero-restore"

	// ClusterScopedDir is the name of the directory containing cluster-scoped
	// resources within a Velero backup.
	ClusterScopedDir = "cluster"

	// NamespaceScopedDir is the name of the directory containing namespace-scoped
	// resource within a Velero backup.
	NamespaceScopedDir = "namespaces"
)
View Source 
const (
	// BackupNameLabel is the label key used to identify a backup by name.
	BackupNameLabel = "velero.io/backup-name"

	// BackupUIDLabel is the label key used to identify a backup by uid.
	BackupUIDLabel = "velero.io/backup-uid"

	// RestoreNameLabel is the label key used to identify a restore by name.
	RestoreNameLabel = "velero.io/restore-name"

	// ScheduleNameLabel is the label key used to identify a schedule by name.
	ScheduleNameLabel = "velero.io/schedule-name"

	// RestoreUIDLabel is the label key used to identify a restore by uid.
	RestoreUIDLabel = "velero.io/restore-uid"

	// PodUIDLabel is the label key used to identify a pod by uid.
	PodUIDLabel = "velero.io/pod-uid"

	// PodVolumeOperationTimeoutAnnotation is the annotation key used to apply
	// a backup/restore-specific timeout value for pod volume operations (i.e.
	// restic backups/restores).
	PodVolumeOperationTimeoutAnnotation = "velero.io/pod-volume-timeout"

	// StorageLocationLabel is the label key used to identify the storage
	// location of a backup.
	StorageLocationLabel = "velero.io/storage-location"

	// ResticVolumeNamespaceLabel is the label key used to identify which
	// namespace a restic repository stores pod volume backups for.
	ResticVolumeNamespaceLabel = "velero.io/volume-namespace"
)
View Source 
const GroupName = "velero.io"

GroupName is the group name for the Velero API

Variables

View Source 
var (
	// SchemeBuilder collects the scheme builder functions for the Velero API
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme applies the SchemeBuilder functions to a specified scheme
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is the GroupVersion for the Velero API

Functions

func CustomResources 

func CustomResources() map[string]typeInfo

CustomResources returns a map of all custom resources within the Velero API group, keyed on Kind.

func Resource 

func Resource(resource string) schema.GroupResource

Resource gets a Velero GroupResource for a specified resource

Types

type Backup 

type Backup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   BackupSpec   `json:"spec"`
	Status BackupStatus `json:"status,omitempty"`
}

Backup is a Velero resource that respresents the capture of Kubernetes cluster state at a point in time (API objects and associated volume state).

func (*Backup) DeepCopy 

func (in *Backup) DeepCopy() *Backup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Backup.

func (*Backup) DeepCopyInto 

func (in *Backup) DeepCopyInto(out *Backup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Backup) DeepCopyObject 

func (in *Backup) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackupHooks 

type BackupHooks struct {
	// Resources are hooks that should be executed when backing up individual instances of a resource.
	Resources []BackupResourceHookSpec `json:"resources"`
}

BackupHooks contains custom behaviors that should be executed at different phases of the backup.

func (*BackupHooks) DeepCopy 

func (in *BackupHooks) DeepCopy() *BackupHooks

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupHooks.

func (*BackupHooks) DeepCopyInto 

func (in *BackupHooks) DeepCopyInto(out *BackupHooks)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupList 

type BackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Backup `json:"items"`
}

BackupList is a list of Backups.

func (*BackupList) DeepCopy 

func (in *BackupList) DeepCopy() *BackupList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupList.

func (*BackupList) DeepCopyInto 

func (in *BackupList) DeepCopyInto(out *BackupList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BackupList) DeepCopyObject 

func (in *BackupList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackupPhase 

type BackupPhase string

BackupPhase is a string representation of the lifecycle phase of a Velero backup. 

const (
	// BackupPhaseNew means the backup has been created but not
	// yet processed by the BackupController.
	BackupPhaseNew BackupPhase = "New"

	// BackupPhaseFailedValidation means the backup has failed
	// the controller's validations and therefore will not run.
	BackupPhaseFailedValidation BackupPhase = "FailedValidation"

	// BackupPhaseInProgress means the backup is currently executing.
	BackupPhaseInProgress BackupPhase = "InProgress"

	// BackupPhaseCompleted means the backup has run successfully without
	// errors.
	BackupPhaseCompleted BackupPhase = "Completed"

	// BackupPhaseFailed means the backup ran but encountered an error that
	// prevented it from completing successfully.
	BackupPhaseFailed BackupPhase = "Failed"

	// BackupPhaseDeleting means the backup and all its associated data are being deleted.
	BackupPhaseDeleting BackupPhase = "Deleting"
)

type BackupResourceHook 

type BackupResourceHook struct {
	// Exec defines an exec hook.
	Exec *ExecHook `json:"exec"`
}

BackupResourceHook defines a hook for a resource.

func (*BackupResourceHook) DeepCopy 

func (in *BackupResourceHook) DeepCopy() *BackupResourceHook

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupResourceHook.

func (*BackupResourceHook) DeepCopyInto 

func (in *BackupResourceHook) DeepCopyInto(out *BackupResourceHook)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupResourceHookSpec 

type BackupResourceHookSpec struct {
	// Name is the name of this hook.
	Name string `json:"name"`
	// IncludedNamespaces specifies the namespaces to which this hook spec applies. If empty, it applies
	// to all namespaces.
	IncludedNamespaces []string `json:"includedNamespaces"`
	// ExcludedNamespaces specifies the namespaces to which this hook spec does not apply.
	ExcludedNamespaces []string `json:"excludedNamespaces"`
	// IncludedResources specifies the resources to which this hook spec applies. If empty, it applies
	// to all resources.
	IncludedResources []string `json:"includedResources"`
	// ExcludedResources specifies the resources to which this hook spec does not apply.
	ExcludedResources []string `json:"excludedResources"`
	// LabelSelector, if specified, filters the resources to which this hook spec applies.
	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`
	// Hooks is a list of BackupResourceHooks to execute. DEPRECATED. Replaced by PreHooks.
	Hooks []BackupResourceHook `json:"hooks"`
	// PreHooks is a list of BackupResourceHooks to execute prior to storing the item in the backup.
	// These are executed before any "additional items" from item actions are processed.
	PreHooks []BackupResourceHook `json:"pre,omitempty"`
	// PostHooks is a list of BackupResourceHooks to execute after storing the item in the backup.
	// These are executed after all "additional items" from item actions are processed.
	PostHooks []BackupResourceHook `json:"post,omitempty"`
}

BackupResourceHookSpec defines one or more BackupResourceHooks that should be executed based on the rules defined for namespaces, resources, and label selector.

func (*BackupResourceHookSpec) DeepCopy 

func (in *BackupResourceHookSpec) DeepCopy() *BackupResourceHookSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupResourceHookSpec.

func (*BackupResourceHookSpec) DeepCopyInto 

func (in *BackupResourceHookSpec) DeepCopyInto(out *BackupResourceHookSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupSpec 

type BackupSpec struct {
	// IncludedNamespaces is a slice of namespace names to include objects
	// from. If empty, all namespaces are included.
	IncludedNamespaces []string `json:"includedNamespaces"`

	// ExcludedNamespaces contains a list of namespaces that are not
	// included in the backup.
	ExcludedNamespaces []string `json:"excludedNamespaces"`

	// IncludedResources is a slice of resource names to include
	// in the backup. If empty, all resources are included.
	IncludedResources []string `json:"includedResources"`

	// ExcludedResources is a slice of resource names that are not
	// included in the backup.
	ExcludedResources []string `json:"excludedResources"`

	// LabelSelector is a metav1.LabelSelector to filter with
	// when adding individual objects to the backup. If empty
	// or nil, all objects are included. Optional.
	LabelSelector *metav1.LabelSelector `json:"labelSelector"`

	// SnapshotVolumes specifies whether to take cloud snapshots
	// of any PV's referenced in the set of objects included
	// in the Backup.
	SnapshotVolumes *bool `json:"snapshotVolumes,omitempty"`

	// TTL is a time.Duration-parseable string describing how long
	// the Backup should be retained for.
	TTL metav1.Duration `json:"ttl"`

	// IncludeClusterResources specifies whether cluster-scoped resources
	// should be included for consideration in the backup.
	IncludeClusterResources *bool `json:"includeClusterResources"`

	// Hooks represent custom behaviors that should be executed at different phases of the backup.
	Hooks BackupHooks `json:"hooks"`

	// StorageLocation is a string containing the name of a BackupStorageLocation where the backup should be stored.
	StorageLocation string `json:"storageLocation"`

	// VolumeSnapshotLocations is a list containing names of VolumeSnapshotLocations associated with this backup.
	VolumeSnapshotLocations []string `json:"volumeSnapshotLocations"`
}

BackupSpec defines the specification for a Velero backup.

func (*BackupSpec) DeepCopy 

func (in *BackupSpec) DeepCopy() *BackupSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSpec.

func (*BackupSpec) DeepCopyInto 

func (in *BackupSpec) DeepCopyInto(out *BackupSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupStatus 

type BackupStatus struct {
	// Version is the backup format version.
	Version int `json:"version"`

	// Expiration is when this Backup is eligible for garbage-collection.
	Expiration metav1.Time `json:"expiration"`

	// Phase is the current state of the Backup.
	Phase BackupPhase `json:"phase"`

	// VolumeBackups is a map of PersistentVolume names to
	// information about the backed-up volume in the cloud
	// provider API.
	//
	// Deprecated: this field is considered read-only as of v0.10
	// and will be removed in a subsequent release. The information
	// previously contained here is now stored in a file in backup
	// storage.
	VolumeBackups map[string]*VolumeBackupInfo `json:"volumeBackups,omitempty"`

	// ValidationErrors is a slice of all validation errors (if
	// applicable).
	ValidationErrors []string `json:"validationErrors"`

	// StartTimestamp records the time a backup was started.
	// Separate from CreationTimestamp, since that value changes
	// on restores.
	// The server's time is used for StartTimestamps
	StartTimestamp metav1.Time `json:"startTimestamp"`

	// CompletionTimestamp records the time a backup was completed.
	// Completion time is recorded even on failed backups.
	// Completion time is recorded before uploading the backup object.
	// The server's time is used for CompletionTimestamps
	CompletionTimestamp metav1.Time `json:"completionTimestamp"`

	// VolumeSnapshotsAttempted is the total number of attempted
	// volume snapshots for this backup.
	VolumeSnapshotsAttempted int `json:"volumeSnapshotsAttempted"`

	// VolumeSnapshotsCompleted is the total number of successfully
	// completed volume snapshots for this backup.
	VolumeSnapshotsCompleted int `json:"volumeSnapshotsCompleted"`
}

BackupStatus captures the current status of a Velero backup.

func (*BackupStatus) DeepCopy 

func (in *BackupStatus) DeepCopy() *BackupStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStatus.

func (*BackupStatus) DeepCopyInto 

func (in *BackupStatus) DeepCopyInto(out *BackupStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupStorageLocation 

type BackupStorageLocation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   BackupStorageLocationSpec   `json:"spec"`
	Status BackupStorageLocationStatus `json:"status"`
}

BackupStorageLocation is a location where Velero stores backup objects.

func (*BackupStorageLocation) DeepCopy 

func (in *BackupStorageLocation) DeepCopy() *BackupStorageLocation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStorageLocation.

func (*BackupStorageLocation) DeepCopyInto 

func (in *BackupStorageLocation) DeepCopyInto(out *BackupStorageLocation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BackupStorageLocation) DeepCopyObject 

func (in *BackupStorageLocation) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackupStorageLocationAccessMode 

type BackupStorageLocationAccessMode string

BackupStorageLocationAccessMode represents the permissions for a BackupStorageLocation. 

const (
	// BackupStorageLocationAccessModeReadOnly represents read-only access to a BackupStorageLocation.
	BackupStorageLocationAccessModeReadOnly BackupStorageLocationAccessMode = "ReadOnly"

	// BackupStorageLocationAccessModeReadWrite represents read and write access to a BackupStorageLocation.
	BackupStorageLocationAccessModeReadWrite BackupStorageLocationAccessMode = "ReadWrite"
)

type BackupStorageLocationList 

type BackupStorageLocationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []BackupStorageLocation `json:"items"`
}

BackupStorageLocationList is a list of BackupStorageLocations.

func (*BackupStorageLocationList) DeepCopy 

func (in *BackupStorageLocationList) DeepCopy() *BackupStorageLocationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStorageLocationList.

func (*BackupStorageLocationList) DeepCopyInto 

func (in *BackupStorageLocationList) DeepCopyInto(out *BackupStorageLocationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BackupStorageLocationList) DeepCopyObject 

func (in *BackupStorageLocationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BackupStorageLocationPhase 

type BackupStorageLocationPhase string

BackupStorageLocationPhase is the lifecyle phase of a Velero BackupStorageLocation. 

const (
	// BackupStorageLocationPhaseAvailable means the location is available to read and write from.
	BackupStorageLocationPhaseAvailable BackupStorageLocationPhase = "Available"

	// BackupStorageLocationPhaseUnavailable means the location is unavailable to read and write from.
	BackupStorageLocationPhaseUnavailable BackupStorageLocationPhase = "Unavailable"
)

type BackupStorageLocationSpec 

type BackupStorageLocationSpec struct {
	// Provider is the provider of the backup storage.
	Provider string `json:"provider"`

	// Config is for provider-specific configuration fields.
	Config map[string]string `json:"config"`

	StorageType `json:",inline"`
}

BackupStorageLocationSpec defines the specification for a Velero BackupStorageLocation.

func (*BackupStorageLocationSpec) DeepCopy 

func (in *BackupStorageLocationSpec) DeepCopy() *BackupStorageLocationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStorageLocationSpec.

func (*BackupStorageLocationSpec) DeepCopyInto 

func (in *BackupStorageLocationSpec) DeepCopyInto(out *BackupStorageLocationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackupStorageLocationStatus 

type BackupStorageLocationStatus struct {
	Phase              BackupStorageLocationPhase      `json:"phase,omitempty"`
	AccessMode         BackupStorageLocationAccessMode `json:"accessMode,omitempty"`
	LastSyncedRevision types.UID                       `json:"lastSyncedRevision,omitempty"`
	LastSyncedTime     metav1.Time                     `json:"lastSyncedTime,omitempty"`
}

BackupStorageLocationStatus describes the current status of a Velero BackupStorageLocation.

func (*BackupStorageLocationStatus) DeepCopy 

func (in *BackupStorageLocationStatus) DeepCopy() *BackupStorageLocationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupStorageLocationStatus.

func (*BackupStorageLocationStatus) DeepCopyInto 

func (in *BackupStorageLocationStatus) DeepCopyInto(out *BackupStorageLocationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeleteBackupRequest 

type DeleteBackupRequest struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   DeleteBackupRequestSpec   `json:"spec"`
	Status DeleteBackupRequestStatus `json:"status,omitempty"`
}

DeleteBackupRequest is a request to delete one or more backups.

func (*DeleteBackupRequest) DeepCopy 

func (in *DeleteBackupRequest) DeepCopy() *DeleteBackupRequest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeleteBackupRequest.

func (*DeleteBackupRequest) DeepCopyInto 

func (in *DeleteBackupRequest) DeepCopyInto(out *DeleteBackupRequest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DeleteBackupRequest) DeepCopyObject 

func (in *DeleteBackupRequest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DeleteBackupRequestList 

type DeleteBackupRequestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []DeleteBackupRequest `json:"items"`
}

DeleteBackupRequestList is a list of DeleteBackupRequests.

func (*DeleteBackupRequestList) DeepCopy 

func (in *DeleteBackupRequestList) DeepCopy() *DeleteBackupRequestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeleteBackupRequestList.

func (*DeleteBackupRequestList) DeepCopyInto 

func (in *DeleteBackupRequestList) DeepCopyInto(out *DeleteBackupRequestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DeleteBackupRequestList) DeepCopyObject 

func (in *DeleteBackupRequestList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DeleteBackupRequestPhase 

type DeleteBackupRequestPhase string

DeleteBackupRequestPhase represents the lifecycle phase of a DeleteBackupRequest. 

const (
	// DeleteBackupRequestPhaseNew means the DeleteBackupRequest has not been processed yet.
	DeleteBackupRequestPhaseNew DeleteBackupRequestPhase = "New"
	// DeleteBackupRequestPhaseInProgress means the DeleteBackupRequest is being processed.
	DeleteBackupRequestPhaseInProgress DeleteBackupRequestPhase = "InProgress"
	// DeleteBackupRequestPhaseProcessed means the DeleteBackupRequest has been processed.
	DeleteBackupRequestPhaseProcessed DeleteBackupRequestPhase = "Processed"
)

type DeleteBackupRequestSpec 

type DeleteBackupRequestSpec struct {
	BackupName string `json:"backupName"`
}

DeleteBackupRequestSpec is the specification for which backups to delete.

func (*DeleteBackupRequestSpec) DeepCopy 

func (in *DeleteBackupRequestSpec) DeepCopy() *DeleteBackupRequestSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeleteBackupRequestSpec.

func (*DeleteBackupRequestSpec) DeepCopyInto 

func (in *DeleteBackupRequestSpec) DeepCopyInto(out *DeleteBackupRequestSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeleteBackupRequestStatus 

type DeleteBackupRequestStatus struct {
	// Phase is the current state of the DeleteBackupRequest.
	Phase DeleteBackupRequestPhase `json:"phase"`
	// Errors contains any errors that were encountered during the deletion process.
	Errors []string `json:"errors"`
}

DeleteBackupRequestStatus is the current status of a DeleteBackupRequest.

func (*DeleteBackupRequestStatus) DeepCopy 

func (in *DeleteBackupRequestStatus) DeepCopy() *DeleteBackupRequestStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeleteBackupRequestStatus.

func (*DeleteBackupRequestStatus) DeepCopyInto 

func (in *DeleteBackupRequestStatus) DeepCopyInto(out *DeleteBackupRequestStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DownloadRequest 

type DownloadRequest struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   DownloadRequestSpec   `json:"spec"`
	Status DownloadRequestStatus `json:"status,omitempty"`
}

DownloadRequest is a request to download an artifact from backup object storage, such as a backup log file.

func (*DownloadRequest) DeepCopy 

func (in *DownloadRequest) DeepCopy() *DownloadRequest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DownloadRequest.

func (*DownloadRequest) DeepCopyInto 

func (in *DownloadRequest) DeepCopyInto(out *DownloadRequest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DownloadRequest) DeepCopyObject 

func (in *DownloadRequest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DownloadRequestList 

type DownloadRequestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []DownloadRequest `json:"items"`
}

DownloadRequestList is a list of DownloadRequests.

func (*DownloadRequestList) DeepCopy 

func (in *DownloadRequestList) DeepCopy() *DownloadRequestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DownloadRequestList.

func (*DownloadRequestList) DeepCopyInto 

func (in *DownloadRequestList) DeepCopyInto(out *DownloadRequestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DownloadRequestList) DeepCopyObject 

func (in *DownloadRequestList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DownloadRequestPhase 

type DownloadRequestPhase string

DownloadRequestPhase represents the lifecycle phase of a DownloadRequest. 

const (
	// DownloadRequestPhaseNew means the DownloadRequest has not been processed by the
	// DownloadRequestController yet.
	DownloadRequestPhaseNew DownloadRequestPhase = "New"
	// DownloadRequestPhaseProcessed means the DownloadRequest has been processed by the
	// DownloadRequestController.
	DownloadRequestPhaseProcessed DownloadRequestPhase = "Processed"
)

type DownloadRequestSpec 

type DownloadRequestSpec struct {
	// Target is what to download (e.g. logs for a backup).
	Target DownloadTarget `json:"target"`
}

DownloadRequestSpec is the specification for a download request.

func (*DownloadRequestSpec) DeepCopy 

func (in *DownloadRequestSpec) DeepCopy() *DownloadRequestSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DownloadRequestSpec.

func (*DownloadRequestSpec) DeepCopyInto 

func (in *DownloadRequestSpec) DeepCopyInto(out *DownloadRequestSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DownloadRequestStatus 

type DownloadRequestStatus struct {
	// Phase is the current state of the DownloadRequest.
	Phase DownloadRequestPhase `json:"phase"`
	// DownloadURL contains the pre-signed URL for the target file.
	DownloadURL string `json:"downloadURL"`
	// Expiration is when this DownloadRequest expires and can be deleted by the system.
	Expiration metav1.Time `json:"expiration"`
}

DownloadRequestStatus is the current status of a DownloadRequest.

func (*DownloadRequestStatus) DeepCopy 

func (in *DownloadRequestStatus) DeepCopy() *DownloadRequestStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DownloadRequestStatus.

func (*DownloadRequestStatus) DeepCopyInto 

func (in *DownloadRequestStatus) DeepCopyInto(out *DownloadRequestStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DownloadTarget 

type DownloadTarget struct {
	// Kind is the type of file to download.
	Kind DownloadTargetKind `json:"kind"`
	// Name is the name of the kubernetes resource with which the file is associated.
	Name string `json:"name"`
}

DownloadTarget is the specification for what kind of file to download, and the name of the resource with which it's associated.

func (*DownloadTarget) DeepCopy 

func (in *DownloadTarget) DeepCopy() *DownloadTarget

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DownloadTarget.

func (*DownloadTarget) DeepCopyInto 

func (in *DownloadTarget) DeepCopyInto(out *DownloadTarget)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DownloadTargetKind 

type DownloadTargetKind string

DownloadTargetKind represents what type of file to download. 

const (
	DownloadTargetKindBackupLog             DownloadTargetKind = "BackupLog"
	DownloadTargetKindBackupContents        DownloadTargetKind = "BackupContents"
	DownloadTargetKindBackupVolumeSnapshots DownloadTargetKind = "BackupVolumeSnapshots"
	DownloadTargetKindRestoreLog            DownloadTargetKind = "RestoreLog"
	DownloadTargetKindRestoreResults        DownloadTargetKind = "RestoreResults"
)

type ExecHook 

type ExecHook struct {
	// Container is the container in the pod where the command should be executed. If not specified,
	// the pod's first container is used.
	Container string `json:"container"`
	// Command is the command and arguments to execute.
	Command []string `json:"command"`
	// OnError specifies how Velero should behave if it encounters an error executing this hook.
	OnError HookErrorMode `json:"onError"`
	// Timeout defines the maximum amount of time Velero should wait for the hook to complete before
	// considering the execution a failure.
	Timeout metav1.Duration `json:"timeout"`
}

ExecHook is a hook that uses the pod exec API to execute a command in a container in a pod.

func (*ExecHook) DeepCopy 

func (in *ExecHook) DeepCopy() *ExecHook

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecHook.

func (*ExecHook) DeepCopyInto 

func (in *ExecHook) DeepCopyInto(out *ExecHook)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HookErrorMode 

type HookErrorMode string

HookErrorMode defines how Velero should treat an error from a hook. 

const (
	// HookErrorModeContinue means that an error from a hook is acceptable, and the backup can
	// proceed.
	HookErrorModeContinue HookErrorMode = "Continue"
	// HookErrorModeFail means that an error from a hook is problematic, and the backup should be in
	// error.
	HookErrorModeFail HookErrorMode = "Fail"
)

type ObjectStorageLocation 

type ObjectStorageLocation struct {
	// Bucket is the bucket to use for object storage.
	Bucket string `json:"bucket"`

	// Prefix is the path inside a bucket to use for Velero storage. Optional.
	Prefix string `json:"prefix"`
}

ObjectStorageLocation specifies the settings necessary to connect to a provider's object storage.

func (*ObjectStorageLocation) DeepCopy 

func (in *ObjectStorageLocation) DeepCopy() *ObjectStorageLocation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectStorageLocation.

func (*ObjectStorageLocation) DeepCopyInto 

func (in *ObjectStorageLocation) DeepCopyInto(out *ObjectStorageLocation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PodVolumeBackup 

type PodVolumeBackup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   PodVolumeBackupSpec   `json:"spec"`
	Status PodVolumeBackupStatus `json:"status,omitempty"`
}

func (*PodVolumeBackup) DeepCopy 

func (in *PodVolumeBackup) DeepCopy() *PodVolumeBackup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeBackup.

func (*PodVolumeBackup) DeepCopyInto 

func (in *PodVolumeBackup) DeepCopyInto(out *PodVolumeBackup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PodVolumeBackup) DeepCopyObject 

func (in *PodVolumeBackup) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PodVolumeBackupList 

type PodVolumeBackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []PodVolumeBackup `json:"items"`
}

PodVolumeBackupList is a list of PodVolumeBackups.

func (*PodVolumeBackupList) DeepCopy 

func (in *PodVolumeBackupList) DeepCopy() *PodVolumeBackupList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeBackupList.

func (*PodVolumeBackupList) DeepCopyInto 

func (in *PodVolumeBackupList) DeepCopyInto(out *PodVolumeBackupList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PodVolumeBackupList) DeepCopyObject 

func (in *PodVolumeBackupList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PodVolumeBackupPhase 

type PodVolumeBackupPhase string

PodVolumeBackupPhase represents the lifecycle phase of a PodVolumeBackup. 

const (
	PodVolumeBackupPhaseNew        PodVolumeBackupPhase = "New"
	PodVolumeBackupPhaseInProgress PodVolumeBackupPhase = "InProgress"
	PodVolumeBackupPhaseCompleted  PodVolumeBackupPhase = "Completed"
	PodVolumeBackupPhaseFailed     PodVolumeBackupPhase = "Failed"
)

type PodVolumeBackupSpec 

type PodVolumeBackupSpec struct {
	// Node is the name of the node that the Pod is running on.
	Node string `json:"node"`

	// Pod is a reference to the pod containing the volume to be backed up.
	Pod corev1api.ObjectReference `json:"pod"`

	// Volume is the name of the volume within the Pod to be backed
	// up.
	Volume string `json:"volume"`

	// BackupStorageLocation is the name of the backup storage location
	// where the restic repository is stored.
	BackupStorageLocation string `json:"backupStorageLocation"`

	// RepoIdentifier is the restic repository identifier.
	RepoIdentifier string `json:"repoIdentifier"`

	// Tags are a map of key-value pairs that should be applied to the
	// volume backup as tags.
	Tags map[string]string `json:"tags"`
}

PodVolumeBackupSpec is the specification for a PodVolumeBackup.

func (*PodVolumeBackupSpec) DeepCopy 

func (in *PodVolumeBackupSpec) DeepCopy() *PodVolumeBackupSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeBackupSpec.

func (*PodVolumeBackupSpec) DeepCopyInto 

func (in *PodVolumeBackupSpec) DeepCopyInto(out *PodVolumeBackupSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PodVolumeBackupStatus 

type PodVolumeBackupStatus struct {
	// Phase is the current state of the PodVolumeBackup.
	Phase PodVolumeBackupPhase `json:"phase"`

	// Path is the full path within the controller pod being backed up.
	Path string `json:"path"`

	// SnapshotID is the identifier for the snapshot of the pod volume.
	SnapshotID string `json:"snapshotID"`

	// Message is a message about the pod volume backup's status.
	Message string `json:"message"`
}

PodVolumeBackupStatus is the current status of a PodVolumeBackup.

func (*PodVolumeBackupStatus) DeepCopy 

func (in *PodVolumeBackupStatus) DeepCopy() *PodVolumeBackupStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeBackupStatus.

func (*PodVolumeBackupStatus) DeepCopyInto 

func (in *PodVolumeBackupStatus) DeepCopyInto(out *PodVolumeBackupStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PodVolumeRestore 

type PodVolumeRestore struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   PodVolumeRestoreSpec   `json:"spec"`
	Status PodVolumeRestoreStatus `json:"status,omitempty"`
}

func (*PodVolumeRestore) DeepCopy 

func (in *PodVolumeRestore) DeepCopy() *PodVolumeRestore

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeRestore.

func (*PodVolumeRestore) DeepCopyInto 

func (in *PodVolumeRestore) DeepCopyInto(out *PodVolumeRestore)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PodVolumeRestore) DeepCopyObject 

func (in *PodVolumeRestore) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PodVolumeRestoreList 

type PodVolumeRestoreList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []PodVolumeRestore `json:"items"`
}

PodVolumeRestoreList is a list of PodVolumeRestores.

func (*PodVolumeRestoreList) DeepCopy 

func (in *PodVolumeRestoreList) DeepCopy() *PodVolumeRestoreList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeRestoreList.

func (*PodVolumeRestoreList) DeepCopyInto 

func (in *PodVolumeRestoreList) DeepCopyInto(out *PodVolumeRestoreList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PodVolumeRestoreList) DeepCopyObject 

func (in *PodVolumeRestoreList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PodVolumeRestorePhase 

type PodVolumeRestorePhase string

PodVolumeRestorePhase represents the lifecycle phase of a PodVolumeRestore. 

const (
	PodVolumeRestorePhaseNew        PodVolumeRestorePhase = "New"
	PodVolumeRestorePhaseInProgress PodVolumeRestorePhase = "InProgress"
	PodVolumeRestorePhaseCompleted  PodVolumeRestorePhase = "Completed"
	PodVolumeRestorePhaseFailed     PodVolumeRestorePhase = "Failed"
)

type PodVolumeRestoreSpec 

type PodVolumeRestoreSpec struct {
	// Pod is a reference to the pod containing the volume to be restored.
	Pod corev1api.ObjectReference `json:"pod"`

	// Volume is the name of the volume within the Pod to be restored.
	Volume string `json:"volume"`

	// BackupStorageLocation is the name of the backup storage location
	// where the restic repository is stored.
	BackupStorageLocation string `json:"backupStorageLocation"`

	// RepoIdentifier is the restic repository identifier.
	RepoIdentifier string `json:"repoIdentifier"`

	// SnapshotID is the ID of the volume snapshot to be restored.
	SnapshotID string `json:"snapshotID"`
}

PodVolumeRestoreSpec is the specification for a PodVolumeRestore.

func (*PodVolumeRestoreSpec) DeepCopy 

func (in *PodVolumeRestoreSpec) DeepCopy() *PodVolumeRestoreSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeRestoreSpec.

func (*PodVolumeRestoreSpec) DeepCopyInto 

func (in *PodVolumeRestoreSpec) DeepCopyInto(out *PodVolumeRestoreSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PodVolumeRestoreStatus 

type PodVolumeRestoreStatus struct {
	// Phase is the current state of the PodVolumeRestore.
	Phase PodVolumeRestorePhase `json:"phase"`

	// Message is a message about the pod volume restore's status.
	Message string `json:"message"`
}

PodVolumeRestoreStatus is the current status of a PodVolumeRestore.

func (*PodVolumeRestoreStatus) DeepCopy 

func (in *PodVolumeRestoreStatus) DeepCopy() *PodVolumeRestoreStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PodVolumeRestoreStatus.

func (*PodVolumeRestoreStatus) DeepCopyInto 

func (in *PodVolumeRestoreStatus) DeepCopyInto(out *PodVolumeRestoreStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResticRepository 

type ResticRepository struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   ResticRepositorySpec   `json:"spec"`
	Status ResticRepositoryStatus `json:"status,omitempty"`
}

func (*ResticRepository) DeepCopy 

func (in *ResticRepository) DeepCopy() *ResticRepository

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResticRepository.

func (*ResticRepository) DeepCopyInto 

func (in *ResticRepository) DeepCopyInto(out *ResticRepository)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResticRepository) DeepCopyObject 

func (in *ResticRepository) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResticRepositoryList 

type ResticRepositoryList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []ResticRepository `json:"items"`
}

ResticRepositoryList is a list of ResticRepositories.

func (*ResticRepositoryList) DeepCopy 

func (in *ResticRepositoryList) DeepCopy() *ResticRepositoryList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResticRepositoryList.

func (*ResticRepositoryList) DeepCopyInto 

func (in *ResticRepositoryList) DeepCopyInto(out *ResticRepositoryList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResticRepositoryList) DeepCopyObject 

func (in *ResticRepositoryList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResticRepositoryPhase 

type ResticRepositoryPhase string

ResticRepositoryPhase represents the lifecycle phase of a ResticRepository. 

const (
	ResticRepositoryPhaseNew      ResticRepositoryPhase = "New"
	ResticRepositoryPhaseReady    ResticRepositoryPhase = "Ready"
	ResticRepositoryPhaseNotReady ResticRepositoryPhase = "NotReady"
)

type ResticRepositorySpec 

type ResticRepositorySpec struct {
	// VolumeNamespace is the namespace this restic repository contains
	// pod volume backups for.
	VolumeNamespace string `json:"volumeNamespace"`

	// BackupStorageLocation is the name of the BackupStorageLocation
	// that should contain this repository.
	BackupStorageLocation string `json:"backupStorageLocation"`

	// ResticIdentifier is the full restic-compatible string for identifying
	// this repository.
	ResticIdentifier string `json:"resticIdentifier"`

	// MaintenanceFrequency is how often maintenance should be run.
	MaintenanceFrequency metav1.Duration `json:"maintenanceFrequency"`
}

ResticRepositorySpec is the specification for a ResticRepository.

func (*ResticRepositorySpec) DeepCopy 

func (in *ResticRepositorySpec) DeepCopy() *ResticRepositorySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResticRepositorySpec.

func (*ResticRepositorySpec) DeepCopyInto 

func (in *ResticRepositorySpec) DeepCopyInto(out *ResticRepositorySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResticRepositoryStatus 

type ResticRepositoryStatus struct {
	// Phase is the current state of the ResticRepository.
	Phase ResticRepositoryPhase `json:"phase"`

	// Message is a message about the current status of the ResticRepository.
	Message string `json:"message"`

	// LastMaintenanceTime is the last time maintenance was run.
	LastMaintenanceTime metav1.Time `json:"lastMaintenanceTime"`
}

ResticRepositoryStatus is the current status of a ResticRepository.

func (*ResticRepositoryStatus) DeepCopy 

func (in *ResticRepositoryStatus) DeepCopy() *ResticRepositoryStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResticRepositoryStatus.

func (*ResticRepositoryStatus) DeepCopyInto 

func (in *ResticRepositoryStatus) DeepCopyInto(out *ResticRepositoryStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Restore 

type Restore struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   RestoreSpec   `json:"spec"`
	Status RestoreStatus `json:"status,omitempty"`
}

Restore is an Ark resource that represents the application of resources from an Ark backup to a target Kubernetes cluster.

func (*Restore) DeepCopy 

func (in *Restore) DeepCopy() *Restore

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Restore.

func (*Restore) DeepCopyInto 

func (in *Restore) DeepCopyInto(out *Restore)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Restore) DeepCopyObject 

func (in *Restore) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RestoreList 

type RestoreList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Restore `json:"items"`
}

RestoreList is a list of Restores.

func (*RestoreList) DeepCopy 

func (in *RestoreList) DeepCopy() *RestoreList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreList.

func (*RestoreList) DeepCopyInto 

func (in *RestoreList) DeepCopyInto(out *RestoreList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RestoreList) DeepCopyObject 

func (in *RestoreList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RestorePhase 

type RestorePhase string

RestorePhase is a string representation of the lifecycle phase of an Ark restore 

const (
	// RestorePhaseNew means the restore has been created but not
	// yet processed by the RestoreController
	RestorePhaseNew RestorePhase = "New"

	// RestorePhaseFailedValidation means the restore has failed
	// the controller's validations and therefore will not run.
	RestorePhaseFailedValidation RestorePhase = "FailedValidation"

	// RestorePhaseInProgress means the restore is currently executing.
	RestorePhaseInProgress RestorePhase = "InProgress"

	// RestorePhaseCompleted means the restore has finished executing.
	// Any relevant warnings or errors will be captured in the Status.
	RestorePhaseCompleted RestorePhase = "Completed"

	// RestorePhaseFailed means the restore was unable to execute.
	// The failing error is recorded in status.FailureReason.
	RestorePhaseFailed RestorePhase = "Failed"
)

type RestoreResult 

type RestoreResult struct {
	// Ark is a slice of messages related to the operation of Ark
	// itself (for example, messages related to connecting to the
	// cloud, reading a backup file, etc.)
	// TODO(1.0) Remove this field. Currently maintained for backwards compatibility.
	Ark []string `json:"ark,omitempty"`

	// 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"`
}

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

func (*RestoreResult) DeepCopy 

func (in *RestoreResult) DeepCopy() *RestoreResult

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreResult.

func (*RestoreResult) DeepCopyInto 

func (in *RestoreResult) DeepCopyInto(out *RestoreResult)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestoreSpec 

type RestoreSpec struct {
	// BackupName is the unique name of the Ark backup to restore
	// from.
	BackupName string `json:"backupName"`

	// ScheduleName is the unique name of the Ark schedule to restore
	// from. If specified, and BackupName is empty, Ark will restore
	// from the most recent successful backup created from this schedule.
	ScheduleName string `json:"scheduleName,omitempty"`

	// IncludedNamespaces is a slice of namespace names to include objects
	// from. If empty, all namespaces are included.
	IncludedNamespaces []string `json:"includedNamespaces"`

	// ExcludedNamespaces contains a list of namespaces that are not
	// included in the restore.
	ExcludedNamespaces []string `json:"excludedNamespaces"`

	// IncludedResources is a slice of resource names to include
	// in the restore. If empty, all resources in the backup are included.
	IncludedResources []string `json:"includedResources"`

	// ExcludedResources is a slice of resource names that are not
	// included in the restore.
	ExcludedResources []string `json:"excludedResources"`

	// NamespaceMapping is a map of source namespace names
	// to target namespace names to restore into. Any source
	// namespaces not included in the map will be restored into
	// namespaces of the same name.
	NamespaceMapping map[string]string `json:"namespaceMapping"`

	// LabelSelector is a metav1.LabelSelector to filter with
	// when restoring individual objects from the backup. If empty
	// or nil, all objects are included. Optional.
	LabelSelector *metav1.LabelSelector `json:"labelSelector,omitempty"`

	// RestorePVs specifies whether to restore all included
	// PVs from snapshot (via the cloudprovider).
	RestorePVs *bool `json:"restorePVs,omitempty"`

	// IncludeClusterResources specifies whether cluster-scoped resources
	// should be included for consideration in the restore. If null, defaults
	// to true.
	IncludeClusterResources *bool `json:"includeClusterResources,omitempty"`
}

RestoreSpec defines the specification for an Ark restore.

func (*RestoreSpec) DeepCopy 

func (in *RestoreSpec) DeepCopy() *RestoreSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreSpec.

func (*RestoreSpec) DeepCopyInto 

func (in *RestoreSpec) DeepCopyInto(out *RestoreSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RestoreStatus 

type RestoreStatus struct {
	// Phase is the current state of the Restore
	Phase RestorePhase `json:"phase"`

	// ValidationErrors is a slice of all validation errors (if
	// applicable)
	ValidationErrors []string `json:"validationErrors"`

	// Warnings is a count of all warning messages that were generated during
	// execution of the restore. The actual warnings are stored in object storage.
	Warnings int `json:"warnings"`

	// Errors is a count of all error messages that were generated during
	// execution of the restore. The actual errors are stored in object storage.
	Errors int `json:"errors"`

	// FailureReason is an error that caused the entire restore to fail.
	FailureReason string `json:"failureReason"`
}

RestoreStatus captures the current status of an Ark restore

func (*RestoreStatus) DeepCopy 

func (in *RestoreStatus) DeepCopy() *RestoreStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreStatus.

func (*RestoreStatus) DeepCopyInto 

func (in *RestoreStatus) DeepCopyInto(out *RestoreStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Schedule 

type Schedule struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   ScheduleSpec   `json:"spec"`
	Status ScheduleStatus `json:"status,omitempty"`
}

Schedule is a Velero resource that represents a pre-scheduled or periodic Backup that should be run.

func (*Schedule) DeepCopy 

func (in *Schedule) DeepCopy() *Schedule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Schedule.

func (*Schedule) DeepCopyInto 

func (in *Schedule) DeepCopyInto(out *Schedule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Schedule) DeepCopyObject 

func (in *Schedule) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ScheduleList 

type ScheduleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []Schedule `json:"items"`
}

ScheduleList is a list of Schedules.

func (*ScheduleList) DeepCopy 

func (in *ScheduleList) DeepCopy() *ScheduleList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduleList.

func (*ScheduleList) DeepCopyInto 

func (in *ScheduleList) DeepCopyInto(out *ScheduleList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ScheduleList) DeepCopyObject 

func (in *ScheduleList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SchedulePhase 

type SchedulePhase string

SchedulePhase is a string representation of the lifecycle phase of a Velero schedule 

const (
	// SchedulePhaseNew means the schedule has been created but not
	// yet processed by the ScheduleController
	SchedulePhaseNew SchedulePhase = "New"

	// SchedulePhaseEnabled means the schedule has been validated and
	// will now be triggering backups according to the schedule spec.
	SchedulePhaseEnabled SchedulePhase = "Enabled"

	// SchedulePhaseFailedValidation means the schedule has failed
	// the controller's validations and therefore will not trigger backups.
	SchedulePhaseFailedValidation SchedulePhase = "FailedValidation"
)

type ScheduleSpec 

type ScheduleSpec struct {
	// Template is the definition of the Backup to be run
	// on the provided schedule
	Template BackupSpec `json:"template"`

	// Schedule is a Cron expression defining when to run
	// the Backup.
	Schedule string `json:"schedule"`
}

ScheduleSpec defines the specification for a Velero schedule

func (*ScheduleSpec) DeepCopy 

func (in *ScheduleSpec) DeepCopy() *ScheduleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduleSpec.

func (*ScheduleSpec) DeepCopyInto 

func (in *ScheduleSpec) DeepCopyInto(out *ScheduleSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScheduleStatus 

type ScheduleStatus struct {
	// Phase is the current phase of the Schedule
	Phase SchedulePhase `json:"phase"`

	// LastBackup is the last time a Backup was run for this
	// Schedule schedule
	LastBackup metav1.Time `json:"lastBackup"`

	// ValidationErrors is a slice of all validation errors (if
	// applicable)
	ValidationErrors []string `json:"validationErrors"`
}

ScheduleStatus captures the current state of a Velero schedule

func (*ScheduleStatus) DeepCopy 

func (in *ScheduleStatus) DeepCopy() *ScheduleStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduleStatus.

func (*ScheduleStatus) DeepCopyInto 

func (in *ScheduleStatus) DeepCopyInto(out *ScheduleStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServerStatusRequest 

type ServerStatusRequest struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   ServerStatusRequestSpec   `json:"spec"`
	Status ServerStatusRequestStatus `json:"status,omitempty"`
}

ServerStatusRequest is a request to access current status information about the Velero server.

func (*ServerStatusRequest) DeepCopy 

func (in *ServerStatusRequest) DeepCopy() *ServerStatusRequest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerStatusRequest.

func (*ServerStatusRequest) DeepCopyInto 

func (in *ServerStatusRequest) DeepCopyInto(out *ServerStatusRequest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServerStatusRequest) DeepCopyObject 

func (in *ServerStatusRequest) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServerStatusRequestList 

type ServerStatusRequestList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []ServerStatusRequest `json:"items"`
}

ServerStatusRequestList is a list of ServerStatusRequests.

func (*ServerStatusRequestList) DeepCopy 

func (in *ServerStatusRequestList) DeepCopy() *ServerStatusRequestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerStatusRequestList.

func (*ServerStatusRequestList) DeepCopyInto 

func (in *ServerStatusRequestList) DeepCopyInto(out *ServerStatusRequestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ServerStatusRequestList) DeepCopyObject 

func (in *ServerStatusRequestList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ServerStatusRequestPhase 

type ServerStatusRequestPhase string

ServerStatusRequestPhase represents the lifecycle phase of a ServerStatusRequest. 

const (
	// ServerStatusRequestPhaseNew means the ServerStatusRequest has not been processed yet.
	ServerStatusRequestPhaseNew ServerStatusRequestPhase = "New"
	// ServerStatusRequestPhaseProcessed means the ServerStatusRequest has been processed.
	ServerStatusRequestPhaseProcessed ServerStatusRequestPhase = "Processed"
)

type ServerStatusRequestSpec 

type ServerStatusRequestSpec struct {
}

ServerStatusRequestSpec is the specification for a ServerStatusRequest.

func (*ServerStatusRequestSpec) DeepCopy 

func (in *ServerStatusRequestSpec) DeepCopy() *ServerStatusRequestSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerStatusRequestSpec.

func (*ServerStatusRequestSpec) DeepCopyInto 

func (in *ServerStatusRequestSpec) DeepCopyInto(out *ServerStatusRequestSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServerStatusRequestStatus 

type ServerStatusRequestStatus struct {
	// Phase is the current lifecycle phase of the ServerStatusRequest.
	Phase ServerStatusRequestPhase `json:"phase"`

	// ProcessedTimestamp is when the ServerStatusRequest was processed
	// by the ServerStatusRequestController.
	ProcessedTimestamp metav1.Time `json:"processedTimestamp"`

	// ServerVersion is the Velero server version.
	ServerVersion string `json:"serverVersion"`
}

ServerStatusRequestStatus is the current status of a ServerStatusRequest.

func (*ServerStatusRequestStatus) DeepCopy 

func (in *ServerStatusRequestStatus) DeepCopy() *ServerStatusRequestStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerStatusRequestStatus.

func (*ServerStatusRequestStatus) DeepCopyInto 

func (in *ServerStatusRequestStatus) DeepCopyInto(out *ServerStatusRequestStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageType 

type StorageType struct {
	ObjectStorage *ObjectStorageLocation `json:"objectStorage,omitempty"`
}

StorageType represents the type of storage that a backup location uses. ObjectStorage must be non-nil, since it is currently the only supported StorageType.

func (*StorageType) DeepCopy 

func (in *StorageType) DeepCopy() *StorageType

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageType.

func (*StorageType) DeepCopyInto 

func (in *StorageType) DeepCopyInto(out *StorageType)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeBackupInfo 

type VolumeBackupInfo struct {
	// SnapshotID is the ID of the snapshot taken in the cloud
	// provider API of this volume.
	SnapshotID string `json:"snapshotID"`

	// Type is the type of the disk/volume in the cloud provider
	// API.
	Type string `json:"type"`

	// AvailabilityZone is the where the volume is provisioned
	// in the cloud provider.
	AvailabilityZone string `json:"availabilityZone,omitempty"`

	// Iops is the optional value of provisioned IOPS for the
	// disk/volume in the cloud provider API.
	Iops *int64 `json:"iops,omitempty"`
}

VolumeBackupInfo captures the required information about a PersistentVolume at backup time to be able to restore it later.

func (*VolumeBackupInfo) DeepCopy 

func (in *VolumeBackupInfo) DeepCopy() *VolumeBackupInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeBackupInfo.

func (*VolumeBackupInfo) DeepCopyInto 

func (in *VolumeBackupInfo) DeepCopyInto(out *VolumeBackupInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotLocation 

type VolumeSnapshotLocation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec   VolumeSnapshotLocationSpec   `json:"spec"`
	Status VolumeSnapshotLocationStatus `json:"status"`
}

VolumeSnapshotLocation is a location where Velero stores volume snapshots.

func (*VolumeSnapshotLocation) DeepCopy 

func (in *VolumeSnapshotLocation) DeepCopy() *VolumeSnapshotLocation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotLocation.

func (*VolumeSnapshotLocation) DeepCopyInto 

func (in *VolumeSnapshotLocation) DeepCopyInto(out *VolumeSnapshotLocation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshotLocation) DeepCopyObject 

func (in *VolumeSnapshotLocation) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotLocationList 

type VolumeSnapshotLocationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []VolumeSnapshotLocation `json:"items"`
}

VolumeSnapshotLocationList is a list of VolumeSnapshotLocations.

func (*VolumeSnapshotLocationList) DeepCopy 

func (in *VolumeSnapshotLocationList) DeepCopy() *VolumeSnapshotLocationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotLocationList.

func (*VolumeSnapshotLocationList) DeepCopyInto 

func (in *VolumeSnapshotLocationList) DeepCopyInto(out *VolumeSnapshotLocationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshotLocationList) DeepCopyObject 

func (in *VolumeSnapshotLocationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotLocationPhase 

type VolumeSnapshotLocationPhase string

VolumeSnapshotLocationPhase is the lifecyle phase of a Velero VolumeSnapshotLocation. 

const (
	// VolumeSnapshotLocationPhaseAvailable means the location is available to read and write from.
	VolumeSnapshotLocationPhaseAvailable VolumeSnapshotLocationPhase = "Available"

	// VolumeSnapshotLocationPhaseUnavailable means the location is unavailable to read and write from.
	VolumeSnapshotLocationPhaseUnavailable VolumeSnapshotLocationPhase = "Unavailable"
)

type VolumeSnapshotLocationSpec 

type VolumeSnapshotLocationSpec struct {
	// Provider is the provider of the volume storage.
	Provider string `json:"provider"`

	// Config is for provider-specific configuration fields.
	Config map[string]string `json:"config"`
}

VolumeSnapshotLocationSpec defines the specification for a Velero VolumeSnapshotLocation.

func (*VolumeSnapshotLocationSpec) DeepCopy 

func (in *VolumeSnapshotLocationSpec) DeepCopy() *VolumeSnapshotLocationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotLocationSpec.

func (*VolumeSnapshotLocationSpec) DeepCopyInto 

func (in *VolumeSnapshotLocationSpec) DeepCopyInto(out *VolumeSnapshotLocationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotLocationStatus 

type VolumeSnapshotLocationStatus struct {
	Phase VolumeSnapshotLocationPhase `json:"phase,omitempty"`
}

VolumeSnapshotLocationStatus describes the current status of a Velero VolumeSnapshotLocation.

func (*VolumeSnapshotLocationStatus) DeepCopy 

func (in *VolumeSnapshotLocationStatus) DeepCopy() *VolumeSnapshotLocationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotLocationStatus.

func (*VolumeSnapshotLocationStatus) DeepCopyInto 

func (in *VolumeSnapshotLocationStatus) DeepCopyInto(out *VolumeSnapshotLocationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.