Skip to content

Commit 4ec90de

Browse files
authored
Merge pull request #71747 from skopacz1/OSDOCS-3630
OSDOCS#3630: OTA etcd backup guidance
2 parents a2dc682 + da3623e commit 4ec90de

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

modules/update-etcd-backup.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/preparing_for_updates/updating-cluster-prepare.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="update-etcd-backup_{context}"]
7+
= etcd backups before cluster updates
8+
9+
etcd backups record the state of your cluster and all of its resource objects.
10+
You can use backups to attempt restoring the state of a cluster in disaster scenarios where you cannot recover a cluster in its currently dysfunctional state.
11+
12+
In the context of updates, you can attempt an etcd restoration of the cluster if an update introduced catastrophic conditions that cannot be fixed without reverting to the previous cluster version.
13+
etcd restorations might be destructive and destabilizing to a running cluster, use them only as a last resort.
14+
15+
[WARNING]
16+
====
17+
Due to their high consequences, etcd restorations are not intended to be used as a rollback solution.
18+
Rolling your cluster back to a previous version is not supported.
19+
If your update is failing to complete, contact Red{nbsp}Hat support.
20+
====
21+
22+
There are several factors that affect the viability of an etcd restoration.
23+
For more information, see "Backing up etcd data" and "Restoring to a previous cluster state".

updating/preparing_for_updates/updating-cluster-prepare.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@ include::modules/update-preparing-conditional.adoc[leveloffset=+1]
5858
.Additional resources
5959
* xref:../../updating/understanding_updates/how-updates-work.adoc#update-evaluate-availability_how-updates-work[Evaluation of update availability]
6060

61+
// etcd backups before cluster updates
62+
include::modules/update-etcd-backup.adoc[leveloffset=+1]
63+
64+
[role="_additional-resources"]
65+
.Additional resources
66+
67+
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
68+
69+
* 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]
70+
6171
// Best practices for cluster updates
6272
include::modules/update-best-practices.adoc[leveloffset=+1]
6373

0 commit comments

Comments
 (0)