From c95abf69b2c578beedb917a5206e73493f74f88f Mon Sep 17 00:00:00 2001 From: Steve Kriss Date: Wed, 1 May 2019 14:59:07 -0600 Subject: [PATCH] update docs/backup.md (#1427) Signed-off-by: Steve Kriss --- docs/api-types/backup.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/api-types/backup.md b/docs/api-types/backup.md index c524c991c..70120a921 100644 --- a/docs/api-types/backup.md +++ b/docs/api-types/backup.md @@ -2,7 +2,7 @@ ## Use -The `Backup` API type is used as a request for the Velero Server to perform a backup. Once created, the +The `Backup` API type is used as a request for the Velero server to perform a backup. Once created, the Velero Server immediately starts the backup process. ## API GroupVersion @@ -119,24 +119,25 @@ spec: # Same content as pre above. # Status about the Backup. Users should not set any data here. status: + # The version of this Backup. The only version currently supported is 1. + version: 1 # The date and time when the Backup is eligible for garbage collection. expiration: null - # The current phase. Valid values are New, FailedValidation, InProgress, Completed, Failed. + # The current phase. Valid values are New, FailedValidation, InProgress, Completed, PartiallyFailed, Failed. phase: "" # An array of any validation errors encountered. validationErrors: null - # The version of this Backup. The only version currently supported is 1. - version: 1 - # Information about PersistentVolumes needed during restores. - volumeBackups: - # Each key is the name of a PersistentVolume. - some-pv-name: - # The ID used by the cloud provider for the snapshot created for this Backup. - snapshotID: snap-1234 - # The type of the volume in the cloud provider API. - type: io1 - # The availability zone where the volume resides in the cloud provider. - availabilityZone: my-zone - # The amount of provisioned IOPS for the volume. Optional. - iops: 10000 + # Date/time when the backup started being processed. + startTimestamp: 2019-04-29T15:58:43Z + # Date/time when the backup finished being processed. + completionTimestamp: 2019-04-29T15:58:56Z + # Number of volume snapshots that Velero tried to create for this backup. + volumeSnapshotsAttempted: 2 + # Number of volume snapshots that Velero successfully created for this backup. + volumeSnapshotsCompleted: 1 + # Number of warnings that were logged by the backup. + warnings: 2 + # Number of errors that were logged by the backup. + errors: 0 + ```