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

### Custom Resources

* [Restore](#restore)

### Sub Resources

* [From](#from)
* [RestoreBucketInfo](#restorebucketinfo)
* [RestoreList](#restorelist)
* [RestoreProgress](#restoreprogress)
* [RestoreSpec](#restorespec)
* [RestoreStatus](#restorestatus)

#### From



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| backup | Backup is the name of the target Backup object, if this field is specified, the backup data will be retrieved from the Backup job. The Backup must exist in the same namespace if specified. | string | true |
| logBackup | LogBackup represents to execute PiTR it is the name of Backup object with Log mode its usage is same as Backup field | *string | false |
| PiTRRestoredTS | PiTRRestoredTS is the PiTR restored ts. it is used when LogBackup is specified | *string | false |
| bucket | (Deprecated) RestoreBucketInfo is the bucket info of the backup data it is used in the case that the restore with workflow Please use Region, SnapshotBackupStorage and LogBackupStorage fields instead | *[RestoreBucketInfo](#restorebucketinfo) | false |
| region | Region is the region of the backup bucket | *string | false |
| snapshotBackupStorage | SnapshotBackupStorage is the snapshot backup bucket storage | *string | false |
| logBackupStorage | LogBackupStorage is the log backup bucket storage | *string | false |

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

#### Restore

Restore is the Schema for the restores API

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata |  | metav1.ObjectMeta | false |
| spec |  | [RestoreSpec](#restorespec) | false |
| status |  | [RestoreStatus](#restorestatus) | false |

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

#### RestoreBucketInfo



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| cloudProvider | CloudProvider is the cloud provider of the bucket | string | false |
| region | Region is the region of the bucket | string | false |
| name | Name is the name of the bucket | string | false |
| backupPrefix | BackupPrefix is the prefix of the backup file. | string | false |
| logBackupPrefix | LogBackupPrefix is the prefix of the log backup file. | string | false |

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

#### RestoreList

RestoreList contains a list of Restore

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

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

#### RestoreProgress



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| step | Step is the step name of progress | string | false |
| progress | Progress is the restore progress percentage value | int32 | false |
| lastTransitionTime | LastTransitionTime is the update time | metav1.Time | false |

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

#### RestoreSpec

RestoreSpec defines the desired state of Restore

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| clusterName | ClusterName specifies the name of the target cluster where data is restored to, the cluster must exist in the same namespace with Restore | string | true |
| from | From specified where the backup data locates | [From](#from) | true |
| configuration | Configuration is the configuration passed from dataflow it is used to replace gitops | *DPConfiguration | false |
| options | Options is the parameters list of br, like --filters=xxx | []string | false |
| nodeRole | NodeRole is the aws role or gcp service account that the br node uses | *string | false |
| env | Env adds environment variables to restore pod | []corev1.EnvVar | false |
| resourceRequirements | ResourceRequirements manage resources(cpu,memory) of restore pod | *corev1.ResourceRequirements | false |
| instanceType | InstanceType specifies the instance type required by restore pod | *string | false |
| paused | Paused specifies whether to pause the reconciliation loop for Restore CR | *bool | false |
| compactBackupName | CompactBackupName is the name of the sibling cloudv1.CompactBackup CR used for compaction-accelerated PiTR restore. When set, the restore-controller populates ReplicationConfig.CompactBackupName on the operator Restore CR.\n\nFor PiTR restore only. | string | false |

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

#### RestoreStatus

RestoreStatus defines the observed state of Restore

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| phase | Phase denotes the current restore progress | RestoreConditionType | true |
| progresses |  | [][RestoreProgress](#restoreprogress) | false |

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