privilegedescalation/headlamp-tns-csi-plugin
Archived
12
0
Fork 0
Code Issues 1 Pull Requests 2 Actions Packages Projects Releases 13 Wiki Activity
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
45bb74d42c7482db0cec896f70a8d9564d7c9013
headlamp-tns-csi-plugin/docs
T
History
Chris Farhood 45bb74d42c docs: update install docs and ArtifactHub metadata to headlamp namespace 
- README: update Helm install URL to v1.0.0, add pods/proxy RBAC scope notes
- docs/getting-started/installation.md: update all download URLs from v0.2.4 to v1.0.0, remove obsolete sha256sum example, fix build output placeholder
- docs/getting-started/quick-start.md: update Helm URL to v1.0.0
- docs/deployment/helm.md: update install command and values URLs to v1.0.0
- docs/README.md: fix Artifact Hub URL (was duplicated 'headlamp')
- docs/architecture/overview.md: update namespace references from kube-system to headlamp
- CLAUDE.md: update driver namespace constant from kube-system to headlamp
- CHANGELOG.md: add [Unreleased] entry documenting the namespace reference update

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-05-04 07:36:05 +00:00
..
architecture
docs: update install docs and ArtifactHub metadata to headlamp namespace
2026-05-04 07:36:05 +00:00
deployment
docs: update install docs and ArtifactHub metadata to headlamp namespace
2026-05-04 07:36:05 +00:00
development
docs: clean up repo cruft and update all documentation for v0.2.4
2026-02-26 18:04:43 +00:00
getting-started
docs: update install docs and ArtifactHub metadata to headlamp namespace
2026-05-04 07:36:05 +00:00
troubleshooting
feat: native Headlamp integration, TrueNAS API, docs, and CI for v0.2.0
2026-02-18 16:37:56 -05:00
user-guide
feat: native Headlamp integration, TrueNAS API, docs, and CI for v0.2.0
2026-02-18 16:37:56 -05:00
README.md
docs: update install docs and ArtifactHub metadata to headlamp namespace
2026-05-04 07:36:05 +00:00

README.md

TNS-CSI Plugin Documentation

Welcome to the Headlamp TNS-CSI Plugin documentation.

Quick Links

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

Reference in New Issue View Git Blame Copy Permalink