Skip to content

Commit

Permalink
chore(docs): update project status to alpha
Browse files Browse the repository at this point in the history
  • Loading branch information
kmova authored May 15, 2020
1 parent 4041d4e commit 2232f2f
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@
# cstor-operators
[![Go](https://github.com/openebs/cstor-operators/workflows/Go/badge.svg)](https://github.com/openebs/cstor-operators/actions)
[![Build Status](https://travis-ci.org/openebs/cstor-operators.svg?branch=master)](https://travis-ci.org/openebs/cstor-operators)
[![Slack](https://img.shields.io/badge/JOIN-SLACK-blue)](https://openebs-community.slack.com)
[![Slack](https://img.shields.io/badge/JOIN-SLACK-blue)](https://slack.cncf.io)

<img width="300" align="right" alt="OpenEBS Logo" src="https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/stacked/color/openebs-stacked-color.png" xmlns="http://www.w3.org/1999/html">

Collection of OpenEBS cStor Data Engine Operators. The data engine operators
are responsible for cStor pool and volume orchestration.

Collection of enhanced Operators for OpenEBS cStor Data Engine.

## Project Status

This project is under active development and is considered to be in beta state.
This project is under active development and is considered to be in alpha state.

The data engine operators works in conjunction with the [cStor CSI driver](https://github.com/openebs/cstor-csi) to finally
provide a consumable volume for stateful workloads.

The current implementation supports the following for cStor pools and volumes:
The current implementation supports the following Operations on cStor pools and volumes:
1. Provisioning and De-provisioning of cStor pools.
2. Pool expansion by adding disk.
3. Disk replacement by removing a disk.
4. Volume replica scale up and scale down.
5. Volume resize.

The data engine operators works in conjunction with the cStor CSI driver to finally
provide a consumable volume for stateful workloads.
We are actively working on the following additional tasks for the beta release:

6. Reactor the Velero-plugin to work with cStor CSI abstractions
7. Support migration from old cStor operators to new operators backed by CSI.
8. Seamless upgrades

For more details on cStor-CSI drivers, please refer [here](https://github.com/openebs/cstor-csi)

Table of contents:
==================
Expand Down Expand Up @@ -79,4 +82,4 @@ Pleae read the community code of conduct [here](./CODE_OF_CONDUCT.md).
[Docker environment]: https://docs.docker.com/engine
[Go environment]: https://golang.org/doc/install
[openebs/openebs]: https://github.com/openebs/openebs
[channel]: https://openebs-community.slack.com
[channel]: https://openebs-community.slack.com

0 comments on commit 2232f2f

Please sign in to comment.