Skip to content

Commit 766ec4a

Browse files
author
Sunil Thaha
committed
docs(power-monitor): point to advanced configuration doc
Rename configuring-kepler.md to guides/custom-configmaps.md to better reflect the content, which focuses on advanced configuration using custom ConfigMaps rather than general PowerMonitor configuration. Signed-off-by: Sunil Thaha <[email protected]>
1 parent e7c8281 commit 766ec4a

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

docs/user/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Choose your platform to begin:
3434
Once installed, learn how to use Kepler Operator:
3535

3636
- **[Creating PowerMonitor Resources](guides/power-monitor.md)** - Deploy and configure Kepler on your cluster
37-
- **[Configuration Options](configuring-kepler.md)** - Deep dive into PowerMonitor configuration
37+
- **[Custom ConfigMaps](guides/custom-configmaps.md)** - Advanced Kepler configuration with custom ConfigMaps
3838
- **[Validating Prometheus Integration](guides/validating-prometheus-integration.md)** - Verify Prometheus is scraping Kepler metrics
3939
- **[Setting up Grafana Dashboards](guides/grafana-dashboard.md)** - Visualize energy metrics
4040
- **[Upgrading](guides/upgrading.md)** - Upgrade the operator (Helm and OLM)

docs/user/configuring-kepler.md renamed to docs/user/guides/custom-configmaps.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,8 @@ If the DaemonSet doesn't roll out after updating the ConfigMap:
260260

261261
## 📚 Related Resources
262262

263-
- [PowerMonitor API Reference](reference/api.md#powermonitor)
263+
- [PowerMonitor Guide](./power-monitor.md) - Complete PowerMonitor configuration guide
264+
- [PowerMonitor API Reference](../reference/api.md#powermonitor)
264265
- [Kepler Configuration Reference](https://sustainable-computing.io/kepler/usage/configuration/)
265266
- [Kepler Documentation](https://sustainable-computing.io/)
266267

docs/user/guides/power-monitor.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,8 @@ spec:
265265

266266
The ConfigMap must exist in the same namespace as PowerMonitor components.
267267

268+
For detailed examples and best practices on using custom ConfigMaps, see the [Custom ConfigMaps Guide](./custom-configmaps.md).
269+
268270
## Common Use Cases
269271

270272
**Note**: All examples below use the required name `power-monitor`. You cannot create multiple PowerMonitor resources with different names.
@@ -468,6 +470,7 @@ For more troubleshooting guidance, see the [Troubleshooting Guide](./troubleshoo
468470

469471
## Next Steps
470472

473+
- **[Custom ConfigMaps Guide](./custom-configmaps.md)** - Advanced Kepler configuration with custom ConfigMaps
471474
- **[Grafana Dashboards](./grafana-dashboard.md)** - Visualize Kepler metrics
472475
- **[Troubleshooting Guide](./troubleshooting.md)** - Diagnose common issues
473476
- **[API Reference](../reference/api.md)** - Complete PowerMonitor API specification

docs/user/guides/validating-prometheus-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ helm upgrade prometheus prometheus-community/kube-prometheus-stack \
501501
Once you've validated that Prometheus is scraping Kepler metrics:
502502

503503
- **[Set up Grafana Dashboards](./grafana-dashboard.md)** to visualize the metrics
504-
- **[Configure PowerMonitor](../configuring-kepler.md)** to adjust metric levels and collection settings
504+
- **[Custom ConfigMaps](./custom-configmaps.md)** to adjust metric levels and collection settings
505505
- **[Set up Alerts](https://prometheus.io/docs/alerting/latest/overview/)** for abnormal power consumption
506506

507507
---

docs/user/installation/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ For complete setup and troubleshooting instructions, see:
225225
Now that the operator is installed, you can:
226226

227227
1. **[Create a PowerMonitor resource](../guides/power-monitor.md)** to deploy Kepler
228-
2. **[Configure PowerMonitor](../configuring-kepler.md)** for your specific needs
228+
2. **[Custom ConfigMaps](../guides/custom-configmaps.md)** for advanced Kepler configuration
229229
3. **[Set up Monitoring Stack](./monitoring-stack-kubernetes.md)** (optional) - If you want to visualize metrics
230230
4. **[Validate Prometheus Integration](../guides/validating-prometheus-integration.md)** (if using Prometheus) - Ensure metrics are being scraped
231231
5. **[Set up Grafana dashboards](../guides/grafana-dashboard.md)** (if using Grafana) - Visualize metrics

0 commit comments

Comments
 (0)