https://github.com/openebs/rawfile-localpv
Dynamically deploy Stateful Persistent Node-Local Volumes & Filesystems for Kubernetes that is provisioned from RAW-device file loop mounted Local-Hostpath storage.
https://github.com/openebs/rawfile-localpv
csi csi-driver experimental hacktoberfest hostpath kubernetes volume
Last synced: 6 months ago
JSON representation
Dynamically deploy Stateful Persistent Node-Local Volumes & Filesystems for Kubernetes that is provisioned from RAW-device file loop mounted Local-Hostpath storage.
- Host: GitHub
- URL: https://github.com/openebs/rawfile-localpv
- Owner: openebs
- License: apache-2.0
- Created: 2020-05-21T08:19:30.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-12T02:47:16.000Z (6 months ago)
- Last Synced: 2025-04-12T03:29:33.812Z (6 months ago)
- Topics: csi, csi-driver, experimental, hacktoberfest, hostpath, kubernetes, volume
- Language: Python
- Homepage: https://openebs.io
- Size: 275 KB
- Stars: 77
- Watchers: 9
- Forks: 28
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
README
## RawFile-LocalPV [Experimental]
The RawFile-LocalPV OpenEBS Data-Engine is a similar but more flexible, yet more complex derivation of the LocalPV-Hostpath Data-Engine.
This are a few reasons to consider using node-based (rather than network-based) storage architetcure:
> - Performance: Almost no network-based storage solution can keep up with baremetal disk performance in terms of IOPS/latency/throughput combined. And you’d like to get the best out of the SSD you’ve got!
> - On-premise Environment: You might not be able to afford the cost of upgrading all your networking infrastructure, to get the best out of your network-based storage solution.
> - Complexity: Network-based solutions are distributed systems. And distributed systems are not easy! You might want to have a system that is easier to understand and to reason about. Also, with less complexity, you can fix unpredicted issues more easily.
### Using node-based storage
The OpenEBS LocalPV-HostPath Data-Engine makes it pretty easy to automatically provision hostPath PVs and use them in your workloads. But, there are known limitations though:
> [!IMPORTANT]
> - You can’t monitor volume usage: There are hacky workarounds to run “du” regularly, but that could prove to be a performance killer, since it could put a lot of burden on your CPU and cause your filesystem cache to fill up. Not really good for a production workload.
> - You can’t enforce hard limits on your volume’s size: Again, you can hack your way around it, with the same caveats.
> - You are stuck with whatever filesystem your kubelet node is offering.
> - You can’t customize your filesystem.
### All the above issues stem from the same root cause:
- hostPath/LocalPVs are simple bind-mounts from the host filesystem into the pod.
### The idea behind RawFile-LocalPV
To use a Filesystem based 'extent file' as the emulated block device (i.e. a soft-LUN block device), and leverage the LINUX loop device to associate that soft-LUN file as a complete flexibe block device (i.e. an emulated soft disk device). At this point you can create a PV with a fileystem on it. This allows you to...
> [!NOTE]
> - You can monitor volume usage by running `df -hT` in `O(1)` since each soft-LUN block device is mounted separately on the local node (displaying utilization status/metrics or each mountpoint).
> - The size limit is enforced by the operating system, based on the backing file system capacity and soft-lun device file size.
> - Since volumes are backed by different files, each soft-lin device file can be formatted using different filesystems, and/or customized with different filesystem options.
### Prerequisites
---
- Kubernetes: 1.21+
## Installation
`helm install -n kube-system rawfile-csi ./deploy/charts/rawfile-csi/`
> Refer to chart's [README](./deploy/charts/rawfile-csi/README.md) to see the [values](./deploy/charts/rawfile-csi/values.yaml) documentation if you need to customize it
Usage
---
You can create one or more storage classes using chart, by default we have a storage class named `rawfile-localpv`, but you can change the name or other options by changing chart values
Features
---
- [x] Direct I/O: Near-zero disk performance overhead
- [x] Dynamic provisioning
- [x] Enforced volume size limit
- [x] Access Modes
- [x] ReadWriteOnce
- ~~ReadOnlyMany~~
- ~~ReadWriteMany~~
- [ ] Volume modes
- [x] `Filesystem` mode
- [ ] `Block` mode
- [x] Volume metrics
- [x] Supports fsTypes: `ext4`, `btrfs`, `xfs`
- [x] Online expansion: If fs supports it (e.g. ext4, btrfs, xfs)
- [ ] Online shrinking: If fs supports it (e.g. btrfs)
- [ ] Offline expansion/shrinking
- [ ] Ephemeral inline volume
- [x] Filesystem-level snapshots: `btrfs` supported
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Frawfile-localpv?ref=badge_large)