Skip to content

Add TrueNAS Scale CSI to CSI drivers list #618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add TrueNAS Scale CSI to CSI drivers list #618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions book/src/drivers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ Name | CSI Driver Name | Compatible with CSI Version(s) | Description | Persiste
[TopoLVM](https://github.com/topolvm/topolvm)| `topolvm.io` | v1.1 | A Container Storage Interface (CSI) Driver for LVM | Persistent | Read/Write Single Node | Yes | Raw Block, Expansion, Topology, Snapshot, Cloning, Storage Capacity Tracking
[Toyou CSI](https://github.com/TydsManagement/Toyou-CSI) | `csi.toyou.com` | v1.9 | A Container Storage Interface (CSI) Driver for [Toyou Storage](https://www.toyou.com.cn/) | Persistent | Read/Write Multiple Pods | Yes |
[TrueNAS](https://github.com/hpe-storage/truenas-csp) | `csi.hpe.com` | v1.3 | A community supported [Container Storage Provider](https://github.com/hpe-storage/container-storage-provider) (CSP) that leverages the HPE CSI Driver for Kubernetes. Works with TrueNAS CORE, TrueNAS SCALE and FreeNAS using iSCSI only | Persistent | Read/Write Multiple Pods | Yes | Raw Block, Snapshot, Expansion, Cloning
[TrueNAS Scale](https://github.com/titou10titou10/csi-driver-truenas-scale) | `tns.csi.titou10.org` | v0.9 | Driver for TrueNAS Scale via wss client API using zfs features on server and NFS on pods| Persistent | Read/Write Multiple Pods | Yes | Snapshot, Expansion, Cloning
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this driver different from the TrueNAS CSI driver that also works with TrueNAS SCALE?

Copy link
Author

@titou10titou10 titou10titou10 Mar 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which one?
csi.hpe.com? only for block devices

org.democratic-csi?

  • Requires only a Truenas API Token, no SSH access or additional configurations
  • Allow custom dataset naming, with arbitrary name that may include pvc/pv name, for easier tracking
  • Includes a unique archiving feature (same as in the"official" csi nfs driver..)
  • Dedicated to TrueNAS Scale written in go, vs a "generic" driver

..and for this comment in democratic csi: democratic-csi/democratic-csi#436 (comment)
As the REST API is deprecated in the coming version of TrunasSCALE, the democratic CSI driver developpers will fallback to using ssh access and so not alleviate the WebSocket API setup simplicity offered by Truenas Scale v25.04+

Ref: https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/

The TrueNAS REST API is deprecated in TrueNAS 25.04. Full removal of the REST API is planned for a future release.

[VAST Data](https://github.com/vast-data/vast-csi) | `csi.vastdata.com` | v1.2 | A Container Storage Interface (CSI) Driver for VAST Data | Persistent and Ephemeral | Read/Write Multiple Pods | Yes | Snapshot, Expansion
[XSKY-EBS](https://xsky-storage.github.io/xsky-csi-driver/csi-block.html) | `csi.block.xsky.com` | v1.0 | A Container Storage Interface (CSI) Driver for XSKY Distributed Block Storage (X-EBS) | Persistent | Read/Write Single Pod | Yes | Raw Block, Snapshot, Expansion, Cloning
[XSKY-FS](https://xsky-storage.github.io/xsky-csi-driver/csi-fs.html) | `csi.fs.xsky.com` | v1.0 | A Container Storage Interface (CSI) Driver for XEDP，XEUS，XUDS，XGFS，X3000，X5000 | Persistent | Read/Write Multiple Pods | Yes | Snapshot, Expansion
Expand Down