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.

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

Conversation

titou10titou10
Copy link

This PR adds TrueNAS Scale CSI to the list of CSI drivers in the community. The TrueNAS Scale CSI drivers provide an interface between CSI-enabled Container Orchestrators and a TrueNAS Scale server, enabling seamless integration and management of containerized applications. By adding TrueNAS Scale CSI to the list, users and developers will have a comprehensive view of available CSI drivers and can benefit from the features and functionality provided by the TrueNAS Scale CSI driver. This contribution enhances the ecosystem of CSI drivers and expands the options for users deploying containerized workloads.

@k8s-ci-robot
Copy link
Contributor

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Mar 14, 2025
@k8s-ci-robot k8s-ci-robot requested review from lpabon and saad-ali March 14, 2025 14:44
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: titou10titou10
Once this PR has been reviewed and has the lgtm label, please assign xing-yang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

linux-foundation-easycla bot commented Mar 14, 2025

CLA Signed

  • ✅login: titou10titou10 / (aa63ba1)

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @titou10titou10!

It looks like this is your first PR to kubernetes-csi/docs 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/docs has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 14, 2025
@@ -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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants