Skip to content

Commit f26a6c4

Browse files
committed
[OSDOCS-12351]: Removing and redirecting etcd backup/restore content
1 parent 8945b49 commit f26a6c4

File tree

43 files changed

+51
-56
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+51
-56
lines changed

architecture/control-plane.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ ifndef::openshift-dedicated,openshift-rosa[]
7070
[role="_additional-resources"]
7171
.Additional resources
7272
* xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
73-
* xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd[Backing up etcd]
73+
* xref:../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[Backing up and restoring etcd data]
7474
endif::openshift-dedicated,openshift-rosa[]

backup_and_restore/application_backup_and_restore/oadp-intro.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ toc::[]
1313
The {oadp-first} product safeguards customer applications on {product-title}. It offers comprehensive disaster recovery protection, covering {product-title} applications, application-related cluster resources, persistent volumes, and internal images. {oadp-short} is also capable of backing up both containerized applications and virtual machines (VMs).
1414

1515
ifndef::openshift-rosa,openshift-rosa-hcp[]
16-
However, {oadp-short} does not serve as a disaster recovery solution for xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd] or {OCP-short} Operators.
16+
However, {oadp-short} does not serve as a disaster recovery solution for xref:../../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[etcd] or {OCP-short} Operators.
1717
endif::openshift-rosa,openshift-rosa-hcp[]
1818

1919
[IMPORTANT]
@@ -44,6 +44,6 @@ ifndef::openshift-rosa,openshift-rosa-hcp[]
4444
[role="_additional-resources"]
4545
.Additional resources
4646

47-
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
47+
* xref:../../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[Backing up etcd data]
4848
// once finished re-work come back and add doc links to the APIs
4949
endif::openshift-rosa,openshift-rosa-hcp[]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../_attributes/
1+
../_attributes/
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../../_attributes/
1+
../_attributes/

backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ include::modules/manually-restoring-cluster-etcd-backup.adoc[leveloffset=+1]
3232

3333
* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
3434

35-
include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+1]
35+
include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+1]

backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
// Recovering from expired control plane certificates
10-
include::modules/dr-recover-expired-control-plane-certs.adoc[leveloffset=+1]
10+
include::modules/dr-recover-expired-control-plane-certs.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../../snippets/
1+
../snippets
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../images
1+
../images
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../modules
1+
../modules

backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ include::modules/restore-replace-stopped-baremetal-etcd-member.adoc[leveloffset=
5454
[role="_additional-resources"]
5555
[id="additional-resources_replacing-unhealthy-etcd-member"]
5656
== Additional resources
57-
* xref:../../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-etcd_deleting-machine[Quorum protection with machine lifecycle hooks]
57+
* xref:../../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-etcd_deleting-machine[Quorum protection with machine lifecycle hooks]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../../snippets/
1+
../snippets

backup_and_restore/graceful-cluster-restart.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Even though the cluster is expected to be functional after the restart, the clus
1414
* Node failure due to hardware
1515
* Network connectivity issues
1616
17-
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].
17+
If your cluster fails to recover, follow the steps to xref:../etcd/etcd-backup.adoc#dr-scenario-2-restoring-cluster-state-about_etcd-backup[restore to a previous cluster state].
1818

1919
== Prerequisites
2020

@@ -26,4 +26,4 @@ include::modules/graceful-restart.adoc[leveloffset=+1]
2626
[role="_additional-resources"]
2727
.Additional resources
2828

29-
* See 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] for how to use an etcd backup to restore if your cluster failed to recover after restarting.
29+
* See xref:../etcd/etcd-backup.adoc#dr-scenario-2-restoring-cluster-state-about_etcd-backup[Restoring to a previous cluster state] for how to use an etcd backup to restore if your cluster failed to recover after restarting.

backup_and_restore/graceful-cluster-shutdown.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document describes the process to gracefully shut down your cluster. You mi
1010

1111
== Prerequisites
1212

13-
* 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 shutting down the cluster.
13+
* Take an xref:../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[etcd backup] prior to shutting down the cluster.
1414
+
1515
[IMPORTANT]
1616
====
@@ -22,7 +22,7 @@ For example, the following conditions can cause the restarted cluster to malfunc
2222
* Node failure due to hardware
2323
* Network connectivity issues
2424
25-
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].
25+
If your cluster fails to recover, follow the steps to xref:../etcd/etcd-backup.adoc#dr-scenario-2-restoring-cluster-state-about_etcd-backup[restore to a previous cluster state].
2626
====
2727

