{"id":13581695,"url":"https://github.com/dravanet/truenas-csi","last_synced_at":"2026-01-10T04:53:03.534Z","repository":{"id":37713183,"uuid":"379855735","full_name":"dravanet/truenas-csi","owner":"dravanet","description":"CSI driver utilizing TrueNAS for volume management","archived":false,"fork":false,"pushed_at":"2024-10-15T19:22:23.000Z","size":756,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-05T21:45:01.445Z","etag":null,"topics":["csi-driver","golang","truenas"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dravanet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-24T08:25:39.000Z","updated_at":"2024-10-15T19:22:27.000Z","dependencies_parsed_at":"2024-11-05T21:33:17.820Z","dependency_job_id":null,"html_url":"https://github.com/dravanet/truenas-csi","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dravanet%2Ftruenas-csi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dravanet%2Ftruenas-csi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dravanet%2Ftruenas-csi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dravanet%2Ftruenas-csi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dravanet","download_url":"https://codeload.github.com/dravanet/truenas-csi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247470450,"owners_count":20944146,"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-driver","golang","truenas"],"created_at":"2024-08-01T15:02:11.150Z","updated_at":"2026-01-10T04:53:03.485Z","avatar_url":"https://github.com/dravanet.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# github.com/dravanet/truenas-csi\n\nCSI driver utilizing TrueNAS for volume management.\n\nWarning: in __BETA__ state.\n\n## Deployment\n\nFor deployment, see [truenas-csi-chart](https://github.com/dravanet/truenas-csi-chart).\n\n## Configuration\n\n__TL;DR__ see [examples](examples).\n\nThe driver needs configuration to access one or more TrueNAS instances. Check [config.go](pkg/config/config.go) for full configuration structure.\n\nThe configuration has `yaml` syntax, must be passed to the application with `-controller-config` argument. This enables controller services.\n\nThe configuration file format is:\n```yaml\ntruenas-1: \u003ctruenas-config\u003e\nbackup: \u003ctruenas-config\u003e\ndefault: \u003ctruenas-config\u003e\n```\n\nA `truenas-config` has the structure:\n```\napiurl: \u003curl of truenas api\u003e\n[username: \u003cusername for api access\u003e]\n[password: \u003cpassword for api access\u003e]\n[apikey: \u003capi key for api access\u003e]\n[nfs: \u003cnfs configuration\u003e]\n[iscsi: \u003ciscsi configuration\u003e]\nconfigurations:\n  sub-config-1: \u003cconfiguration\u003e\n  default: \u003cconfiguration\u003e\n```\n\n`apikey` is recommended over `username`+`password`.\n\n`nfs` configuration has the strucure:\n```yaml\nserver: \u003cserver address\u003e\n[allowedhosts: [array of allowed hosts to access share]]\n[allowednetworks: [array of allowed networks to access share]]\n```\n\n`iscsi` configuration has the structure:\n```yaml\nportal: \u003cportal address\u003e\nportalid: \u003cportal id in TrueNAS\u003e\n```\n\nEach `configuration` section has the structure:\n```yaml\ndataset: \u003croot dataset\u003e\ndeletePolicy: [delete|retain]\n[sparse: [true|false]]\n[nfs: \u003cnfs sub-configuration\u003e]\n[iscsi: \u003ciscsi sub-configuration\u003e]\n```\n\n## Detailed operation\n\nDuring volume create, evaluating capability requests, the driver makes a decision to create an nfs or an iscsi share.\n\nThen a dataset is created under the selected `configuration` section. If nfs was chosen, an nfs export is created according to the selected configuration's nfs section. If iscsi was chosen, a new secret/target is created according to the selected configuration's iscsi section. Then, connection parameters are returned in the volume_context.\n\n## NAS configuration selection\n\nOn CreateVolume request, parameters may specify which TrueNAS to use, and may select its sub-configuration. Any of these parameters may be omitted, then `default` entries are looked up.\n\nParameter name | Effect\n---------------|--------\ntruenas-csi.dravanet.net/nas | NAS Selection\ntruenas-csi.dravanet.net/config | Sub-configuration selection\n\n## Implementation goals\n\n- Use TrueNAS API only.\n- Meet CSI requirements as much as can\n  - idempotency during volume operations\n  - implement as much capabilities\n\n## Capabilities\n\nThe following capabilities are supported from CSI Specification 1.3.0:\n\nPlugin:\n- online volume expansion\n\nController:\n- create/delete volume\n- expand-volume\n\nNode:\n- stage-unstage volume\n- get volume stats\n- expand volume\n\n## Planned features\n\n- Snapshot handling\n\n## Related projects\n\n- [TrueNAS](https://www.truenas.com/) itself is the NAS solution\n- [democratic-csi](https://github.com/democratic-csi/democratic-csi) is an existing implementation\n- [ganeti-extstorage-csi](https://github.com/dravanet/ganeti-extstorage-csi) is a Ganeti external storage driver utilizing CSI\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdravanet%2Ftruenas-csi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdravanet%2Ftruenas-csi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdravanet%2Ftruenas-csi/lists"}