Skip to content

docs(influxdb3 backup-restore): add object versioning guidance#7162

Open
jstirnaman wants to merge 4 commits into
masterfrom
dar-665-object-versioning
Open

docs(influxdb3 backup-restore): add object versioning guidance#7162
jstirnaman wants to merge 4 commits into
masterfrom
dar-665-object-versioning

Conversation

@jstirnaman
Copy link
Copy Markdown
Contributor

@jstirnaman jstirnaman commented Apr 28, 2026

Summary

Adds a new "Object storage features and backup planning" section to the shared Core/Enterprise backup-restore page covering:

  • Short-term object versioning (typically 1-2 days) as protection against errant writes and accidental deletions.
  • Limitations: {{% product-name %}} writes mostly immutable Parquet files, so versioning helps most with recovering specific accidentally deleted files; mass-restore via individual versions is impractical.
  • Cost trade-offs: versioning costs scale with object update frequency, amplified by compaction-driven object writes. Treat versioning as a short-window safety net, not a long-term backup substitute.
  • Provider-side features (versioning, soft delete, PITR) are not a substitute for periodic backups to a separate object store.
  • Provider-agnostic backup-to-different-bucket pattern with low-load timing guidance.
  • Enterprise-only cross-reference: cross-bucket restores affect license binding (gated with show-in).

Sources: the original recommendation comes from the existing Clustered backup-restore page; additional generalized guidance comes from internal SME comments on EAR#6827

Adjacent restructuring

The shared file's ## Important considerations umbrella was a heterogeneous catch-all. Promoted its ### subsections to ## and renamed a few for subject orientation:

Before After
### Recovery expectations ## Recovery expectations
### License files (Enterprise) ## Licensing and disaster recovery (Enterprise)
### Docker considerations ## Containerized deployments
### Table snapshot files ## Excluded files
### Timing recommendations ## Backup timing

Verified no inbound links use the previous anchors.

Closes influxdata/DAR#665

Test plan

Add a new "Object storage features and backup planning" section to the
shared Core/Enterprise backup-restore page covering:

- Short-term object versioning as protection against errant writes and
  accidental deletions (1-2 day retention).
- Limitations: Parquet files are mostly immutable, so versioning helps
  most with single-file recovery rather than mass restores.
- Cost trade-offs: versioning costs scale with object update frequency,
  amplified by compaction-driven object writes.
- Provider-side features (versioning, soft delete, PITR) are not a
  substitute for periodic backups to a separate object store.
- Provider-agnostic backup-to-different-bucket pattern with low-load
  timing guidance.
- Enterprise-only cross-reference: cross-bucket restores affect license
  binding (gated with show-in).

Restructure the section: drop the "Important considerations" umbrella
and promote its subsections to top-level subject-oriented headings
(`Recovery expectations`, `Licensing and disaster recovery`,
`Containerized deployments`, `Excluded files`, `Backup timing`). No
inbound external links use the renamed anchors.

Closes influxdata/DAR#665
@jstirnaman jstirnaman requested a review from a team as a code owner April 28, 2026 21:12
@jstirnaman jstirnaman requested review from sanderson and removed request for a team April 28, 2026 21:12
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

Vale Style Check Results

Metric Count
Errors 0
Warnings 2
Suggestions 0
Warnings (2)
File Line Rule Message
content/influxdb3/core/admin/backup-restore.md 18 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/enterprise/admin/backup-restore.md 20 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.

Check passed

@github-actions github-actions Bot added product:shared Shared content across products product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable) labels Apr 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-7162/
on branch gh-pages at 2026-05-01 13:36 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 28, 2026

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED
Preview View preview
Pages 2 page(s) deployed
Build time 72s
Last updated 2026-05-01 13:36:50 UTC
Pages included in this preview
  • /influxdb3/enterprise/admin/backup-restore/
  • /influxdb3/core/admin/backup-restore/

Preview auto-deploys on push. Will be cleaned up when PR closes.

Comment thread content/shared/influxdb3-admin/backup-restore.md
Comment thread content/shared/influxdb3-admin/backup-restore.md
@jstirnaman jstirnaman requested a review from reidkaufmann April 28, 2026 21:27
Copy link
Copy Markdown
Contributor

@reidkaufmann reidkaufmann left a comment

Choose a reason for hiding this comment

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

Looks fine. Could mention cost concerns with versioning and provider-side features, but this is sufficient.

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

Labels

product:shared Shared content across products product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants