Update Schedule Docs 684 (#1925)
* add basic skeleton docs Signed-off-by: Christopher Phillips <cphillips918@gmail.com>pull/1810/head
Christopher Angelo Phillips
KubeKween
parent
e054a2f0b3
commit
81a4fcbb24
|
|
@ -17,4 +17,4 @@ id: blog
|
|||
{% include blog-posts.html %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -6,9 +6,11 @@ Here we list the API types that have some functionality that you can only config
|
|||
(hooks)
|
||||
|
||||
* [Backup][1]
|
||||
* [BackupStorageLocation][2]
|
||||
* [VolumeSnapshotLocation][3]
|
||||
* [Schedule][2]
|
||||
* [BackupStorageLocation][3]
|
||||
* [VolumeSnapshotLocation][4]
|
||||
|
||||
[1]: backup.md
|
||||
[2]: backupstoragelocation.md
|
||||
[3]: volumesnapshotlocation.md
|
||||
[2]: schedule.md
|
||||
[3]: backupstoragelocation.md
|
||||
[4]: volumesnapshotlocation.md
|
||||
|
|
|
|||
|
|
@ -0,0 +1,130 @@
|
|||
# Schedule API Type
|
||||
|
||||
## Use
|
||||
|
||||
The `Schedule` API type is used as a repeatable request for the Velero server to perform a backup for a given cron notation. Once created, the
|
||||
Velero Server will start the backup process. It will then wait for the next valid point of the given cron expression and execute the backup
|
||||
process on a repeating basis.
|
||||
|
||||
## API GroupVersion
|
||||
|
||||
Schedule belongs to the API group version `velero.io/v1`.
|
||||
|
||||
## Definition
|
||||
|
||||
Here is a sample `Schedule` object with each of the fields documented:
|
||||
|
||||
```yaml
|
||||
# Standard Kubernetes API Version declaration. Required.
|
||||
apiVersion: velero.io/v1
|
||||
# Standard Kubernetes Kind declaration. Required.
|
||||
kind: Schedule
|
||||
# Standard Kubernetes metadata. Required.
|
||||
metadata:
|
||||
# Schedule name. May be any valid Kubernetes object name. Required.
|
||||
name: a
|
||||
# Schedule namespace. Must be the namespace of the Velero server. Required.
|
||||
namespace: velero
|
||||
# Parameters about the scheduled backup. Required.
|
||||
spec:
|
||||
# Schedule is a Cron expression defining when to run the Backup
|
||||
schedule: 0 7 * * *
|
||||
# Array of namespaces to include in the scheduled backup. If unspecified, all namespaces are included.
|
||||
# Optional.
|
||||
includedNamespaces:
|
||||
- '*'
|
||||
# Array of namespaces to exclude from the scheduled backup. Optional.
|
||||
excludedNamespaces:
|
||||
- some-namespace
|
||||
# Array of resources to include in the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods')
|
||||
# or fully-qualified. If unspecified, all resources are included. Optional.
|
||||
includedResources:
|
||||
- '*'
|
||||
# Array of resources to exclude from the scheduled backup. Resources may be shortcuts (e.g. 'po' for 'pods')
|
||||
# or fully-qualified. Optional.
|
||||
excludedResources:
|
||||
- storageclasses.storage.k8s.io
|
||||
# Whether or not to include cluster-scoped resources. Valid values are true, false, and
|
||||
# null/unset. If true, all cluster-scoped resources are included (subject to included/excluded
|
||||
# resources and the label selector). If false, no cluster-scoped resources are included. If unset,
|
||||
# all cluster-scoped resources are included if and only if all namespaces are included and there are
|
||||
# no excluded namespaces. Otherwise, if there is at least one namespace specified in either
|
||||
# includedNamespaces or excludedNamespaces, then the only cluster-scoped resources that are backed
|
||||
# up are those associated with namespace-scoped resources included in the scheduled backup. For example, if a
|
||||
# PersistentVolumeClaim is included in the backup, its associated PersistentVolume (which is
|
||||
# cluster-scoped) would also be backed up.
|
||||
includeClusterResources: null
|
||||
# Individual objects must match this label selector to be included in the scheduled backup. Optional.
|
||||
labelSelector:
|
||||
matchLabels:
|
||||
app: velero
|
||||
component: server
|
||||
# Whether or not to snapshot volumes. This only applies to PersistentVolumes for Azure, GCE, and
|
||||
# AWS. Valid values are true, false, and null/unset. If unset, Velero performs snapshots as long as
|
||||
# a persistent volume provider is configured for Velero.
|
||||
snapshotVolumes: null
|
||||
# Where to store the tarball and logs.
|
||||
storageLocation: aws-primary
|
||||
# The list of locations in which to store volume snapshots created for backups under this schedule.
|
||||
volumeSnapshotLocations:
|
||||
- aws-primary
|
||||
- gcp-primary
|
||||
# The amount of time before backups created on this schedule are eligible for garbage collection. If not specified,
|
||||
# a default value of 30 days will be used. The default can be configured on the velero server
|
||||
# by passing the flag --default-backup-ttl.
|
||||
ttl: 24h0m0s
|
||||
# Actions to perform at different times during a backup. The only hook currently supported is
|
||||
# executing a command in a container in a pod using the pod exec API. Optional.
|
||||
hooks:
|
||||
# Array of hooks that are applicable to specific resources. Optional.
|
||||
resources:
|
||||
-
|
||||
# Name of the hook. Will be displayed in backup log.
|
||||
name: my-hook
|
||||
# Array of namespaces to which this hook applies. If unspecified, the hook applies to all
|
||||
# namespaces. Optional.
|
||||
includedNamespaces:
|
||||
- '*'
|
||||
# Array of namespaces to which this hook does not apply. Optional.
|
||||
excludedNamespaces:
|
||||
- some-namespace
|
||||
# Array of resources to which this hook applies. The only resource supported at this time is
|
||||
# pods.
|
||||
includedResources:
|
||||
- pods
|
||||
# Array of resources to which this hook does not apply. Optional.
|
||||
excludedResources: []
|
||||
# This hook only applies to objects matching this label selector. Optional.
|
||||
labelSelector:
|
||||
matchLabels:
|
||||
app: velero
|
||||
component: server
|
||||
# An array of hooks to run before executing custom actions. Currently only "exec" hooks are supported.
|
||||
pre:
|
||||
-
|
||||
# The type of hook. This must be "exec".
|
||||
exec:
|
||||
# The name of the container where the command will be executed. If unspecified, the
|
||||
# first container in the pod will be used. Optional.
|
||||
container: my-container
|
||||
# The command to execute, specified as an array. Required.
|
||||
command:
|
||||
- /bin/uname
|
||||
- -a
|
||||
# How to handle an error executing the command. Valid values are Fail and Continue.
|
||||
# Defaults to Fail. Optional.
|
||||
onError: Fail
|
||||
# How long to wait for the command to finish executing. Defaults to 30 seconds. Optional.
|
||||
timeout: 10s
|
||||
# An array of hooks to run after all custom actions and additional items have been
|
||||
# processed. Currently only "exec" hooks are supported.
|
||||
post:
|
||||
# Same content as pre above.
|
||||
status:
|
||||
# The current phase of the latest scheduled backup. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed.
|
||||
phase: ""
|
||||
# Date/time of the last backup for a given schedule
|
||||
lastBackup:
|
||||
# An array of any validation errors encountered.
|
||||
validationErrors:
|
||||
```
|
||||
Loading…
Reference in New Issue