velero.io / v1 / Schedule

• 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

  ScheduleSpec defines the specification for a Velero schedule

• boolean

  .spec .paused

  Paused specifies whether the schedule is paused or not

• string required

  .spec .schedule

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

• boolean

  .spec .skipImmediately

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

• object required

  .spec .template

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

• string

  .spec .template .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 .template .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 .template .defaultVolumesToFsBackup

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

• boolean | null

  .spec .template .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 .template .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 .template .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 .template .excludedNamespaces

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

• array | null

  .spec .template .excludedResources

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

• object

  .spec .template .hooks

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

• array | null

  .spec .template .hooks .resources

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

• boolean | null

  .spec .template .includeClusterResources

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

• array | null

  .spec .template .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 .template .includedNamespaceScopedResources

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

• array | null

  .spec .template .includedNamespaces

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

• array | null

  .spec .template .includedResources

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

• string

  .spec .template .itemOperationTimeout

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

• object | null

  .spec .template .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 .template .labelSelector .matchExpressions

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

• string required

  .spec .template .labelSelector .matchExpressions[] .key

  key is the label key that the selector applies to.

• string required

  .spec .template .labelSelector .matchExpressions[] .operator

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

• array

  .spec .template .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 .template .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 .template .metadata

• object

  .spec .template .metadata .labels

• array | null

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

  ResourcePolicy specifies the referenced resource policies that backup should follow

• string

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

  Kind is the type of resource being referenced

• string required

  .spec .template .resourcePolicy .name

  Name is the name of resource being referenced

• boolean | null

  .spec .template .snapshotMoveData

  SnapshotMoveData specifies whether snapshot data should be moved

• boolean | null

  .spec .template .snapshotVolumes

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

• string

  .spec .template .storageLocation

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

• string

  .spec .template .ttl

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

• object | null

  .spec .template .uploaderConfig

  UploaderConfig specifies the configuration for the uploader.

• integer

  .spec .template .uploaderConfig .parallelFilesUpload

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

• array

  .spec .template .volumeSnapshotLocations

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

• boolean | null

  .spec .useOwnerReferencesInBackup

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

• object

  .status

  ScheduleStatus captures the current state of a Velero schedule

• string | null

  .status .lastBackup

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

• string | null

  .status .lastSkipped

  LastSkipped is the last time a Schedule was skipped

• string

  .status .phase

  Phase is the current phase of the Schedule

• array

  .status .validationErrors

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