You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This topic provides an introduction to the Replicated KOTS snapshots feature, including information about backing up and restoring KOTS installations with snapshots.
10
+
This topic provides an introduction to performing backup and restore with the Replicated KOTS snapshots feature.
11
+
12
+
:::note
13
+
<NoEcSupport/>
14
+
:::
10
15
11
16
## Overview
12
17
@@ -16,7 +21,9 @@ Velero and restic are the underlying technologies for snapshots. For more inform
16
21
17
22
### Limitations and Considerations
18
23
19
-
- The snapshots feature is available only for KOTS-enabled licenses with the **Allow Snapshots** feature.
24
+
* <NoEcSupport/>
25
+
26
+
- The snapshots feature is available only for licenses with the **Allow Snapshots** option enabled. For more information, see [Creating and Managing Customers](/vendor/releases-creating-customer).
20
27
21
28
- Snapshots are useful for rollback and disaster recovery scenarios. They are not intended to be used for application migration.
The KOTS Snapshots feature is supported for existing cluster installations with KOTS and Replicated kURL installations only. Snapshots is not supported for Replicated Embedded Cluster installations. For more information about configuring backup and restore for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery).
Copy file name to clipboardExpand all lines: docs/vendor/snapshots-overview.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,17 @@
1
1
import RestoreTable from "../partials/snapshots/_restoreTable.mdx"
2
+
import NoEcSupport from "../partials/snapshots/_limitation-no-ec-support.mdx"
2
3
3
4
# Understanding Backup and Restore
4
5
5
-
This topic describes how vendors enable the backup and restore feature, the type of data that is backed up, and how to troubleshoot issues for enterprise users.
6
+
This topic provides an introduction to the Replicated KOTS snapshots feature for backup and restore. It describes how vendors enable snapshots, the type of data that is backed up, and how to troubleshoot issues for enterprise users.
7
+
8
+
:::note
9
+
<NoEcSupport/>
10
+
:::
6
11
7
12
## About Backup and Restore
8
13
9
-
As a vendor, when you distribute your application with Replicated KOTS you can enable Replicated snapshots to support backup and restore for your enterprise users.
14
+
You can enable Replicated KOTS snapshots to support backup and restore for existing cluster installations with KOTS and Replicated kURL installations.
10
15
11
16
Snapshots uses the Velero open source project as the backend to back up Kubernetes manifests and persistent volumes. Velero is a mature, fully-featured application. For more information, see the [Velero documentation](https://velero.io/docs/).
12
17
@@ -16,7 +21,7 @@ KOTS provides the Admin Console and the KOTS CLI so that your users can fully ma
16
21
17
22
## What Data is Backed Up
18
23
19
-
Full backups include the Admin Console and all application data, including KOTS-specific object-stored data. For embedded clusters created with Replicated kURL, this also backs up the Docker registry, which is required for air gapped installations.
24
+
Full backups include the Admin Console and all application data, including KOTS-specific object-stored data. For Replicated kURL installations, this also backs up the Docker registry, which is required for air gapped installations.
20
25
21
26
### Other Object-Stored Data
22
27
@@ -41,7 +46,7 @@ To enable the snapshots backup and restore feature for your users, you must:
41
46
42
47
## Understanding Backup and Restore for Enterprise Users {#how-users}
43
48
44
-
After vendors enable backup and restore, enterprise users install Velero and configure a storage destination in the Admin Console. Then users can create backups manually or schedule automatic backups. For more information about how users create and restore backups, see [About Backup and Restore](/enterprise/snapshots-understanding) in _Enterprise_.
49
+
After vendors enable backup and restore, enterprise users install Velero and configure a storage destination in the Admin Console. Then users can create backups manually or schedule automatic backups. For more information about how users create and restore backups, see [About Backing Up and Restoring with Snapshots](/enterprise/snapshots-understanding).
45
50
46
51
Replicated recommends advising your users to make full backups for disaster recovery purposes. Additionally, full backups give users the flexibility to do a full restore, a partial restore (application only), or restore just the Admin Console.
47
52
@@ -55,8 +60,8 @@ Partial backups are not recommended as they are a legacy feature and only back u
55
60
56
61
To support end users with backup and restore, use the following resources:
57
62
58
-
- To help troubleshoot error messages, see [Troubleshooting Backup and Restore](/enterprise/snapshots-troubleshooting-backup-restore) in _Enterprise_.
63
+
- To help troubleshoot error messages, see [Troubleshooting Backup and Restore](/enterprise/snapshots-troubleshooting-backup-restore).
59
64
60
-
- Review the Limitations and Considerations section to make sure an end users system is compliant. See [Limitations and Considerations](/enterprise/snapshots-understanding#limitations-and-considerations) in _Enterprise_.
65
+
- Review the Limitations and Considerations section to make sure an end users system is compliant. See [Limitations and Considerations](/enterprise/snapshots-understanding#limitations-and-considerations).
61
66
62
-
- Check that the installed Velero version and KOTS version are compatible. See [Velero Version Compatibility](/enterprise/snapshots-understanding#velero-version-compatibility) in _Enterprise_.
67
+
- Check that the installed Velero version and KOTS version are compatible. See [Velero Version Compatibility](/enterprise/snapshots-understanding#velero-version-compatibility).
0 commit comments