From 9a5cec5cb0aab9d55a5a17a33de81b439a8a13ce Mon Sep 17 00:00:00 2001 From: Jonas Rosland Date: Mon, 14 Apr 2025 11:54:23 -0400 Subject: [PATCH] docs: enhance README with project overview and key features Signed-off-by: Jonas Rosland --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 97225660..3d21bc96 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ # VAST Data CSI Driver +The VAST Data CSI Driver allows Kubernetes clusters to dynamically provision persistent volumes on VAST Data storage systems. + +## Overview + +This driver implements the [Container Storage Interface (CSI)](https://github.com/container-storage-interface/spec) specification for container orchestrators like Kubernetes to manage the lifecycle of VAST Data storage. + +### Key Features + +- Dynamic volume provisioning (NFS and Block Storage) +- Snapshots and clones +- Volume resizing +- Ephemeral volumes +- Multi-tenancy support +- Container Object Storage Interface (COSI) support +- Quality of Service (QoS) policies +- Multiple VAST clusters support +- ARM architecture support + +## Official Documentation + The source-code in this repository is for informational purposes only. It is not meant to be used directly. -If you wish to use our driver with your VAST storage system, please refer to our [official documentation](https://support.vastdata.com/s/topic/0TOV40000000TwTOAU/vast-csi-driver-23-administrators-guide). +If you wish to use our driver with your VAST storage system, please refer to our [official documentation](https://support.vastdata.com/s/topic/0TOV400000026yzOAA/vast-csi-driver). + +## Support -Avoid opening issues in this within this project. +Avoid opening issues within this project for support requests. If you need support, please use VAST's Customer Support channels - https://support.vastdata.com