diff --git a/README.md b/README.md index 03716e3..a25ece1 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,20 @@ ![Image](https://img.shields.io/github/workflow/status/democratic-csi/democratic-csi/CI?style=flat-square) # Introduction -## What is Democratic-CSI? -`Democratic-CSI` implements the `csi` (Container Storage Interface) specifications +## What is Democratic-CSI? +`Democratic-CSI` implements the `csi` (Container Storage Interface) specifications providing storage for various container orchestration systems (*ie: Kubernetes, Nomad, OpenShift*). The current focus is providing storage via iSCSI or NFS from ZFS-based storage systems, predominantly `TrueNAS / FreeNAS` and `ZoL on Ubuntu`. -The current drivers implement the depth and breadth of the `csi` specifications, so you +The current drivers implement the depth and breadth of the `csi` specifications, so you have access to resizing, snapshots, clones, etc functionality. - ## What can Democratic-CSI offer? **Several implementations of `CSI` drivers** » `freenas-nfs` (manages zfs datasets to share over nfs) - » `freenas-iscsi` (manages zfs zvols to share over iscsi) + » `freenas-iscsi` (manages zfs zvols to share over iscsi) » `freenas-smb` (manages zfs datasets to share over smb) » `freenas-api-nfs` experimental use with SCALE only (manages zfs datasets to share over nfs) » `freenas-api-iscsi` experimental use with SCALE only (manages zfs zvols to share over iscsi) @@ -34,8 +33,8 @@ have access to resizing, snapshots, clones, etc functionality. » `node-manual` (allows connecting to manually created smb, nfs, lustre, and iscsi volumes, see sample PVs in the `examples` directory) - **Development** - » Framework for developing `CSI` drivers + **Development** + » Framework for developing `CSI` drivers If you have any interest in providing a `CSI` driver, simply open an issue to discuss. The project provides an extensive framework to build from making it