k8s-volume-mount

A tool to mount Kubernetes PersistentVolumeClaims (PVCs) to your local filesystem. This allows you to access data stored in Kubernetes volumes directly from your local machine.

Features

• Mount Kubernetes PVCs to your local filesystem
• Support for multiple storage providers:
  • WebDAV
  • NFS
  • SFTP
• Automatic port forwarding
• Easy to use command-line interface

Installation

Download the latest binary for your OS and move it to your PATH.

Prerequisites for usage

• kubectl configured with access to your Kubernetes cluster
• Mount libraries installed (depending on the provider you want to use)

Building from source

Go 1.24 or higher is required for building.

git clone https://github.com/yourusername/k8s-volume-mount.git
cd k8s-volume-mount
go build -o k8s-volume-mount

Installing dependencies

In general, rclone is recommended as it is also used for the server pod. Standard mount tools are also supported.

macOS

NFS support is built-in. For other protocols, rclone is recommended.
Don't install rclone via homebrew because the release does not include the rclone mount functionality.
(see official install instructions)

Ubuntu/Debian

# For WebDAV support
sudo apt-get install davfs2 # or rclone

# For NFS support
sudo apt-get install nfs-common

# For SFTP support
# use rclone

Usage

Mount a PVC

k8s-volume-mount mount -pvc=my-pvc -provider=webdav

Options:

• pvc: Name of the PersistentVolumeClaim to mount (required)
• port: Specific port for local port forwarding (optional, default: auto-detect)
• provider: Provider type to use (optional, default: webdav)
  • Available types: webdav, nfs, sftp

Unmount a PVC

k8s-volume-mount unmount -pvc=my-pvc

List mounted PVCs

k8s-volume-mount list

How it works

1. The tool creates a temporary deployment in your Kubernetes cluster that mounts the specified PVC
2. Depending on the provider type, it starts a server (WebDAV, NFS, SFTP) in the pod
3. It uses kubectl port-forward to set up port forwarding from your local machine to the pod
4. It mounts the remote filesystem to your local machine using the appropriate method

Configuration

The tool uses the following default directories:

• Temporary files: /tmp/k8s-volume-mount
• Mount base directory: k8s-mounts in your home directory

These can be overridden using environment variables:

• K8S_VOLUME_MOUNT_TEMP_DIR: Override the temporary directory
• K8S_VOLUME_MOUNT_BASE_DIR: Override the mount base directory

Logging

Additional logs are stored in the configured temporary directory.

Troubleshooting

Port already in use

If you see an error about a port already being in use, you can specify a different port with the -port option.

Connection issues

Make sure your kubectl is properly configured and you have access to the Kubernetes cluster. You can test this with:

kubectl get pvc

License

This project is licensed under the MIT License - see the LICENSE file for details.