Skip to content

Document Comprehensively Documented Backup and Restoration Procedures #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tamalsaha wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document Comprehensively Documented Backup and Restoration Procedures #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/concepts/capabilities/documented-backup-restoration-procedures/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)
1 change: 1 addition & 0 deletions docs/concepts/what-is-kubestash/overview/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Loading