privilegedescalation-engineer[bot]
b0110e474c
* docs: update install docs to headlamp namespace (PRI-434) - Update Helm/plugin install URLs from v0.2.4 to v1.0.0 - README: add pods/proxy RBAC scope, clarify controller is in kube-system - docs/getting-started/*: update all download URLs to v1.0.0 - docs/deployment/helm.md: update install URLs to v1.0.0 - docs/architecture/overview.md: Headlamp Pod label → headlamp namespace - docs/README.md: fix ArtifactHub URL - CHANGELOG.md: add [Unreleased] entry Note: driver/API-path references to kube-system are preserved as they describe where the tns-csi controller workload runs, not where Headlamp is installed. Co-Authored-By: Paperclip <noreply@paperclip.ing> * chore: remove E2E testing infrastructure - Delete e2e/ directory (auth.setup.ts, tns-csi.spec.ts) - Delete playwright.config.ts - Delete scripts/deploy-e2e-headlamp.sh - Delete scripts/teardown-e2e-headlamp.sh - Delete .github/workflows/e2e.yaml - Remove e2e script from package.json - Remove @playwright/test dependency from package.json Context: [PRI-1133](/PRI/issues/PRI-1133) — full E2E purge across org. Co-Authored-By: Paperclip <noreply@paperclip.ing> * fix: update pnpm-lock.yaml after E2E deletion Remove @playwright/test dependencies after E2E infrastructure cleanup. Resolves ERR_PNPM_OUTDATED_LOCKFILE on PR. Co-Authored-By: Paperclip <noreply@paperclip.ing> --------- Co-authored-by: Chris Farhood <chris@farhood.org> Co-authored-by: Paperclip <noreply@paperclip.ing>
3.1 KiB
3.1 KiB
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 |