Skip to content

Commit 97625fb

Browse files
authored
Merge pull request #37905 from chinmayi-chandrasekar/JIRA2582_overview_of_backup_restore
OSDOCS2582: include overview for the backup and restore book
2 parents 94153f5 + 6c62824 commit 97625fb

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2075,6 +2075,8 @@ Name: Backup and restore
20752075
Dir: backup_and_restore
20762076
Distros: openshift-origin,openshift-enterprise
20772077
Topics:
2078+
- Name: Overview of backup and restore operations
2079+
File: index
20782080
- Name: Shutting down a cluster gracefully
20792081
File: graceful-cluster-shutdown
20802082
- Name: Restarting a cluster gracefully

backup_and_restore/index.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[id="backup-restore-overview"]
2+
= Backup and restore
3+
include::modules/common-attributes.adoc[]
4+
:context: backup-restore-overview
5+
6+
toc::[]
7+
8+
9+
[id="backup-restore-operations-overview"]
10+
== Overview of backup and restore operations in {product-title}
11+
12+
As a cluster administrator, you might need to stop an {product-title} cluster for a period and restart it later. Some reasons for restarting a cluster are that you need to perform maintenance on a cluster or want to reduce resource costs. In {product-title}, you can perform a xref:../backup_and_restore/graceful-cluster-shutdown.adoc#graceful-shutdown-cluster[graceful shutdown of a cluster] so that you can easily restart the cluster later.
13+
14+
You must xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[back up etcd data] before shutting down a cluster; etcd is the key-value store for {product-title}, which persists the state of all resource objects. An etcd backup plays a crucial role in disaster recovery. In {product-title}, you can also xref:../backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc#replacing-unhealthy-etcd-member[replace an unhealthy etcd member].
15+
16+
When you want to get your cluster running again, xref:../backup_and_restore/graceful-cluster-restart.adoc#graceful-restart-cluster[restart the cluster gracefully].
17+
18+
[NOTE]
19+
====
20+
A cluster's certificates expire one year after the installation date. You can shut down a cluster and expect it to restart gracefully while the certificates are still valid. Although the cluster automatically retrieves the expired control plane certificates, you must still xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[approve the certificate signing requests (CSRs)].
21+
====
22+
23+
You might run into several situations where {product-title} does not work as expected, such as:
24+
25+
* You have a cluster that is not functional after the restart because of unexpected conditions, such as node failure, or network connectivity issues.
26+
* You have deleted something critical in the cluster by mistake.
27+
* You have lost the majority of your control plane hosts, leading to etcd quorum loss.
28+
29+
You can always recover from a disaster situation by xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restoring your cluster to its previous state] using the saved etcd snapshots.

0 commit comments

Comments
 (0)