Revenant documentation
Guides for proving database recovery with the Revenant CLI, AWS RDS restore drills, evidence, and Revenant Cloud.
Getting started
Introduction, restore drills, product paths, and quick starts.
- What is Revenant?
Disaster recovery proof for PostgreSQL and AWS RDS — prove your backups actually restore, measure RTO, and keep audit-ready evidence.
- How restore drills work
Snapshot → sandbox → verify → evidence → reap.
- Choose your path
CLI vs Cloud Starter vs Pro.
- Quick start (local Postgres)
DATABASE_URL, init, verify — expected PASS output.
- GitHub Actions
Local Postgres weekly proof and AWS restore + reap cleanup.
- Roadmap
CLI core done; Cloud ships recovery readiness; challenges and observability next.
CLI reference
Install, configure, and run revenant in your terminal or CI.
- Install the CLI
GitHub Action, binary download, or build from source.
- Quick start
doctor → init → verify in minutes.
- Commands
doctor, init, verify, snapshot, reap.
- revenant.yaml
Plan, database, recovery, and checks.
- Check types
Seven yaml check types — connect through index.
- revenant doctor
Validate config, env vars, and database connectivity before verify.
- revenant init
Scan live Postgres → starter revenant.yaml (schema, counts, FKs).
- revenant verify
Run all checks; optional AWS RDS snapshot restore sandbox.
- revenant snapshot
Validate source DB first; create RDS snapshot only if checks pass.
- revenant reap
Delete orphaned Revenant-managed RDS sandboxes older than max-age.
- revenant migrate
Demo only — sample customers + orders tables for learning.
Evidence & reports
JSON, Markdown, PDF exports — CLI and cloud vault.
- Report formats
report.json and report.md from CLI; PDF in cloud vault.
- CI artifacts
Wire reports into GitHub Actions workflows.
Recovery readiness
Contracts, readiness scores, drift detection, passports, and application-aware checks in Revenant Cloud.
- Recovery readiness overview
From backup proof to continuous recoverability scoring.
- Recovery contract
Define RTO, RPO, and what “recoverable” means.
- Readiness score & dimensions
How the 0–100 score and status tag work.
- Recovery regression
Detect when RTO, RPO, or readiness score worsens vs the prior drill.
- Evidence vault & recovery passport
Drill reports vs signed passports.
- Sign in with Google or GitHub
Social OAuth for cloud dashboard access.
Integrations
Alerts, webhooks, email, and scheduled drills (cloud).
- Slack notifications
Post drill results to a channel when a workflow finishes.
- Custom HTTP webhooks
POST signed JSON to your endpoint after each drill.
- Email alerts & digests
Starter email on failure; weekly digest when SMTP is configured.
- CI/CD recovery gate
Block deploys when recovery readiness is below your floor.
- Schedules & cron drills
Automated restore proof on a timetable — cloud control plane.
Revenant Cloud
Dashboard, trials, workflows, evidence, and plans.
- Create an account
30-day Starter trial — no card at signup.
- Workflows & databases
One production DB + validation plan = one workflow.
- Schedules & jobs
Cron drills, job history, parallel sandbox limits.
- Evidence vault
Signed reports, retention, exports.
- Database + API health checks
Prove your app answers after restore — not just the database.
- Product guide (in-app)
Step-by-step tour of the cloud dashboard.
- Team, alerts & integrations
RBAC, email, Slack, HTTP webhooks.
- Self-hosted agent (Pro)
Only for private-network Postgres — not free CLI bypass.
- Plans & limits
Developer, Starter ₹499, Pro ₹1,499, Enterprise.
AWS restore
RDS snapshots, sandboxes, IAM, and free-tier tips.
- RDS restore drill
What happens during an AWS sandbox run.
- Typical AWS workflow
migrate (demo) → snapshot → verify → reap.
- IAM & credentials
Keys stay in your account; least privilege for restore.
Redis
Redis restore proofs, optional snapshot storage, and plan limits.
- Redis restore proofs
Capture a Redis RDB, verify it can be restored, and choose whether Revenant keeps the snapshot.