Skip to content

Commit 7fbbfb8

Browse files
authored
chore(README): add badges, adopters link, roadmap link, compatibility matrix, project status to README.md (#93)
* Add badges and adopters link * Add project status * Added Roadmap link * Add Kubernetes compatibility matrix Signed-off-by: Niladri Halder <[email protected]>
1 parent 4bb22c5 commit 7fbbfb8

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# Dynamic Kubernetes Local Persistent Volumes
2+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/openebs/dynamic-localpv-provisioner?color=orange&style=for-the-badge)](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/docs/quickstart.md)<br>
3+
[![GitHub build (develop)](https://github.com/openebs/dynamic-localpv-provisioner/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/openebs/dynamic-localpv-provisioner/actions/workflows/build.yml)
4+
[![GitHub go.mod Go version (develop)](https://img.shields.io/github/go-mod/go-version/openebs/dynamic-localpv-provisioner/develop?style=flat)](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/go.mod)
5+
[![codecov](https://codecov.io/gh/openebs/dynamic-localpv-provisioner/branch/develop/graph/badge.svg)](https://codecov.io/gh/openebs/dynamic-localpv-provisioner)
6+
[![Go Report Card](https://goreportcard.com/badge/github.com/openebs/maya)](https://goreportcard.com/report/github.com/openebs/maya)
7+
![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)
8+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/LICENSE)
29
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner?ref=badge_shield)
310

411

@@ -8,9 +15,10 @@
815
<strong>OpenEBS Dynamic Local PV provisioner</strong> can be used to dynamically provision
916
Kubernetes Local Volumes using different kinds of storage available on the Kubernetes nodes.
1017
<br>
11-
<br>
1218
</p>
1319

20+
## Project Status: Beta
21+
1422
Local Persistent Volumes are great for distributed cloud native data services that can handle resiliency and availability and expect low-latency access to the storage. Local Persistent Volumes can be provisioned using the hostpath, NVMe or PCIe based SSDs, Hard Disks or on top of other filesystems like ZFS, LVM.
1523

1624
Some of the targetted applications are:
@@ -42,6 +50,16 @@ differences include:
4250
attached to the node and hostpath based Local PVs offer efficient management
4351
of the storage available on the node.
4452

53+
## Kubernetes Compatibity Matrix
54+
55+
| | Kubernetes <= 1.15 | Kubernetes 1.16 | Kubernetes 1.17 | Kubernetes 1.18 | Kubernetes 1.19 | Kubernetes 1.20 | Kubernetes 1.21 | Kubernetes 1.22 |
56+
|-------------------------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------|
57+
| `localpv-provisioner-2.10.1`/`v2.10.1` |||||||||
58+
| `localpv-provisioner-2.11.1`/`v2.11.1` |||||||||
59+
| `localpv-provisioner-2.12.0`/`v2.12.0` |||||||||
60+
| `HEAD` |||||||||
61+
62+
4563
## Install
4664

4765
Please refer to our [Quickstart](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/docs/quickstart.md) and the [OpenEBS Documentation](http://docs.openebs.io/).
@@ -50,6 +68,14 @@ Please refer to our [Quickstart](https://github.com/openebs/dynamic-localpv-prov
5068

5169
Head over to the [CONTRIBUTING.md](./CONTRIBUTING.md).
5270

71+
## Roadmap
72+
73+
Find the Dynamic Local PV roadmap items at the [OpenEBS Roadmap page](https://github.com/openebs/openebs/blob/master/ROADMAP.md#dynamic-local-pvs).
74+
75+
## OpenEBS Adopters
76+
77+
Check out the list of organizations and users who have chosen OpenEBS to run their stateful workloads, over at the [OpenEBS Adopters page](https://github.com/openebs/openebs/blob/master/ADOPTERS.md).
78+
5379
## Community, discussion, and support
5480

5581
Learn how to engage with the OpenEBS community on the [community page](https://github.com/openebs/openebs/tree/master/community).
@@ -74,4 +100,4 @@ OpenEBS Local PV has been inspired by the prior work done by the following the K
74100

75101

76102
## License
77-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner?ref=badge_large)
103+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fdynamic-localpv-provisioner?ref=badge_large)

0 commit comments

Comments
 (0)