2828
// Shutting down the cluster

backup_and_restore/hibernating-cluster.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ include::modules/hibernating-cluster-about.adoc[leveloffset=+1]
1414
[id="hibernating-cluster_prerequisites_{context}"]
1515
== Prerequisites
1616

17-
* 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.
17+
* Take an xref:../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[etcd backup] prior to hibernating the cluster.
1818
+
1919
[IMPORTANT]
2020
====
@@ -26,7 +26,7 @@ For example, the following conditions can cause the resumed cluster to malfuncti
2626
* Node failure due to hardware
2727
* Network connectivity issues
2828
29-
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].
29+
If your cluster fails to recover, follow the steps to xref:../etcd/etcd-backup.adoc#dr-scenario-2-restoring-cluster-state-about_etcd-backup[restore to a previous cluster state].
3030
====
3131

3232
// Hibernating a cluster
@@ -35,7 +35,7 @@ include::modules/hibernating-cluster-hibernate.adoc[leveloffset=+1]
3535
[role="_additional-resources"]
3636
.Additional resources
3737

38-
* xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
38+
* xref:../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[Backing up and restoring etcd data]
3939

4040
// Resuming a hibernated cluster
4141
include::modules/hibernating-cluster-resume.adoc[leveloffset=+1]

backup_and_restore/index.adoc

+5-4
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,26 @@ toc::[]
1212

1313
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.
1414

15-
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+
You must xref:../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[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:../etcd/etcd-backup.adoc#replace-unhealthy-etcd-member_etcd-backup[replace an unhealthy etcd member].
1616

1717
When you want to get your cluster running again, xref:../backup_and_restore/graceful-cluster-restart.adoc#graceful-restart-cluster[restart the cluster gracefully].
1818

1919
[NOTE]
2020
====
21-
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+
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:../etcd/etcd-backup.adoc#dr-scenario-3-recovering-expired-certs_etcd-backup[approve the certificate signing requests (CSRs)].
2222
====
2323

24-
You might run into several situations where {product-title} does not work as expected, such as:
24+
You might run into several situations where {product-title} does not work as expected, such as:
2525

2626
* You have a cluster that is not functional after the restart because of unexpected conditions, such as node failure or network connectivity issues.
2727
* You have deleted something critical in the cluster by mistake.
2828
* You have lost the majority of your control plane hosts, leading to etcd quorum loss.
2929

30-
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.
30+
You can always recover from a disaster situation by xref:../etcd/etcd-backup.adoc#dr-scenario-2-restoring-cluster-state-about_etcd-backup[restoring your cluster to its previous state] using the saved etcd snapshots.
3131

3232
[role="_additional-resources"]
3333
.Additional resources
34+
* xref:../etcd/etcd-backup.adoc#etcd-backup[Backing up and restoring etcd data]
3435
* xref:../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-etcd_deleting-machine[Quorum protection with machine lifecycle hooks]
3536

3637
[id="application-backup-restore-operations-overview"]

disconnected/updating/disconnected-update.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use the following procedures to update a cluster in a disconnected environment w
2020
* You must provision a local container image registry with the container images for your update, as described in xref:../../disconnected/updating/mirroring-image-repository.adoc#mirroring-ocp-image-repository[Mirroring {product-title} images].
2121
* You must have access to the cluster as a user with `admin` privileges.
2222
See xref:../../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions].
23-
* You must have a recent xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your update fails and you must xref:../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state].
23+
* You must have a recent xref:../../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[etcd backup] in case your update fails and you must xref:../../etcd/etcd-backup.adoc#dr-restoring-cluster-state_etcd-backup[restore your cluster to a previous state].
2424
* You have updated all Operators previously installed through Operator Lifecycle Manager (OLM) to a version that is compatible with your target release. Updating the Operators ensures they have a valid update path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster update. See xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators] for more information on how to check compatibility and, if necessary, update the installed Operators.
2525
* You must ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy.
2626
* If your cluster uses manually maintained credentials, update the cloud provider resources for the new release. For more information, including how to determine if this is a requirement for your cluster, see xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials].

edge_computing/day_2_core_cnf_clusters/updating/telco-update-before-the-update.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ include::modules/creating-single-etcd-backup.adoc[leveloffset=+2]
2222
[role="_additional-resources"]
2323
.Additional resources
2424

