headlamp-tns-csi-plugin/docs

TNS-CSI Plugin Documentation

Welcome to the Headlamp TNS-CSI Plugin documentation.

Quick Links

• Quick Start — Get up and running in 5 minutes
• Installation Guide — All installation methods
• Troubleshooting — Common issues and fixes

Documentation Index

Getting Started

Guide	Description
Quick Start	Fastest path to a working installation
Installation	Plugin Manager, manual tarball, build from source
Prerequisites	Headlamp version, tns-csi driver, RBAC

User Guide

Guide	Description
Overview Dashboard	Driver health, storage summary, protocol distribution
Storage Classes	StorageClass list and detail panel
Volumes	PersistentVolume list and detail panel
Snapshots	VolumeSnapshot list and CRD requirements
Metrics	Prometheus metrics display
Benchmark	kbench interactive storage benchmarking
PVC Detail Injection	TNS-CSI section in PVC detail views
RBAC Permissions	Required permissions per feature

Architecture

Guide	Description
Overview	System architecture, data flow, component hierarchy
Data Flow	How data moves from K8s API to the UI
Design Decisions	Key architectural choices and rationale

Deployment

Guide	Description
Helm	Deploy with Helm (recommended)
Production Checklist	Security and reliability checklist

Troubleshooting

Guide	Description
Common Issues	Quick diagnosis table
RBAC Issues	403 errors, missing permissions
Driver Detection	Driver not installed, wrong provisioner
Metrics Issues	Empty metrics page, unreachable controller
Benchmark Issues	Benchmark fails to start or complete

Development

Guide	Description
Development Setup	Clone, install, run dev server
Testing	Unit tests, mocking headlamp APIs
Release Process	How releases are cut and published

External Links

• GitHub Repository
• Artifact Hub
• tns-csi Driver
• kbench
• Headlamp