velero.io/v1/Backup - manifests.fyi

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

BackupSpec defines the specification for a Velero backup.

string

.spec .csiSnapshotTimeout

CSISnapshotTimeout specifies the time used to wait for CSI VolumeSnapshot status turns to ReadyToUse during creation, before returning error as timeout. The default value is 10 minute.

string

.spec .datamover

DataMover specifies the data mover to be used by the backup. If DataMover is “” or “velero”, the built-in data mover will be used.

boolean | null

.spec .defaultVolumesToFsBackup

DefaultVolumesToFsBackup specifies whether pod volume file system backup should be used for all volumes by default.

boolean | null

.spec .defaultVolumesToRestic

DefaultVolumesToRestic specifies whether restic should be used to take a backup of all pod volumes by default.

Deprecated: this field is no longer used and will be removed entirely in future. Use DefaultVolumesToFsBackup instead.

array | null

.spec .excludedClusterScopedResources

ExcludedClusterScopedResources is a slice of cluster-scoped resource type names to exclude from the backup. If set to “*”, all cluster-scoped resource types are excluded. The default value is empty.

array | null

.spec .excludedNamespaceScopedResources

ExcludedNamespaceScopedResources is a slice of namespace-scoped resource type names to exclude from the backup. If set to “*”, all namespace-scoped resource types are excluded. The default value is empty.

array | null

.spec .excludedNamespaces

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

array | null

.spec .excludedResources

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

object

.spec .hooks

Hooks represent custom behaviors that should be executed at different phases of the backup.

array | null

.spec .hooks .resources

Resources are hooks that should be executed when backing up individual instances of a resource.

boolean | null

.spec .includeClusterResources

IncludeClusterResources specifies whether cluster-scoped resources should be included for consideration in the backup.

array | null

.spec .includedClusterScopedResources

IncludedClusterScopedResources is a slice of cluster-scoped resource type names to include in the backup. If set to “*”, all cluster-scoped resource types are included. The default value is empty, which means only related cluster-scoped resources are included.

array | null

.spec .includedNamespaceScopedResources

IncludedNamespaceScopedResources is a slice of namespace-scoped resource type names to include in the backup. The default value is “*”.

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 backup. If empty, all resources are included.

string

.spec .itemOperationTimeout

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

object | null

.spec .labelSelector

LabelSelector is a metav1.LabelSelector to filter with when adding individual objects to 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 .metadata

object

.spec .metadata .labels

array | null

.spec .orLabelSelectors

OrLabelSelectors is list of metav1.LabelSelector to filter with when adding individual objects to the backup. If multiple provided they will be joined by the OR operator. LabelSelector as well as OrLabelSelectors cannot co-exist in backup request, only one of them can be used.

object | null

.spec .orderedResources

OrderedResources specifies the backup order of resources of specific Kind. The map key is the resource name and value is a list of object names separated by commas. Each resource name has format “namespace/objectname”. For cluster resources, simply use “objectname”.

object

.spec .resourcePolicy

ResourcePolicy specifies the referenced resource policies that backup should follow

string

.spec .resourcePolicy .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 .resourcePolicy .kind

Kind is the type of resource being referenced

string required

.spec .resourcePolicy .name

Name is the name of resource being referenced

boolean | null

.spec .snapshotMoveData

SnapshotMoveData specifies whether snapshot data should be moved

boolean | null

.spec .snapshotVolumes

SnapshotVolumes specifies whether to take snapshots of any PV’s referenced in the set of objects included in the Backup.

string

.spec .storageLocation

StorageLocation is a string containing the name of a BackupStorageLocation where the backup should be stored.

string

.spec .ttl

TTL is a time.Duration-parseable string describing how long the Backup should be retained for.

object | null

.spec .uploaderConfig

UploaderConfig specifies the configuration for the uploader.

integer

.spec .uploaderConfig .parallelFilesUpload

ParallelFilesUpload is the number of files parallel uploads to perform when using the uploader.

array

.spec .volumeSnapshotLocations

VolumeSnapshotLocations is a list containing names of VolumeSnapshotLocations associated with this backup.

object

.status

BackupStatus captures the current status of a Velero backup.

integer

.status .backupItemOperationsAttempted

BackupItemOperationsAttempted is the total number of attempted async BackupItemAction operations for this backup.

integer

.status .backupItemOperationsCompleted

BackupItemOperationsCompleted is the total number of successfully completed async BackupItemAction operations for this backup.

integer

.status .backupItemOperationsFailed

BackupItemOperationsFailed is the total number of async BackupItemAction operations for this backup which ended with an error.

string | null

.status .completionTimestamp

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

integer

.status .csiVolumeSnapshotsAttempted

CSIVolumeSnapshotsAttempted is the total number of attempted CSI VolumeSnapshots for this backup.

integer

.status .csiVolumeSnapshotsCompleted

CSIVolumeSnapshotsCompleted is the total number of successfully completed CSI VolumeSnapshots for this backup.

integer

.status .errors

Errors is a count of all error messages that were generated during execution of the backup. The actual errors are in the backup’s log file in object storage.

string | null

.status .expiration

Expiration is when this Backup is eligible for garbage-collection.

string

.status .failureReason

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

string

.status .formatVersion

FormatVersion is the backup format version, including major, minor, and patch version.

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 Backup.

object | null

.status .progress

Progress contains information about the backup’s execution progress. Note that this information is best-effort only – if Velero fails to update it during a backup for any reason, it may be inaccurate/stale.

integer

.status .progress .itemsBackedUp

ItemsBackedUp is the number of items that have actually been written to the backup tarball so far.

integer

.status .progress .totalItems

TotalItems is the total number of items to be backed up. This number may change throughout the execution of the backup due to plugins that return additional related items to back up, the velero.io/exclude-from-backup label, and various other filters that happen as items are processed.

string | null

velero.io / v1 / Backup