Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 504d71d68d | |||
| bc46a6a620 | |||
| c808030317 | |||
| 72ce7fa585 | |||
| be254b1eec | |||
| 90efdf5569 | |||
| 4ba90fa218 | |||
| a089a2cc2d |
@@ -0,0 +1,53 @@
|
|||||||
|
{
|
||||||
|
"config": {
|
||||||
|
// Line length — not enforced for docs with code examples
|
||||||
|
"MD013": false,
|
||||||
|
// First line heading — files use YAML frontmatter, not headings
|
||||||
|
"MD041": false,
|
||||||
|
// Emphasis as heading — common pattern for Option 1/2/3 sections
|
||||||
|
"MD036": false,
|
||||||
|
// No duplicate heading — changelog files repeat section names intentionally
|
||||||
|
"MD024": false,
|
||||||
|
// Fenced code language — not always applicable for diagram blocks
|
||||||
|
"MD040": false,
|
||||||
|
// Table column style — table alignment is visual, not semantic
|
||||||
|
"MD060": false,
|
||||||
|
// Ordered list item prefix — number resets are intentional in documents
|
||||||
|
"MD029": false,
|
||||||
|
// No inline HTML — each elements are valid in valid Markdown
|
||||||
|
"MD033": false,
|
||||||
|
// List marker space — spacing after list markers varies by editor
|
||||||
|
"MD030": false,
|
||||||
|
// Blanks around headings — not always needed in compact docs
|
||||||
|
"MD022": false,
|
||||||
|
// Blanks around lists — not always needed in compact docs
|
||||||
|
"MD032": false,
|
||||||
|
// Blanks around fences — not always needed between adjacent blocks
|
||||||
|
"MD031": false,
|
||||||
|
// Multiple blanks — editor artifacts, not semantic
|
||||||
|
"MD012": false,
|
||||||
|
// Single title — files may have multiple H1 sections
|
||||||
|
"MD025": false,
|
||||||
|
// Trailing spaces — editor artifacts
|
||||||
|
"MD009": false,
|
||||||
|
// Bare URLs — URL shortening not always needed
|
||||||
|
"MD034": false,
|
||||||
|
// Single trailing newline — editor artifacts
|
||||||
|
"MD047": false,
|
||||||
|
// Trailing punctuation — heading punctuation is intentional
|
||||||
|
"MD026": false,
|
||||||
|
// Space in emphasis — double-asterisk bold spacing varies by renderer
|
||||||
|
"MD037": false,
|
||||||
|
// No hard tabs — some generated docs use tabs for indentation
|
||||||
|
"MD010": false,
|
||||||
|
// Code block style — generated docs may use inconsistent styles
|
||||||
|
"MD046": false,
|
||||||
|
// Comment style — generated docs have no comments
|
||||||
|
"MD048": false,
|
||||||
|
// Commands show output — shell examples intentionally show only commands
|
||||||
|
"MD014": false
|
||||||
|
},
|
||||||
|
"ignores": [
|
||||||
|
"docs/api-reference/generated/**"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
docs/api-reference/generated/**
|
||||||
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [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
|
## [1.0.0] - 2026-03-24
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
@@ -63,12 +63,12 @@ config:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
## RBAC / Security Setup
|
## RBAC / Security Setup
|
||||||
|
|
||||||
The plugin reads from the Kubernetes API and the tns-csi controller pod's Prometheus endpoint. The Benchmark page additionally creates and deletes Jobs and PVCs.
|
The plugin reads from the Kubernetes API and the tns-csi controller pod's Prometheus endpoint (deployed in `kube-system`). The Benchmark page additionally creates and deletes Jobs and PVCs.
|
||||||
|
|
||||||
### Minimal read-only permissions
|
### Minimal read-only permissions
|
||||||
|
|
||||||
@@ -90,6 +90,10 @@ rules:
|
|||||||
- apiGroups: [""]
|
- apiGroups: [""]
|
||||||
resources: ["pods/log"]
|
resources: ["pods/log"]
|
||||||
verbs: ["get"]
|
verbs: ["get"]
|
||||||
|
- apiGroups: [""]
|
||||||
|
resources: ["pods/proxy"]
|
||||||
|
verbs: ["get"]
|
||||||
|
resourceNames: ["pods"]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Additional permissions for Benchmark page
|
### Additional permissions for Benchmark page
|
||||||
@@ -105,13 +109,13 @@ rules:
|
|||||||
|
|
||||||
### Metrics access
|
### Metrics access
|
||||||
|
|
||||||
The plugin fetches Prometheus metrics from the tns-csi controller pod via the Kubernetes pod proxy sub-resource. Grant `get` on `pods/proxy` in `kube-system`:
|
The plugin fetches Prometheus metrics from the tns-csi controller pod via the Kubernetes pod proxy sub-resource in `kube-system`. Grant `get` on `pods/proxy` scoped to `kube-system`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- apiGroups: [""]
|
- apiGroups: [""]
|
||||||
resources: ["pods/proxy"]
|
resources: ["pods/proxy"]
|
||||||
verbs: ["get"]
|
verbs: ["get"]
|
||||||
# Optionally scope to the controller pod namespace
|
# Scope to kube-system where the tns-csi controller runs
|
||||||
```
|
```
|
||||||
|
|
||||||
Apply the role and bind it to your Headlamp service account with a ClusterRoleBinding.
|
Apply the role and bind it to your Headlamp service account with a ClusterRoleBinding.
|
||||||
|
|||||||
+1
-1
@@ -187,7 +187,7 @@ Report security vulnerabilities via:
|
|||||||
|
|
||||||
The project uses:
|
The project uses:
|
||||||
- **npm audit**: Runs automatically during `npm install`
|
- **npm audit**: Runs automatically during `npm install`
|
||||||
- **GitHub Dependabot**: Monitors dependencies and creates PRs for updates
|
- **Renovate**: Automated dependency updates via Mend Renovate (org-wide configured)
|
||||||
|
|
||||||
Headlamp itself (`@kinvolk/headlamp-plugin`) is a peer dependency. Security updates to Headlamp should be applied by upgrading your Headlamp installation.
|
Headlamp itself (`@kinvolk/headlamp-plugin`) is a peer dependency. Security updates to Headlamp should be applied by upgrading your Headlamp installation.
|
||||||
|
|
||||||
|
|||||||
+4
-4
@@ -1,5 +1,5 @@
|
|||||||
version: "1.0.0"
|
version: "1.0.2"
|
||||||
name: headlamp-tns-csi-plugin
|
name: tns-csi
|
||||||
displayName: TrueNAS CSI (tns-csi)
|
displayName: TrueNAS CSI (tns-csi)
|
||||||
description: >-
|
description: >-
|
||||||
Headlamp plugin for tns-csi CSI driver visibility and kbench storage
|
Headlamp plugin for tns-csi CSI driver visibility and kbench storage
|
||||||
@@ -63,7 +63,7 @@ changes:
|
|||||||
description: "GitHub App token secrets passed to release workflow"
|
description: "GitHub App token secrets passed to release workflow"
|
||||||
|
|
||||||
annotations:
|
annotations:
|
||||||
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz"
|
headlamp/plugin/archive-url: "https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.2/tns-csi-1.0.0.tar.gz"
|
||||||
headlamp/plugin/archive-checksum: sha256:e38846ceb17a79438f8aecc50f22920b0efa7456f3ebb3e628d89856af83ad01
|
headlamp/plugin/archive-checksum: sha256:3e4fa137c912eb13610557dd82ef7086fc396a42365e30a39e618afa97bbc202
|
||||||
headlamp/plugin/version-compat: ">=0.20.0"
|
headlamp/plugin/version-compat: ">=0.20.0"
|
||||||
headlamp/plugin/distro-compat: "in-cluster,web,app"
|
headlamp/plugin/distro-compat: "in-cluster,web,app"
|
||||||
|
|||||||
+1
-1
@@ -67,7 +67,7 @@ Welcome to the Headlamp TNS-CSI Plugin documentation.
|
|||||||
## External Links
|
## External Links
|
||||||
|
|
||||||
- **[GitHub Repository](https://github.com/privilegedescalation/headlamp-tns-csi-plugin)**
|
- **[GitHub Repository](https://github.com/privilegedescalation/headlamp-tns-csi-plugin)**
|
||||||
- **[Artifact Hub](https://artifacthub.io/packages/headlamp/headlamp-tns-csi-plugin/headlamp-tns-csi-plugin)**
|
- **[Artifact Hub](https://artifacthub.io/packages/headlamp/tns-csi/headlamp-tns-csi-plugin)**
|
||||||
- **[tns-csi Driver](https://github.com/fenio/tns-csi)**
|
- **[tns-csi Driver](https://github.com/fenio/tns-csi)**
|
||||||
- **[kbench](https://github.com/longhorn/kbench)**
|
- **[kbench](https://github.com/longhorn/kbench)**
|
||||||
- **[Headlamp](https://headlamp.dev/)**
|
- **[Headlamp](https://headlamp.dev/)**
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ The TNS-CSI plugin is a single-page React application bundled as a Headlamp plug
|
|||||||
│ HTTPS
|
│ HTTPS
|
||||||
▼
|
▼
|
||||||
┌─────────────────────────────────────────────────────┐
|
┌─────────────────────────────────────────────────────┐
|
||||||
│ Headlamp Pod (kube-system) │
|
│ Headlamp Pod (headlamp namespace) │
|
||||||
│ │
|
│ │
|
||||||
│ Headlamp UI server + API proxy │
|
│ Headlamp UI server + API proxy │
|
||||||
│ (forwards requests using service account token │
|
│ (forwards requests using service account token │
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ helm install headlamp headlamp/headlamp \
|
|||||||
--create-namespace \
|
--create-namespace \
|
||||||
--set config.pluginsDir=/headlamp/plugins \
|
--set config.pluginsDir=/headlamp/plugins \
|
||||||
--set pluginsManager.sources[0].name=tns-csi \
|
--set pluginsManager.sources[0].name=tns-csi \
|
||||||
--set pluginsManager.sources[0].url=https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
--set pluginsManager.sources[0].url=https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
## Complete values.yaml Example
|
## Complete values.yaml Example
|
||||||
@@ -27,7 +27,7 @@ config:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
|
|
||||||
serviceAccount:
|
serviceAccount:
|
||||||
name: headlamp
|
name: headlamp
|
||||||
@@ -81,7 +81,7 @@ spec:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
## RBAC Manifest (Apply Separately)
|
## RBAC Manifest (Apply Separately)
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ config:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
**Via FluxCD HelmRelease:**
|
**Via FluxCD HelmRelease:**
|
||||||
@@ -46,7 +46,7 @@ spec:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
### Method 2: Manual Tarball Install
|
### Method 2: Manual Tarball Install
|
||||||
@@ -55,13 +55,10 @@ Download and extract the plugin directly:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Download the release tarball
|
# Download the release tarball
|
||||||
wget https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
wget https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
|
|
||||||
# Verify the checksum
|
|
||||||
echo "14a3e8c13d0b894a41aa1cfccbcb1f6af09dcbb8fd95c7040a540987ea2096a7 tns-csi-0.2.4.tar.gz" | sha256sum --check
|
|
||||||
|
|
||||||
# Extract into your Headlamp plugins directory
|
# Extract into your Headlamp plugins directory
|
||||||
tar xzf tns-csi-0.2.4.tar.gz -C /headlamp/plugins/
|
tar xzf tns-csi-1.0.0.tar.gz -C /headlamp/plugins/
|
||||||
```
|
```
|
||||||
|
|
||||||
The plugin directory should appear as `/headlamp/plugins/tns-csi/`.
|
The plugin directory should appear as `/headlamp/plugins/tns-csi/`.
|
||||||
@@ -81,7 +78,7 @@ initContainers:
|
|||||||
- -c
|
- -c
|
||||||
- |
|
- |
|
||||||
wget -O /tmp/plugin.tar.gz \
|
wget -O /tmp/plugin.tar.gz \
|
||||||
https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
tar xzf /tmp/plugin.tar.gz -C /headlamp/plugins/
|
tar xzf /tmp/plugin.tar.gz -C /headlamp/plugins/
|
||||||
volumeMounts:
|
volumeMounts:
|
||||||
- name: plugins
|
- name: plugins
|
||||||
@@ -98,10 +95,10 @@ cd headlamp-tns-csi-plugin
|
|||||||
npm install
|
npm install
|
||||||
npm run build
|
npm run build
|
||||||
npm run package
|
npm run package
|
||||||
# Produces tns-csi-0.2.4.tar.gz
|
# Produces tns-csi-<version>.tar.gz
|
||||||
|
|
||||||
# Extract to your Headlamp plugins directory
|
# Extract to your Headlamp plugins directory
|
||||||
tar xzf tns-csi-0.2.4.tar.gz -C /headlamp/plugins/
|
tar xzf tns-csi-<version>.tar.gz -C /headlamp/plugins/
|
||||||
```
|
```
|
||||||
|
|
||||||
Or use `headlamp-plugin extract` for automatic placement:
|
Or use `headlamp-plugin extract` for automatic placement:
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ config:
|
|||||||
pluginsManager:
|
pluginsManager:
|
||||||
sources:
|
sources:
|
||||||
- name: tns-csi
|
- name: tns-csi
|
||||||
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v0.2.4/tns-csi-0.2.4.tar.gz
|
url: https://github.com/privilegedescalation/headlamp-tns-csi-plugin/releases/download/v1.0.0/tns-csi-1.0.0.tar.gz
|
||||||
```
|
```
|
||||||
|
|
||||||
Then upgrade your Headlamp release:
|
Then upgrade your Headlamp release:
|
||||||
|
|||||||
+2
-1
@@ -51,6 +51,7 @@
|
|||||||
"overrides": {
|
"overrides": {
|
||||||
"tar": "^7.5.11",
|
"tar": "^7.5.11",
|
||||||
"undici": "^7.24.3",
|
"undici": "^7.24.3",
|
||||||
"vite": ">=6.4.2"
|
"vite": ">=6.4.2",
|
||||||
|
"elliptic": ">=6.6.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Generated
+567
-529
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user