Skip to content

docs: refresh backup/restore for R26.3; add plain-Linux control-plane backup page - #210

Merged
noctarius merged 1 commit into
mainfrom
docs/backup-restore-26.3
Sep 4, 2026
Merged

docs: refresh backup/restore for R26.3; add plain-Linux control-plane backup page#210
noctarius merged 1 commit into
mainfrom
docs/backup-restore-26.3

Conversation

@schmidt-scaled

Copy link
Copy Markdown
Contributor

Validated the whole data-protection section against sbcli R26.3 and operator main; fixed what had drifted and added what was missing.

Non-Kubernetes

  • backup-recovery.md
    • NEW Configuring the Backup Target: cluster create/add --use-backup <json> with the full config-file schema (endpoint, bucket default simplyblock-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.
    • Retention wording: limits merge the oldest backup into the next one, nothing is deleted.
    • Dropped the embedded Kubernetes CRD half (carried the deprecated simplybk/ annotation) in favour of 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 with access verification, automatic scheduling, and a danger note that restore clears the database first (verified in fdb_backup_controller).

Kubernetes

  • backup-recovery.md
    • NEW BackupImport CRD section: cross-cluster restore; the operator resolves the source cluster's credentials, so no cluster-wide backup-source switch is needed (unlike the CLI flow).
    • StorageBackup.spec.snapshotName; fsType capture/preservation on restore; BackupRestore.targetNode default corrected; StorageCluster backup spec 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/cli pages).

🤖 Generated with Claude Code

… 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>
@noctarius
noctarius merged commit d50e3f7 into main Sep 4, 2026
4 checks passed
@noctarius
noctarius deleted the docs/backup-restore-26.3 branch September 4, 2026 09:12
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🤖: Deployment available as https://docstest.simplyblock.io/docs-backup-restore-26.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants