Skip to content

Commit e4ae8c7

Browse files
committed
edits and xref fixes
1 parent 4bc84ad commit e4ae8c7

File tree

5 files changed

+14
-12
lines changed

5 files changed

+14
-12
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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/reference/custom-resource-backup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,5 +157,5 @@ However, not all fields are supported for full backups. The table below lists th
157157
Some of these fields are supported for hook arrays, as described in the previous field definition table. See [Supported Fields for Full Backups with Snapshots](#fields) above.
158158
:::
159159

160-
- All resources are included in the backup by default. However, resources can be excluded by adding `velero.io/exclude-from-backup=true` to the manifest files that you want to exclude. For more information, see [Configuring Backups](/vendor/snapshots-configuring-backups).
160+
- All resources are included in the backup by default. However, resources can be excluded by adding `velero.io/exclude-from-backup=true` to the manifest files that you want to exclude. For more information, see [Configuring Snapshots](/vendor/snapshots-configuring-backups).
161161

docs/vendor/replicated-onboarding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -545,7 +545,7 @@ Enable backup and restore with Velero for your application so that users can bac
545545

546546
There are different steps to configure backup and restore for Embedded Cluster and for existing cluster installations with KOTS:
547547
* To configure the disaster recovery feature for Embedded Cluster, see [Disaster Recovery for Embedded Cluster](/vendor/embedded-disaster-recovery)
548-
* To configure the snapshots feature for existing cluster KOTS installations, see [Configuring Backup and Restore](snapshots-configuring-backups).
548+
* To configure the snapshots feature for existing cluster KOTS installations, see [Configuring Snapshots](snapshots-configuring-backups).
549549

550550
### Add Custom Metrics
551551

docs/vendor/snapshots-configuring-backups.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Enabling and Configuring Snapshots
1+
# Configuring Snapshots
22

33
This topic provides information about how to configure the Velero Backup resource to enable Replicated KOTS snapshots for an application.
44

55
For more information about snapshots, see [About Backup and Restore with snapshots](/vendor/snapshots-overview).
66

7-
## Configure the Velero Backup Resource
7+
## Configure Snapshots
88

99
Add a Velero Backup custom resource (`kind: Backup`, `apiVersion: velero.io/v1`) to your release and configure it as needed. After configuring the Backup resource, add annotations for each volume that you want to be included in backups.
1010

11-
To configure the Velero Backup Resource for snapshots:
11+
To configure snapshots for your application:
1212

1313
1. Log in to the[ Vendor Portal](https://vendor.replicated.com) and create a new release containing your application files.
1414

@@ -26,7 +26,7 @@ To configure the Velero Backup Resource for snapshots:
2626
2727
For more information about the Velero Backup resource, including limitations, the list of supported fields for snapshots, and an example, see [Velero Backup Resource for Snapshots](/reference/custom-resource-backup).
2828
29-
1. (Optional) Configure backup and restore hooks in the Backup resource. For more information, see [Configuring Velero Backup and Restore Hooks for Snapshots](snapshots-hooks).
29+
1. (Optional) Configure backup and restore hooks in the Backup resource. For more information, see [Configuring Backup and Restore Hooks for Snapshots](snapshots-hooks).
3030
3131
1. For each volume that requires a backup, add the `backup.velero.io/backup-volumes` annotation. The annotation name is `backup.velero.io/backup-volumes` and the value is a comma separated list of volumes to include in the backup.
3232

docs/vendor/snapshots-overview.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When snapshots is enabled for your application, your customers can manage and pe
2222

2323
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/).
2424

25-
In addition to the default functionality that Velero provides, KOTS exposes hooks that let you inject scripts that can execute both before and after a backup, and before and after a restore. For more information, see [Configuring Backup and Restore Hooks](/vendor/snapshots-hooks).
25+
In addition to the default functionality that Velero provides, KOTS exposes hooks that let you inject scripts that can execute both before and after a backup, and before and after a restore. For more information, see [Configuring Backup and Restore Hooks for Snapshots](/vendor/snapshots-hooks).
2626

2727
### Limitations and Considerations
2828

@@ -101,13 +101,13 @@ Full backups include the Admin Console and all application data, including KOTS-
101101

102102
For kURL clusters, you might be using object-stored data that is not specific to the kURL KOTS add-on.
103103

104-
For object-stored data that is not KOTS-specific and does not use persistentVolumeClaims (PVCs), you must write custom backup and restore hooks to enable back ups for that object-stored data. For example, Rook and Ceph do not use PVCs and so require custom backup and restore hooks. For more information about writing custom hooks, see [Configuring Backup and Restore Hooks](snapshots-hooks).
104+
For object-stored data that is not KOTS-specific and does not use persistentVolumeClaims (PVCs), you must write custom backup and restore hooks to enable back ups for that object-stored data. For example, Rook and Ceph do not use PVCs and so require custom backup and restore hooks. For more information about writing custom hooks, see [Configuring Backup and Restore Hooks for Snapshots](snapshots-hooks).
105105

106106
#### Pod Volume Data
107107

108108
Replicated supports only the restic backup program for pod volume data.
109109

110-
By default, Velero requires that you opt-in to have pod volumes backed up. In the Backup resource that you configure to enable snapshots, you must annotate each specific volume that you want to back up. For more information about including and excluding pod volumes, see [Configuring Backups](snapshots-configuring-backups).
110+
By default, Velero requires that you opt-in to have pod volumes backed up. In the Backup resource that you configure to enable snapshots, you must annotate each specific volume that you want to back up. For more information about including and excluding pod volumes, see [Configuring Snapshots](/vendor/snapshots-configuring-backups).
111111

112112
## About Restores {#restores}
113113

@@ -123,13 +123,15 @@ For information about how to restore using the Admin Console or the KOTS CLI, se
123123

124124
## Using Snapshots
125125

126+
This section provides an overview of how vendors and enterprise users can configure and use the snapshots feature.
127+
126128
### How to Enable Snapshots for Your Application
127129

128130
To enable the snapshots backup and restore feature for your users, you must:
129131

130132
- Have the snapshots entitlement enabled in your Replicated vendor account. For account entitlements, contact the Replicated TAM team.
131-
- Define a manifest for creating backups. See [Configuring Backups](snapshots-configuring-backups).
132-
- When needed, configure backup and restore hooks. See [Configuring Backup and Restore Hooks](snapshots-hooks).
133+
- Define a manifest for creating backups. See [Configuring Snapshots](snapshots-configuring-backups).
134+
- When needed, configure backup and restore hooks. See [Configuring Backup and Restore Hooks for Snapshots](snapshots-hooks).
133135
- Enable the **Allow Snapshot** option in customer licenses. See [Creating and Managing Customers](releases-creating-customer).
134136

135137
### Understanding Backup and Restore for Users {#how-users}

0 commit comments

Comments
 (0)