docs

Author: fenio

docs/pv-mounter.md

@@ -0,0 +1,24 @@
+## pv-mounter
+
+Mount and unmount Kubernetes PersistentVolumes using SSHFS
+
+### Synopsis
+
+pv-mounter is a kubectl plugin that allows you to easily mount and unmount
+Kubernetes PersistentVolumeClaims (PVCs) locally via SSHFS.
+
+It transparently manages proxy pods, ephemeral containers, port-forwarding,
+and SSHFS connections.
+
+### Options
+
+```
+  -h, --help   help for pv-mounter
+```
+
+### SEE ALSO
+
+* [pv-mounter clean](pv-mounter_clean.md)	 - Clean up resources created by pv-mounter
+* [pv-mounter mount](pv-mounter_mount.md)	 - Mount a PersistentVolumeClaim (PVC) to a local directory using SSHFS.
+
+###### Auto generated by spf13/cobra on 16-Mar-2025

docs/pv-mounter_clean.md

@@ -0,0 +1,26 @@
+## pv-mounter clean
+
+Clean up resources created by pv-mounter
+
+### Synopsis
+
+Clean up resources created by pv-mounter.
+
+This command unmounts the local directory, terminates port-forwarding,
+removes any proxy pods created, and cleans up ephemeral containers.
+
+```
+pv-mounter clean <namespace> <pvc-name> <local-mount-point> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for clean
+```
+
+### SEE ALSO
+
+* [pv-mounter](pv-mounter.md)	 - Mount and unmount Kubernetes PersistentVolumes using SSHFS
+
+###### Auto generated by spf13/cobra on 16-Mar-2025

docs/pv-mounter_mount.md

@@ -0,0 +1,30 @@
+## pv-mounter mount
+
+Mount a PersistentVolumeClaim (PVC) to a local directory using SSHFS.
+
+### Synopsis
+
+Mount a PersistentVolumeClaim (PVC) to a local directory using SSHFS.
+
+This command sets up necessary Kubernetes resources and establishes an SSHFS connection
+to mount the specified PVC locally.
+
+```
+pv-mounter mount [flags] <namespace> <pvc-name> <local-mount-point>
+```
+
+### Options
+
+```
+      --debug                 Enable debug mode to print additional information (default: false)
+  -h, --help                  help for mount
+      --image string          Custom container image for the volume-exposer (optional)
+      --image-secret string   Kubernetes secret name for accessing private registry (optional)
+      --needs-root            Mount the filesystem using the root account (default: false)
+```
+
+### SEE ALSO
+
+* [pv-mounter](pv-mounter.md)	 - Mount and unmount Kubernetes PersistentVolumes using SSHFS
+
+###### Auto generated by spf13/cobra on 16-Mar-2025