From a6a859fc0ea8e43743e70c90448c9530a7ed7c6d Mon Sep 17 00:00:00 2001 From: Mehran Kholdi Date: Tue, 28 Apr 2020 17:52:32 +0430 Subject: [PATCH] Add installation and usage instructions to readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 9f0d169..fe8a193 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,25 @@ RawFilePV Kubernetes LocalPVs on Steroids +Install +--- +`helm install -n kube-system rawfile-csi ./deploy/charts/rawfile-csi/` + +Usage +--- + +Create a `StorageClass` with your desired options: + +``` +apiVersion: storage.k8s.io/v1 +kind: StorageClass +metadata: + name: my-sc +provisioner: rawfile.hamravesh.com +reclaimPolicy: Delete +volumeBindingMode: WaitForFirstConsumer +``` + Features ---