Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openebs/zfs-localpv
Dynamically provision Stateful Persistent Node-Local Volumes & Filesystems for Kubernetes that is integrated with a backend ZFS data storage stack.
https://github.com/openebs/zfs-localpv
csi csi-driver kubernetes kubernetes-local-pv kubernetes-local-storage kubernetes-storage openebs openebs-storage storage storage-api storage-engine zfs zfs-snapshots zfsonlinux
Last synced: 3 days ago
JSON representation
Dynamically provision Stateful Persistent Node-Local Volumes & Filesystems for Kubernetes that is integrated with a backend ZFS data storage stack.
- Host: GitHub
- URL: https://github.com/openebs/zfs-localpv
- Owner: openebs
- License: apache-2.0
- Created: 2019-08-21T08:57:13.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-20T08:50:58.000Z (about 2 months ago)
- Last Synced: 2024-12-24T20:36:57.265Z (about 2 months ago)
- Topics: csi, csi-driver, kubernetes, kubernetes-local-pv, kubernetes-local-storage, kubernetes-storage, openebs, openebs-storage, storage, storage-api, storage-engine, zfs, zfs-snapshots, zfsonlinux
- Language: Go
- Homepage: https://openebs.io
- Size: 30.8 MB
- Stars: 447
- Watchers: 27
- Forks: 107
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
- awesome-starred - openebs/zfs-localpv - CSI Driver for dynamic provisioning of Persistent Local Volumes for Kubernetes using ZFS. (kubernetes)
README
## OpenEBS Local PV ZFS
[](https://www.cncf.io/projects/openebs/)
[](./LICENSE)
[](https://github.com/openebs/zfs-localpv/actions/workflows/build.yml)
[](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fzfs-localpv?ref=badge_shield&issueType=license)
[](https://www.bestpractices.dev/projects/3523)
[](https://kubernetes.slack.com/messages/openebs/)
[](https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1)
[](https://goreportcard.com/report/github.com/openebs/zfs-localpv)
[](https://clomonitor.io/projects/cncf/openebs)
[](https://artifacthub.io/packages/helm/openebs/openebs)
## Overview
### What is OpenEBS Local PV ZFS?
OpenEBS Local PV ZFS is a [CSI](https://github.com/container-storage-interface/spec) plugin for implementation of [ZFS](https://en.wikipedia.org/wiki/ZFS) backed persistent volumes for Kubernetes. It is a local storage solution, which means the device, volume and the application are on the same host. It doesn't contain any dataplane, i.e only its simply a control-plane for the kernel zfs volumes. It mainly comprises of two components which are implemented in accordance to the CSI Specs:
1. CSI Controller - Frontends the incoming requests and initiates the operation.
2. CSI Node Plugin - Serves the requests by performing the operations and making the volume available for the initiator.
### Why OpenEBS Local PV ZFS?
1. Lightweight, easy to set up storage provisoner for host-local volumes in k8s ecosystem.
2. Makes ZFS stack available to K8s, allowing end users to use the ZFS functionalites like snapshot, restore, clone, thin provisioning, resize, encryption, compression, dedup, etc for their Persistent Volumes.
3. Cloud native, i.e based on CSI spec, so developed to run on K8s.
### Architecture
LocalPV refers to storage that is directly attached to a specific node in the Kubernetes cluster. It uses locally available disks (e.g., SSDs, HDDs) on the node.
Use Case: Ideal for workloads that require low-latency access to storage or when data locality is critical (e.g., databases, caching systems).
#### Characteristics:
- Node-bound: The volume is tied to the node where the disk is physically located.
- No replication: Data is not replicated across nodes, so if the node fails, the data may become inaccessible.
- High performance: Since the storage is local, it typically offers lower latency compared to network-attached storage.
The diagram below depicts the mapping to the host disks, the ZFS stack on top of the disks and the kubernetes persistent volumes to be consumed by the workload. Local PV ZFS CSI Controller upon creation of the Persistent Volume Claim, creates a ZFSVolume CR, which emits an event for Local PV ZFS CSI Node Plugin to create the zvol/dataset. When workloads are scheduled the Local PV ZFS CSI Node Plugin makes this zvol/dataset available via a mount point on the host.
```mermaid
graph TD;
subgraph Node2["Node 2"]
subgraph K8S_NODE1[" "]
N1_PV1["PV"] --> N1_APP1["APP"]
N1_PV2["PV"] --> N1_APP2["APP"]
end
subgraph LVM_Stack2["ZFS Stack"]
V1_1 --> L1_1["ZVOL"]
V1_1 --> L3_1["ZVOL"]
L1_1 --> N1_PV1
L3_1 --> N1_PV2
end
subgraph Blockdevices1[" "]
D1["/dev/sdc"] --> V1_1["ZPOOL"]
D2["/dev/sdb"] --> V1_1["ZPOOL"]
end
end
subgraph Node1["Node 1"]
subgraph K8S_NODE2[" "]
N2_PV1["PV"] --> N2_APP1["APP"]
end
subgraph LVM_Stack1["ZFS Stack"]
V2_2 --> Z2_2["ZVOL"]
Z2_2 --> N2_PV1
end
subgraph Blockdevices2[" "]
D3["/dev/sdb"] --> V2_2["ZPOOL"]
end
end
classDef pv fill:#FFCC00,stroke:#FF9900,color:#000;
classDef app fill:#99CC00,stroke:#66CC00,color:#000;
classDef disk fill:#FF6666,stroke:#FF3333,color:#000;
classDef zfs fill:#99CCFF,stroke:#6699FF,color:#000;
class N1_PV1,N1_PV2,N2_PV1 pv;
class N1_APP1,N1_APP2,N2_APP1 app;
class D1,D2,D3 disk;
class V1_1,V2_2 zfs;
class L1_1,L3_1,Z2_2 zfs;
```
### Supported System
> | Name | Version |
> | :--- | :--- |
> | K8S | 1.23+ |
> | Distro | Alpine, Arch, CentOS, Debian, Fedora, NixOS, SUSE, RHEL, Ubuntu |
> | Kenel | oldest supported kernel is 2.6.32 |
> | ZFS | 0.7, 0.8, 2.2.3 |
> | Memory | ECC Memory is highly recommended |
> | RAM | 8GiB for best perf with Dedup enabled. (Will work with 2GiB or less without Dedup) |
Check the [features](./docs/features.md) supported for each k8s version.
### Documents
- [Prerequisites](./docs/quickstart.md#prerequisites)
- [Quickstart](./docs/quickstart.md#setup)
- [Developer Setup](./docs/developer-setup.md#development-workflow)
- [Testing](./docs/developer-setup.md#testing)
- [Contibuting Guidelines](./CONTRIBUTING.md)
- [Governance](./GOVERNANCE.md)
- [Changelog](./CHANGELOG.md)
- [Release Process](./RELEASE.md)
## Features
- [x] Access Modes
- [x] ReadWriteOnce
- ~~ReadOnlyMany~~
- ~~ReadWriteMany~~
- [x] Volume modes
- [x] `Filesystem` mode
- [x] `Block` mode
- [x] Supports fsTypes: `ext4`, `btrfs`, `xfs`, `zfs`
- [x] Volume metrics
- [x] [Snapshot]
- [x] [Create](docs/snapshot.md)
- [x] [Restore](docs/clone.md#create-clone-from-snapshot)
- [x] [Clone](docs/clone.md#create-clone-from-volume)
- [x] [Volume Resize](docs/resize.md)
- [x] [Raw Block Volume](docs/raw-block-volume.md)
- [x] [Backup/Restore](docs/backup-restore.md)
- [ ] Ephemeral inline volume
## Dev Activity dashboard
## License compliance
[](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fzfs-localpv?ref=badge_large&issueType=license)
## OpenEBS is a [CNCF Sandbox Project](https://www.cncf.io/projects/openebs)
