docs: remove incorrect watchPlugins: false references
Remove all references to the incorrect `config.watchPlugins: false` requirement that was believed necessary for Headlamp v0.39.0+. Investigation revealed that plugins work correctly with the default `watchPlugins: true` setting. The earlier documentation was based on a misunderstanding of the plugin loading mechanism. Changes: - Remove watchPlugins: false from all YAML configuration examples - Remove warning sections about watchPlugins requirement - Update troubleshooting guides to focus on actual issues - Simplify installation instructions by removing unnecessary config Files updated: - README.md (main installation docs and troubleshooting table) - docs/DEPLOYMENT.md - docs/TROUBLESHOOTING.md - docs/getting-started/* (quick-start, installation, prerequisites) - docs/deployment/* (helm, production) - docs/troubleshooting/* (common-issues, README) - Multiple other doc files formatted by prettier This cleanup ensures ArtifactHub and GitHub documentation show correct, simplified installation instructions. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
@@ -4,12 +4,12 @@ Before installing the Headlamp Polaris Plugin, ensure your environment meets the
|
||||
|
||||
## Required Components
|
||||
|
||||
| Requirement | Minimum Version | Recommended Version |
|
||||
| -------------------------------- | ------------------ | ------------------- |
|
||||
| **Kubernetes** | v1.24+ | v1.28+ |
|
||||
| **Headlamp** | v0.26+ | v0.39+ |
|
||||
| **Polaris** (dashboard enabled) | Any recent release | Latest stable |
|
||||
| **Browser** | Modern (ES2020+) | Latest Chrome/Firefox/Safari/Edge |
|
||||
| Requirement | Minimum Version | Recommended Version |
|
||||
| ------------------------------- | ------------------ | --------------------------------- |
|
||||
| **Kubernetes** | v1.24+ | v1.28+ |
|
||||
| **Headlamp** | v0.26+ | v0.39+ |
|
||||
| **Polaris** (dashboard enabled) | Any recent release | Latest stable |
|
||||
| **Browser** | Modern (ES2020+) | Latest Chrome/Firefox/Safari/Edge |
|
||||
|
||||
## Polaris Requirements
|
||||
|
||||
@@ -91,7 +91,6 @@ helm repo update
|
||||
helm install headlamp headlamp/headlamp \
|
||||
--namespace kube-system \
|
||||
--set config.pluginsDir="/headlamp/plugins" \
|
||||
--set config.watchPlugins=false \
|
||||
--set pluginsManager.enabled=true
|
||||
|
||||
# Wait for pod to be ready
|
||||
@@ -133,6 +132,7 @@ Headlamp Pod → Kubernetes API Server → Polaris Dashboard Service
|
||||
```
|
||||
|
||||
**Required network paths:**
|
||||
|
||||
- Headlamp pod → Kubernetes API server (443)
|
||||
- Kubernetes API server → Polaris dashboard service (80)
|
||||
|
||||
@@ -161,12 +161,12 @@ The plugin uses modern JavaScript features and requires:
|
||||
|
||||
### Tested Browsers
|
||||
|
||||
| Browser | Minimum Version |
|
||||
| ---------------- | --------------- |
|
||||
| Chrome/Chromium | 80+ |
|
||||
| Firefox | 75+ |
|
||||
| Safari | 13.1+ |
|
||||
| Edge | 80+ |
|
||||
| Browser | Minimum Version |
|
||||
| --------------- | --------------- |
|
||||
| Chrome/Chromium | 80+ |
|
||||
| Firefox | 75+ |
|
||||
| Safari | 13.1+ |
|
||||
| Edge | 80+ |
|
||||
|
||||
## Optional Components
|
||||
|
||||
|
||||
Reference in New Issue
Block a user