Skip to content

Commit 8be582e

Browse files
committed
improve recipe doc
1 parent 22f5876 commit 8be582e

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/recipe.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,27 @@ SPDX-License-Identifier: Apache-2.0
55

66
# Kubernetes Resource Protection with Recipes
77

8+
## Introduction
9+
10+
Recipes are part of Ramen's OpenShift-native Disaster Recovery ecosystem, providing vendor-supplied or custom disaster recovery specifications for complex stateful applications. While Ramen supports multiple workload protection methods (GitOps, discovered applications, and Recipes), Recipes are specifically designed for applications that require:
11+
12+
- Application-specific quiesce operations before capture (e.g., database flush)
13+
- Strict resource ordering during capture or recovery
14+
- Custom pre/post hooks for DR operations
15+
- Vendor-defined DR workflows that ensure data consistency
16+
17+
**Target Audience:**
18+
- **Software Vendors**: Create Recipes to accompany your products, providing DR protection as a product feature
19+
- **Advanced Users**: Write custom Recipes when vendors haven't provided them for critical applications
20+
21+
**When to use Recipes:**
22+
- Your application requires specific operations before backup (quiesce, flush, etc.)
23+
- Resources must be captured/restored in a specific order
24+
- Standard volume replication alone doesn't guarantee application consistency
25+
- You need to execute custom logic during DR operations
26+
27+
For general workload protection without custom workflows, see [usage.md](usage.md) for simpler alternatives (GitOps or discovered applications).
28+
829
## Overview
930

1031
By default, Kubernetes resources are Captured and Recovered as single, namespaced

0 commit comments

Comments
 (0)