Skip to content

Commit

Permalink
chore: update changelog, release and readme
Browse files Browse the repository at this point in the history
Signed-off-by: Abhinandan Purkait <[email protected]>
  • Loading branch information
Abhinandan-Purkait committed Jan 29, 2025
1 parent 5a919bf commit 79b2923
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 23 deletions.
10 changes: 7 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
v2.6.2 / 2024-09-25
========================
* Cherry-pick #552 ([#552](https://github.com/openebs/zfs-localpv/pull/552),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* fix(chart): handle trailing slash (/) in csi plugin kubelet directory ([#532](https://github.com/openebs/zfs-localpv/pull/532),[@w3aman](https://github.com/w3aman))
* fix(chart): remove anti-affinity from csi controller ([#552](https://github.com/openebs/zfs-localpv/pull/552),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))

v2.6.1 / 2024-09-17
========================
* Cherry-pick CI changes ([#583](https://github.com/openebs/zfs-localpv/pull/548),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* Cherry-pick PR 575 into release/2.6 branch ([#575](https://github.com/openebs/zfs-localpv/pull/575),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* ci: enhance pull_request workflow ([#557](https://github.com/openebs/zfs-localpv/pull/557),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* ci: add branch preparation and release CI changes ([#567](https://github.com/openebs/zfs-localpv/pull/567),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* chore: cleanup unused scripts, update make manifests ([#569](https://github.com/openebs/zfs-localpv/pull/569),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))
* chore: replace CRD with auto-generated copy ([#564](https://github.com/openebs/zfs-localpv/pull/548),[@niladrih](https://github.com/niladrih))
* chore(deps): update analytics dependency ([#578](https://github.com/openebs/zfs-localpv/pull/578),[@niladrih](https://github.com/niladrih))
* fix: chart.yaml indentation ([#586](https://github.com/openebs/zfs-localpv/pull/586),[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait))

v2.6.0 / 2024-07-03
Expand Down
52 changes: 33 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ OpenEBS ZFS LocalPV is a [CSI](https://github.com/container-storage-interface/sp
2. CSI Node Plugin - Serves the requests by performing the operations and making the volume available for the initiator.

### Why OpenEBS ZFS LocalPV?
1. Light weight, easy to setup storage provisoner for provisioning node local volumes in k8s ecosystem.
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 certified to run on K8s.

Expand All @@ -30,37 +30,51 @@ LocalPV refers to storage that is directly attached to a specific node in the Ku
- <b>No replication</b>: Data is not replicated across nodes, so if the node fails, the data may become inaccessible.
- <b>High performance</b>: 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. ZFS LocalPV CSI Controller upon creation of the Persistent Volume Claim, creates a ZFSVolume CR, which emits an event for ZFS LocalPV CSI Node Plugin to create the zvol/dataset. When workloads are scheduled the ZFS LocalPV CSI Node Plugin makes this zvol/dataset available via a mount point on the host.

```mermaid
graph TD;
subgraph Node1["Node 1"]
subgraph K8S NODE 1[" "]
NODE_1_PV1["PV 1"] --> NODE_1_APP1["APP 1"]
NODE_1_PV2["PV 2"] --> NODE_1_APP2["APP 2"]
subgraph Node2["Node 2"]
subgraph K8S_NODE1[" "]
N1_PV1["PV"] --> N1_APP1["APP"]
N1_PV2["PV"] --> N1_APP2["APP"]
end
subgraph ZFS Stack 2["ZFS Stack"]
ZPOOL_1_1 --> ZVOL1_1["ZVOL 1"]
ZPOOL_1_1 --> ZVOL3_1["ZVOL 2"]
ZVOL1_1["ZVOL 1"] --> NODE_1_PV1
ZVOL3_1["ZVOL 2"] --> NODE_1_PV2
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[" "]
NODE_1_DISK_1["/dev/sdc"] --> ZPOOL_1_1["ZPOOL"]
NODE_1_DISK_2["/dev/sdb"] --> ZPOOL_1_1["ZPOOL"]
D1["/dev/sdc"] --> V1_1["ZPOOL"]
D2["/dev/sdb"] --> V1_1["ZPOOL"]
end
end
subgraph Node2["Node 2"]
subgraph K8S NODE 2[" "]
NODE_2_PV1["PV 1"] --> NODE_2_APP1["APP 1"]
subgraph Node1["Node 1"]
subgraph K8S_NODE2[" "]
N2_PV1["PV"] --> N2_APP1["APP"]
end
subgraph ZFS Stack 1["ZFS Stack"]
ZPOOL_2_2 --> ZVOL_2_2["ZVOL 1"]
ZVOL_2_2["ZVOL 1"] --> NODE_2_PV1
subgraph LVM_Stack1["ZFS Stack"]
V2_2 --> Z2_2["ZVOL"]
Z2_2 --> N2_PV1
end
subgraph Blockdevices2[" "]
NODE_2_DISK["/dev/sdb"] --> ZPOOL_2_2["ZPOOL"]
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
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Release Process
zfs-localpv follows a on quaterly release cadence for minor version releases. The scope of the release is determined by contributor availability. The scope is published in the [Release Tracker Projects](https://github.com/orgs/openebs/projects/78).

## Prerelease Candidate Verification Checklist
## Pre-release Candidate Verification Checklist

Every release has a prerelease tag that gets created on branch creation, explained further below. This prerelease tag is meant for all the below action items throughout the release process:
- Platform Verification
Expand Down

0 comments on commit 79b2923

Please sign in to comment.