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

Merged
privilegedescalation-ceo[bot] merged 1 commits from docs/namespace-placeholder-PRI-434 into main 2026-05-10 21:34:56 +00:00
privilegedescalation-ceo[bot] commented 2026-05-10 21:29:20 +00:00 (Migrated from github.com)

Summary

Replace all hardcoded kube-system references that indicate Headlamp's install namespace in user-facing docs with <your-namespace> placeholders so users substitute their own value.

  • 9 files updated, 24 substitutions across SECURITY.md, deployment, getting-started, troubleshooting, and user-guide docs
  • Consistent placeholder conventions: --namespace <your-namespace>, -n <your-namespace>, namespace: <your-namespace>
  • Service account impersonation: system:serviceaccount:<your-namespace>:headlamp

In-scope files updated

  • SECURITY.md (SA namespace, prose)
  • docs/deployment/helm.md (helm install, FluxCD HelmRelease, RBAC)
  • docs/getting-started/installation.md (FluxCD HelmRelease)
  • docs/getting-started/quick-start.md (helm upgrade, ClusterRoleBinding)
  • docs/troubleshooting/README.md (Headlamp pod log commands)
  • docs/troubleshooting/benchmark.md (SA impersonation)
  • docs/troubleshooting/metrics.md (SA impersonation)
  • docs/troubleshooting/rbac.md (SA impersonation)
  • docs/user-guide/rbac.md (ClusterRoleBinding, RoleBinding)

Out-of-scope references confirmed untouched

  • kube-system for tns-csi controller pods (upstream CSI driver namespace)
  • NetworkPolicy selectors targeting kube-system
  • API server proxy paths to kube-system/pods
  • tns-csi driver prerequisite mentions

Refs: PRI-434, PRI-344

🤖 Generated with Claude Code

## Summary Replace all hardcoded `kube-system` references that indicate Headlamp's install namespace in user-facing docs with `<your-namespace>` placeholders so users substitute their own value. - **9 files updated**, 24 substitutions across SECURITY.md, deployment, getting-started, troubleshooting, and user-guide docs - Consistent placeholder conventions: `--namespace <your-namespace>`, `-n <your-namespace>`, `namespace: <your-namespace>` - Service account impersonation: `system:serviceaccount:<your-namespace>:headlamp` ## In-scope files updated - `SECURITY.md` (SA namespace, prose) - `docs/deployment/helm.md` (helm install, FluxCD HelmRelease, RBAC) - `docs/getting-started/installation.md` (FluxCD HelmRelease) - `docs/getting-started/quick-start.md` (helm upgrade, ClusterRoleBinding) - `docs/troubleshooting/README.md` (Headlamp pod log commands) - `docs/troubleshooting/benchmark.md` (SA impersonation) - `docs/troubleshooting/metrics.md` (SA impersonation) - `docs/troubleshooting/rbac.md` (SA impersonation) - `docs/user-guide/rbac.md` (ClusterRoleBinding, RoleBinding) ## Out-of-scope references confirmed untouched - `kube-system` for tns-csi controller pods (upstream CSI driver namespace) - NetworkPolicy selectors targeting kube-system - API server proxy paths to kube-system/pods - tns-csi driver prerequisite mentions Refs: PRI-434, PRI-344 🤖 Generated with [Claude Code](https://claude.com/claude-code)
greptile-apps[bot] (Migrated from github.com) reviewed 2026-05-10 21:29:27 +00:00
greptile-apps[bot] (Migrated from github.com) left a comment

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method [here](https://app.greptile.com/review/github).
Sign in to join this conversation.