Skip to content

Commit 1f74b96

Browse files
committed
expanded and clarified after feedback
Signed-off-by: Silvio Moioli <[email protected]>
1 parent 0e9f574 commit 1f74b96

File tree

7 files changed

+91
-35
lines changed

7 files changed

+91
-35
lines changed

docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

versioned_docs/version-2.10/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

versioned_docs/version-2.11/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,26 @@ title: Backup Restore Usage Guide
66
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-restore-usage-guide"/>
77
</head>
88

9-
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
9+
:::caution
1010

11-
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
11+
If the local cluster fails, you might need to restore Rancher to a previous version.
1212

13-
:::caution
13+
You can restore Rancher using two supported methods: cluster Datastore Restores (available for [k3s](https://docs.k3s.io/datastore/backup-restore) and [RKE2](https://docs.rke2.io/datastore/backup_restore) distributions) and Rancher's Backup, as described on this page.
14+
15+
Datastore Restores are suitable when no changes have been made to downstream (managed) clusters since the snapshot. For example, if a local cluster change causes an outage after a snapshot, use Datastore Restore.
1416

15-
While Kubernetes distributions like k3s and RKE2 offer [cluster configuration backups](https://docs.rke2.io/datastore/backup_restore) (etcd snapshots), these can sometimes cause issues with Rancher.
17+
However, if you take a Datastore snapshot and then upgrade a downstream cluster's Kubernetes version, a Datastore Restore will revert the downstream cluster's Kubernetes version in the datastore, creating a version mismatch between data in the local cluster and the actual downstream cluster nodes.
18+
Rancher will then attempt to reconcile the versions, potentially causing unexpected behavior and data loss.
19+
Similarly, if you take a Datastore snapshot, rotate nodes in a Rancher-provisioned downstream cluster, and then restore from the snapshot, the rotated nodes may become orphaned, possibly making the cluster inoperable. *Recovery from these scenarios is not supported*.
1620

17-
For a reliable Rancher backup, we recommend using the Rancher Backup functionality described in this guide. Consider etcd snapshots as a last resort option.
21+
Generally, if you've made changes that directly or indirectly affect downstream clusters (e.g., installing charts/apps, performing "day 2" operations, creating or deleting clusters or nodes, or rotating Rancher certificates), use Rancher's Backup restore, as described on this page.
1822

1923
:::
2024

25+
The Rancher Backups chart is our solution for disaster recovery and migration. This chart allows you to take backups of your Kubernetes resources and save them to a variety of persistent storage locations.
26+
27+
This chart is a very simple tool which has its hands in many different areas of the Rancher ecosystem. As a result, edge cases have arisen which lead to undocumented functionality. The purpose of this document is to highlight the proper and defined usage for Rancher Backups, as well as discussing some of these edge cases we’ve run into.
28+
2129
## Functionality Overview
2230

2331
### Backup

0 commit comments

Comments
 (0)