Skip to content

Commit 96d80a3

Browse files
authored
Merge pull request #60004 from lahinson/hcp-book
2 parents 2d2303a + 0ac46c8 commit 96d80a3

11 files changed

+42
-44
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2201,6 +2201,8 @@ Topics:
22012201
File: hcp-configuring
22022202
- Name: Managing hosted control planes
22032203
File: hcp-managing
2204+
- Name: Backup, restore, and disaster recovery for hosted control planes
2205+
File: hcp-backup-restore-dr
22042206
---
22052207
Name: Nodes
22062208
Dir: nodes
@@ -2757,8 +2759,6 @@ Topics:
27572759
File: backing-up-etcd
27582760
- Name: Replacing an unhealthy etcd member
27592761
File: replacing-unhealthy-etcd-member
2760-
- Name: Backing up and restoring etcd on a hosted cluster
2761-
File: etcd-backup-restore-hosted-cluster
27622762
- Name: Disaster recovery
27632763
Dir: disaster_recovery
27642764
Topics:
@@ -2768,8 +2768,6 @@ Topics:
27682768
File: scenario-2-restoring-cluster-state
27692769
- Name: Recovering from expired control plane certificates
27702770
File: scenario-3-expired-certs
2771-
- Name: Disaster recovery for a hosted cluster within an AWS region
2772-
File: dr-hosted-cluster-within-aws-region
27732771
---
27742772
Name: Migrating from version 3 to 4
27752773
Dir: migrating_from_ocp_3_to_4

backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,8 @@ After you have an etcd backup, you can xref:../../backup_and_restore/control_pla
2121

2222
// Backing up etcd data
2323
include::modules/backup-etcd.adoc[leveloffset=+1]
24+
25+
[role="_additional-resources"]
26+
[id="additional-resources_backup-etcd"]
27+
== Additional resources
28+
* xref:../../hosted_control_planes/hcp-backup-restore-dr.adoc#hcp-backup-restore[Backing up and restoring etcd on a hosted cluster]

backup_and_restore/control_plane_backup_and_restore/etcd-backup-restore-hosted-cluster.adoc

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
:_content-type: ASSEMBLY
2-
[id="dr-hosted-cluster-within-aws-region"]
3-
= Disaster recovery for a hosted cluster within an AWS region
2+
[id="hcp-backup-restore-dr"]
3+
= Backup, restore, and disaster recovery for hosted control planes
44
include::_attributes/common-attributes.adoc[]
5-
:context: dr-hosted-cluster-within-aws-region
5+
:context: hcp-backup-restore-dr
66

77
toc::[]
88

9+
If you need to back up and restore etcd on a hosted cluster or provide disaster recovery for a hosted cluster, see the following procedures.
10+
11+
:FeatureName: Hosted control planes
12+
include::snippets/technology-preview.adoc[]
13+
14+
[id="hcp-backup-restore"]
15+
== Backing up and restoring etcd on a hosted cluster
16+
17+
If you use hosted control planes on {product-title}, the process to back up and restore etcd is different from xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[the usual etcd backup process].
18+
19+
// Backing up etcd on a hosted cluster
20+
include::modules/backup-etcd-hosted-cluster.adoc[leveloffset=+2]
21+
22+
// Restoring an etcd snapshot on a hosted cluster
23+
include::modules/restoring-etcd-snapshot-hosted-cluster.adoc[leveloffset=+2]
24+
25+
[id="hcp-dr-aws"]
26+
== Disaster recovery for a hosted cluster within an AWS region
27+
928
In a situation where you need disaster recovery (DR) for a hosted cluster, you can recover a hosted cluster to the same region within AWS. For example, you need DR when the upgrade of a management cluster fails and the hosted cluster is in a read-only state.
1029

1130
:FeatureName: Hosted control planes
@@ -37,7 +56,7 @@ If you do not include the `--external-dns` flags to maintain the API server URL,
3756
====
3857

3958
[id="dr-hosted-cluster-env-context"]
40-
== Example environment and context
59+
=== Example environment and context
4160

4261
Consider an scenario where you have three clusters to restore. Two are management clusters, and one is a hosted cluster. You can restore either the control plane only or the control plane and the nodes. Before you begin, you need the following information:
4362

@@ -100,7 +119,7 @@ EXTERNAL_DNS_DOMAIN="hc.jpdv.aws.kerbeross.com"
100119
----
101120

