diff --git a/backup_and_restore/hibernating-cluster.adoc b/backup_and_restore/hibernating-cluster.adoc index 73a84eba323..1ee8e389fd0 100644 --- a/backup_and_restore/hibernating-cluster.adoc +++ b/backup_and_restore/hibernating-cluster.adoc @@ -6,28 +6,17 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can hibernate your {product-title} cluster for up to 90 days. +[role="_abstract"] +Hibernate your {product-title} cluster for up to 90 days to pause cluster operation without deprovisioning it. You can resume the cluster within that window to restore normal operation. // About hibernating a cluster include::modules/hibernating-cluster-about.adoc[leveloffset=+1] -[id="hibernating-cluster_prerequisites_{context}"] -== Prerequisites - -* Take an xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[etcd backup] prior to hibernating the cluster. -+ -[IMPORTANT] -==== -It is important to take an etcd backup before hibernating so that your cluster can be restored if you encounter any issues when resuming the cluster. - -For example, the following conditions can cause the resumed cluster to malfunction: - -* etcd data corruption during hibernation -* Node failure due to hardware -* Network connectivity issues +//Included here to go with the above module +[role="_additional-resources"] +.Additional resources -If your cluster fails to recover, follow the steps to xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore to a previous cluster state]. -==== +* link:https://www.redhat.com/en/blog/enabling-openshift-4-clusters-to-stop-and-resume-cluster-vms[Enabling OpenShift 4 Clusters to Stop and Resume Cluster VMs (Red Hat Blog)] // Hibernating a cluster include::modules/hibernating-cluster-hibernate.adoc[leveloffset=+1] @@ -36,6 +25,7 @@ include::modules/hibernating-cluster-hibernate.adoc[leveloffset=+1] .Additional resources * xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd] +* xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[Restoring to a previous cluster state] // Resuming a hibernated cluster include::modules/hibernating-cluster-resume.adoc[leveloffset=+1] diff --git a/modules/hibernating-cluster-about.adoc b/modules/hibernating-cluster-about.adoc index 7b88dcc63c3..d36f41d8e0b 100644 --- a/modules/hibernating-cluster-about.adoc +++ b/modules/hibernating-cluster-about.adoc @@ -6,15 +6,28 @@ [id="hibernating-cluster-about_{context}"] = About cluster hibernation -{product-title} clusters can be hibernated in order to save money on cloud hosting costs. You can hibernate your {product-title} cluster for up to 90 days and expect it to resume successfully. +[role="_abstract"] +Review cluster hibernation limits and supported behavior before you pause a cluster. Understanding timing, node, and resume requirements helps you hibernate and resume successfully within 90 days. -You must wait at least 24 hours after cluster installation before hibernating your cluster to allow for the first certification rotation. +You must wait at least 24 hours after cluster installation before hibernating your cluster to allow for the first certificate rotation. + +Take an etcd backup before hibernating so that your cluster can be restored if you encounter issues when resuming the cluster. + +You might need to restore from the backup if any of the following conditions occur: + +* etcd data is corrupted during hibernation +* A node fails because of hardware +* Network connectivity is interrupted + +If the cluster does not recover after restart, follow the steps to restore to a previous cluster state. [IMPORTANT] ==== -If you must hibernate your cluster before the 24 hour certificate rotation, use the following procedure instead: link:https://www.redhat.com/en/blog/enabling-openshift-4-clusters-to-stop-and-resume-cluster-vms[Enabling OpenShift 4 Clusters to Stop and Resume Cluster VMs]. +If you must hibernate your cluster before the 24 hour certificate rotation, use the workaround in "Enabling OpenShift 4 Clusters to Stop and Resume Cluster VMs" instead. ==== -When hibernating a cluster, you must hibernate all cluster nodes. It is not supported to suspend only certain nodes. +When hibernating a cluster, you must hibernate all cluster nodes. Suspending only selected nodes is not supported. After resuming, it can take up to 45 minutes for the cluster to become ready. + + diff --git a/modules/hibernating-cluster-hibernate.adoc b/modules/hibernating-cluster-hibernate.adoc index 4faebbd44e4..8afddd239b8 100644 --- a/modules/hibernating-cluster-hibernate.adoc +++ b/modules/hibernating-cluster-hibernate.adoc @@ -6,19 +6,20 @@ [id="hibernating-cluster-hibernate_{context}"] = Hibernating a cluster -You can hibernate a cluster for up to 90 days. The cluster can recover if certificates expire while the cluster was in hibernation. +[role="_abstract"] +Hibernate your cluster by verifying node and Operator health, then stopping the cluster virtual machines. This process pauses the cluster in a supported state so you can resume it later. .Prerequisites * The cluster has been running for at least 24 hours to allow the first certificate rotation to complete. + +* You created an etcd backup before hibernating the cluster. + [IMPORTANT] ==== -If you must hibernate your cluster before the 24 hour certificate rotation, use the following procedure instead: link:https://www.redhat.com/en/blog/enabling-openshift-4-clusters-to-stop-and-resume-cluster-vms[Enabling OpenShift 4 Clusters to Stop and Resume Cluster VMs]. +Without a recent etcd backup, you might not be able to restore the cluster if hibernation or resume fails. ==== -* You have taken an etcd backup. - * You have access to the cluster as a user with the `cluster-admin` role. .Procedure @@ -89,7 +90,7 @@ All machine config pools should show `UPDATING`=`False` and `DEGRADED`=`False`. . Stop the cluster virtual machines: + -Use the tools native to your cluster's cloud environment to shut down the cluster's virtual machines. +Use the tools native to the cloud environment of your cluster to shut down the cluster virtual machines. + [IMPORTANT] ==== diff --git a/modules/hibernating-cluster-resume.adoc b/modules/hibernating-cluster-resume.adoc index 10e94b43a17..d0606caab76 100644 --- a/modules/hibernating-cluster-resume.adoc +++ b/modules/hibernating-cluster-resume.adoc @@ -6,7 +6,8 @@ [id="hibernating-cluster-resume_{context}"] = Resuming a hibernated cluster -When you resume a hibernated cluster within 90 days, you might have to approve certificate signing requests (CSRs) for the nodes to become ready. +[role="_abstract"] +Resume a hibernated cluster by starting the cluster virtual machines and approving certificate signing requests (CSRs) as needed. This process restores the cluster to a ready state within the supported 90-day window. It can take around 45 minutes for the cluster to resume, depending on the size of your cluster. @@ -19,13 +20,13 @@ It can take around 45 minutes for the cluster to resume, depending on the size o . Within 90 days of cluster hibernation, resume the cluster virtual machines: + -Use the tools native to your cluster's cloud environment to resume the cluster's virtual machines. +Use the tools native to the cloud environment of your cluster to resume the cluster virtual machines. . Wait about 5 minutes, depending on the number of nodes in your cluster. . Approve CSRs for the nodes: -.. Check that there is a CSR for each node in the `NotReady` state: +.. Check that there is a CSR for each node in the `NotReady` state by running the following command: + [source,terminal] ----