Hamburger Cross Icon
DR Documentation Collector - Lunar Collector

DR Documentation Collector

↓ Collector Stable Documentation

Parse disaster recovery plan and exercise documentation to extract RTO/RPO targets, exercise dates, review timestamps, and section headings. Verify that teams document and regularly practice recovery procedures.

Add dr-docs to your lunar-config.yml:
uses: github://earthly/lunar-lib/collectors/dr-docs@v1.0.0
Get Started View on GitHub

What This Integration Collects

This integration includes 2 collectors that gather metadata from your systems.

Collector code

dr-plan

Collects the disaster recovery plan document (default: docs/dr-plan.md). Expects YAML frontmatter with recovery objectives (rto_minutes, rpo_minutes), review metadata (last_reviewed, approver), and a Markdown body with sections covering recovery procedures.

disaster recovery DR plan RTO RPO compliance operational readiness
Book a demo
Collector code

dr-exercise

Collects DR exercise records from a directory (default: docs/dr-exercises/). Each exercise is a date-prefixed Markdown file (e.g., 2025-11-15.md or 2025-11-15-database-failover.md) with optional YAML frontmatter for exercise type and body sections documenting the scenario and outcomes. Provides full exercise history and summary metrics.

DR exercise tabletop exercise game day compliance operational readiness
Book a demo

How Collectors Fit into Lunar

Lunar watches your code and CI/CD systems to collect SDLC data from config files, test results, IaC, deployment configurations, security scans, and more.

Collectors are the automatic data-gathering layer. They extract structured metadata from your repositories and pipelines, feeding it into Lunar's centralized database where guardrails evaluate it to enforce your engineering standards.

Learn How Lunar Works →
1
↓ Collectors Gather Data This Integration
Triggered by code changes or CI pipelines, collectors extract metadata from config files, tool outputs, test results, and scans
2
{ } Centralized as JSON
All data merged into each component's unified metadata document
3
✓ Guardrails Enforce Standards
Real-time feedback in PRs and AI workflows

Example Collected Data

This collector writes structured metadata to the Component JSON. Here's an example of the data it produces:

{ } component.json Component JSON 
{
  "oncall": {
    "disaster_recovery": {
      "plan": {
        "exists": true,
        "path": "docs/dr-plan.md",
        "rto_defined": true,
        "rto_minutes": 60,
        "rpo_defined": true,
        "rpo_minutes": 15,
        "last_reviewed": "2025-12-01",
        "approver": "jane.doe@company.com",
        "sections": [
          "Overview",
          "Recovery Steps",
          "Contact List",
          "Dependencies"
        ]
      },
      "exercises": [
        {
          "date": "2025-11-15",
          "path": "docs/dr-exercises/2025-11-15.md",
          "exercise_type": "tabletop",
          "sections": [
            "Scenario",
            "Recovery Steps Tested",
            "Participants",
            "Action Items",
            "Lessons Learned"
          ]
        },
        {
          "date": "2025-05-20",
          "path": "docs/dr-exercises/2025-05-20.md",
          "exercise_type": "failover",
          "sections": [
            "Scenario",
            "Recovery Steps Tested",
            "Participants"
          ]
        }
      ],
      "latest_exercise_date": "2025-11-15",
      "exercise_count": 2
    }
  }
}

Configuration

Configure this collector in your lunar-config.yml.

Inputs

Input Required Default Description
plan_paths Optional docs/dr-plan.md Comma-separated list of candidate paths to the DR plan document (first match wins)
exercise_dir_paths Optional docs/dr-exercises Comma-separated list of candidate directories for DR exercise records (first match wins)

Related

Policy Operational Readiness
Compliance Documentation Guardrails

Enforces DR readiness requirements based on collected data

Documentation

View on GitHub

DR Documentation Collector

Collects disaster recovery plan and exercise documentation including RTO/RPO targets, exercise history, and document structure.

Overview

This collector parses two types of disaster recovery documentation: a DR plan and a directory of exercise records. The plan is a single Markdown file with YAML frontmatter for recovery objectives and review metadata. Exercises are date-named Markdown files (YYYY-MM-DD.md) in a directory, each documenting a tabletop exercise, failover test, or full recovery drill.

