docs: replace hardcoded namespace with <your-namespace> placeholder

Users choose their own namespace for Headlamp. Replace all hardcoded
kube-system references that indicate Headlamp's install namespace with
<your-namespace> so users substitute their own value.

Upstream workload references left untouched:
- tns-csi controller pods in kube-system (upstream CSI driver)
- NetworkPolicy selectors targeting kube-system
- API server proxy paths to kube-system pods

Refs: PRI-434

Co-authored-by: Chris Farhood <chris@farhood.org>
Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit was merged in pull request #48.
This commit is contained in:
privilegedescalation-ceo[bot]
2026-05-10 21:34:56 +00:00
committed by GitHub
parent be254b1eec
commit 2e2713fd3f
9 changed files with 24 additions and 24 deletions
+3 -3
View File
@@ -91,7 +91,7 @@ metadata:
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
name: headlamp name: headlamp
namespace: kube-system # adjust to your Headlamp namespace namespace: <your-namespace>
roleRef: roleRef:
kind: ClusterRole kind: ClusterRole
name: headlamp-tns-csi-reader name: headlamp-tns-csi-reader
@@ -143,7 +143,7 @@ The Kubernetes API server performs the pod proxy hop, so policies should permit
### Service Account (Default) ### Service Account (Default)
Headlamp runs with a dedicated service account (`headlamp` in `kube-system`). All users share the same RBAC permissions. Headlamp runs with a dedicated service account (`headlamp` in the namespace where Headlamp is installed). All users share the same RBAC permissions.
**Security Considerations:** **Security Considerations:**
- All users have identical access to plugin functionality including Benchmark - All users have identical access to plugin functionality including Benchmark
@@ -223,7 +223,7 @@ All API requests are logged in Kubernetes API audit logs (if enabled). Pod proxy
"verb": "get", "verb": "get",
"requestURI": "/api/v1/namespaces/kube-system/pods/<controller-pod>/proxy/metrics", "requestURI": "/api/v1/namespaces/kube-system/pods/<controller-pod>/proxy/metrics",
"user": { "user": {
"username": "system:serviceaccount:kube-system:headlamp" "username": "system:serviceaccount:<your-namespace>:headlamp"
} }
} }
``` ```
+7 -7
View File
@@ -9,7 +9,7 @@ helm repo add headlamp https://headlamp-k8s.github.io/headlamp/
helm repo update helm repo update
helm install headlamp headlamp/headlamp \ helm install headlamp headlamp/headlamp \
--namespace kube-system \ --namespace <your-namespace> \
--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 \
@@ -44,7 +44,7 @@ Apply:
```bash ```bash
helm install headlamp headlamp/headlamp \ helm install headlamp headlamp/headlamp \
--namespace kube-system \ --namespace <your-namespace> \
-f headlamp-values.yaml -f headlamp-values.yaml
``` ```
@@ -55,7 +55,7 @@ apiVersion: source.toolkit.fluxcd.io/v1
kind: HelmRepository kind: HelmRepository
metadata: metadata:
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
spec: spec:
interval: 12h interval: 12h
url: https://headlamp-k8s.github.io/headlamp/ url: https://headlamp-k8s.github.io/headlamp/
@@ -64,7 +64,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
spec: spec:
interval: 1h interval: 1h
chart: chart:
@@ -74,7 +74,7 @@ spec:
sourceRef: sourceRef:
kind: HelmRepository kind: HelmRepository
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
values: values:
config: config:
pluginsDir: /headlamp/plugins pluginsDir: /headlamp/plugins
@@ -122,7 +122,7 @@ metadata:
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
roleRef: roleRef:
kind: ClusterRole kind: ClusterRole
name: headlamp-tns-csi-reader name: headlamp-tns-csi-reader
@@ -136,7 +136,7 @@ To upgrade to a new plugin version, update the `url` in your values and apply:
```bash ```bash
helm upgrade headlamp headlamp/headlamp \ helm upgrade headlamp headlamp/headlamp \
--namespace kube-system \ --namespace <your-namespace> \
-f headlamp-values.yaml -f headlamp-values.yaml
``` ```
+1 -1
View File
@@ -32,7 +32,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease kind: HelmRelease
metadata: metadata:
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
spec: spec:
chart: chart:
spec: spec:
+3 -3
View File
@@ -34,7 +34,7 @@ pluginsManager:
Then upgrade your Headlamp release: Then upgrade your Headlamp release:
```bash ```bash
helm upgrade headlamp headlamp/headlamp -f values.yaml -n kube-system helm upgrade headlamp headlamp/headlamp -f values.yaml -n <your-namespace>
``` ```
## Step 2: Configure RBAC ## Step 2: Configure RBAC
@@ -70,7 +70,7 @@ metadata:
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
roleRef: roleRef:
kind: ClusterRole kind: ClusterRole
name: headlamp-tns-csi-reader name: headlamp-tns-csi-reader
@@ -78,7 +78,7 @@ roleRef:
EOF EOF
``` ```
Adjust `name: headlamp` and `namespace: kube-system` to match your Headlamp service account. Adjust `name: headlamp` and `namespace: <your-namespace>` to match your Headlamp service account.
## Step 3: Verify ## Step 3: Verify
+2 -2
View File
@@ -77,7 +77,7 @@ If a page shows a loading spinner indefinitely:
1. **Check browser console** for errors (F12 → Console) 1. **Check browser console** for errors (F12 → Console)
2. **Check network tab** for failed API requests (look for 403, 404, 500) 2. **Check network tab** for failed API requests (look for 403, 404, 500)
3. **Check Headlamp pod logs**: `kubectl logs -n kube-system -l app.kubernetes.io/name=headlamp` 3. **Check Headlamp pod logs**: `kubectl logs -n <your-namespace> -l app.kubernetes.io/name=headlamp`
4. **Try refreshing** — the watch connection may have been interrupted 4. **Try refreshing** — the watch connection may have been interrupted
## Common API Errors ## Common API Errors
@@ -102,7 +102,7 @@ Look for errors related to `tns-csi`, `headlamp-plugin`, or Kubernetes API paths
**Headlamp pod logs:** **Headlamp pod logs:**
```bash ```bash
kubectl logs -n kube-system -l app.kubernetes.io/name=headlamp --tail=100 kubectl logs -n <your-namespace> -l app.kubernetes.io/name=headlamp --tail=100
``` ```
**tns-csi controller logs:** **tns-csi controller logs:**
+2 -2
View File
@@ -8,10 +8,10 @@ The Benchmark page requires permissions to create and delete Jobs and PVCs:
```bash ```bash
kubectl auth can-i create jobs -n <benchmark-namespace> \ kubectl auth can-i create jobs -n <benchmark-namespace> \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
kubectl auth can-i create persistentvolumeclaims -n <benchmark-namespace> \ kubectl auth can-i create persistentvolumeclaims -n <benchmark-namespace> \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
``` ```
Apply the additional permissions if missing — see [RBAC Issues](rbac.md) or [SECURITY.md](../../SECURITY.md). Apply the additional permissions if missing — see [RBAC Issues](rbac.md) or [SECURITY.md](../../SECURITY.md).
+1 -1
View File
@@ -47,7 +47,7 @@ This requires `get` on `pods/proxy` in `kube-system`:
```bash ```bash
kubectl auth can-i get pods/proxy \ kubectl auth can-i get pods/proxy \
-n kube-system \ -n kube-system \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
``` ```
### 5. Network Policies ### 5. Network Policies
+3 -3
View File
@@ -11,16 +11,16 @@ Use `kubectl auth can-i` to check specific permissions:
```bash ```bash
# Check if the Headlamp service account can list StorageClasses # Check if the Headlamp service account can list StorageClasses
kubectl auth can-i list storageclasses \ kubectl auth can-i list storageclasses \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
# Check pod proxy access (for metrics) # Check pod proxy access (for metrics)
kubectl auth can-i get pods/proxy \ kubectl auth can-i get pods/proxy \
-n kube-system \ -n kube-system \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
# Check snapshot access # Check snapshot access
kubectl auth can-i list volumesnapshots \ kubectl auth can-i list volumesnapshots \
--as=system:serviceaccount:kube-system:headlamp --as=system:serviceaccount:<your-namespace>:headlamp
``` ```
### Applying the Required RBAC ### Applying the Required RBAC
+2 -2
View File
@@ -47,7 +47,7 @@ metadata:
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
name: headlamp # adjust to your Headlamp service account name name: headlamp # adjust to your Headlamp service account name
namespace: kube-system # adjust to your Headlamp namespace namespace: <your-namespace>
roleRef: roleRef:
kind: ClusterRole kind: ClusterRole
name: headlamp-tns-csi-reader name: headlamp-tns-csi-reader
@@ -99,7 +99,7 @@ metadata:
subjects: subjects:
- kind: ServiceAccount - kind: ServiceAccount
name: headlamp name: headlamp
namespace: kube-system namespace: <your-namespace>
roleRef: roleRef:
kind: Role kind: Role
name: headlamp-tns-csi-benchmark name: headlamp-tns-csi-benchmark