Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 45 additions & 2 deletions business_continuity/backup_restore/backup_hcp.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[#config-hcp-backup]
= Backup and restore for hosted control planes and hosted clusters
= Backup and restore for {hcp} overview
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file has new content.


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.

Expand All @@ -11,4 +13,45 @@ 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].
* 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 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.

{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
- Purpose: Backup the infrastructure hosting the control planes
- 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}.

== Additional resources

* xref:../about/mce_hcp_overview.adoc#mce-hcp-overview[About hosted control planes with {mce-short}]
15 changes: 2 additions & 13 deletions business_continuity/backup_restore/backup_intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just removed unnecessary spaces here.


* 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]
27 changes: 27 additions & 0 deletions business_continuity/backup_restore/backup_restore_hcp_mngmt.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[#restore-hcp]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a new file

= 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 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].

.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}].
3 changes: 2 additions & 1 deletion business_continuity/main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this order did not match the intro

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]
Expand Down
2 changes: 2 additions & 0 deletions release_notes/acm_new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

announcement


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].
Expand Down