← Back to index Esc
Kind
Restore
Group
velero.io
Version
v1
apiVersion: velero.io/v1 kind: Restore metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
RestoreSpec defines the specification for a Velero restore.
backupName string
BackupName is the unique name of the Velero backup to restore from.
excludedNamespaces []string
ExcludedNamespaces contains a list of namespaces that are not included in the restore.
excludedResources []string
ExcludedResources is a slice of resource names that are not included in the restore.
existingResourcePolicy string
ExistingResourcePolicy specifies the restore behavior for the Kubernetes resource to be restored
hooks object
Hooks represent custom behaviors that should be executed during or post restore.
resources []object
excludedNamespaces []string
ExcludedNamespaces specifies the namespaces to which this hook spec does not apply.
excludedResources []string
ExcludedResources specifies the resources to which this hook spec does not apply.
includedNamespaces []string
IncludedNamespaces specifies the namespaces to which this hook spec applies. If empty, it applies to all namespaces.
includedResources []string
IncludedResources specifies the resources to which this hook spec applies. If empty, it applies to all resources.
labelSelector object
LabelSelector, if specified, filters the resources to which this hook spec applies.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
name string required
Name is the name of this hook.
postHooks []object
PostHooks is a list of RestoreResourceHooks to execute during and after restoring a resource.
exec object
Exec defines an exec restore hook.
command []string required
Command is the command and arguments to execute from within a container after a pod has been restored.
minItems: 1
container string
Container is the container in the pod where the command should be executed. If not specified, the pod's first container is used.
execTimeout string
ExecTimeout defines the maximum amount of time Velero should wait for the hook to complete before considering the execution a failure.
onError string
OnError specifies how Velero should behave if it encounters an error executing this hook.
enum: Continue, Fail
waitForReady boolean
WaitForReady ensures command will be launched when container is Ready instead of Running.
waitTimeout string
WaitTimeout defines the maximum amount of time Velero should wait for the container to be Ready before attempting to run the command.
init object
Init defines an init restore hook.
initContainers []object
InitContainers is list of init containers to be added to a pod during its restore.
timeout string
Timeout defines the maximum amount of time Velero should wait for the initContainers to complete.
includeClusterResources boolean
IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the restore. If null, defaults to true.
includedNamespaces []string
IncludedNamespaces is a slice of namespace names to include objects from. If empty, all namespaces are included.
includedResources []string
IncludedResources is a slice of resource names to include in the restore. If empty, all resources in the backup are included.
itemOperationTimeout string
ItemOperationTimeout specifies the time used to wait for RestoreItemAction operations The default value is 4 hour.
labelSelector object
LabelSelector is a metav1.LabelSelector to filter with when restoring individual objects from the backup. If empty or nil, all objects are included. Optional.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
namespaceMapping object
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.
orLabelSelectors []object
OrLabelSelectors is list of metav1.LabelSelector to filter with when restoring individual objects from the backup. If multiple provided they will be joined by the OR operator. LabelSelector as well as OrLabelSelectors cannot co-exist in restore request, only one of them can be used
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
preserveNodePorts boolean
PreserveNodePorts specifies whether to restore old nodePorts from backup.
resourceModifier object
ResourceModifier specifies the reference to JSON resource patches that should be applied to resources before restoration.
apiGroup string
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind string required
Kind is the type of resource being referenced
name string required
Name is the name of resource being referenced
restorePVs boolean
RestorePVs specifies whether to restore all included PVs from snapshot
restoreStatus object
RestoreStatus specifies which resources we should restore the status field. If nil, no objects are included. Optional.
excludedResources []string
ExcludedResources specifies the resources to which will not restore the status.
includedResources []string
IncludedResources specifies the resources to which will restore the status. If empty, it applies to all resources.
scheduleName string
ScheduleName is the unique name of the Velero schedule to restore from. If specified, and BackupName is empty, Velero will restore from the most recent successful backup created from this schedule.
uploaderConfig object
UploaderConfig specifies the configuration for the restore.
parallelFilesDownload integer
ParallelFilesDownload is the concurrency number setting for restore.
writeSparseFiles boolean
WriteSparseFiles is a flag to indicate whether write files sparsely or not.
status object
RestoreStatus captures the current status of a Velero restore
completionTimestamp string
CompletionTimestamp records the time the restore operation was completed. Completion time is recorded even on failed restore. The server's time is used for StartTimestamps
format: date-time
errors integer
Errors is a count of all error messages that were generated during execution of the restore. The actual errors are stored in object storage.
failureReason string
FailureReason is an error that caused the entire restore to fail.
hookStatus object
HookStatus contains information about the status of the hooks.
hooksAttempted integer
HooksAttempted is the total number of attempted hooks Specifically, HooksAttempted represents the number of hooks that failed to execute and the number of hooks that executed successfully.
hooksFailed integer
HooksFailed is the total number of hooks which ended with an error
phase string
Phase is the current state of the Restore
enum: New, FailedValidation, InProgress, WaitingForPluginOperations, WaitingForPluginOperationsPartiallyFailed, Completed, PartiallyFailed, Failed, Finalizing, FinalizingPartiallyFailed
progress object
Progress contains information about the restore's execution progress. Note that this information is best-effort only -- if Velero fails to update it during a restore for any reason, it may be inaccurate/stale.
itemsRestored integer
ItemsRestored is the number of items that have actually been restored so far
totalItems integer
TotalItems is the total number of items to be restored. This number may change throughout the execution of the restore due to plugins that return additional related items to restore
restoreItemOperationsAttempted integer
RestoreItemOperationsAttempted is the total number of attempted async RestoreItemAction operations for this restore.
restoreItemOperationsCompleted integer
RestoreItemOperationsCompleted is the total number of successfully completed async RestoreItemAction operations for this restore.
restoreItemOperationsFailed integer
RestoreItemOperationsFailed is the total number of async RestoreItemAction operations for this restore which ended with an error.
startTimestamp string
StartTimestamp records the time the restore operation was started. The server's time is used for StartTimestamps
format: date-time
validationErrors []string
ValidationErrors is a slice of all validation errors (if applicable)
warnings integer
Warnings is a count of all warning messages that were generated during execution of the restore. The actual warnings are stored in object storage.
Copied!