docs: Point-in-Time Recovery for Postgres#1134
Merged
Merged
Conversation
New reference page under Volumes covering the PITR feature: how it works, the standalone vs HA enable flows (incl. the rolling-restart sequence), restoring to a target timestamp, the no-snapshot / coverage-gap warnings the UI surfaces, the disable flow (and bucket-retention behavior), cost, and limitations. Sibling to /volumes/backups; sidebar entry added next to Backups.
|
🚅 Deployed to the docs-pr-1134 environment in 🪄 *.railway.com
6 services not affected by this PR
|
Daily-only is broken: snapshot retention is 6 days, WAL retention is 7 — the oldest day of the WAL window has no base snapshot to replay onto. Weekly snapshots (27-day retention) close the gap. Both schedules are required and Enable PITR adds them automatically; document that removing either breaks the feature.
The previous draft documented the wal-g design. The implementation has since pivoted to pgBackRest baked into the Postgres image (direct-to-S3, async push) and restore now creates a new sibling service rather than mutating the source in place. Key updates: - wal-g → pgBackRest, with the WAL_ARCHIVE_* tool-agnostic env contract replacing the wal-g credential references. - Base backups taken by pgBackRest itself (full + incremental), not by Railway snapshot schedules — drops the daily/weekly schedule requirement that was a workaround for snapshot-as-base. - Restore creates <source>-restored-YYYYMMDD-HHMM as a new service; source service stays online and untouched. Same flow for standalone and HA — drops the "HA restore requires full cluster downtime" claim. - Coverage timeline reads pgBackRest catalog directly: green band + red diagonal stripes for gaps; upper bound is latest archived WAL, not current time. - Standalone disable stages a patch (env vars + bucket deletion) for user review; HA disable runs imperatively and retains the bucket. - Drops the arm64 limitation (was wal-g specific) and the "consider pgBackRest" hedge (we use it now).
paulocsanz
changed the title
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
1 participant
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.
New reference page under Volumes covering the PITR feature (
/volumes/point-in-time-recovery).What's covered
Sidebar
Added next to the existing Backups page under Volumes.
Test plan
pnpm devand verify the page renders