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
Added docs covering VMinstance and VMDisk backups (#456)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Replaced the generic Kubernetes Backup and Recovery guide with a
virtualization-focused Backup and Recovery doc covering VMInstance and
VMDisk one‑off/scheduled backups, restores, status checks, examples, and
troubleshooting (including Velero-related notes).
* Updated backup configuration guidance to introduce separate VMInstance
and VMDisk strategies, adjust example settings (selectors, TTLs,
timeouts, storage parameters), and redirect workflow links to the new
virtualization backup/restore documentation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Copy file name to clipboardExpand all lines: content/en/docs/v1/operations/services/velero-backup-configuration.md
+67-14Lines changed: 67 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: "Configure backup storage, strategies, and BackupClasses for cluste
5
5
weight: 30
6
6
---
7
7
8
-
This guide is for **cluster administrators** who configure the backup infrastructure in Cozystack: S3 storage, Velero locations, backup **strategies**, and **BackupClasses**. Tenant users then use existing BackupClasses to create [BackupJobs and Plans]({{% ref "/docs/v1/kubernetes/backup-and-recovery" %}}).
8
+
This guide is for **cluster administrators** who configure the backup infrastructure in Cozystack: S3 storage, Velero locations, backup **strategies**, and **BackupClasses**. Tenant users then use existing BackupClasses to create [BackupJobs and Plans]({{% ref "/docs/v1/virtualization/backup-and-recovery" %}}).
Template context for substitutions in template spec will be resolved according to defined Parameters in BackupClass and desired ApplicationRef defined in BackupJob / Plan.
200
+
Template variables (`{{ .Application.* }}` and `{{ .Parameters.* }}`) are resolved from the ApplicationRef in the BackupJob/Plan and the parameters defined in the BackupClass.
158
201
159
202
Don't forget to apply it into management cluster:
160
203
@@ -183,9 +226,19 @@ spec:
183
226
- strategyRef:
184
227
apiGroup: strategy.backups.cozystack.io
185
228
kind: Velero
186
-
name: velero-backup-strategy
229
+
name: vminstance-strategy
187
230
application:
188
231
kind: VMInstance
232
+
apiGroup: apps.cozystack.io
233
+
parameters:
234
+
backupStorageLocationName: default
235
+
- strategyRef:
236
+
apiGroup: strategy.backups.cozystack.io
237
+
kind: Velero
238
+
name: vmdisk-strategy
239
+
application:
240
+
kind: VMDisk
241
+
apiGroup: apps.cozystack.io
189
242
parameters:
190
243
backupStorageLocationName: default
191
244
```
@@ -201,8 +254,8 @@ kubectl get backupclasses
201
254
202
255
Once strategies and BackupClasses are in place, **tenant users** can run backups without touching Velero or storage configuration:
203
256
204
-
- **One-off backup**: create a [BackupJob]({{% ref "/docs/v1/kubernetes/backup-and-recovery#create-a-one-off-backup-backupjob" %}}) that references a BackupClass.
205
-
- **Scheduled backups**: create a [Plan]({{% ref "/docs/v1/kubernetes/backup-and-recovery#create-scheduled-backups-plan" %}}) with a cron schedule and a BackupClass reference.
257
+
- **One-off backup**: create a [BackupJob]({{% ref "/docs/v1/virtualization/backup-and-recovery#one-off-backup" %}}) that references a BackupClass.
258
+
- **Scheduled backups**: create a [Plan]({{% ref "/docs/v1/virtualization/backup-and-recovery#scheduled-backup" %}}) with a cron schedule and a BackupClass reference.
206
259
207
260
Direct use of Velero CRDs (`Backup`, `Schedule`, `Restore`) remains available for advanced or recovery scenarios:
For a description of restore procedures (including listing backups and checking restore progress), see [Restore from a backup (all resources)]({{% ref "/docs/v0/kubernetes/backup-and-recovery#3-restore-from-a-backup-all-resources" %}}).
284
+
Once strategies and BackupClasses are in place, tenant users can restore from a backup using **RestoreJob** resources. See the [Backup and Recovery]({{% ref "/docs/v1/virtualization/backup-and-recovery" %}}) guide for restore instructions covering VMInstance and VMDisk in-place restores.
0 commit comments