Skip to content

Commit 58f2ee3

Browse files
author
Sunil Thaha
committed
docs(experimental): add redfish BMC power monitoring guide
Add documentation and examples for enabling the experimental Redfish BMC power monitoring feature: - New experimental/redfish.md guide with complete setup instructions - Example YAML files for ConfigMap, Secret, and PowerMonitor configuration - Updated user guide index with experimental features section - Enhanced power-monitor.md with Redfish secret mounting example - Added Redfish ConfigMap example to custom-configmaps.md This documentation supports the experimental platform-level power monitoring capability that collects kepler_platform_watts metrics from BMCs via Redfish API. Signed-off-by: Sunil Thaha <[email protected]>
1 parent 766ec4a commit 58f2ee3

File tree

7 files changed

+792
-0
lines changed

7 files changed

+792
-0
lines changed

docs/user/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Once installed, learn how to use Kepler Operator:
3939
- **[Setting up Grafana Dashboards](guides/grafana-dashboard.md)** - Visualize energy metrics
4040
- **[Upgrading](guides/upgrading.md)** - Upgrade the operator (Helm and OLM)
4141

42+
### Experimental Features
43+
44+
⚠️ These features are experimental and may change in future versions:
45+
46+
- **[Redfish BMC Power Monitoring](guides/experimental/redfish.md)** - Platform-level power consumption via Baseboard Management Controllers
47+
4248
## Troubleshooting and Support
4349

4450
- **[Troubleshooting Guide](guides/troubleshooting.md)** - Common issues and platform-specific solutions

docs/user/guides/custom-configmaps.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,42 @@ data:
148148
enabled: true
149149
```
150150
151+
### 🔬 Example 5: Enabling Experimental Redfish BMC Monitoring
152+
153+
⚠️ **EXPERIMENTAL FEATURE** - See [Redfish Monitoring Guide](./experimental/redfish.md)
154+
155+
Enable platform-level power monitoring via Redfish BMC API:
156+
157+
```yaml
158+
apiVersion: v1
159+
kind: ConfigMap
160+
metadata:
161+
name: enable-redfish
162+
namespace: power-monitor
163+
data:
164+
config.yaml: |
165+
experimental:
166+
platform:
167+
redfish:
168+
enabled: true
169+
configFile: /etc/kepler/secrets/redfish/redfish.yaml
170+
httpTimeout: 5s
171+
```
172+
173+
**Important Notes:**
174+
175+
- This feature is **experimental** and may change in future versions
176+
- Requires a **Secret** containing BMC credentials (not shown here)
177+
- The `configFile` must point to a mounted Secret path
178+
- See the complete [Redfish Monitoring Guide](./experimental/redfish.md) for full setup instructions
179+
180+
**When to use:**
181+
182+
- You need platform-level power consumption (PSU, cooling, storage)
183+
- Running on servers with Redfish-enabled BMCs
184+
- Want to complement CPU-only RAPL monitoring
185+
- Need power data when running Kepler in VMs
186+
151187
## 🗂️ Using Multiple ConfigMaps
152188

153189
You can reference multiple ConfigMaps to organize your configuration. The operator merges them in the order specified:
@@ -162,6 +198,7 @@ spec:
162198
- name: kepler-prometheus-config
163199
- name: kepler-dev-config
164200
- name: kepler-pprof-config
201+
- name: enable-redfish
165202
```
166203

167204
**📌 Note:** If there are conflicting settings across multiple ConfigMaps, the later ConfigMap in the list takes precedence.

0 commit comments

Comments
 (0)