This resource is namespace scoped, refer to [Namespace](./namespace.md) for details.

### Custom Resources

* [Backup](#backup)

### Sub Resources

* [BackupList](#backuplist)
* [BackupSpec](#backupspec)
* [BackupStatus](#backupstatus)

#### Backup

Backup is the Schema for the backups API

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [BackupSpec](#backupspec) | true |
| status |  | [BackupStatus](#backupstatus) | false |

[Back to Custom Resources](#custom-resources)

#### BackupList

BackupList contains a list of Backup

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ListMeta | false |
| items |  | [][Backup](#backup) | true |

[Back to Custom Resources](#custom-resources)

#### BackupSpec

BackupSpec defines the desired state of Backup

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| clusterName | ClusterName is the target cluster name, target cluster must exist in the same namespace as backup | string | true |
| mode | Mode is the backup mode, such as snapshot backup or log backup. | *BackupMode | false |
| commitTS | CommitTs is the commit ts of the backup, snapshot ts for snapshot backup or start ts for log backup. Format supports TSO or datetime, e.g. '400036290571534337', '2018-05-11 01:42:23'. Default is current timestamp. | *string | false |
| logTruncateUntil | LogTruncateUntil is log backup truncate until timestamp. Format supports TSO or datetime, e.g. '400036290571534337', '2018-05-11 01:42:23'. | *string | false |
| logStop | LogStop indicates that will stop the log backup. | *bool | false |
| storage | Storage is the target storage address, use s3 uri. like gs://xxxx | *string | false |
| options | Options is the parameters list of br, like --backupts=xxx | []string | false |

[Back to Custom Resources](#custom-resources)

#### BackupStatus

BackupStatus defines the observed state of Backup

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| phase | Phase denotes current backup progress | BackupConditionType | true |
| backupSize | BackupSize is the physical storage size taken by the backup assets | int64 | false |
| backupTS | BackupTS is the snapshot timestamp for snapshot backup or start timestamp for log backup | string | false |
| bucketName | BucketName is the object store path of this backup | string | false |
| backupPath | BackupPath is the location of the backup. | string | false |
| logCheckpointTs | LogCheckpointTs is the ts of log backup process | string | false |
| logTruncateUntil | LogTruncateUntil is log backup truncate until timestamp which will be the same as Spec.LogTruncateUntil when truncate is complete | string | false |
| fromProvider | FromProvider encodes the provider specific status of the backup, e.g. target shoot name of the backup | runtime.RawExtension | false |

[Back to Custom Resources](#custom-resources)