document k8s-csi-cleaner usage

Signed-off-by: Travis Glenn Hansen <travisghansen@yahoo.com>
2021-09-24 10:53:59 -06:00 · 2021-09-24 10:53:59 -06:00 · 20c40f14fb
parent dd8e82b37c
commit 20c40f14fb
1 changed files with 4 additions and 1 deletions
--- a/bin/k8s-csi-cleaner
+++ b/bin/k8s-csi-cleaner
@ -2,7 +2,10 @@

 /**
 * The purpose of this script is to prune volumes in the storage system which
- * do not have correlating PVs in k8s
+ * do not have correlating PVs in k8s.
+ * 
+ * kubectl -n democratic-csi exec -ti <controller pod> --container=csi-driver -- bash
+ * ./bin/k8s-csi-cleaner
 *
 * env vars:
 * # prevents manual input on a per-volume basis to confirm delete action