Skip to content

Commit 4c44d37

Browse files
authored
Merge pull request #2846 from replicatedhq/116159
Snapshots only for KOTS existing and kURL
2 parents f3783af + c8954df commit 4c44d37

File tree

4 files changed

+26
-13
lines changed

4 files changed

+26
-13
lines changed

docs/enterprise/snapshots-understanding.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,15 @@ import Dr from "../partials/snapshots/_limitation-dr.mdx"
33
import Os from "../partials/snapshots/_limitation-os.mdx"
44
import InstallMethod from "../partials/snapshots/_limitation-install-method.mdx"
55
import CliRestores from "../partials/snapshots/_limitation-cli-restores.mdx"
6+
import NoEcSupport from "../partials/snapshots/_limitation-no-ec-support.mdx"
67

7-
# About Backup and Restore
8+
# About Backing Up and Restoring with Snapshots
89

9-
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+
:::
1015

1116
## Overview
1217

@@ -16,7 +21,9 @@ Velero and restic are the underlying technologies for snapshots. For more inform
1621

1722
### Limitations and Considerations
1823

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).
2027

2128
- Snapshots are useful for rollback and disaster recovery scenarios. They are not intended to be used for application migration.
2229

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
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).

docs/vendor/packaging-rbac.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This topic describes role-based access control (RBAC) for Replicated KOTS in exi
44

55
## Cluster-scoped RBAC
66

7-
When a user installs your application in an existing cluster, Kubernetes RBAC resources are created to allow KOTS to install and manage the application.
7+
When a user installs your application with KOTS in an existing cluster, Kubernetes RBAC resources are created to allow KOTS to install and manage the application.
88

99
By default, the following ClusterRole and ClusterRoleBinding resources are created that grant KOTS access to all resources across all namespaces in the cluster:
1010

@@ -98,11 +98,11 @@ The following limitations apply when using the `requireMinimalRBACPrivileges` or
9898

9999
* **Preflight checks**: When namespace-scoped access is enabled, preflight checks cannot read resources outside the namespace where KOTS is installed. The preflight checks continue to function, but return less data. For more information, see [Defining Preflight Checks](/vendor/preflight-defining).
100100

101-
* **Velero namespace access**: Namespace-scoped RBAC does not grant access to the namespace where Velero is installed in the cluster. Velero is a requirement for configuring backup and restore with snapshots.
101+
* **Velero namespace access for KOTS snapshots**: Velero is required for enabling backup and restore with the KOTS snapshots feature. Namespace-scoped RBAC does not grant access to the namespace where Velero is installed in the cluster.
102102

103103
To set up snapshots when KOTS has namespace-scoped access, users can run the `kubectl kots velero ensure-permissions` command. This command creates additional Roles and RoleBindings to allow the necessary cross-namespace access. For more information, see [`velero ensure-permissions`](/reference/kots-cli-velero-ensure-permissions/) in the KOTS CLI documentation.
104104

105-
For more information about snapshots, see [About Backup and Restore](/enterprise/snapshots-understanding).
105+
For more information about snapshots, see [About Backing Up and Restoring with Snapshots](/enterprise/snapshots-understanding).
106106

107107
* **Air Gap Installations**: For air gap installations, the `requireMinimalRBACPrivileges` and `supportMinimalRBACPrivileges` flags are supported only in automated, or _headless_, installations. In headless installations, the user passes all the required information to install both KOTS and the application with the `kots install` command. In non-headless installations, the user provides information to install the application through the Admin Console UI after KOTS is installed.
108108

docs/vendor/snapshots-overview.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
import RestoreTable from "../partials/snapshots/_restoreTable.mdx"
2+
import NoEcSupport from "../partials/snapshots/_limitation-no-ec-support.mdx"
23

34
# Understanding Backup and Restore
45

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+
:::
611

712
## About Backup and Restore
813

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.
1015

1116
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/).
1217

@@ -16,7 +21,7 @@ KOTS provides the Admin Console and the KOTS CLI so that your users can fully ma
1621

1722
## What Data is Backed Up
1823

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.
2025

2126
### Other Object-Stored Data
2227

@@ -41,7 +46,7 @@ To enable the snapshots backup and restore feature for your users, you must:
4146

4247
## Understanding Backup and Restore for Enterprise Users {#how-users}
4348

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).
4550

4651
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.
4752

@@ -55,8 +60,8 @@ Partial backups are not recommended as they are a legacy feature and only back u
5560

5661
To support end users with backup and restore, use the following resources:
5762

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).
5964

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).
6166

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

Comments
 (0)