25-
* xref:../../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[Backing up etcd]
25+
* xref:../../../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[Backing up and restoring etcd data]
2626

2727
include::modules/telco-update-checking-the-cluster-health.adoc[leveloffset=+1]

edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,6 @@ include::modules/cnf-image-based-upgrade-rollback.adoc[leveloffset=+1]
3434
[role="_additional-resources"]
3535
.Additional resources
3636

37-
* xref:../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-scenario-3-recovering-expired-certs_dr-recovering-expired-certs[Recovering from expired control plane certificates]
37+
* xref:../../etcd/etcd-backup.adoc#dr-scenario-3-recovering-expired-certs_etcd-backup[Recovering from expired control plane certificates]
3838
3939
include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]

edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ include::modules/ztp-image-based-upgrade-procedure-rollback.adoc[leveloffset=+1]
5353

5454
* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-supported-combinations_ztp-gitops[Supported action combinations]
5555
56-
* xref:../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-scenario-3-recovering-expired-certs_dr-recovering-expired-certs[Recovering from expired control plane certificates]
56+
* xref:../../etcd/etcd-backup.adoc#dr-scenario-3-recovering-expired-certs_etcd-backup[Recovering from expired control plane certificates]
5757
5858
include::modules/cnf-image-based-upgrade-troubleshooting.adoc[leveloffset=+1]

etcd/etcd-backup.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ include::modules/dr-restoring-etcd-quorum-ha.adoc[leveloffset=+2]
121121
.Additional resources
122122
* xref:../installing/installing_bare_metal/upi/installing-bare-metal.adoc[Installing a user-provisioned cluster on bare metal]
123123

124-
//* xref:../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
124+
* xref:../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
125125

126126
// Restoring to a previous cluster state
127127
include::modules/dr-restoring-cluster-state-about.adoc[leveloffset=+2]
@@ -140,7 +140,7 @@ include::modules/manually-restoring-cluster-etcd-backup.adoc[leveloffset=+3]
140140
* xref:../etcd/etcd-backup.adoc#backing-up-etcd-data_etcd-backup[Backing up etcd data]
141141
* xref:../installing/installing_bare_metal/upi/installing-bare-metal.adoc[Installing a user-provisioned cluster on bare metal]
142142
* xref:../networking/accessing-hosts.adoc#accessing-hosts[Accessing hosts on Amazon Web Services in an installer-provisioned infrastructure cluster]
143-
//* xref:../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
143+
* xref:../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
144144

145145
// Issues and workarounds for restoring a persistent storage state
146146
include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+3]

hosted_control_planes/hcp-backup-restore-dr.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ include::modules/hosted-cluster-single-node-recovery.adoc[leveloffset=+2]
1919
[id="hcp-backup-restore"]
2020
== Backing up and restoring etcd on a hosted cluster on {aws-short}
2121

22-
If you use {hcp} for {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].
22+
If you use {hcp} for {product-title}, the process to back up and restore etcd is different from xref:../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[the usual etcd backup process].
2323

2424
The following procedures are specific to {hcp} on {aws-short}.
2525

installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leve
2626
[role="_additional-resources"]
2727
.Additional resources
2828

29-
* xref:../../backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc#replacing-the-unhealthy-etcd-member[Replacing an unhealthy etcd member]
29+
* xref:../../etcd/etcd-backup.adoc#replace-unhealthy-etcd-member_etcd-backup[Replacing an unhealthy etcd member]
3030
31-
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[Backing up etcd]
31+
* xref:../../etcd/etcd-backup.adoc#backup-etcd_etcd-backup[Backing up and restoring etcd data]
3232
3333
* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
3434

installing/installing_bare_metal/upi/installing-bare-metal.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev
150150
[role="_additional-resources"]
151151
.Additional resources
152152

153-
* See xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
153+
* See xref:../../../etcd/etcd-backup.adoc#dr-scenario-3-recovering-expired-certs_etcd-backup[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
154154

155155
include::modules/creating-machines-bare-metal.adoc[leveloffset=+1]
156156

installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev
142142
[role="_additional-resources"]
143143
.Additional resources
144144

145-
* See xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
145+
* See xref:../../../etcd/etcd-backup.adoc#dr-scenario-3-recovering-expired-certs_etcd-backup[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
146146

147147
include::modules/installation-special-config-chrony.adoc[leveloffset=+1]
148148

0 commit comments

Comments
 (0)