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
Copy file name to clipboardExpand all lines: docs/vendor/embedded-disaster-recovery.mdx
+19-18Lines changed: 19 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,11 @@ Embedded Cluster does not support backup and restore with the KOTS snapshots fea
12
12
13
13
## Overview
14
14
15
-
The Embedded Cluster disaster recovery feature allows your customers to take backups from the Admin Console and to perform restores from the command line with the Embedded Cluster `restore` command.
15
+
The Embedded Cluster disaster recovery feature allows your customers to take backups from the Admin Console and perform restores from the command line. Disaster recovery for Embedded Cluster is implemented with Velero. For more information about Velero, see the [Velero](https://velero.io/docs/latest/) documentation.
16
16
17
-
Disaster recovery for Embedded Cluster is implemented with Velero. For more information about Velero, see the [Velero](https://velero.io/docs/v1.14/) documentation.
17
+
The backups that your customers take from the Admin Console will include both the Embedded Cluster infrastructure and the application resources that you specify.
18
18
19
-
Backups taken from the Admin Console include both the Embedded Cluster infrastructure and your application resources:
20
-
* The Embedded Cluster infrastructure that is backed up includes components such as the KOTS Admin Console and the built-in registry that is deployed for air gap installations. No configuration is required to include Embedded Cluster components in the backup.
21
-
* The application resources backed up include those that you specify in a Velero Backup custom resource in the release.
19
+
The Embedded Cluster infrastructure that is backed up includes components such as the KOTS Admin Console and the built-in registry that is deployed for air gap installations. No configuration is required to include Embedded Cluster infrastructure in backups. Vendors specify the application resources to include in backups by configuring a Velero Backup resource in the application release.
22
20
23
21
## Requirements
24
22
@@ -48,23 +46,23 @@ Embedded Cluster disaster recovery has the following limitations and known issue
48
46
49
47
## Configure Disaster Recovery
50
48
51
-
This section describes how to configure disaster recovery for Embedded Cluster installations and enable access to the disaster recovery feature on a per-customer basis.
49
+
This section describes how to configure disaster recovery for Embedded Cluster installations. It also describes how to enable access to the disaster recovery feature on a per-customer basis.
52
50
53
51
### Configure the Velero Custom Resources {#config-velero-resources}
54
52
55
-
This section describes how to set up Embedded Cluster disaster recovery for your application by configuring Velero Backup and Restore custom resources in a release.
53
+
This section describes how to set up Embedded Cluster disaster recovery for your application by configuring Velero [Backup](https://velero.io/docs/latest/api-types/backup/) and [Restore](https://velero.io/docs/latest/api-types/restore/) custom resources in a release.
56
54
57
-
To configure the Velero custom resources for disaster recovery:
55
+
To configure Velero Backup and Restore custom resources for Embedded Cluster disaster recovery:
58
56
59
57
1. In a new release containing your application files, add a Velero Backup resource. In the Backup resource, use namespace-based or label-based selection to indicate the application resources that you want to be included in the backup. For more information, see [Backup API Type](https://velero.io/docs/latest/api-types/backup/) in the Velero documentation.
60
58
61
-
**Example**:
59
+
:::important
60
+
If you use namespace-based selection to include all of your application resources deployed in the `kotsadm` namespace, ensure that you exclude the Replicated resources that are also deployed in the `kotsadm` namespace. Because the Embedded Cluster infrastructure components are always included in backups automatically, this avoids duplication.
61
+
:::
62
62
63
-
The following Backup resource uses namespace-based selection to include all resources deployed in the `kotsadm` namespace. It also uses an expression in the `orLabelSelectors.matchExpressions` field to _exclude_ the Replicated resources that are deployed in the `kotsadm` namespace.
63
+
**Example:**
64
64
65
-
:::note
66
-
If you use namespace-based selection to include all of your application resources deployed in the `kotsadm` namespace, ensure that you exclude the Replicated resources that are also deployed in the `kotsadm` namespace. This avoid duplication in backups taken by user because the Embedded Cluster infrastructure components are always included in backups automatically.
67
-
:::
65
+
The following Backup resource uses namespace-based selection to include application resources deployed in the `kotsadm` namespace:
68
66
69
67
```yaml
70
68
apiVersion: velero.io/v1
@@ -79,9 +77,9 @@ To configure the Velero custom resources for disaster recovery:
1. In the same release, add a Velero Restore resource. In the Restore resource, include the name of the Backup resource that you created in the `backupName` field. For more information, see [Restore API Type](https://velero.io/docs/latest/api-types/restore/) in the Velero documentation.
82
+
1. In the same release, add a Velero Restore resource. In the `backupName` field of the Restore resource, include the name of the Backup resource that you created. For more information, see [Restore API Type](https://velero.io/docs/latest/api-types/restore/) in the Velero documentation.
85
83
86
84
**Example**:
87
85
@@ -91,13 +89,13 @@ To configure the Velero custom resources for disaster recovery:
91
89
metadata:
92
90
name: restore
93
91
spec:
94
-
# the name of the Backup resource that you added
92
+
# the name of the Backup resource that you created
95
93
backupName: backup
96
94
includedNamespaces:
97
95
- '*'
98
96
```
99
97
100
-
1. (Optional) In addition to the previous steps, you can use Velero functionality like [backup](https://velero.io/docs/main/backup-hooks/) and [restore](https://velero.io/docs/main/restore-hooks/) hooks to customize the backup and restore process as needed.
98
+
1. (Optional) You can use Velero functionality like [backup](https://velero.io/docs/main/backup-hooks/) and [restore](https://velero.io/docs/main/restore-hooks/) hooks to customize the backup and restore process as needed.
101
99
102
100
**Example**:
103
101
@@ -112,6 +110,8 @@ To configure the Velero custom resources for disaster recovery:
112
110
post.hook.restore.velero.io/wait-for-ready: 'true' # waits for the pod to be ready before running the post-restore hook
113
111
```
114
112
113
+
1. Save and the promote the release to a development channel for testing.
114
+
115
115
### Enable the Disaster Recovery Feature for Your Customers
116
116
117
117
After configuring disaster recovery for your application, you can enable it on a per-customer basis with the **Allow Disaster Recovery (Alpha)** license field.
@@ -144,13 +144,14 @@ To configure backup storage and take backups:
144
144
145
145
1. (Optional) From this same page, configure scheduled backups and a retention policy for backups.
0 commit comments