Collected Data

The DR plan sub-collector expects a single file (default: docs/dr-plan.md):

---
rto_minutes: 60
rpo_minutes: 15
last_reviewed: 2025-12-01
approver: jane.doe@company.com
---

# Disaster Recovery Plan

## Overview
...

## Recovery Steps
...

## Contact List
...

The DR exercise sub-collector scans a directory (default: docs/dr-exercises/) for date-named files:

docs/dr-exercises/
├── 2025-11-15.md    # Most recent tabletop
├── 2025-05-20.md    # Failover test
└── 2024-11-01.md    # Previous year's exercise

Each exercise file is a Markdown file with optional frontmatter:

---
exercise_type: tabletop
---

# DR Exercise

## Scenario
Simulated complete loss of the primary database...

## Recovery Steps Tested
1. Detected outage via PagerDuty alert...

## Participants
- Jane Doe (Engineering Manager)
...

This collector writes to the following Component JSON paths:

Path Type Description
.oncall.disaster_recovery.plan.exists boolean Whether a DR plan document exists
.oncall.disaster_recovery.plan.path string Path to the DR plan document
.oncall.disaster_recovery.plan.rto_defined boolean Whether RTO is documented
.oncall.disaster_recovery.plan.rto_minutes number Recovery Time Objective in minutes
.oncall.disaster_recovery.plan.rpo_defined boolean Whether RPO is documented
.oncall.disaster_recovery.plan.rpo_minutes number Recovery Point Objective in minutes
.oncall.disaster_recovery.plan.last_reviewed string ISO 8601 date of last plan review
.oncall.disaster_recovery.plan.approver string Email of the plan approver
.oncall.disaster_recovery.plan.sections array Section headings found in the plan
.oncall.disaster_recovery.exercises[] array All exercise records, newest first
.oncall.disaster_recovery.exercises[].date string Exercise date (from filename or frontmatter)
.oncall.disaster_recovery.exercises[].path string Path to the exercise file
.oncall.disaster_recovery.exercises[].exercise_type string Type of exercise (tabletop, failover, full)
.oncall.disaster_recovery.exercises[].sections array Section headings found in the exercise
.oncall.disaster_recovery.latest_exercise_date string Date of the most recent exercise
.oncall.disaster_recovery.exercise_count number Total number of exercise records

Collectors

This integration provides the following collectors (use include to select a subset):

Collector Description
dr-plan Parses DR plan document for recovery objectives and review metadata
dr-exercise Scans directory of date-named exercise records for exercise history

Installation

Add to your lunar-config.yml:

collectors:
  - uses: github://earthly/lunar-lib/collectors/dr-docs@v1.0.0
    on: ["domain:your-domain"]  # Or use tags like [backend, production]
    # with:
    #   plan_path: "docs/dr-plan.md"
    #   exercise_dir: "docs/dr-exercises"

Open Source

This collector is open source and available on GitHub. Contribute improvements, report issues, or fork it for your own use.

View Repository

Common Use Cases

Explore guardrails that use data from DR Documentation Collector.

+
Dr Plan Exists + DR Documentation Collector Verifies that a disaster recovery plan exists in the repository. Every...
→
+
Dr Plan Rto Rpo Defined + DR Documentation Collector Requires that Recovery Time Objective (RTO) and Recovery Point Objective (RPO)...
→
+
Dr Plan Required Sections + DR Documentation Collector Ensures the DR plan contains required section headings covering key recovery...
→
+
Dr Exercise Recent + DR Documentation Collector Ensures a DR exercise (tabletop, failover, or full) was conducted within the...
→
+
Dr Exercise Required Sections + DR Documentation Collector Ensures the most recent DR exercise record contains required section headings...
→

Ready to Automate Your Standards?

See how Lunar can turn your engineering wiki, compliance docs, or postmortem action items into automated guardrails with our 100+ built-in guardrails.

Works with any process
check Infrastructure conventions
check Post-mortem action items
check Security & compliance policies
check Testing & quality requirements
Automate Now
Turn any process doc into guardrails
Book a Demo