Skip to content

docs(backup): stop presenting a full restore as a backup review - #208

Open
iddocohen wants to merge 2 commits into
mainfrom
ic/docs-backup-restore-tl-dr-step-deployment-2uux6
Open

iddocohen wants to merge 2 commits into
mainfrom
ic/docs-backup-restore-tl-dr-step-deployment-2uux6

Conversation

@iddocohen

@iddocohen iddocohen commented Nov 15, 2026 •

Copy link
Copy Markdown

Fixes #206.

Problem

Step 6 of Create a backup labelled this command as a way to "Review what would be restored":

infrahub-backup restore infrahub_backups/infrahub_backup_20250929_143022.tar.gz

The command restores the archive over the target deployment. restore has no dry-run flag (only prune has one), so a reader who runs it to check a backup overwrites their running Infrahub.

Change

Step 6 now:

  • reviews the archive with read-only commands (tar -tzf and the backup_information.json metadata), as Step 4 already does
  • restores into a separate Docker Compose project (--project=infrahub-staging), matching the example in Restore from a backup
  • warns that restore replaces the data of the target deployment and has no dry-run mode
  • links to the full restore procedure

Docs only, so labelled ci/skip-changelog. Vale passes on the changed file.

View guided diff Turn on auto-fix

Step 6 of "Create a backup" labelled infrahub-backup restore as a way
to review what would be restored. The command overwrites the target
deployment. Replace it with read-only archive commands, show the
restore against a staging project, and warn that restore has no
dry-run mode.

Fixes #206
@iddocohen
iddocohen requested a review from a team as a code owner November 15, 2026 12:19
@iddocohen iddocohen added the ci/skip-changelog No changelog fragment required for this pull request label Nov 15, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Deploying infrahub-ops-cli with  Cloudflare Pages  Cloudflare Pages

Latest commit: f4bf253
Status: ✅  Deploy successful!
Preview URL: https://b072cd2c.infrahub-ops-cli.pages.dev
Branch Preview URL: https://ic-docs-backup-restore-tl-dr.infrahub-ops-cli.pages.dev

View logs

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file

Reply with feedback, questions, or to request a fix.

View guided diff | Turn on auto-fix | Re-trigger cubic

Comment thread docs/docs/backup/create.mdx Resolved
Comment thread docs/docs/backup/create.mdx Resolved
@iddocohen iddocohen added changes/patch Release with fixes or maintenance documentation Improvements or additions to documentation labels Nov 15, 2026
…ployment ID

The archive stores its files under backup/, so the metadata commands
in Steps 4 and 6 must read backup/backup_information.json. Restoring
into staging now passes --reset-deployment-id so staging does not
report the production identity.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changes/patch Release with fixes or maintenance ci/skip-changelog No changelog fragment required for this pull request documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: "Review what would be restored" in Create a backup runs a full restore

1 participant