102121
[id="dr-hosted-cluster-process"]
103-
== Overview of the backup and restore process
122+
=== Overview of the backup and restore process
104123

105124
The backup and restore process works as follows:
106125

@@ -127,13 +146,14 @@ image::298_OpenShift_Backup_Restore_0123_04.png[]
127146
You can manually back up and restore your hosted cluster, or you can run a script to complete the process. For more information about the script, see "Running a script to back up and restore a hosted cluster".
128147

129148
// Backing up the hosted cluster
130-
include::modules/dr-hosted-cluster-within-aws-region-backup.adoc[leveloffset=+1]
149+
include::modules/dr-hosted-cluster-within-aws-region-backup.adoc[leveloffset=+2]
131150

132151
// Restoring the hosted cluster
133-
include::modules/dr-hosted-cluster-within-aws-region-restore.adoc[leveloffset=+1]
152+
include::modules/dr-hosted-cluster-within-aws-region-restore.adoc[leveloffset=+2]
134153

135154
// Deleting the hosted cluster
136-
include::modules/dr-hosted-cluster-within-aws-region-delete.adoc[leveloffset=+1]
155+
include::modules/dr-hosted-cluster-within-aws-region-delete.adoc[leveloffset=+2]
137156

138157
//Helper script
139-
include::modules/dr-hosted-cluster-within-aws-region-script.adoc[leveloffset=+1]
158+
include::modules/dr-hosted-cluster-within-aws-region-script.adoc[leveloffset=+2]
159+

hosted_control_planes/hcp-configuring.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ You can view the procedures by selecting from one of the following providers:
1818

1919
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring the hosted cluster on AWS]: The tasks to configure a hosted cluster on AWS include creating the AWS S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling AWS PrivateLink, enabling the hosted control planes feature, and installing the hosted control planes CLI.
2020
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/clusters/cluster_mce_overview#hosted-control-planes-manage-aws[Managing hosted control plane clusters on AWS]: Management tasks include creating, importing, accessing, or deleting a hosted cluster on AWS.
21-
* xref:../backup_and_restore/control_plane_backup_and_restore/etcd-backup-restore-hosted-cluster.adoc#etcd-backup-restore-hosted-cluster[Backing up and restoring etcd on a hosted cluster]: The procedure to back up and restore etcd on a hosted cluster differs from the typical procedure for {product-title}.
22-
* xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/dr-hosted-cluster-within-aws-region.adoc#dr-hosted-cluster-within-aws-region[Disaster recovery for a hosted cluster within an AWS region]: In a disaster situation, such as when a hosted cluster becomes read-only because of a failure, learn how to restore the hosted cluster.
2321

2422
[id="hcp-configuring-bm"]
2523
== Bare metal

modules/backup-etcd-hosted-cluster.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assembly:
22
//
3-
// * control_plane_backup_and_restore/etcd-backup-restore-hosted-cluster.adoc
3+
// * hcp-backup-restore-dr.adoc
44

55
:_content-type: PROCEDURE
66
[id="backup-etcd-hosted-cluster_{context}"]

modules/dr-hosted-cluster-within-aws-region-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assembly:
22
//
3-
// * control_plane_backup_and_restore/dr-hcp-within-aws-region.adoc
3+
// * hcp-backup-restore-dr.adoc
44

55
:_content-type: PROCEDURE
66
[id="dr-hosted-cluster-within-aws-region-backup_{context}"]

modules/dr-hosted-cluster-within-aws-region-delete.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assembly:
22
//
3-
// * control_plane_backup_and_restore/dr-hcp-within-aws-region.adoc
3+
// * hcp-backup-restore-dr.adoc
44

55
:_content-type: PROCEDURE
66
[id="dr-hosted-cluster-within-aws-region-delete_{context}"]

modules/dr-hosted-cluster-within-aws-region-restore.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assembly:
22
//
3-
// * control_plane_backup_and_restore/dr-hcp-within-aws-region.adoc
3+
// * hcp-backup-restore-dr.adoc
44

55
:_content-type: PROCEDURE
66
[id="dr-hosted-cluster-within-aws-region-restore_{context}"]

modules/dr-hosted-cluster-within-aws-region-script.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assembly:
22
//
3-
// * control_plane_backup_and_restore/dr-hcp-within-aws-region.adoc
3+
// * hcp-backup-restore-dr.adoc
44

55
:_content-type: PROCEDURE
66
[id="dr-hosted-cluster-within-aws-region-script_{context}"]

0 commit comments

Comments
 (0)