docs: migrate Headlamp install namespace from kube-system to headlamp (PRI-434) #45

Closed
privilegedescalation-engineer[bot] wants to merge 3 commits from gandalf/pri-434-namespace-docs into main
10 changed files with 23 additions and 23 deletions
+3 -3
View File
@@ -91,7 +91,7 @@ metadata:
subjects:
- kind: ServiceAccount
name: headlamp
namespace: kube-system # adjust to your Headlamp namespace
namespace: headlamp # adjust to your Headlamp namespace
roleRef:
kind: ClusterRole
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)
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 `headlamp`). All users share the same RBAC permissions.
**Security Considerations:**
- 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",
"requestURI": "/api/v1/namespaces/kube-system/pods/<controller-pod>/proxy/metrics",
"user": {
"username": "system:serviceaccount:kube-system:headlamp"
"username": "system:serviceaccount:headlamp:headlamp"
}
}
```
+1 -1
View File
@@ -28,7 +28,7 @@ The TNS-CSI plugin is a single-page React application bundled as a Headlamp plug
│ HTTPS
┌─────────────────────────────────────────────────────┐
│ Headlamp Pod (kube-system) │
│ Headlamp Pod (headlamp) │
│ │
│ Headlamp UI server + API proxy │
│ (forwards requests using service account token │
+5 -5
View File
@@ -9,7 +9,7 @@ helm repo add headlamp https://headlamp-k8s.github.io/headlamp/
helm repo update
helm install headlamp headlamp/headlamp \
--namespace kube-system \
--namespace headlamp \
--create-namespace \
--set config.pluginsDir=/headlamp/plugins \
--set pluginsManager.sources[0].name=tns-csi \
@@ -44,7 +44,7 @@ Apply:
```bash
helm install headlamp headlamp/headlamp \
--namespace kube-system \
--namespace headlamp \
-f headlamp-values.yaml
```
@@ -64,7 +64,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: headlamp
namespace: kube-system
namespace: headlamp
spec:
interval: 1h
chart:
@@ -122,7 +122,7 @@ metadata:
subjects:
- kind: ServiceAccount
name: headlamp
namespace: kube-system
namespace: headlamp
roleRef:
kind: ClusterRole
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
helm upgrade headlamp headlamp/headlamp \
--namespace kube-system \
--namespace headlamp \
-f headlamp-values.yaml
```
+1 -1
View File
@@ -32,7 +32,7 @@ apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: headlamp
namespace: kube-system
namespace: headlamp
spec:
chart:
spec:
+3 -3
View File
@@ -34,7 +34,7 @@ pluginsManager:
Then upgrade your Headlamp release:
```bash
helm upgrade headlamp headlamp/headlamp -f values.yaml -n kube-system
helm upgrade headlamp headlamp/headlamp -f values.yaml -n headlamp
```
## Step 2: Configure RBAC
@@ -70,7 +70,7 @@ metadata:
subjects:
- kind: ServiceAccount
name: headlamp
namespace: kube-system
namespace: headlamp
roleRef:
kind: ClusterRole
name: headlamp-tns-csi-reader
@@ -78,7 +78,7 @@ roleRef:
EOF
```
Adjust `name: headlamp` and `namespace: kube-system` to match your Headlamp service account.
Adjust `name: headlamp` and `namespace: headlamp` to match your Headlamp service account.
## 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)
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 headlamp -l app.kubernetes.io/name=headlamp`
4. **Try refreshing** — the watch connection may have been interrupted
## Common API Errors
@@ -102,7 +102,7 @@ Look for errors related to `tns-csi`, `headlamp-plugin`, or Kubernetes API paths
**Headlamp pod logs:**
```bash
kubectl logs -n kube-system -l app.kubernetes.io/name=headlamp --tail=100
kubectl logs -n headlamp -l app.kubernetes.io/name=headlamp --tail=100
```
**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
kubectl auth can-i create jobs -n <benchmark-namespace> \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
kubectl auth can-i create persistentvolumeclaims -n <benchmark-namespace> \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
```
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
kubectl auth can-i get pods/proxy \
-n kube-system \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
```
### 5. Network Policies
+3 -3
View File
@@ -11,16 +11,16 @@ Use `kubectl auth can-i` to check specific permissions:
```bash
# Check if the Headlamp service account can list StorageClasses
kubectl auth can-i list storageclasses \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
# Check pod proxy access (for metrics)
kubectl auth can-i get pods/proxy \
-n kube-system \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
# Check snapshot access
kubectl auth can-i list volumesnapshots \
--as=system:serviceaccount:kube-system:headlamp
--as=system:serviceaccount:headlamp:headlamp
```
### Applying the Required RBAC
+2 -2
View File
@@ -47,7 +47,7 @@ metadata:
subjects:
- kind: ServiceAccount
name: headlamp # adjust to your Headlamp service account name
namespace: kube-system # adjust to your Headlamp namespace
namespace: headlamp # adjust to your Headlamp namespace
roleRef:
kind: ClusterRole
name: headlamp-tns-csi-reader
@@ -99,7 +99,7 @@ metadata:
subjects:
- kind: ServiceAccount
name: headlamp
namespace: kube-system
namespace: headlamp
roleRef:
kind: Role
name: headlamp-tns-csi-benchmark