Merge pull request openebs#2725 from kmova/update-readme

Update README with latest project status.
vino-cloud7 · Aug 30, 2019 · 60c133c · 60c133c
2 parents 22f6562 + 41665f3
commit 60c133c
Showing 1 changed file with 50 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -9,16 +9,26 @@
 
 https://www.openebs.io/
 
-**OpenEBS** enables the use of containers for mission-critical, persistent workloads and for other stateful workloads such as logging or Prometheus for example. OpenEBS is containerized storage and related storage services.
-
-**OpenEBS** allows you to treat your persistent workload containers, such as DBs on containers, just like other containers. OpenEBS itself is deployed as just another container on your host and enables storage services that can be designated on a per pod, application, cluster or container level, including:
+**OpenEBS** is the most widely deployed and easy to use open source storage solution for Kubernetes. 
+
+**OpenEBS** is the leading open source example of a category of storage solutions sometimes called [Container Attached Storage](https://www.cncf.io/blog/2018/04/19/container-attached-storage-a-primer/). **OpenEBS** is listed as an open source example in the [CNCF Storage Landscape White Paper](https://github.com/cncf/sig-storage/blob/master/CNCF%20Storage%20Landscape%20-%20White%20Paper.pdf) under the hyperconverged storage solutions.
+
+Some key aspects that make OpenEBS different compared to other traditional storage solutions:
+- Built using the micro-services architecture like the applications it serves. OpenEBS is itself deployed as a set of containers on Kubernetes worker nodes. Uses Kubernetes itself to orchestrate and manage OpenEBS components
+- Built completely in userspace making it highly portable to run across any OS/platform
+- Completely intent-driven, inheriting the same principles that drive the ease of use with Kubernetes
+- OpenEBS supports a range of storage engines so that developers can deploy the storage technology appropriate to their application design objectives. Distributed applications like Cassandra can use the LocalPV engine for lowest latency writes. Monolithic applications like MySQL and PostgresQL can use the ZFS engine (cStor) for resilience. Streaming applications like Kafka can use the NVMe engine [MayaStor](https://github.com/openebs/MayaStor) for best performance in edge environments. Across engine types, OpenEBS provides a consistent framework for high availability, snapshots, clones and manageability.
+
+OpenEBS itself is deployed as just another container on your host and enables storage services that can be designated on a per pod, application, cluster or container level, including:
+- Automate the management of storage attached to the Kubernetes worker nodes and allow the storage to be used for Dynamically provisioning OpenEBS PVs or Local PVs.
 - Data persistence across nodes, dramatically reducing time spent rebuilding Cassandra rings for example.
 - Synchronization of data across availability zones and cloud providers improving availability and decreasing attach/detach times for example.
 - A common layer so whether you are running on AKS, or your bare metal, or GKE, or AWS - your wiring and developer experience for storage services is as similar as possible.
-- Integration with Kubernetes, so  developer and application intent flows into OpenEBS configurations automatically.
 - Management of tiering to and from S3 and other targets.
-
-**Our vision** is simple: let storage and storage services for persistent workloads be fully integrated into the environment so that each team and workload benefits from granularity of control and Kubernetes native behavior. 
+
+An added advantage of being a completely Kubernetes native solution is that administrators and developers can interact and manage OpenEBS using all the wonderful tooling that is available for Kubernetes like: kubectl, Helm, Prometheus, Grafana, Weave Scope, etc.
+
+**Our vision** is simple: let storage and storage services for persistent workloads be fully integrated into the environment so that each team and workload benefits from the granularity of control and Kubernetes native behavior.
 
 #### *Read this in [other languages](translations/TRANSLATIONS.md).*
 
@@ -28,7 +38,7 @@ https://www.openebs.io/
 
 ## Scalability
 
-OpenEBS can scale to include an arbitrarily large number of containerized storage controllers. Kubernetes is used to provide fundamental pieces such as using etcd for inventory. OpenEBS scales to the extent your Kubernetes scales.  
+OpenEBS can scale to include an arbitrarily large number of containerized storage controllers. Kubernetes is used to provide fundamental pieces such as using etcd for inventory. OpenEBS scales to the extent your Kubernetes scales.
 
 ## Installation and Getting Started
 
@@ -51,32 +61,51 @@ You could also follow our [QuickStart Guide](https://docs.openebs.io/docs/overvi
 OpenEBS can be deployed on any Kubernetes cluster - either in cloud, on-premise or developer laptop (minikube). Note that there are no changes to the underlying kernel that are required as OpenEBS operates in userspace.  Please follow our [OpenEBS Setup](https://docs.openebs.io/docs/overview.html) documentation. Also, we have a Vagrant environment available that includes a sample Kubernetes deployment and synthetic load that you can use to simulate the performance of OpenEBS. You may also find interesting the related project called Litmus (https://www.openebs.io/litmus) which helps with chaos engineering for stateful workloads on Kubernetes.
 
 ## Status
-We are approaching the beta stage with active development underway. See our [Project Tracker](https://github.com/openebs/openebs/wiki/Project-Tracker) for more details. Many users are running OpenEBS in production and early access commercial solutions were made available in September 2018 by our primary sponsor MayaData (https://www.mayadata.io).  
+
+OpenEBS is one of the most widely used and tested Kubernetes storage infrastructures in the industry. A CNCF Sandbox project since May 2019, OpenEBS is the first and only storage system to provide a consistent set of software-defined storage capabilities on multiple backends (local, nfs, zfs, nvme) across both on-premise and cloud systems, and was the first to open source its own Chaos Engineering Framework for Stateful Workloads, the [Litmus Project](https://www.openebs.io/litmus), which the community relies on to automatically readiness assess the monthly cadence of OpenEBS versions. Enterprise customers have been using OpenEBS in production since 2018 and the project supports 2.5M+ docker pulls a week.
+
+The status of various storage engines that power the OpenEBS Persistent Volumes is provided below.
+
+| Storage Engine | Status | Details |
+|---|---|---|
+| Jiva | stable | Best suited for running Replicated Block Storage on nodes that make use of ephemeral storage on the Kubernetes worker nodes |
+| cStor | beta | A preferred option for running on nodes that have Block Devices. Recommended option if Snapshot and Clones are required |
+| Local Volumes | beta | Best suited for Distributed Application that need low latency storage - direct attached storage from the Kubernetes nodes. |
+| MayaStor | alpha | A new storage engine that operates at the efficiency of Local Storage but also offers storage services like Replication. Development is underway to support Snapshots and Clones. |
+
+For more details, please refer to [OpenEBS Documentation](https://docs.openebs.io/docs/next/quickstart.html).
 
 ## Contributing
 
 OpenEBS welcomes your feedback and contributions in any form possible.
 
 - [Join our community](https://openebs.io/join-our-slack-community)
   - Already signed up? Head to our discussions at [#openebs-users](https://openebs-community.slack.com/messages/openebs-users/)
-- Want to raise an issue?
-  - If it is a generic (or `not really sure`), you can still raise it at [issues](https://github.com/openebs/openebs/issues)
-  - Project (repository) specific issues also can be raised at [issues](https://github.com/openebs/openebs/issues) and tagged with the individual repository labels like *repo/maya*.
-- Want to help with fixes and features?
+- Want to raise an issue or help with fixes and features?
   - See [open issues](https://github.com/openebs/openebs/labels)
   - See [contributing guide](./CONTRIBUTING.md)
-  - Want to join our community, [check this out](./community/README.md). 
+  - Want to join our contributor community meetings, [check this out](./community/README.md). 
+- Join our OpenEBS CNCF Mailing lists
+  - For OpenEBS project updates, subscribe to https://lists.cncf.io/g/cncf-openebs-announcements
+  - For interacting with other openebs users, subscribe to https://lists.cncf.io/g/cncf-openebs-users
 
 ## Show me the Code
 
-This is a meta-repository for OpenEBS. The source code is available at the following locations:
-- The source code for the initial storage engine is under [openebs/jiva](https://github.com/openebs/jiva).
-- The storage orchestration source code is under [openebs/maya](https://github.com/openebs/maya).
-- While *jiva* and *maya* contain significant chunks of source code, some of the orchestration and automation code is also distributed in other repositories under the OpenEBS organization. 
-
-Please start with the pinned repositories or with [OpenEBS Architecture](./contribute/design/README.md) document. 
+This is a meta-repository for OpenEBS. Please start with the pinned repositories or with [OpenEBS Architecture](./contribute/design/README.md) document. 
 
 ## License
 
-OpenEBS is developed under Apache 2.0 license at the project level. 
-Some components of the project are derived from other open source projects and are distributed under their respective licenses. 
+OpenEBS is developed under Apache 2.0 license at the project level. Some components of the project are derived from other open source projects and are distributed under their respective licenses. 
+
+OpenEBS is part of the CNCF Projects.
+
+[![CNCF Sandbox Project](https://raw.githubusercontent.com/cncf/artwork/master/other/cncf-sandbox/horizontal/color/cncf-sandbox-horizontal-color.png)](https://landscape.cncf.io/selected=open-ebs)
+
+## Commercial Offerings
+
+This is a list of third-party companies and individuals who provide products or services related to OpenEBS. OpenEBS is an CNCF project which does not endorse any company. The list is provided in alphabetical order.
+- [Clouds Sky GmbH](https://cloudssky.com/en/)
+- [CodeWave](https://codewave.eu/)
+- [Gridworkz Cloud Services](https://gridworkz.com/)
+- [MayaData](https://mayadata.io/)
+