{"id":18927955,"url":"https://github.com/openebs/rawfile-localpv","last_synced_at":"2025-04-15T13:34:34.010Z","repository":{"id":41161058,"uuid":"265793550","full_name":"openebs/rawfile-localpv","owner":"openebs","description":"Dynamically deploy Stateful Persistent Node-Local Volumes \u0026 Filesystems for Kubernetes that is provisioned from RAW-device file loop mounted Local-Hostpath storage.","archived":false,"fork":false,"pushed_at":"2025-04-12T02:47:16.000Z","size":282,"stargazers_count":77,"open_issues_count":20,"forks_count":28,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2025-04-12T03:29:33.812Z","etag":null,"topics":["csi","csi-driver","experimental","hacktoberfest","hostpath","kubernetes","volume"],"latest_commit_sha":null,"homepage":"https://openebs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openebs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-21T08:19:30.000Z","updated_at":"2025-04-11T19:26:59.000Z","dependencies_parsed_at":"2025-03-02T16:28:08.687Z","dependency_job_id":"7e8116ee-346a-4083-8049-09ee14d92fda","html_url":"https://github.com/openebs/rawfile-localpv","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Frawfile-localpv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Frawfile-localpv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Frawfile-localpv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Frawfile-localpv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openebs","download_url":"https://codeload.github.com/openebs/rawfile-localpv/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249080714,"owners_count":21209566,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csi","csi-driver","experimental","hacktoberfest","hostpath","kubernetes","volume"],"created_at":"2024-11-08T11:21:55.923Z","updated_at":"2025-04-15T13:34:34.003Z","avatar_url":"https://github.com/openebs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Frawfile-localpv.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Frawfile-localpv?ref=badge_shield)--\u003e\n\n## RawFile-LocalPV [Experimental]\nThe RawFile-LocalPV OpenEBS Data-Engine is a similar but more flexible, yet more complex derivation of the LocalPV-Hostpath Data-Engine. \u003cBR\u003e\n\nThis are a few reasons to consider using node-based (rather than network-based) storage architetcure:\n\u003e - 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!\n\u003e - 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.\n\u003e - 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.\n\n### Using node-based storage\nThe 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:\n\n\u003e [!IMPORTANT]\n\u003e - 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.\n\u003e - You can’t enforce hard limits on your volume’s size: Again, you can hack your way around it, with the same caveats.\n\u003e - You are stuck with whatever filesystem your kubelet node is offering.\n\u003e - You can’t customize your filesystem.\n\n\u003cBR\u003e\n### All the above issues stem from the same root cause: \n   - hostPath/LocalPVs are simple bind-mounts from the host filesystem into the pod.\n\n### The idea behind RawFile-LocalPV \nTo 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...\n\u003e [!NOTE]\n\u003e - 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).\n\u003e - The size limit is enforced by the operating system, based on the backing file system capacity and soft-lun device file size.\n\u003e - 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.\n\n\n### Prerequisites\n---\n\n- Kubernetes: 1.21+\n\n## Installation\n\n`helm install -n kube-system rawfile-csi ./deploy/charts/rawfile-csi/`\n\n\u003e 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\n\nUsage\n---\n\nYou 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\n\nFeatures\n---\n\n- [x] Direct I/O: Near-zero disk performance overhead\n- [x] Dynamic provisioning\n- [x] Enforced volume size limit\n- [x] Access Modes\n  - [x] ReadWriteOnce\n  - ~~ReadOnlyMany~~\n  - ~~ReadWriteMany~~\n- [ ] Volume modes\n  - [x] `Filesystem` mode\n  - [ ] `Block` mode\n- [x] Volume metrics\n- [x] Supports fsTypes: `ext4`, `btrfs`, `xfs`\n- [x] Online expansion: If fs supports it (e.g. ext4, btrfs, xfs)\n- [ ] Online shrinking: If fs supports it (e.g. btrfs)\n- [ ] Offline expansion/shrinking\n- [ ] Ephemeral inline volume\n- [x] Filesystem-level snapshots: `btrfs` supported\n\n## License\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fopenebs%2Frawfile-localpv.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Frawfile-localpv?ref=badge_large)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenebs%2Frawfile-localpv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenebs%2Frawfile-localpv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenebs%2Frawfile-localpv/lists"}