ramen

README

Ramen

Ramen is an open-cluster-management (OCM) placement extension that provides recovery and relocation services for workloads, and their persistent data, across a set of OCM managed clusters. Ramen provides cloud-native interfaces to orchestrate the placement of workloads and their data on PersistentVolumes, which include:

• Relocating workloads to a peer cluster, for planned migrations across clusters
• Recovering workloads to a peer cluster, due to unplanned loss of a cluster

Ramen relies on storage plugins providing support for the CSI storage replication addon, of which ceph-csi is a sample implementation.

For details regarding use-cases for Ramen see the motivation guide.

Getting Started and Documentation

For installation, see the install guide.

For configuration, see the configure guide.

For usage of Ramen to orchestrate placement of workloads, see the usage guide.

Volume Replication Group (VRG) usage

Kubernetes Resource Protection

Contributing

We welcome contributions. See contributing guide to get started.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Project Status

The entire project is under development, and hence all APIs supported by Ramen are currently alpha. There are no releases as yet.

• Alpha: The API may change in incompatible ways in a later software release without notice, recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.

Licensing

Ramen is under the Apache 2.0 license.