https://github.com/fenio/pv-mounter

A tool to locally mount k8s PVs using SSHFS
https://github.com/fenio/pv-mounter

golang k8s plugin pv sshfs

Last synced: 30 days ago
JSON representation

A tool to locally mount k8s PVs using SSHFS

• Host: GitHub
• URL: https://github.com/fenio/pv-mounter
• Owner: fenio
• License: apache-2.0
• Created: 2024-05-20T02:08:36.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-05-21T16:23:57.000Z (about 1 month ago)
• Last Synced: 2024-05-22T04:00:04.463Z (about 1 month ago)
• Topics: golang, k8s, plugin, pv, sshfs
• Language: Go
• Homepage:
• Size: 7.74 MB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - fenio/pv-mounter - A tool to locally mount k8s PVs using SSHFS (Go)

README

        
# pv-mounter 

A tool to locally mount k8s PVs using SSHFS.

Might be used as `kubectl` plugin.

## Disclaimer

This tool was created with huge help of [ChatGPT-4o](https://chatgpt.com/?model=gpt-4o) and [perplexity](https://www.perplexity.ai/).

In fact I didn't have to write my own code almost at all but I had to spend a lot of time writing correct prompts for these tools.

I published it using Apache-2.0 license cause initial [repository](https://github.com/replicatedhq/krew-plugin-template) was licensed this way but to be honest I'm not sure how such copy&paste stuff should be licensed.

## Rationale

I often need to copy some files from my [homelab](https://github.com/fenio/homelab) which is running on k8s. Having ability to work on these files locally greatly simplifies this task.

Thus pv-mounter was born to automate that process.

## What exactly does it do?

Few things. Namely:

* spawns POD with minimalistic image that contains SSH daemon and binds to existing PVC

* creates port-forward to make it locally accessible

* mounts volume locally using SSHFS 

See also demo below.

## Prerequisities

* You need working SSHFS setup.

## Quick Start

```

kubectl krew install pv-mounter

kubectl pv-mounter mount   

kubectl pv-mounter clean   

```

Or you can simply grab binaries from [releases](https://github.com/fenio/pv-mounter/releases).

## Demo

![Demo](demo.gif)

## Limitations

### PVC with RWO access mode already mounted somewhere else

It's not possible to mount such PVC unless it's first unmounted.

I tried to workaround this by using ephemeral container but unfortunately they're too limited for that task as they can't expose port thus it's not possible to access them with SSHFS.

**UPDATE**

Some hack with reversed SSH tunnel might be workaround for that. I'll try this approach.

### Windows

Since I can't test Windows binaries they're now simply not included but I saw there is SSHFS implementation for Windows so in theory this should work.

## FAQ

Ask questions first ;)