Skip to content

Commit 6bfb9a3

Browse files
authored
Merge pull request #7787 from stolostron/jcberger-17815-hub-changes-213
https://issues.redhat.com/browse/ACM-17815
2 parents 9c696ff + 46b787d commit 6bfb9a3

File tree

4 files changed

+23
-20
lines changed

4 files changed

+23
-20
lines changed

business_continuity/backup_restore/backup_arch.adoc

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
[#backup-restore-architecture]
22
= Backup and restore operator architecture
33

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:
57

68
image:../images/cluster_backup_controller_dataflow25.png[Backup and restore architecture diagram]
79

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+
814
[#backed-up-resources]
915
== Resources that are backed up
1016

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.
1218

1319
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.
1420

@@ -131,9 +137,9 @@ Aside from the activation data resources that are identified by using the `clust
131137
- `clusterclaim.hive.openshift.io`
132138
- `clustercurator.cluster.open-cluster-management.io`
133139
134-
[#extend-backup-data]
135-
== Extending backup data
140+
[#backup-label-function]
141+
== _Backup_ label function
136142

137143
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.
138144

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.

business_continuity/backup_restore/backup_install.adoc

-9
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,6 @@ To enable the backup operator for your active and passive hub clusters, complete
4949
.. Create the `DataProtectionApplication` resource on both the active and passive hub cluster.
5050
.. For the restore hub cluster, when you create the `DataProtectionApplication` resource, use the same storage location as the backup hub.
5151

52-
[#running-restore-operation]
53-
==== Running a restore operation on a hub cluster with a newer version
54-
55-
If you want to run the restore operation on a hub cluster that uses a newer {acm-short} version than the hub cluster where the backup was created, you can still run a restore operation by completing the following steps:
56-
57-
. On the restore hub cluster, install the operator at the same version as the hub cluster where the backup was created.
58-
. Restore the backup data on the restore hub cluster.
59-
. On the restore hub cluster, use the upgrade operation to upgrade to the version you want to use.
60-
6152
[#installing-the-oadp-operator]
6253
=== Installing the OADP operator
6354

business_continuity/backup_restore/backup_intro.adoc

+2-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
[#backup-intro]
22
= Backup and restore
33

4-
The cluster backup and restore operator runs on the hub cluster and provides disaster recovery solutions for {acm} hub cluster failures. When the hub cluster fails, some features, such as policy configuration-based alerting or cluster updates stop working, even if all managed clusters still work. Once the hub cluster is unavailable, you need a recovery plan to decide if recovery is possible, or if the data needs to be recovered on a newly deployed hub cluster.
4+
The cluster backup and restore operator runs on the hub cluster and provides disaster recovery solutions for {acm} hub cluster failures. When the hub cluster fails, some features, such as policy configuration-based alerting or cluster updates stop working, even if all managed clusters still work. When the hub cluster is unavailable, you need a recovery plan to determine if recovery is possible, or if you need to recover the data on a newly deployed hub cluster.
55

6-
The backup and restore component provides a set of policies for reporting issues with the backup and restore component, such as backup pods or backup schedules not running. You can use the policy templates to create an alert to the hub cluster administrator if the backup solution is not functioning as expected. For more information, see _Validating your backup or restore configurations_.
7-
8-
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.
9-
10-
The cluster backup and restore operator supports backups of any third-party resources that extend the hub cluster installation. With this backup solution, you can define cron-based backup schedules which run at specified time intervals. When the hub cluster fails, a new hub cluster can be deployed and the backed up data is moved to the new hub cluster.
6+
The cluster backup and restore operator supports backups of any third-party resources that extend the hub cluster installation. With this backup solution, you can define cron-based backup schedules that run at specified time intervals. When the hub cluster fails, a new hub cluster can be deployed and the backed up data is moved to the new hub cluster.
117

128
Continue reading the following topics to learn more about the backup and restore operator:
139

business_continuity/backup_restore/backup_restore.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ To fully restore a backup, complete the following:
1010
* <<restoring-backup-restore-operation,Using the restore operation for backup types>>
1111
* <<restoring-data-primary-hub,Restoring data back to the initial primary hub>>
1212
* <<prepare-new-hub,Preparing the new hub cluster>>
13+
* <<run-restore-operation,Running a restore operation on a hub cluster with a newer version>>
1314
* <<clean-hub-restore,Cleaning the hub cluster after restore>>
1415
* <<restore-passive-resources-check-backups,Restoring passive resources while checking for backups>>
1516
* <<restore-passive-resources,Restoring passive resources>>
@@ -88,6 +89,15 @@ Use the same configuration as on the initial hub cluster for the `MultiClusterHu
8889

8990
For example, if the initial hub cluster has any other operators installed, such as {aap-short}, {gitops}, `cert-manager`, you have to install them before running the restore operation. This ensures that the new hub cluster is configured in the same way as the initial hub cluster.
9091

92+
[#run-restore-operation]
93+
== Running a restore operation on a hub cluster with a newer version
94+
95+
If you want to run the restore operation on a hub cluster that uses a newer {acm-short} version than the hub cluster where the backup was created, you can still run a restore operation by completing the following steps:
96+
97+
. On the restore hub cluster, install the operator at the same version as the hub cluster where the backup was created.
98+
. Restore the backup data on the restore hub cluster.
99+
. On the restore hub cluster, use the upgrade operation to upgrade to the version you want to use.
100+
91101
[#clean-hub-restore]
92102
== Cleaning the hub cluster after restore
93103

0 commit comments

Comments
 (0)