From 1928d2f671271c77f14ffc024d0e3e8c3528e55b Mon Sep 17 00:00:00 2001 From: Orville Wright Date: Tue, 28 May 2024 13:46:56 -0700 Subject: [PATCH] refactor (README.md) to align with new v4.0 gtihub layout Align this readme with the new post-archive GitHub repo structure and the main org readme design & message Signed-off-by: Dave Brace --- README.md | 80 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 54 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 95ba28c2c..302e79a6c 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,73 @@ # Welcome to OpenEBS -
-We are an ultra-modern Block Mode storage platform, a Hyper-Converged software Storage System and an Enterprise Grade virtual NVMe-oF SAN (vSAN) Fabric that is natively & very tightly integrated into Kubernetes.
+[![OpenEBS Welcome Banner](https://github.com/openebs/community/blob/develop/images/community_banner_retro_gamer_level-up-2024_transp.png)](https://www.openebs.io/) + +OopenEBS is a modern Block-Mode storage platform, a Hyper-Converged software Storage System and virtual NVMe-oF SAN (vSAN) Fabric that is natively & tightly integrated into the core of Kubernetes.

> [!IMPORTANT] > **OpenEBS provides**...
> - Stateful persistent Dynamically provisioned storage volumes for Kubernetes > - High Performance NVMe-oF storage access optimized for All-Flash Solid State storage media -> - is a 100% Cloud-Native storage platform -> - Delivers a Kubernetes cluster-wide vSAN fabric that provides containers/Pods with resilient access to storage across the entire cluster. +> - Block devices, LVM, ZFS, ext2/ext3/ext4, XFS, BTRFS...and more +> - 100% Cloud-Native K8s declarative storage platform +> - A cluster-wide vSAN block-mode fabric that provides containers/Pods with HA resilient access to storage across the entire cluster. +> - Node local K8s PV's and n-way Replciated K8s PV's +> - Deployable On-premise & in-cloud: (AWS EC2/EKS, Google GCP/GKE, Azure VM/AKS, Oracle OCI, IBM/RedHat OpenShift, Civo Cloud, Hetzner Cloud... and more) > - Enterprise Grade data management capabilities such as **snapshots, clones, replicated volumes, DiskGroups, Volume Groups, Aggregates, RAID**

-### Multiple Storage Engines -OpenEBS is a Kubernetes provides Persistent Stateful Storage Platform that has **5 core Data-Engines**
-Each Storage engine provides different Capabilities, Flexibility, Resilience, Data Protections, and Performance features.
- -| ID | Data-Engines | Where to create your issues | -| :---: | :--- | :--- | -| | ```Replicated PV``` | ```Replicated storage and data volumes``` | -| 1 | [Replicated PV Mayastor](https://github.com/openebs/mayastor) | Distributed vSAN Fabric attached volumes that are replicated | -|   | | -| | ```Local PV``` | ```Non-replicated node local storage and volumes``` | | -| 2. | [Local PV HostPath](https://github.com/openebs/dynamic-localpv-provisioner) | Dynamically provisioned Node-local volumes with **```Hostpath```** resident backend data | -| 3. | [Local PV ZFS](https://github.com/openebs/zfs-localpv) | Dynamically provisioned Node-local volumes with an integrated **```ZFS```** storage backend | -| 4. | [Local PV LVM](https://github.com/openebs/lvm-localpv) | Dynamically provisioned Node-local volumes with an integrated **```LVM```** storage backend | -| 5. | [Local PV Raw-device-File](https://github.com/openebs/rawfile-localpv) | Dynamically provisioned Node-local volumes via **```soft-lun RAW Device files```** on ```Hostpath``` resident backend filesystem | +## **openEBS has 2 Editions**:
+> | 1. ** STANDARD ** :heavy_check_mark: > ```Ready Player 1``` | +> | - | +> | 2. ** LEGACY ** :warning: ```Game Over``` | + +Within **STANDARD**, you have a choice of 2 Types of K8s Storage Services. ```Replicated PV``` and ```Local PV```. + +---
+ +| Type | Storage Engine | Type of data services | Status | In OSS ver | +| :---: | :--- | :--- | :--- | :---: | +| ```Replicated_PV``` | | Replicated data volumes (in a Cluster wide vSAN block mode fabric) | | | +| [Replicated PV Mayastor](https://github.com/openebs/mayastor) | [Mayastor](https://github.com/openebs/mayastor) | for High Availability deploymemnts distributing & replicating volumes across the cluster | Stable, deployable in PROD
[![Releases](https://img.shields.io/github/release/openebs/Mayastor/all.svg?style=flat-square)]() | v4.0.1 | +| |   | | | | +| ```Local PV``` | | Non-replicated node local data volumes | (Local-PV has multiple variants. See below) | v4.0.1 | +| [Local PV Hostpath](https://github.com/openebs/dynamic-localpv-provisioner) | [Local PV HostPath](https://github.com/openebs/dynamic-localpv-provisioner) | for integration with local node hostpath (e.g. /mnt/fs1) | Stable, deployable in PROD
[![Releases](https://img.shields.io/github/release/openebs/dynamic-localpv-provisioner/all.svg?style=flat-square)]() | v4.0.1 | +| [Local PV ZFS](https://github.com/openebs/zfs-localpv) | [Local PV ZFS](https://github.com/openebs/zfs-localpv) | for integration with local ZFS storage deployments | Stable, deployable in PROD
[![Releases](https://img.shields.io/github/release/openebs/zfs-localpv/all.svg?style=flat-square)]() | v4.0.1 | +| [Local PV LVM2](https://github.com/openebs/lvm-localpv) | [Local PV LVM](https://github.com/openebs/lvm-localpv) | for integration with local LVM2 storage deployments | Stable, deployable in PROD
[![Releases](https://img.shields.io/github/release/openebs/lvm-localpv/all.svg?style=flat-square)]() | v4.0.1 | +| [Local PV Rawfile](https://github.com/openebs/rawfile-localpv) | [Local PV Rawfile](https://github.com/openebs/rawfile-localpv) | for integration with Loop mounted Raw device-file filesystem | Stable, deployable in PROD, undergoing evaluation & integration
```release: v0.70``` | v4.0.1 |
-> **OpenEBS is very popular** : Live OpenEBS systems actively report back product metrics every day, to our Global Anaytics metrics engine (unless disabled by the user). -> Here are our key project popularity metrics as of: 01 Feb 2024
+**STANDARD** (Open Source Standard) is our Ultra modern Datastore stack that is strongly aligned with the cutting edge direction of storage use-cases in the K8s industry. It is designed to facilitate modern K8s datastore architectures, key K8s I/O patterns, K8s data access methods, K8s data use-cases and where K8s Datastore applications are heading. +
+ + +STANDARD is optimized for NVMe and SSD Flash storage media, and integrates ultra modern cutting-edge high performance storage technologies at its core... + > -> :rocket:   OpenEBS is the #1 deployed Storage Platform for Kubernetes
-> :star:   We are the [#1 GitHub Star ranked](https://github.com/openebs/website/blob/main/website/public/images/png/github_star-history-2024_Feb_1.png) K8s Data Storage platform
-> :floppy_disk:   We have +49 Million Volumes deployed globally
-> :tv:   We have +8 Million Global installations
-> :zap:   1 Million OpenEBS K8s Containers are spawned per week
-> :sunglasses:   1.1 Million global users
+> :ballot_box_with_check:   It uses the High performance [SPDK](https://spdk.io) storage stack - (SPDK is an open-source NVMe project initiated by INTEL)
+> :ballot_box_with_check:   The hyper modern [IO_Uring](https://github.com/axboe/liburing) Linux Kernel Async polling-mode I/O Interface - (fastest kernel I/O mode possible)
+> :ballot_box_with_check:   Native abilities for RDMA and Zero-Copy I/O
+> :ballot_box_with_check:   NVMe-oF TCP Block storage Hyper-converged data fabric
+> :ballot_box_with_check:   Block layer volume replication
+> :ballot_box_with_check:   Logical volumes and Diskpool based data managment
+> :ballot_box_with_check:   a Native high performance [Blobstore](https://spdk.io/doc/blob.html)
+> :ballot_box_with_check:   Native Block layer Thin provisioning
+> :ballot_box_with_check:   Native Block layer Snapshots and Clones
+--- + +> **OpenEBS is very popular :**
+> Live OpenEBS systems actively report back product telemetry each day, to our Global Analytics system (unless disabled by the user).
+> Below are our project popularity & pentration metrics as of: 01 May 2024
+> +> :rocket:   OpenEBS is the **#1 deployed** Storage ```Platform``` for Kubernetes
+> :star:   We are the [#1 GitHub Star ranked](https://github.com/openebs/website/blob/main/website/public/images/png/github_star-history-2024_Feb_1.png) K8s Data Storage platform
+> :floppy_disk:   We have **+49 Million** Volumes deployed globally
+> :tv:   We have **+9 Million** Global Live Nodes
+> :zap:   **1 Million** OpenEBS K8s Containers are ```spawned per week```
+> :sunglasses:   **1.7 Million** ```User Installations ```

We have a very large [active community](https://github.com/openebs/community), and many storage users [contribute to our product](https://github.com/openebs/community/blob/develop/CONTRIBUTING.md) with discussions, ideas, Issues, Feature requests and even code contribnutions.