This repository has been archived on 2026-06-16. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
headlamp-tns-csi-plugin/artifacthub-pkg.yml
T
Chris Farhood f1feb5c2f7 feat: native Headlamp integration, TrueNAS API, docs, and CI for v0.2.0
Native Headlamp integrations:
- registerResourceTableColumnsProcessor: add Protocol/Pool/Server columns to
  native StorageClass table and Protocol/Volume Handle to PV table
- registerDetailsViewSection: inject TNS-CSI section into PV detail pages
- registerDetailsViewSection: inject driver role/status into tns-csi Pod pages
- registerDetailsViewHeaderAction: Benchmark shortcut on StorageClass detail
- registerAppBarAction: driver health badge (N/Nc M/Mn, color-coded)
- Trim sidebar from 6 → 4 entries (Overview, Snapshots, Metrics, Benchmark)

TrueNAS API integration:
- src/api/truenas.ts: ConfigStore-backed settings, WebSocket JSON-RPC client
  for pool.query (auth.login_with_api_key + pool.query)
- src/components/TnsCsiSettings.tsx: API key + server override settings UI
  with connection test button
- TnsCsiDataContext: fetch real pool stats (size/allocated/free/status)
- OverviewPage: three-tier pool capacity display (real data → error → metrics
  fallback)

Documentation:
- README, CHANGELOG, CONTRIBUTING, SECURITY
- docs/: architecture, deployment (Helm), getting-started, user-guide,
  troubleshooting

CI:
- .github/workflows/ci.yaml: lint + type-check + test on PR/push
- .github/workflows/release.yaml: workflow_dispatch versioned release

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
2026-02-18 16:37:56 -05:00

66 lines
2.2 KiB
YAML

version: "0.1.0"
name: headlamp-tns-csi-plugin
displayName: TrueNAS CSI (tns-csi)
description: >-
Headlamp plugin for tns-csi CSI driver visibility and kbench storage
benchmarking. Surfaces StorageClasses with protocol/pool/server details,
PersistentVolumes, VolumeSnapshots, Prometheus metrics from the controller
pod, and an interactive kbench benchmark runner with FIO result cards.
Supports NFS, NVMe-oF, and iSCSI protocols. Read-only except for the
Benchmark page.
createdAt: "2026-02-18T00:00:00Z"
license: Apache-2.0
category: storage
homeURL: https://github.com/privilegedescalation/headlamp-tns-csi-plugin
appVersion: "0.1.0"
keywords:
- headlamp
- kubernetes
- storage
- csi
- tns-csi
- truenas
- nfs
- nvmeof
- iscsi
- kbench
- benchmarking
- prometheus
maintainers:
- name: privilegedescalation
email: chris@farhood.org
provider:
name: privilegedescalation
links:
- name: GitHub
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin
- name: Issues
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/issues
- name: tns-csi driver
url: https://github.com/fenio/tns-csi
- name: kbench
url: https://github.com/longhorn/kbench
changes:
- kind: added
description: "Overview dashboard: driver health, storage summary, protocol distribution, non-Bound PVC alerts"
- kind: added
description: "Storage Classes, Volumes, Snapshots pages with slide-in detail panels"
- kind: added
description: "Metrics page: Prometheus WebSocket health, volume ops, CSI ops from controller pod"
- kind: added
description: "Benchmark page: kbench Job+PVC lifecycle, FIO log parser, results with IOPS/bandwidth/latency cards"
- kind: added
description: "PVC detail injection: TNS-CSI section on Headlamp PVC detail pages"
annotations:
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.1.0/headlamp-tns-csi-plugin-0.1.0.tar.gz"
headlamp/plugin/archive-checksum: "sha256:14a3e8c13d0b894a41aa1cfccbcb1f6af09dcbb8fd95c7040a540987ea2096a7"
headlamp/plugin/version-compat: ">=0.20.0"
headlamp/plugin/distro-compat: "in-cluster,web,app"