#Schedule [velero.io/v1]

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

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

ScheduleSpec defines the specification for a Velero schedule

ScheduleStatus captures the current state of a Velero schedule

Paused specifies whether the schedule is paused or not

Schedule is a Cron expression defining when to run the Backup.

SkipImmediately specifies whether to skip backup if schedule is due immediately from schedule.status.lastBackup timestamp when schedule is unpaused or if schedule is new. If true, backup will be skipped immediately when schedule is unpaused if it is due based on .Status.LastBackupTimestamp or schedule is new, and will run at next schedule time. If false, backup will not be skipped immediately when schedule is unpaused, but will run at next schedule time. If empty, will follow server configuration (default: false).

Template is the definition of the Backup to be run on the provided schedule

UseOwnerReferencesBackup specifies whether to use OwnerReferences on backups created by this Schedule.

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.

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

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

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.

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.

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.

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

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

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

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

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.

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

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

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

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

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

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

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.

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

ResourcePolicy specifies the referenced resource policies that backup should follow

SnapshotMoveData specifies whether snapshot data should be moved

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

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

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

UploaderConfig specifies the configuration for the uploader.

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

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

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

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

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

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

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

Name is the name of this hook.

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.

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.

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

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.

key is the label key that the selector applies to.

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

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.

Exec defines an exec hook.

Command is the command and arguments to execute.

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

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

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

Exec defines an exec hook.

Command is the command and arguments to execute.

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

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

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

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

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.

key is the label key that the selector applies to.

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

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.

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

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.

key is the label key that the selector applies to.

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

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.

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 is the type of resource being referenced

Name is the name of resource being referenced

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

LastBackup is the last time a Backup was run for this Schedule schedule

LastSkipped is the last time a Schedule was skipped

Phase is the current phase of the Schedule

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