From 676f90c6641cff210184bac5260477d691f7d25a Mon Sep 17 00:00:00 2001 From: brandi swope Date: Mon, 17 Nov 2025 15:56:01 -0500 Subject: [PATCH 1/6] https://issues.redhat.com/browse/ACM-24669--new procedure for hcp restore --- .../backup_restore/backup_hcp.adoc | 37 ++++++++++++++++++- .../backup_restore/backup_hosting.adoc | 22 +++++++++++ 2 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 business_continuity/backup_restore/backup_hosting.adoc diff --git a/business_continuity/backup_restore/backup_hcp.adoc b/business_continuity/backup_restore/backup_hcp.adoc index 72b9bc2b28..ab0adf2714 100644 --- a/business_continuity/backup_restore/backup_hcp.adoc +++ b/business_continuity/backup_restore/backup_hcp.adoc @@ -11,4 +11,39 @@ See the following information for backing up and restoring hosted clusters with * {oadp} resources, such as `DataProtectionApplication`, `BackupSchedule`, `Backup` and `Restore` for your hosted clusters, are created in the `open-cluster-management-backup` namespace. -* For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-backup-restore-aws-overview_hcp-disaster-recovery-aws[Overview of Hosted Cluster backup and restore process]. \ No newline at end of file +* For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-backup-restore-aws-overview_hcp-disaster-recovery-aws[Overview of Hosted Cluster backup and restore process]. + +== Backup ccope for hosted clusters + +When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you need to know the scope of the {acm-short) backup and recovery operation. + +{acm-short} only recovers the management capability of {mce-short} hosting clusters and the attached hosted clusters. This includes the following functional areas: + +- Discovery and import configuration: Auto-discovery policies and `DiscoveredCluster` resources +- Management resources: Policies, applications, and governance configurations applied to hosted clusters +- Backup labels: Resources marked with `cluster.open-cluster-management.io/backup` labels +- Add-on configurations: HyperShift addon settings and deployment configurations + +The following functional areas are outside the disaster recovery scope: + +- {mce-short} hosting clusters: Physical infrastructure and cluster lifecycle +- Hosted clusters: The actual hosted control planes and their workloads +- Hosted cluster data: Applications, persistent volumes, and user data within hosted clusters + +For complete disaster recovery in hosted cluster environments, implement a multi-layered backup strategy that includes the following processes: + +* {acm-short} hub cluster backup + + - Purpose: Restore management capabilities and discovery configurations + - Scope {acm-short} resources, policies, applications, and addon configurations + - Implementation: Use {acm-short}'s cluster-backup-operator + +* Hosted cluster backup + - Purpose: Backup hosted control planes and workloads + - Scope: Hosted cluster etcd, persistent volumes, and application data + - Implementation: Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. + +* The {mce-short} hosting cluster backup + - Purposs: Backup the infrastructure hosting the control planes + - Scope: {mce-short} cluster state and configurations + - Implementation: Standard OpenShift backup procedures diff --git a/business_continuity/backup_restore/backup_hosting.adoc b/business_continuity/backup_restore/backup_hosting.adoc new file mode 100644 index 0000000000..56c88439d8 --- /dev/null +++ b/business_continuity/backup_restore/backup_hosting.adoc @@ -0,0 +1,22 @@ +[#restore-hcp] += Restoring hosted clusters + +When restoring hosted clusters managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. + +Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. + +. Restore the {acm-short} hub cluster. +//all of these need actions +.. Deploy new {acm-short} hub with same configuration as original +.. Enable backup component and configure OADP +.. Restore {acm-short} backup using the cluster-backup-operator +.. Verify discovery and auto-import policies are restored + +. Reconnect {mce-short} Hosting Clusters +- {mce-short} hosting clusters will automatically reconnect to restored {acm-short} hub +- HyperShift addon will resume discovery operations +- Previously discovered hosted clusters will be rediscovered + +. Recover your hosted cluster. Hosted clusters require a separate recovery by using individual backup procedures. The {acm-short} hub automatically rediscovers clusters after the APIs become available. + +For other comprehensive guidance on backup and restore, see the xref:../backup_restore/backup_intro.adoc#backup-intro[Backup and restore] documentation. \ No newline at end of file From 67876c3eb50d15692e68d848228197744cb205c1 Mon Sep 17 00:00:00 2001 From: brandi swope Date: Mon, 17 Nov 2025 17:40:08 -0500 Subject: [PATCH 2/6] more changes --- business_continuity/backup_restore/backup_hcp.adoc | 6 ++++-- .../{backup_hosting.adoc => backup_restore_hosting.adoc} | 2 +- release_notes/acm_new.adoc | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) rename business_continuity/backup_restore/{backup_hosting.adoc => backup_restore_hosting.adoc} (94%) diff --git a/business_continuity/backup_restore/backup_hcp.adoc b/business_continuity/backup_restore/backup_hcp.adoc index ab0adf2714..aaf1e8b77e 100644 --- a/business_continuity/backup_restore/backup_hcp.adoc +++ b/business_continuity/backup_restore/backup_hcp.adoc @@ -15,7 +15,7 @@ See the following information for backing up and restoring hosted clusters with == Backup ccope for hosted clusters -When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you need to know the scope of the {acm-short) backup and recovery operation. +When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you need to know the scope of the {acm-short} backup and recovery operation. {acm-short} only recovers the management capability of {mce-short} hosting clusters and the attached hosted clusters. This includes the following functional areas: @@ -44,6 +44,8 @@ For complete disaster recovery in hosted cluster environments, implement a multi - Implementation: Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. * The {mce-short} hosting cluster backup - - Purposs: Backup the infrastructure hosting the control planes + - Purpose: Backup the infrastructure hosting the control planes - Scope: {mce-short} cluster state and configurations - Implementation: Standard OpenShift backup procedures + +Continue to the xref:../backup_restore/backup_restore_hosting.adoc#restore-hcp[Restoring hosted clusters] for detailed steps on restoring hosted clusters managed by {acm-short}. \ No newline at end of file diff --git a/business_continuity/backup_restore/backup_hosting.adoc b/business_continuity/backup_restore/backup_restore_hosting.adoc similarity index 94% rename from business_continuity/backup_restore/backup_hosting.adoc rename to business_continuity/backup_restore/backup_restore_hosting.adoc index 56c88439d8..20fb6b65ca 100644 --- a/business_continuity/backup_restore/backup_hosting.adoc +++ b/business_continuity/backup_restore/backup_restore_hosting.adoc @@ -6,7 +6,7 @@ When restoring hosted clusters managed by {acm-short}, follow steps to ensure a Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. . Restore the {acm-short} hub cluster. -//all of these need actions +//all of these need actions or is this just a guide for how to us the procedure? .. Deploy new {acm-short} hub with same configuration as original .. Enable backup component and configure OADP .. Restore {acm-short} backup using the cluster-backup-operator diff --git a/release_notes/acm_new.adoc b/release_notes/acm_new.adoc index c04ffa99a2..ea25a5d029 100644 --- a/release_notes/acm_new.adoc +++ b/release_notes/acm_new.adoc @@ -110,6 +110,8 @@ See link:../observability/observe_environments_intro.adoc#observing-environments Learn about new features for _Back up and restore_ and _VolSync_ components. +* You can back up and restore hosted clusters that are managed by {acm-short}. When restoring hosted clusters managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. For more information, see link:../business_continuity/backup_restore/backup_hcp.adoc#config-hcp-backup[Backup and restore for hosted control planes and hosted clusters] and link:../business_continuity/backup_restore/backup_restore_hosting.adoc#restore-hcp[Restoring hosted clusters]. + To learn about VolSync, which enables asynchronous replication of persistent volumes within a cluster, see link:../business_continuity/volsync/volsync.adoc#volsync[VolSync persistent volume replication service] To learn about Backup and restore, see link:../business_continuity/backup_restore/backup_intro.adoc#backup-intro[Backup and restore]. From 97ba88a30769279ebcb6c7c04b82704af046e15e Mon Sep 17 00:00:00 2001 From: brandi swope Date: Mon, 17 Nov 2025 17:45:10 -0500 Subject: [PATCH 3/6] more changes --- business_continuity/backup_restore/backup_hcp.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/business_continuity/backup_restore/backup_hcp.adoc b/business_continuity/backup_restore/backup_hcp.adoc index aaf1e8b77e..c437f201da 100644 --- a/business_continuity/backup_restore/backup_hcp.adoc +++ b/business_continuity/backup_restore/backup_hcp.adoc @@ -13,7 +13,7 @@ See the following information for backing up and restoring hosted clusters with * For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-backup-restore-aws-overview_hcp-disaster-recovery-aws[Overview of Hosted Cluster backup and restore process]. -== Backup ccope for hosted clusters +== Backup scope for hosted clusters When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you need to know the scope of the {acm-short} backup and recovery operation. @@ -46,6 +46,6 @@ For complete disaster recovery in hosted cluster environments, implement a multi * The {mce-short} hosting cluster backup - Purpose: Backup the infrastructure hosting the control planes - Scope: {mce-short} cluster state and configurations - - Implementation: Standard OpenShift backup procedures + - Implementation: Standard {ocp-short} backup procedures Continue to the xref:../backup_restore/backup_restore_hosting.adoc#restore-hcp[Restoring hosted clusters] for detailed steps on restoring hosted clusters managed by {acm-short}. \ No newline at end of file From 2e9ccfff3724837404a7fe9a8fb013f43fc5ed0e Mon Sep 17 00:00:00 2001 From: brandi swope Date: Thu, 20 Nov 2025 17:46:22 -0500 Subject: [PATCH 4/6] adding comments for review --- business_continuity/backup_restore/backup_hcp.adoc | 3 +++ business_continuity/backup_restore/backup_restore_hosting.adoc | 1 + 2 files changed, 4 insertions(+) diff --git a/business_continuity/backup_restore/backup_hcp.adoc b/business_continuity/backup_restore/backup_hcp.adoc index c437f201da..05abc278b5 100644 --- a/business_continuity/backup_restore/backup_hcp.adoc +++ b/business_continuity/backup_restore/backup_hcp.adoc @@ -1,5 +1,8 @@ [#config-hcp-backup] = Backup and restore for hosted control planes and hosted clusters +//trying to break this out in to two files in a way that makes sense + +When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you can back up and restore both the {acm-short} hub cluster and the hosted clusters. See the {ocp-short} {hcp} disaster recovery documentation to help you install the {oadp} operator, create {oadp} resources, and use the {oadp} to backup and restore hosted clusters. Then, note the differences in the {acm-short} process. diff --git a/business_continuity/backup_restore/backup_restore_hosting.adoc b/business_continuity/backup_restore/backup_restore_hosting.adoc index 20fb6b65ca..71b667d3ce 100644 --- a/business_continuity/backup_restore/backup_restore_hosting.adoc +++ b/business_continuity/backup_restore/backup_restore_hosting.adoc @@ -1,5 +1,6 @@ [#restore-hcp] = Restoring hosted clusters +//hosting? When restoring hosted clusters managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. From 65e552f9848a5f144978cfef7e8859e26502a730 Mon Sep 17 00:00:00 2001 From: brandi swope Date: Fri, 21 Nov 2025 19:58:22 -0500 Subject: [PATCH 5/6] https://issues.redhat.com/browse/ACM-24669--post review with developer --- .../backup_restore/backup_hcp.adoc | 9 ++++--- .../backup_restore_hcp_mngmt.adoc | 27 +++++++++++++++++++ .../backup_restore_hosting.adoc | 23 ---------------- 3 files changed, 33 insertions(+), 26 deletions(-) create mode 100644 business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc delete mode 100644 business_continuity/backup_restore/backup_restore_hosting.adoc diff --git a/business_continuity/backup_restore/backup_hcp.adoc b/business_continuity/backup_restore/backup_hcp.adoc index 05abc278b5..8ca896f82a 100644 --- a/business_continuity/backup_restore/backup_hcp.adoc +++ b/business_continuity/backup_restore/backup_hcp.adoc @@ -1,6 +1,5 @@ [#config-hcp-backup] -= Backup and restore for hosted control planes and hosted clusters -//trying to break this out in to two files in a way that makes sense += Backup and restore for {hcp} overview When using {acm-short} to manage hosted clusters with {mce-short} hosting clusters, you can back up and restore both the {acm-short} hub cluster and the hosted clusters. @@ -51,4 +50,8 @@ For complete disaster recovery in hosted cluster environments, implement a multi - Scope: {mce-short} cluster state and configurations - Implementation: Standard {ocp-short} backup procedures -Continue to the xref:../backup_restore/backup_restore_hosting.adoc#restore-hcp[Restoring hosted clusters] for detailed steps on restoring hosted clusters managed by {acm-short}. \ No newline at end of file +Continue to the xref:../backup_restore/backup_restore_hosting.adoc#restore-hcp[Restoring hosted clusters] for detailed steps on restoring hosted clusters managed by {acm-short}. + +== Additional resources + +* xref:../about/mce_hcp_overview.adoc#mce-hcp-overview[About hosted control planes with {mce-short}] \ No newline at end of file diff --git a/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc b/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc new file mode 100644 index 0000000000..5e08d4c606 --- /dev/null +++ b/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc @@ -0,0 +1,27 @@ +[#restore-hcp] += Restoring {hcp} management configuration + +When restoring hosted clusters that are managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. + +Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. + +.Procedure + +See the following guidance to restore {hcp} management configuration + +. Restore the {acm-short} hub cluster. See xref:../backup_restore/backup_restore.adoc#restore-backup[Restoring a backup]. +. Deploy new {acm-short} hub with same configuration as the original. See xref:../backup_restore/backup_install.adoc#dr4hub-install-backup-and-restore[Installing the backup and restore operator] +. Enable backup component and configure OADP. +. Restore {acm-short} backup by using the `cluster-backup-operator`. +. Verify discovery and auto-import policies are restored. See xref:../../mce_acm_integration/discover_hosted/acm_discover_hosted.adoc#discover-hosted-acm[Discovering {mce-short} hosted clusters in {acm-short}] + +. Verify that {mce-short} hosted environment is reconnected to the restored {acm-short} hub cluster. See xref:../backup_restore/backup_restore.adoc#restore-backup[Restoring a backup]. The following clusters and resources are restored when the backup and restore is successful: + - {mce-short} hosting clusters automatically reconnect to restored {acm-short} hub cluster. + - The `hypershift-addon` resumes discovery operations. + - Previously discovered hosted clusters are rediscovered. + +. Recover your hosted cluster. Hosted clusters require a separate recovery by using individual backup procedures. The {acm-short} hub cluster automatically rediscovers clusters after the APIs become available. See https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp-auto. + +For other guidance on backup and restore, see the xref:../backup_restore/backup_intro.adoc#backup-intro[Backup and restore] documentation. + +For more information about {hcp}, see xref:../about/mce_hcp_overview.adoc#mce-hcp-overview[About hosted control planes with {mce-short}]. \ No newline at end of file diff --git a/business_continuity/backup_restore/backup_restore_hosting.adoc b/business_continuity/backup_restore/backup_restore_hosting.adoc deleted file mode 100644 index 71b667d3ce..0000000000 --- a/business_continuity/backup_restore/backup_restore_hosting.adoc +++ /dev/null @@ -1,23 +0,0 @@ -[#restore-hcp] -= Restoring hosted clusters -//hosting? - -When restoring hosted clusters managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. - -Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. - -. Restore the {acm-short} hub cluster. -//all of these need actions or is this just a guide for how to us the procedure? -.. Deploy new {acm-short} hub with same configuration as original -.. Enable backup component and configure OADP -.. Restore {acm-short} backup using the cluster-backup-operator -.. Verify discovery and auto-import policies are restored - -. Reconnect {mce-short} Hosting Clusters -- {mce-short} hosting clusters will automatically reconnect to restored {acm-short} hub -- HyperShift addon will resume discovery operations -- Previously discovered hosted clusters will be rediscovered - -. Recover your hosted cluster. Hosted clusters require a separate recovery by using individual backup procedures. The {acm-short} hub automatically rediscovers clusters after the APIs become available. - -For other comprehensive guidance on backup and restore, see the xref:../backup_restore/backup_intro.adoc#backup-intro[Backup and restore] documentation. \ No newline at end of file From 9a2900171bacb3f85d4600eb5174ae01553b3c0a Mon Sep 17 00:00:00 2001 From: brandi swope Date: Mon, 1 Dec 2025 14:18:45 -0500 Subject: [PATCH 6/6] post meeting and some clean up (intro out of order with main) --- .../backup_restore/backup_intro.adoc | 15 ++------------- .../backup_restore/backup_restore_hcp_mngmt.adoc | 2 +- business_continuity/main.adoc | 3 ++- 3 files changed, 5 insertions(+), 15 deletions(-) diff --git a/business_continuity/backup_restore/backup_intro.adoc b/business_continuity/backup_restore/backup_intro.adoc index aab7fb331c..d6b206f873 100644 --- a/business_continuity/backup_restore/backup_intro.adoc +++ b/business_continuity/backup_restore/backup_intro.adoc @@ -8,29 +8,18 @@ The cluster backup and restore operator supports backups of any third-party reso Complete the following topics to learn more about the backup and restore operator: * xref:../backup_restore/backup_arch.adoc#backup-restore-architecture[Backup and restore operator architecture] - * xref:../backup_restore/backup_hub_config.adoc#dr4hub-config[Configuring active passive hub cluster] - * xref:../backup_restore/backup_install.adoc#dr4hub-install-backup-and-restore[Installing the backup and restore operator] - * xref:../backup_restore/backup_schedule.adoc#using-backup-restore[Scheduling and restoring backups] - * xref:../backup_restore/backup_restore.adoc#restore-backup[Restoring a backup] - * xref:../backup_restore/backup_validate.adoc#backup-validation-using-a-policy[Validating your backup or restore configurations] - * xref:../backup_restore/backup_msa.adoc#auto-connect-clusters-msa[Connecting clusters automatically by using a Managed Service Account] - * xref:../backup_restore/backup_active_restore.adoc#keep-hub-active-restore[Running the restore operation while the primary hub cluster is active] - * xref:../backup_restore/backup_velero.adoc#config-velero-res-limit[Configuring Velero resource requests and limits] - * xref:../backup_restore/use_existing_hub_cluster.adoc#using-existing-hub[Scenarios when using an existing hub cluster as a restore hub cluster] - * xref:../backup_restore/tag_resources.adoc#tagging-resources[Tagging user resources with the backup label] - * xref:../backup_restore/backup_restore_hub.adoc#restore-data-initial-hub[Restoring data to the initial hub cluster] - * xref:../backup_restore/backup_hcp.adoc#config-hcp-backup[Backup and restore for hosted control planes and hosted clusters] - +* xref:../backup_restore/backup_restore_hcp_mngmt.adoc#restore-hcp-management[Restoring hosted control plane management clusters] * xref:../backup_restore/backup_restore_config_obs.adoc#backup-restore-obs-config[Backup and restore configuration for Observability] +* xref:../backup_restore/backup_restore_obs.adoc#restore-obs-data[Restoring Observability data] diff --git a/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc b/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc index 5e08d4c606..4f7fba4c77 100644 --- a/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc +++ b/business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc @@ -1,7 +1,7 @@ [#restore-hcp] = Restoring {hcp} management configuration -When restoring hosted clusters that are managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub and the hosted clusters. +When restoring hosted clusters that are managed by {acm-short}, follow steps to ensure a successful recovery of both the {acm-short} hub cluster and the hosted clusters. Follow link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/hosted_control_planes/high-availability-for-hosted-control-planes#hcp-disaster-recovery-oadp[OpenShift Hosted Control Plane Disaster Recovery documentation]. diff --git a/business_continuity/main.adoc b/business_continuity/main.adoc index f464befd10..f5f1af7237 100644 --- a/business_continuity/main.adoc +++ b/business_continuity/main.adoc @@ -9,14 +9,15 @@ include::backup_restore/backup_hub_config.adoc[leveloffset=+3] include::backup_restore/backup_install.adoc[leveloffset=+3] include::backup_restore/backup_schedule.adoc[leveloffset=+3] include::backup_restore/backup_restore.adoc[leveloffset=+3] -include::backup_restore/backup_msa.adoc[leveloffset=+3] include::backup_restore/backup_validate.adoc[leveloffset=+3] +include::backup_restore/backup_msa.adoc[leveloffset=+3] include::backup_restore/backup_active_restore.adoc[leveloffset=+3] include::backup_restore/backup_velero.adoc[leveloffset=+3] include::backup_restore/use_existing_hub_cluster.adoc[leveloffset=+3] include::backup_restore/tag_resources.adoc[leveloffset=+3] include::backup_restore/backup_restore_hub.adoc[leveloffset=+3] include::backup_restore/backup_hcp.adoc[leveloffset=+3] +include::backup_restore/backup_restore_hcp_mngmt.adoc[leveloffset=+3] include::backup_restore/backup_restore_config_obs.adoc[leveloffset=+3] include::backup_restore/backup_restore_obs.adoc[leveloffset=+3] include::volsync/volsync.adoc[leveloffset=+2]