Skip to content

Commit 4bc84ad

Browse files
committed
copy edits
1 parent 5e2d9ef commit 4bc84ad

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

docs/vendor/embedded-disaster-recovery.mdx

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ Embedded Cluster does not support backup and restore with the KOTS snapshots fea
1212

1313
## Overview
1414

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

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

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

2321
## Requirements
2422

@@ -48,23 +46,23 @@ Embedded Cluster disaster recovery has the following limitations and known issue
4846

4947
## Configure Disaster Recovery
5048

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

5351
### Configure the Velero Custom Resources {#config-velero-resources}
5452

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

57-
To configure the Velero custom resources for disaster recovery:
55+
To configure Velero Backup and Restore custom resources for Embedded Cluster disaster recovery:
5856

5957
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.
6058

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

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:**
6464

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:
6866

6967
```yaml
7068
apiVersion: velero.io/v1
@@ -79,9 +77,9 @@ To configure the Velero custom resources for disaster recovery:
7977
- matchExpressions:
8078
# Exclude Replicated resources from the backup
8179
- { key: kots.io/kotsadm, operator: NotIn, values: ["true"] }
82-
```
80+
```
8381
84-
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.
8583

8684
**Example**:
8785

@@ -91,13 +89,13 @@ To configure the Velero custom resources for disaster recovery:
9189
metadata:
9290
name: restore
9391
spec:
94-
# the name of the Backup resource that you added
92+
# the name of the Backup resource that you created
9593
backupName: backup
9694
includedNamespaces:
9795
- '*'
9896
```
9997

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

102100
**Example**:
103101

@@ -112,6 +110,8 @@ To configure the Velero custom resources for disaster recovery:
112110
post.hook.restore.velero.io/wait-for-ready: 'true' # waits for the pod to be ready before running the post-restore hook
113111
```
114112

113+
1. Save and the promote the release to a development channel for testing.
114+
115115
### Enable the Disaster Recovery Feature for Your Customers
116116

117117
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:
144144

145145
1. (Optional) From this same page, configure scheduled backups and a retention policy for backups.
146146

147-
<img src="/images/dr-scheduled-backups.png" width="450px" alt="scheduled backups"/>
147+
<img src="/images/dr-scheduled-backups.png" width="400px" alt="scheduled backups"/>
148148
149149
[View a larger version of this image](/images/dr-scheduled-backups.png)
150150

151151
1. In the **Disaster Recovery** submenu, click **Backups**. Backups can be taken from this screen.
152152

153153
<img src="/images/dr-backups.png" alt="backups page" width="600px"/>
154+
154155
[View a larger version of this image](/images/dr-backups.png)
155156

156157
### Restore from a Backup

0 commit comments

Comments
 (0)