Chris Farhood
f1feb5c2f7
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>
80 lines
2.7 KiB
Markdown
80 lines
2.7 KiB
Markdown
# Benchmark Page
|
|
|
|
The Benchmark page provides an interactive storage benchmark runner using [kbench](https://github.com/longhorn/kbench) (the Longhorn storage benchmark tool based on FIO).
|
|
|
|
## What It Does
|
|
|
|
1. You select a tns-csi StorageClass, a namespace, a PVC capacity, and an access mode
|
|
2. The plugin creates a PVC and a Kubernetes Job that runs `yasker/kbench:latest`
|
|
3. FIO log output streams in real-time from the kbench pod
|
|
4. When complete, results are parsed and displayed as IOPS, bandwidth (MB/s), and latency (µs) cards
|
|
|
|
## Prerequisites
|
|
|
|
- RBAC permissions for Jobs and PVCs — see [RBAC Permissions](rbac.md)
|
|
- The target namespace must exist
|
|
- The selected StorageClass must support the chosen access mode
|
|
|
|
## Running a Benchmark
|
|
|
|
1. Navigate to **TrueNAS (tns-csi) → Benchmark**
|
|
2. Select a StorageClass from the dropdown (only tns-csi classes are listed)
|
|
3. Enter the target namespace (defaults to `default`)
|
|
4. Set PVC capacity (e.g., `10Gi`)
|
|
5. Choose access mode (`ReadWriteOnce`, `ReadWriteMany`, etc.)
|
|
6. Click **Run Benchmark**
|
|
|
|
The benchmark progress shows:
|
|
- Benchmark state (Starting, Running, Parsing Results, Complete, Failed)
|
|
- Live FIO log output as it streams from the pod
|
|
- Result cards once FIO completes
|
|
|
|
## Result Cards
|
|
|
|
When the benchmark completes, the plugin displays:
|
|
|
|
| Card | Metric |
|
|
| ---- | ------ |
|
|
| Read IOPS | Random 4K read I/O operations per second |
|
|
| Write IOPS | Random 4K write I/O operations per second |
|
|
| Read Bandwidth | Sequential read throughput (MB/s) |
|
|
| Write Bandwidth | Sequential write throughput (MB/s) |
|
|
| Read Latency | Average read latency (µs) |
|
|
| Write Latency | Average write latency (µs) |
|
|
|
|
## Stopping a Benchmark
|
|
|
|
Click **Stop** to cancel the running benchmark. The plugin will delete the Job and PVC.
|
|
|
|
If the page is closed or navigated away from during a benchmark, the Job and PVC will remain in the cluster with the label:
|
|
|
|
```
|
|
app.kubernetes.io/managed-by=headlamp-tns-csi-plugin
|
|
```
|
|
|
|
Clean them up manually:
|
|
|
|
```bash
|
|
kubectl delete jobs,pvc -n <namespace> \
|
|
-l app.kubernetes.io/managed-by=headlamp-tns-csi-plugin
|
|
```
|
|
|
|
## Resource Cleanup
|
|
|
|
The plugin automatically deletes the benchmark Job and PVC when:
|
|
- The benchmark completes successfully
|
|
- You click Stop
|
|
- The page component unmounts
|
|
|
|
## Protocol Notes
|
|
|
|
Different protocols have different performance characteristics:
|
|
|
|
| Protocol | Typical Use Case | Access Modes |
|
|
| -------- | ---------------- | ------------ |
|
|
| NFS | Shared storage, RWX workloads | RWO, RWX, RWOP |
|
|
| NVMe-oF | High-performance block storage | RWO, RWOP |
|
|
| iSCSI | Block storage | RWO, RWOP |
|
|
|
|
For NVMe-oF benchmarks, ensure nodes have the `nvme-tcp` kernel module loaded and the controller has a static IP.
|