diff --git a/docs/concepts/capabilities/documented-backup-restoration-procedures/index.md b/docs/concepts/capabilities/documented-backup-restoration-procedures/index.md new file mode 100644 index 0000000..a7f9dfe --- /dev/null +++ b/docs/concepts/capabilities/documented-backup-restoration-procedures/index.md @@ -0,0 +1,25 @@ +--- +title: Comprehensively Documented Backup and Restoration Procedures +description: All backup and restoration procedures comprehensively documented through declarative CRDs. +menu: + docs_{{ .version }}: + identifier: capabilities-documented-backup-restoration-procedures + name: Comprehensively Documented Backup and Restoration Procedures + parent: capabilities + weight: 70 +product_name: kubestash +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + +# Comprehensively Documented Backup and Restoration Procedures + +KubeStash documents all backup and restoration procedures comprehensively, by collapsing procedure and configuration into the same artifact: a Kubernetes Custom Resource Definition (CRD). Every backup schedule, restore plan, retention rule, pre and post hook, verification cadence, and disaster recovery drill is expressed as a `BackupConfiguration`, `RestoreSession`, `RetentionPolicy`, `HookTemplate`, `BackupVerifier`, or `BackupBlueprint` object. These YAML manifests live in Git, are reviewed in pull requests, and are applied via GitOps. The documentation is the configuration, which means it cannot drift from reality. + +## Related concepts + +- [BackupConfiguration](../../crds/backupconfiguration/) +- [BackupBlueprint](../../crds/backupblueprint/) +- [RestoreSession](../../crds/restoresession/) +- [RetentionPolicy](../../crds/retentionpolicy/) +- [BackupVerifier](../../crds/backupverifier/) diff --git a/docs/concepts/what-is-kubestash/overview/index.md b/docs/concepts/what-is-kubestash/overview/index.md index 745dac1..1b5b113 100644 --- a/docs/concepts/what-is-kubestash/overview/index.md +++ b/docs/concepts/what-is-kubestash/overview/index.md @@ -37,3 +37,4 @@ section_menu_id: concepts | Auto Backup | Share backup configuration across workloads using templates. Enable backup for a target application via annotation. | | Point-In-Time Recovery (PITR) | Restore a set of files from a time in the past. | | Role Based Access Control (RBAC) | | +| Comprehensively Documented Backup and Restoration Procedures | All backup and restoration procedures are documented through declarative CRDs (BackupConfiguration, RestoreSession, RetentionPolicy, HookTemplate, BackupVerifier, BackupBlueprint), stored in Git and applied via GitOps. |