Skip to content

Commit fd6a135

Browse files
authored
Merge pull request #2916 from replicatedhq/117608
Updates to EC disaster recovery + related KOTS snapshots docs updates
2 parents 442e337 + 57060b8 commit fd6a135

21 files changed

+233
-206
lines changed

docs/enterprise/snapshots-config-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ After you configure a storage destination, you can create a backup. See [Creatin
4747
## Additional Resources
4848

4949
* [Restoring Full Backups](snapshots-restoring-full)
50-
* [Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
50+
* [Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-configuring-hostpath.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This topic describes how to install Velero and configure a host path as your sto
2525

2626
Complete the following items before you perform this task:
2727

28-
* Review the limitations and considerations. See [Limitations and Considerations](snapshots-understanding#limitations-and-considerations) in _About Backup and Restore_.
28+
* Review the limitations and considerations. See [Limitations and Considerations](/vendor/snapshots-overview#limitations-and-considerations) in _About Backup and Restore_.
2929
* Install the velero CLI. See [Installing the Velero CLI](snapshots-velero-cli-installing).
3030

3131
## Install Velero and Configure Host Path Storage in Online Environments
@@ -118,4 +118,4 @@ To install Velero and configure host path storage for existing clusters:
118118
119119
## Additional Resources
120120
121-
* [Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
121+
* [Troubleshooting Snapshots](/enterprise/snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-configuring-nfs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Configuring an NFS server as a snapshots storage destination has the following r
2626

2727
Complete the following items before you perform this task:
2828

29-
* Review the limitations and considerations. See [Limitations and Considerations](snapshots-understanding#limitations-and-considerations) in _About Backup and Restore_.
29+
* Review the limitations and considerations. See [Limitations and Considerations](/vendor/snapshots-overview#limitations-and-considerations) in _About Backup and Restore_.
3030
* Install the velero CLI. See [Installing the Velero CLI](snapshots-velero-cli-installing).
3131

3232
## Install Velero and Configure NFS Storage in Online Environments
@@ -121,4 +121,4 @@ To install Velero and configure NFS storage for existing clusters:
121121

122122
## Additional Resources
123123

124-
* [Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
124+
* [Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-creating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,4 @@ To schedule automatic backups in the Admin Console:
9797
The retention policy applies to all backups, including both automatically- and manually-created backups. Changing the retention policy affects only backups created after the time of the change.
9898
## Additional Resources
9999

100-
[Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
100+
[Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-restoring-full.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following limitations apply to restoring from backups using snapshots:
2626
* <InstallMethod/>
2727
* <CliRestores/>
2828

29-
For a full list of limitations and considerations related to the snapshots feature, see [Limitations and Considerations](snapshots-understanding#limitations-and-considerations) in _About Backup and Restore_.
29+
For a full list of limitations and considerations related to the snapshots feature, see [Limitations and Considerations](/vendor/snapshots-overview#limitations-and-considerations) in _About Backup and Restore_.
3030

3131
## Restore From a Full Backup Using the CLI {#full-cli}
3232

@@ -158,4 +158,4 @@ To restore an application from a partial backup:
158158

159159
## Additional Resources
160160

161-
[Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
161+
[Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-storage-destinations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To configure host path or NFS as a storage destination, see [Configuring a Host
1616

1717
Complete the following items before you install Velero and configure a storage destination:
1818

19-
* Review the limitations and considerations. See [Limitations and Considerations](snapshots-understanding#limitations-and-considerations) in _About Backup and Restore_.
19+
* Review the limitations and considerations. See [Limitations and Considerations](/vendor/snapshots-overview#limitations-and-considerations) in _About Backup and Restore_.
2020
* Install the velero CLI. See [Installing the Velero CLI](snapshots-velero-cli-installing).
2121

2222
## Configure AWS Storage for Online Environments
@@ -188,4 +188,4 @@ If no Velero installation is detected, instructions are displayed to install Vel
188188

189189
## Additional Resources
190190

191-
* [Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
191+
* [Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)

docs/enterprise/snapshots-troubleshooting-backup-restore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import NodeAgentMemLimit from "../partials/snapshots/_node-agent-mem-limit.mdx"
22

3-
# Troubleshooting Backup and Restore
3+
# Troubleshooting Snapshots
44

55
When a snapshot fails, a support bundle will be collected and stored automatically. Because this is a point-in-time collection of all logs and system state at the time of the failed snapshot, this is a good place to view the logs.
66

@@ -160,7 +160,7 @@ There are file changes between Restic's initial scan of the volume and during th
160160

161161
To resolve this issue, do one of the following:
162162

163-
* Use [Snapshot Hooks](https://docs.replicated.com/vendor/snapshots-hooks) to export data to an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume and include that in the backup instead of the primary PVC volume.
163+
* Use [hooks](/vendor/snapshots-hooks) to export data to an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume and include that in the backup instead of the primary PVC volume. See [Configuring Backup and Restore Hooks for Snapshots](/vendor/snapshots-hooks).
164164
* Freeze the file system to ensure all pending disk I/O operations have completed prior to taking a snapshot. For more information, see [Hook Example with fsfreeze](https://velero.io/docs/main/backup-hooks/#hook-example-with-fsfreeze) in the Velero documentation.
165165

166166

docs/enterprise/snapshots-velero-cli-installing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To install the Velero CLI in an online cluster:
1515
- (Embedded kURL cluster) Run an SSH command to access and authenticate to your cluster node.
1616
- (Existing cluster) Open a terminal in the environment that you manage the cluster from, which can be a local machine that has kubectl installed.
1717

18-
1. Check for the latest supported release of the Velero CLI for **Linux AMD64** in the Velero GitHub repo at https://github.com/vmware-tanzu/velero/releases. Although earlier versions of Velero are supported, Replicated recommends using the latest supported version. For more information about supported versions, see [Velero Version Compatibility](snapshots-understanding#velero-version-compatibility) in _About Backup and Restore_.
18+
1. Check for the latest supported release of the Velero CLI for **Linux AMD64** in the Velero GitHub repo at https://github.com/vmware-tanzu/velero/releases. Although earlier versions of Velero are supported, Replicated recommends using the latest supported version. For more information about supported versions, see [Velero Version Compatibility](/vendor/snapshots-overview#velero-version-compatibility).
1919

2020
Note the version number for the next step.
2121

@@ -55,7 +55,7 @@ To install the Velero CLI in an online cluster:
5555

5656
To install the Velero CLI in an air gapped cluster:
5757

58-
1. From a computer with internet access, check for the latest supported release of the Velero CLI for **Linux AMD64** in the Velero GitHub repo at https://github.com/vmware-tanzu/velero/releases. Although earlier versions of Velero are supported, Replicated recommends using the latest [supported version](/enterprise/snapshots-understanding#velero-version-compatibility).
58+
1. From a computer with internet access, check for the latest supported release of the Velero CLI for **Linux AMD64** in the Velero GitHub repo at https://github.com/vmware-tanzu/velero/releases. Although earlier versions of Velero are supported, Replicated recommends using the latest supported version. See [Velero Version Compatibility](/vendor/snapshots-overview#velero-version-compatibility).
5959

6060
Note the version number for the next step.
6161

docs/enterprise/snapshots-velero-installing-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ Velero sets default limits for the velero Pod and the node-agent (restic) Pod du
3737

3838
## Additional Resources
3939

40-
* [Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
40+
* [Troubleshooting Snapshots](snapshots-troubleshooting-backup-restore)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Only full backups can be restored using the KOTS CLI. To restore an application from a partial backup, use the Admin Console. See [Restore the Application Only Using the Admin Console](snapshots-restoring-full#admin-console).
1+
Only full backups can be restored using the KOTS CLI. To restore an application from a partial backup, use the Admin Console. See [Restore the Application Only Using the Admin Console](/enterprise/snapshots-restoring-full#admin-console).

0 commit comments

Comments
 (0)