velero.io / v1 / Restore

• string

  .apiVersion

  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

• string

  .kind

  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

• object

  .metadata

• object

  .spec

  RestoreSpec defines the specification for a Velero restore.

• string

  .spec .backupName

  BackupName is the unique name of the Velero backup to restore from.

• array | null

  .spec .excludedNamespaces

  ExcludedNamespaces contains a list of namespaces that are not included in the restore.

• array | null

  .spec .excludedResources

  ExcludedResources is a slice of resource names that are not included in the restore.

• string | null

  .spec .existingResourcePolicy

  ExistingResourcePolicy specifies the restore behavior for the Kubernetes resource to be restored

• object

  .spec .hooks

  Hooks represent custom behaviors that should be executed during or post restore.

• array

  .spec .hooks .resources

• array | null

  .spec .hooks .resources[] .excludedNamespaces

  ExcludedNamespaces specifies the namespaces to which this hook spec does not apply.

• array | null

  .spec .hooks .resources[] .excludedResources

  ExcludedResources specifies the resources to which this hook spec does not apply.

• array | null

  .spec .hooks .resources[] .includedNamespaces

  IncludedNamespaces specifies the namespaces to which this hook spec applies. If empty, it applies to all namespaces.

• array | null

  .spec .hooks .resources[] .includedResources

  IncludedResources specifies the resources to which this hook spec applies. If empty, it applies to all resources.

• object | null

  .spec .hooks .resources[] .labelSelector

  LabelSelector, if specified, filters the resources to which this hook spec applies.

• array

  .spec .hooks .resources[] .labelSelector .matchExpressions

  matchExpressions is a list of label selector requirements. The requirements are ANDed.

• string required

  .spec .hooks .resources[] .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .hooks .resources[] .labelSelector .matchExpressions[] .operator

  operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

• array

  .spec .hooks .resources[] .labelSelector .matchExpressions[] .values

  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.

• object

  .spec .hooks .resources[] .labelSelector .matchLabels

  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.

• string required

  .spec .hooks .resources[] .name

  Name is the name of this hook.

• array

  .spec .hooks .resources[] .postHooks

  PostHooks is a list of RestoreResourceHooks to execute during and after restoring a resource.

• object

  .spec .hooks .resources[] .postHooks[] .exec

  Exec defines an exec restore hook.

• array required

  .spec .hooks .resources[] .postHooks[] .exec .command

  Command is the command and arguments to execute from within a container after a pod has been restored.

• string

  .spec .hooks .resources[] .postHooks[] .exec .container

  Container is the container in the pod where the command should be executed. If not specified, the pod’s first container is used.

• string

  .spec .hooks .resources[] .postHooks[] .exec .execTimeout

  ExecTimeout defines the maximum amount of time Velero should wait for the hook to complete before considering the execution a failure.

• string

  .spec .hooks .resources[] .postHooks[] .exec .onError

  OnError specifies how Velero should behave if it encounters an error executing this hook.

• boolean | null

  .spec .hooks .resources[] .postHooks[] .exec .waitForReady

  WaitForReady ensures command will be launched when container is Ready instead of Running.

• string

  .spec .hooks .resources[] .postHooks[] .exec .waitTimeout

  WaitTimeout defines the maximum amount of time Velero should wait for the container to be Ready before attempting to run the command.

• object

  .spec .hooks .resources[] .postHooks[] .init

  Init defines an init restore hook.

• array

  .spec .hooks .resources[] .postHooks[] .init .initContainers

  InitContainers is list of init containers to be added to a pod during its restore.

• string

  .spec .hooks .resources[] .postHooks[] .init .timeout

  Timeout defines the maximum amount of time Velero should wait for the initContainers to complete.

• boolean | null

  .spec .includeClusterResources

  IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the restore. If null, defaults to true.

• array | null

  .spec .includedNamespaces

  IncludedNamespaces is a slice of namespace names to include objects from. If empty, all namespaces are included.

