docs: refresh backup/restore for R26.3; add plain-Linux control-plane backup page - #210
Merged
Conversation
… backup for plain Linux Validated every command and CRD field against sbcli R26.3 and the operator main branch. Changes: Non-Kubernetes (docs/non-kubernetes/operations/data-protection): - backup-recovery.md: add the missing 'Configuring the Backup Target' section (cluster create/add --use-backup JSON schema); fix 'backup restore' (no --cluster-id anymore, cluster derives from the pool; default target node is automatic placement, not the node that took the backup); document restore preconditions (complete chain, matching active S3 source), encryption/KMS and allowed-hosts preservation, and merge-based retention; replace the embedded Kubernetes CRD half (stale simplybk/ annotation) with a pointer to the Kubernetes page. - control-plane-backup.md (NEW): sbctl db-backup config/create/list/ status/restore for Docker deployments — defaults (3h, /etc/foundationdb/backup), S3 destination, automatic scheduling, and the clear-before-restore danger note. - index.md: list the new page. Kubernetes (docs/kubernetes/operations/data-protection): - backup-recovery.md: document the BackupImport CRD (cross-cluster restore without a backup-source switch — the operator resolves the source cluster's credentials); add StorageBackup.spec.snapshotName and the fsType capture/preservation behaviour; fix BackupRestore.targetNode default; StorageCluster backup spec field table incl. secondaryTarget; align retention wording with the merge semantics; cross-link the CLI and FoundationDB pages. Quality gates: no errors in the touched files (remaining syntax-gate errors are pre-existing links to build-generated reference/cli pages). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
🤖: Deployment available as https://docstest.simplyblock.io/docs-backup-restore-26.3 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Validated the whole data-protection section against sbcli R26.3 and operator main; fixed what had drifted and added what was missing.
Non-Kubernetes
cluster create/add --use-backup <json>with the full config-file schema (endpoint, bucket defaultsimplyblock-backup-<CLUSTER_ID>, compression, ...) — previously undocumented anywhere.backup restore: --cluster-id no longer exists (cluster derives from the pool); default target node is automatic placement, not "the node that took the backup"; documented preconditions (complete chain, matching active S3 source), encryption/KMS + allowed-hosts preservation.simplybk/annotation) in favour of a pointer to the Kubernetes page.sbctl db-backup config/create/list/status/restorefor Docker deployments — defaults (3h,/etc/foundationdb/backup), S3 destination with access verification, automatic scheduling, and a danger note that restore clears the database first (verified infdb_backup_controller).Kubernetes
StorageBackup.spec.snapshotName; fsType capture/preservation on restore;BackupRestore.targetNodedefault corrected; StorageClusterbackupspec field table incl.secondaryTarget; merge-based retention wording; cross-links to the CLI and FoundationDB pages.Quality gates: clean for all touched files (remaining syntax-gate errors are pre-existing links to build-generated
reference/clipages).🤖 Generated with Claude Code