headlamp-tns-csi-plugin/CHANGELOG.md

Changelog

All notable changes to the Headlamp TNS-CSI Plugin will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

• docs: namespace references — Updated all documentation, README, and ArtifactHub metadata to explicitly reference the headlamp namespace instead of generic "controller pod" language. RBAC examples now clearly scope pods/proxy access to kube-system where the tns-csi controller runs.

1.0.0 - 2026-03-24

Added

• Missing devDependencies — added @mui/material, @types/react, @types/react-dom, and notistack to devDependencies so the full test suite resolves correctly; upgraded vitest to ^3.2.4

Changed

• Test infrastructure fix — added define: { 'process.env.NODE_ENV': '"test"' } to vitest.config.mts to prevent React production-build act() errors; all 159 component tests now pass
• Version bump — bumped package version from 0.2.7 to 1.0.0 (stable release)
• Lock file — removed package-lock.json; pnpm-lock.yaml is now the canonical lock file
• Renovate config — extended from org-level preset (PR #18)
• GitHub Actions SHA pinning — added pinDigests to Renovate config for SHA-pinned Actions (PR #17)
• Dual-approval caller workflow — added dual-approval status check workflow to CI (PR #16)
• Release workflow — GitHub App token secrets now passed to release workflow (PR #15)

0.2.6 - 2026-03-04

Fixed

• PVC bind loop leak — benchmark page's PVC wait loop now checks a cancellation ref on unmount, preventing leaked async work after navigation
• DeleteOptions body — deleteJob now sends correct Kubernetes DeleteOptions with apiVersion and kind fields so foreground propagation is honored
• Snapshot filtering — TnsCsiDataContext now filters volume snapshots and snapshot classes to only tns-csi driver ones using filterTnsCsiVolumeSnapshots and isTnsCsiVolumeSnapshotClass (previously showed all drivers' snapshots)
• Stale closures in Escape handlers — closeSc / closeVolume in StorageClassesPage and VolumesPage wrapped in useCallback with proper deps, removing eslint-disable suppressions
• Cleanup button double-click — benchmark cleanup "Delete Job + PVC" button now has a cleaningUp loading state with disabled styling, replacing unsafe window.confirm/window.alert calls
• Dark mode protocol colors — replaced hardcoded hex colors in OverviewPage protocol chart with var(--mui-palette-*) tokens
• Import style consistency — unified React.useMemo to destructured useMemo in OverviewPage
• Lint warnings — fixed all 35 ESLint warnings (import sorting, indentation, boolean attributes, line length, chained call newlines)

0.2.4 - 2026-02-26

Added

• Component tests — 159 unit tests across 12 test files (up from 67 across 4)
• ESLint configuration — added .eslintrc.json so npm run lint works
• JUnit test reporter — CI posts test summary directly on PRs via dorny/test-reporter

Changed

• CI workflow — split into 4 parallel jobs (lint, typecheck, test, build) with build gating on the other three
• Release workflow — CI gate (needs: [ci]) prevents releases when checks fail; concurrency control prevents racing releases
• Node.js — upgraded from 20 to 22 (current LTS) in all workflows
• CI scripts — replaced inline npx commands with npm run scripts
• appVersion tracking — artifacthub-pkg.yml now tracks the latest upstream tns-csi release (0.12.0); release workflow auto-fetches it

Fixed

• Conditional hook — moved React.useMemo above early return in OverviewPage to fix react-hooks/rules-of-hooks violation
• Tarball name — release workflow now uses correct name tns-csi-VERSION.tar.gz (matching package.json name field)

0.2.3 - 2026-02-19

Changed

• Package name — renamed from headlamp-tns-csi-plugin to tns-csi so the plugin displays correctly in Headlamp's Plugins list

0.2.2 - 2026-02-19

Fixed

• Duplicate columns — Protocol and Pool columns on mixed-driver clusters (tns-csi + rook-ceph) are now merged into a single shared column rather than duplicated; whichever plugin loads first owns the column and the second merges into it
• Plugin settings name — settings entry now registers as tns-csi instead of headlamp-tns-csi-plugin

0.2.1 - 2026-02-19

Fixed

• OverviewPage crash — brace mismatch in TnsCsiDataContext placed TrueNAS pool stats fetch outside the outer try block, breaking the entire context provider
• PV Pool column — tns-csi driver writes datasetName (e.g. pool0/pvc-abc), not pool, into volumeAttributes; Pool is now correctly derived from the first path segment
• App bar badge removed — removed the colored tns-csi status bubble from the top nav bar

0.2.0 - 2026-02-18

Added

• Native Headlamp integration — Protocol/Pool/Server columns injected into the native StorageClass table; Protocol/Volume Handle columns into the native PV table
• PV Detail Injection — TNS-CSI section injected into Headlamp PV detail views with full CSI volume attributes
• Pod Detail Injection — Driver role/status section injected into tns-csi Pod detail pages (controller vs node role, ready status, restart count)
• StorageClass Benchmark button — "Benchmark" shortcut button added to tns-csi StorageClass detail page headers
• App Bar Badge — driver health badge in top nav bar showing tns-csi: N/Nc M/Mn (controller/node pod ready counts), color-coded green/orange/red
• Sidebar trim — reduced from 6 to 4 entries (Overview, Snapshots, Metrics, Benchmark); Storage Classes and Volumes accessible via direct URL
• TrueNAS API integration — WebSocket JSON-RPC client (pool.query) for real pool capacity (size/allocated/free/health status)
• Plugin settings page — API key and server address configuration with connection test button
• Three-tier pool capacity display — real TrueNAS API data → error hint → metrics-based provisioned-capacity fallback
• CI workflow — lint + type-check + test on every push and PR
• Release workflow — manual workflow_dispatch for versioned releases with automatic version bump, checksum, tag, and GitHub release creation
• Documentation — README, CHANGELOG, CONTRIBUTING, SECURITY, and full docs/ suite (architecture, deployment, user guide, troubleshooting)

0.1.0 - 2026-02-18

Added

• Overview Dashboard — driver health card, storage summary (StorageClass / PV / PVC counts), protocol distribution with PercentageBar, non-Bound PVC alert table, and live Prometheus metric snapshot
• Storage Classes page — table with Protocol, Pool, Server, Reclaim Policy, Expansion, and PV count columns; slide-in detail panel with protocol-specific prerequisite notes (NFS, NVMe-oF, iSCSI)
• Volumes page — PersistentVolume table with capacity, access modes, reclaim policy, phase status badge, and bound claim; slide-in detail panel with full CSI volume attributes
• Snapshots page — VolumeSnapshot table scoped to tns-csi VolumeSnapshotClasses; graceful degradation when snapshot CRD is not installed
• Metrics page — Prometheus WebSocket health indicator, per-volume I/O (read/write IOPS and bandwidth), CSI operation latency cards from controller pod port 8080
• Benchmark page — interactive kbench runner with StorageClass selection, capacity/access-mode configuration, Job+PVC lifecycle management, live FIO log streaming, and IOPS/bandwidth/latency result cards
• PVC Detail Injection — TNS-CSI section automatically injected into Headlamp's PVC detail views showing protocol, server, pool, volume handle, and link to the bound PV
• TnsCsiDataContext — shared React context provider for all plugin pages; extracts jsonData from Headlamp KubeObject instances so StorageClass parameters (protocol, pool, server) are accessible
• Prometheus text format parser — zero-dependency parser for the Prometheus exposition format used by the tns-csi controller
• kbench FIO log parser — parses yasker/kbench FIO output into structured IOPS, bandwidth (MB/s), and latency (µs) results
• ArtifactHub publishing — artifacthub-pkg.yml and artifacthub-repo.yml registered at Artifact Hub; plugin available in Headlamp catalog

Infrastructure

• GitHub repository setup with initial CI and release workflows
• 67 unit tests with Vitest + @testing-library/react
• TypeScript strict mode with zero any types
• ESLint + Prettier code quality tooling