|
1 | 1 | [#backup-restore-architecture]
|
2 | 2 | = Backup and restore operator architecture
|
3 | 3 |
|
4 |
| -The operator defines the `BackupSchedule.cluster.open-cluster-management.io` resource, which is used to set up {acm-short} backup schedules, and the `restore.cluster.open-cluster-management.io` resource, which is used to process and restore these backups. The operator creates corresponding Velero resources, and defines the options needed to back up remote clusters and any other hub cluster resources that need to be restored. View the following diagram: |
| 4 | +The operator defines the `BackupSchedule.cluster.open-cluster-management.io` resource that sets up {acm-short} backup schedules, and the `restore.cluster.open-cluster-management.io` resource. Use these resources to process and restore these backups. The operator creates corresponding Velero resources, and defines the options needed to back up remote clusters and any other hub cluster resources that need to be restored. |
| 5 | + |
| 6 | +View the following architecture diagram: |
5 | 7 |
|
6 | 8 | image:../images/cluster_backup_controller_dataflow25.png[Backup and restore architecture diagram]
|
7 | 9 |
|
| 10 | +The backup and restore component provides a set of policies for reporting issues, such as backup pods or backup schedules not running. Use the policy templates to create an alert to the hub cluster administrator if the backup solution does not function. For more information, see _Validating your backup or restore configurations_. |
| 11 | + |
| 12 | +The cluster backup and restore operator depends on the link:https://docs.redhat.com/documentation/en-us/openshift_container_platform/4.16/html/backup_and_restore/oadp-application-backup-and-restore#oadp-release-notes[OADP Operator] to install Velero, and to create a connection from the hub cluster to the backup storage location where the data is stored. Velero is the component that runs the backup and restore operations. The cluster backup and restore operator solution provides backup and restore support for all {acm-short} hub cluster resources, including managed clusters, applications, and policies. |
| 13 | + |
8 | 14 | [#backed-up-resources]
|
9 | 15 | == Resources that are backed up
|
10 | 16 |
|
11 |
| -The cluster backup and restore operator solution provides backup and restore support for all hub cluster resources such as managed clusters, applications, and policies. You can use the solution to back up any third-party resources extending the basic hub cluster installation. With this backup solution, you can define a cron-based backup schedule, which runs at specified time intervals and continuously backs up the latest version of the hub cluster content. |
| 17 | +The cluster backup and restore operator solution provides backup and restore support for all hub cluster resources such as managed clusters, applications, and policies. Use the solution to back up any third-party resources extending the basic hub cluster installation. With this backup solution, define a cron-based backup schedule, which runs at specified time intervals and continuously backs up the latest version of the hub cluster content. |
12 | 18 |
|
13 | 19 | When the hub cluster needs to be replaced or is in a disaster scenario when the hub cluster fails, a new hub cluster can be deployed and backed up data is moved to the new hub cluster.
|
14 | 20 |
|
@@ -131,9 +137,9 @@ Aside from the activation data resources that are identified by using the `clust
|
131 | 137 | - `clusterclaim.hive.openshift.io`
|
132 | 138 | - `clustercurator.cluster.open-cluster-management.io`
|
133 | 139 |
|
134 |
| -[#extend-backup-data] |
135 |
| -== Extending backup data |
| 140 | +[#backup-label-function] |
| 141 | +== _Backup_ label function |
136 | 142 |
|
137 | 143 | You can backup third-party resources with cluster backup and restore by adding the `cluster.open-cluster-management.io/backup` label to the resources. The value of the label can be any string, including an empty string. Use a value that can help you identify the component that you are backing up. For example, use the `cluster.open-cluster-management.io/backup: idp` label if the components are provided by an IDP solution.
|
138 | 144 |
|
139 |
| -*Note:* Use the `cluster-activation` value for the `cluster.open-cluster-management.io/backup` label if you want the resources to be restored when the managed clusters activation resources are restored. When you restore the managed clusters activation resources, the restore starts for the managed clusters that are actively managed by the hub cluster. |
| 145 | +*Note:* Use the `cluster-activation` value for the `cluster.open-cluster-management.io/backup` label if you want the resources to be restored when the managed clusters activation resources are restored. When you restore the managed clusters activation resources, the restore starts for the managed clusters that are actively managed by the hub cluster. |
0 commit comments