Update README.md

Major tidy-up. Add community dev activity dashboard. remove project logo. add Hero status
openebs · Mar 29, 2024 · 278f7fa · 278f7fa
1 parent 4600558
commit 278f7fa
Showing 1 changed file with 61 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,48 +1,83 @@
-# OpenEBS ZFS CSI Driver
+## OpenEBS - ZFS-LocalPV CSI Driver
 [![Build Status](https://github.com/openebs/zfs-localpv/actions/workflows/build.yml/badge.svg)](https://github.com/openebs/zfs-localpv/actions/workflows/build.yml)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopenebs%2Fzfs-localpv.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopenebs%2Fzfs-localpv?ref=badge_shield)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3523/badge)](https://bestpractices.coreinfrastructure.org/en/projects/3523)
 [![Slack](https://img.shields.io/badge/chat!!!-slack-ff1493.svg?style=flat-square)](https://kubernetes.slack.com/messages/openebs/)
 [![Community Meetings](https://img.shields.io/badge/Community-Meetings-blue)](https://hackmd.io/yJb407JWRyiwLU-XDndOLA?view)
 [![Go Report](https://goreportcard.com/badge/github.com/openebs/zfs-localpv)](https://goreportcard.com/report/github.com/openebs/zfs-localpv)
 
-<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">
 
-CSI driver for provisioning Local PVs backed by ZFS and more.
+| [![opezfs](https://github.com/openebs/website/blob/main/website/public/images/svg/openzfs_logo_2024.svg.png "OpenZFS")](https://github.com/openebs/website/blob/main/website/public/images/svg/openzfs_logo_2024.svg.png) | The OpenEBS ZFS-LocalPV Data-Engine is a heavily deployed production grade CSI driver for dynamically provisioning Node Local Volumes into a K8s cluster utilizing the OpenZFS storage ZPool Data Mgmt stack as the storage backend. It integrates OpenZFS into the OpenEBS platform and exposes many ZFS services and capabilities.   |
+| :---  | :--- |
+<BR>
 
-## Project Status
 
-ZFS-LocalPV was declared GA in Dec 2020. Many users are running ZFS-LocalPV in production, see what our [adopters](./Adopters.md) are saying.
 
-## Project Tracker
+## Overview
 
-See [roadmap](https://github.com/orgs/openebs/projects/10), [e2e-wiki](https://github.com/openebs/zfs-localpv/wiki/ZFS-LocalPV-e2e-test-cases) and [e2e-test](https://github.com/openebs/e2e-tests/projects/7).
+The ZFS-LocalPV Data-Engine became GA on Dec 2020 and is now a core component of the OpenEBS storage platform. <BR>
+Due to the major adoption of ZFS-LocalPV (+120,000 users), this Data-Engine is now being unified and integrated into the core OpenEBS Storage platform; instead of being maintained as an external Data-Engine within our project.<BR>
 
-## Usage
+Our [2024 Roadmap is here](https://github.com/openebs/openebs/blob/main/ROADMAP.md). It defines a rich set of new featrues, which covers the integration of ZFS-LocalPV into the core OpenEBS platform.<br>
+Please review this roadmp and feel free to pass back any feedback on it, as well as recommend and suggest new ideas regarding ZFS-LocalPV. We welcome all your feedback.
+<br>
 
-### Prerequisites
+<BR>
+
+> **ZFS-LocalPV 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 Mar 2024 <BR>
+>
+> :rocket: &nbsp; OpenEBS is the #1 deployed Storage Platform for Kubernetes <BR>
+> :zap: &nbsp; ZFS-LocalPV is the 2nd most deployed Data-Engine within the platform <BR>
+> :sunglasses: &nbsp; ZFS-LocalPV has +120,000 Daily Acive Users <BR>
+> :sunglasses: &nbsp; ZFS-LocalPV has +250,000 Global instllations <BR>
+> :floppy_disk: &nbsp; +49 Million OpenEBS Volumes have been deployed globally <BR>
+> :tv: &nbsp; We have +8 Million Global OpenEBS installations <BR>
+> :star: &nbsp; 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 <BR>
+
+<BR>
+
+## Dev Activity dashboard
+![Alt](https://repobeats.axiom.co/api/embed/d990adda232a580d4c0fd9b98d6557079bb3bf4a.svg "Repobeats analytics image")
+
+## Project info
+
+The orignal v1.0 dev roadmap [is here ](https://github.com/orgs/openebs/projects/10). This tracks our base historical engineering development work and is now somewhat out of date. We will be publish an updated 2024 Unified Roadmp soon, as ZFS-LoalPV is now being integrated and unified into the core OpenEBS storage platform.<BR>
+- The E2E Wiki [is here ](https://github.com/openebs/zfs-localpv/wiki/ZFS-LocalPV-e2e-test-cases)
+- The E2S Tests [are here](https://github.com/openebs/e2e-tests/projects/7).
 
-Before installing the ZFS-LocalPV driver please make sure your Kubernetes Cluster meets the following prerequisites:
+<BR>
 
-1. all the nodes must have zfs utils installed
-2. ZPOOL has been setup for provisioning the volume
-3. You have access to install RBAC components into kube-system namespace.
-   The OpenEBS ZFS driver components are installed in kube-system namespace
-   to allow them to be flagged as system critical components.
+## Usage and Deployment
+
+### Prerequisites
+
+> [!IMPORTANT]
+> Before installing the ZFS-LocalPV driver please make sure your Kubernetes Cluster meets the following prerequisites:
+> 1. All the nodes must have ZFS utils package installed
+> 2. A ZPOOL has been configurred for provisioning volumes
+> 3. You have access to install RBAC components into kube-system namespace. The OpenEBS ZFS driver components are installed in kube-system namespace to allow them to be flagged as system critical components.
+<BR>
 
 ### Supported System
 
-| Name | Version |
-| :--- | :--- |
-| K8S | 1.20+ |
-| OS | Ubuntu, CentOS |
-| ZFS | 0.7, 0.8 |
+> | Name | Version |
+> | :--- | :--- |
+> | K8S | 1.20+ |
+> | Distro | Alpine, Arch, CentOS, Debian, Fedora, NixOS, SUSE, RHEL, Ubuntu |
+> | Kenel | oldest supported kernel is 2.6.32 |
+> | ZFS | 0.7, 0.8, 2.2.3 |
+> | Memory | ECC Memory is highly recommended |
+> | RAM | 8GiB for best perf with Dedupe enabled. (Will work with 2GiB or less without dedupe) |
 
 Check the [features](./docs/features.md) supported for each k8s version.
 
-### Setup
+<BR>
+
+## Setup
+
+All nodes should have the same verion of zfsutils-linux installed. <BR>
 
-All the node should have zfsutils-linux installed. We should go to the each node of the cluster and install zfs utils :
 ```bash
 $ apt-get install zfsutils-linux
 ```
@@ -81,7 +116,9 @@ Configure the custom topology keys (if needed). This can be used for many purpos
 
 https://github.com/openebs/zfs-localpv/blob/HEAD/docs/faq.md#6-how-to-add-custom-topology-key
 
-### Installation
+<BR>
+
+## Installation
 In order to support moving data to a new node later on, you must label each node with a unique value for `openebs.io/nodeid`.
 For more information on migrating data, please [see here](docs/faq.md#8-how-to-migrate-pvs-to-the-new-node-in-case-old-node-is-not-accessible)
 
@@ -406,5 +443,5 @@ persistentvolumeclaim "csi-zfspv" deleted
 - [x] [Backup/Restore](docs/backup-restore.md)
 - [ ] Ephemeral inline volume
 
-## License
+## License compliance
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fopenebs%2Fzfs-localpv.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fopenebs%2Fzfs-localpv?ref=badge_large)