• array | null

  .spec .includedResources

  IncludedResources is a slice of resource names to include in the restore. If empty, all resources in the backup are included.

• string

  .spec .itemOperationTimeout

  ItemOperationTimeout specifies the time used to wait for RestoreItemAction operations The default value is 4 hour.

• object | null

  .spec .labelSelector

  LabelSelector is a metav1.LabelSelector to filter with when restoring individual objects from the backup. If empty or nil, all objects are included. Optional.

• array

  .spec .labelSelector .matchExpressions

  matchExpressions is a list of label selector requirements. The requirements are ANDed.

• string required

  .spec .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .labelSelector .matchExpressions[] .operator

  operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

• array

  .spec .labelSelector .matchExpressions[] .values

  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.

• object

  .spec .labelSelector .matchLabels

  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.

• object

  .spec .namespaceMapping

  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.

• array | null

  .spec .orLabelSelectors

  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

• boolean | null

  .spec .preserveNodePorts

  PreserveNodePorts specifies whether to restore old nodePorts from backup.

• object | null

  .spec .resourceModifier

  ResourceModifier specifies the reference to JSON resource patches that should be applied to resources before restoration.

• string

  .spec .resourceModifier .apiGroup

  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.

• string required

  .spec .resourceModifier .kind

  Kind is the type of resource being referenced

• string required

  .spec .resourceModifier .name

  Name is the name of resource being referenced

• boolean | null

  .spec .restorePVs

  RestorePVs specifies whether to restore all included PVs from snapshot

• object | null

  .spec .restoreStatus

  RestoreStatus specifies which resources we should restore the status field. If nil, no objects are included. Optional.

• array | null

  .spec .restoreStatus .excludedResources

  ExcludedResources specifies the resources to which will not restore the status.

• array | null

  .spec .restoreStatus .includedResources

  IncludedResources specifies the resources to which will restore the status. If empty, it applies to all resources.

• string

  .spec .scheduleName

  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.

• object | null

  .spec .uploaderConfig

  UploaderConfig specifies the configuration for the restore.

• integer

  .spec .uploaderConfig .parallelFilesDownload

  ParallelFilesDownload is the concurrency number setting for restore.

• boolean | null

  .spec .uploaderConfig .writeSparseFiles

  WriteSparseFiles is a flag to indicate whether write files sparsely or not.

• object

  .status

  RestoreStatus captures the current status of a Velero restore

• string | null

  .status .completionTimestamp

  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

• integer

  .status .errors

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

• string

  .status .failureReason

  FailureReason is an error that caused the entire restore to fail.

• object | null

  .status .hookStatus

  HookStatus contains information about the status of the hooks.

• integer

  .status .hookStatus .hooksAttempted

  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.

• integer

  .status .hookStatus .hooksFailed

  HooksFailed is the total number of hooks which ended with an error

• string

  .status .phase

  Phase is the current state of the Restore

• object | null

  .status .progress

  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.

• integer

  .status .progress .itemsRestored

  ItemsRestored is the number of items that have actually been restored so far

• integer

  .status .progress .totalItems

  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

• integer

  .status .restoreItemOperationsAttempted

  RestoreItemOperationsAttempted is the total number of attempted async RestoreItemAction operations for this restore.

• integer

  .status .restoreItemOperationsCompleted

  RestoreItemOperationsCompleted is the total number of successfully completed async RestoreItemAction operations for this restore.

• integer

  .status .restoreItemOperationsFailed

  RestoreItemOperationsFailed is the total number of async RestoreItemAction operations for this restore which ended with an error.

• string | null

  .status .startTimestamp

  StartTimestamp records the time the restore operation was started. The server’s time is used for StartTimestamps

• array | null

  .status .validationErrors

  ValidationErrors is a slice of all validation errors (if applicable)

• integer

  .status .warnings

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