Ramen
  • Documentation
  • GitHub
  • Documentation
    • User quick start guide for testing application DR
    • Ramen developer quick start guide
    • Installing Ramen
    • Configure Ramen
    • Workload Management Using Ramen
    • Using Recipes for Disaster Recovery (DR)
    • Logging
    • Metrics
    • Testing
    • End to End testing
    • Building ramen
    • DRPolicy CRD
    • DRCluster CRD
    • DRClusterConfig CRD
    • DRPlacementControl CRD
    • VolumeReplicationGroup CRD
    • MaintenanceMode CRD
    • Design
      • Proposals
        • VRG reconciler workflow
      • CephFS Regional DR Consistency Group
      • Global VolumeGroupReplication Design Document
      • Incremental Sync for Consistency Groups
      • VRG Type Sequence
    • Developer
      • Handling CVEs in the project
    • drenv
      • drenv metrics
      • drenv stress test
View page source Edit this page Create child page Create documentation issue
  • Getting started
  • API reference
  • Design & development
  1. Documentation

Documentation

Welcome to the Ramen documentation. These pages are generated from the docs/ directory of the repository.

Getting started

  • User quick start — protect your first workload
  • Developer quick start — set up a local environment
  • Install — deploy Ramen on your clusters
  • Configure — configure DR policies and clusters
  • Usage — day-to-day operations

API reference

  • DRPolicy
  • DRCluster
  • DRClusterConfig
  • DRPlacementControl (DRPC)
  • VolumeReplicationGroup (VRG)
  • MaintenanceMode

Design & development

  • Design documents
  • Developer notes
  • drenv test environment

User quick start guide for testing application DR

Ramen developer quick start guide

Installing Ramen

Configure Ramen

Workload Management Using Ramen

Using Recipes for Disaster Recovery (DR)

Logging

Metrics

Testing

End to End testing

Building ramen

DRPolicy CRD

DRCluster CRD

DRClusterConfig CRD

DRPlacementControl CRD

VolumeReplicationGroup CRD

MaintenanceMode CRD

Design

Developer

drenv

© 2026 The RamenDR authorsAll Rights Reserved