docs(validators): add node state-recovery and rollup-outage runbooks#435
docs(validators): add node state-recovery and rollup-outage runbooks#435MuncleUscles wants to merge 1 commit into
Conversation
Add two operator runbook pages under pages/validators/: - state-recovery.mdx: recovering a node that has fallen behind or lost state. Documents the two real paths — seeding a new node from a POST /snapshot archive (create-only endpoint; restore is a manual filesystem drop-in, no first-class restore command), and a trustless full re-sync from genesis that re-executes history through GenVM. Honestly flags where restore tooling is thin. - rollup-outage.mdx: incident response when the underlying rollup / sequencer is unreachable. Detection (doctor + /health zksync-connectivity + transport circuit-breaker metrics), why validators are not falsely slashed (slashing/quarantine are on-chain; the node skips duties rather than mis-voting), status-comms, and automatic resume. Grounded in the Bradbury outage of 2026-07-01 as precedent. Wire both into pages/validators/_meta.json and cross-link setup-guide, monitoring, upgrade, staking, and slashing.
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 48 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Description
Adds two node-operator runbook pages under
pages/validators/, plus navigation and cross-links.1.
state-recovery.mdx— Node State Recovery & Re-syncThe operator's guide to recovering a node that has fallen behind or lost state. It documents the two paths that actually exist today:
POST /snapshotendpoint, then seed a target node from the archive. The archive is a consistent checkpoint of the Pebble chain DB (SSTables /MANIFEST/ WAL).Honesty note (per the audit): the snapshot endpoint is create-only — there is no first-class
restore/importcommand or endpoint. Restoring from a snapshot is a manual filesystem drop-in performed while the node is stopped, and the page says so explicitly and flags where the tooling is genuinely thin, rather than inventing a restore command.2.
rollup-outage.mdx— Rollup / Sequencer Outage: Incident ResponseWhat a node operator does when the underlying rollup / sequencer (the GenLayer Chain L2) is unreachable, structured as detect → communicate → wait & verify → resume → post-incident:
doctorGenLayer-Chain RPC/WS failures, the/healthzksync-connectivitycheck, and the transport circuit breaker (observable via metrics, not logs).Both pages are wired into
pages/validators/_meta.jsonand cross-link the setup guide, monitoring, upgrade, staking (priming/quarantine), and slashing pages.monitoring.mdxandupgrade.mdxgain reciprocal links.All technical claims were verified against
genlayer-node@origin/v0.6-dev(snapshot API, sync/circuit-breaker, health/doctor checks, transient-retry behavior) and thegenlayer-consensuscontracts (quarantine/slashing are on-chain). Validated withscripts/list-docs-routes.js,scripts/generate-full-docs.js, andscripts/check-llm-exports.js(209 pages, exports OK).Release Notes
Added two validator runbooks to docs.genlayer.com: Node State Recovery & Re-sync (snapshot seeding and trustless full re-sync from genesis) and Rollup / Sequencer Outage: Incident Response (detect, wait, and resume without false slashing).
Types of Changes
Checklist
pages/validators/*.mdxNextra/MDX conventions)generate-full-docs.jsandcheck-llm-exports.jspass; both routes register)genlayer-nodeandgenlayer-consensusrepositories, and thin tooling is called out rather than invented