Skip to content

Commit 6fcde71

Browse files
author
Sunil Thaha
committed
docs: make Prometheus Operator a strict requirement
Signed-off-by: Sunil Thaha <[email protected]>
1 parent 6710d09 commit 6fcde71

File tree

3 files changed

+33
-18
lines changed

3 files changed

+33
-18
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
3131
# Wait for cert-manager to be ready
3232
kubectl wait --for=condition=available --timeout=120s deployment -n cert-manager --all
3333

34-
# 2. Install monitoring stack (Prometheus + Grafana)
35-
# Skip if you already have Prometheus installed
34+
# 2. Install Prometheus Operator (required for ServiceMonitor support)
35+
# This installs prometheus-operator + Prometheus + Grafana
36+
# If you only need prometheus-operator, see the monitoring stack guide
3637
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
3738
helm install prometheus prometheus-community/kube-prometheus-stack \
3839
--namespace monitoring \

docs/user/README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ Choose your platform to begin:
1717
### Installation Guides
1818

1919
- **[Kubernetes Installation (Helm)](installation/kubernetes.md)** - Install on vanilla Kubernetes using Helm
20-
- Includes prerequisites: cert-manager setup
21-
- Optional: Prometheus and Grafana setup
20+
- Includes prerequisites: cert-manager and prometheus-operator
21+
- Optional: Prometheus and Grafana for metrics visualization
2222
- **[OpenShift Installation (OperatorHub)](installation/openshift.md)** - Install via OperatorHub/OLM
2323
- Uses OpenShift's built-in certificate management
2424
- Integrates with OpenShift monitoring stack
2525

2626
### Prerequisites
2727

28-
- **[Setting up Monitoring Stack on Kubernetes](installation/monitoring-stack-kubernetes.md)** - Optional guide for Prometheus and Grafana setup
29-
- Required only if you want metrics visualization
30-
- Not needed for basic Kepler installation
28+
- **[Setting up Monitoring Stack on Kubernetes](installation/monitoring-stack-kubernetes.md)** - Guide for prometheus-operator, Prometheus, and Grafana
29+
- prometheus-operator is **REQUIRED** (Kepler Operator creates ServiceMonitor resources)
30+
- Prometheus and Grafana are optional (needed only for metrics visualization)
3131

3232
## Guides
3333

@@ -62,15 +62,23 @@ If you want to contribute to Kepler Operator or understand its internals, see th
6262
### Kubernetes Quick Start
6363

6464
```bash
65-
# Install cert-manager
65+
# 1. Install cert-manager (required)
6666
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.18.2/cert-manager.yaml
6767

68-
# Install Kepler Operator via Helm
68+
# 2. Install prometheus-operator (required)
69+
# Using kube-prometheus-stack (includes Prometheus + Grafana)
70+
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
71+
helm install prometheus prometheus-community/kube-prometheus-stack \
72+
--namespace monitoring \
73+
--create-namespace \
74+
--set prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues=false
75+
76+
# 3. Install Kepler Operator via Helm
6977
helm install kepler-operator ./manifests/helm/kepler-operator \
7078
--namespace kepler-operator \
7179
--create-namespace
7280

73-
# Create PowerMonitor
81+
# 4. Create PowerMonitor
7482
kubectl apply -f - <<EOF
7583
apiVersion: kepler.system.sustainable.computing.io/v1alpha1
7684
kind: PowerMonitor

docs/user/installation/monitoring-stack-kubernetes.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,30 @@ This guide helps you set up Prometheus and Grafana on vanilla Kubernetes to visu
44

55
## Overview
66

7-
Kepler exports metrics in Prometheus format. To visualize these metrics with Grafana dashboards, you need:
7+
Kepler exports metrics in Prometheus format. To use Kepler Operator, you need:
88

9-
1. **Prometheus** - To collect and store Kepler metrics
10-
2. **prometheus-operator** - To enable ServiceMonitor-based discovery (optional but recommended)
11-
3. **Grafana** - To visualize metrics with dashboards
9+
1. **prometheus-operator** - **REQUIRED** for ServiceMonitor support (Kepler Operator creates ServiceMonitor resources)
10+
2. **Prometheus** - Optional, to collect and store Kepler metrics for visualization
11+
3. **Grafana** - Optional, to visualize metrics with dashboards
1212

13-
**Note**: This is a prerequisite guide, not part of Kepler Operator itself. Kepler Operator assumes you already have a monitoring solution if you want metrics visualization.
13+
**Important**: Kepler Operator requires prometheus-operator to be installed because it creates ServiceMonitor custom resources. You can install just prometheus-operator without Prometheus/Grafana, but you won't be able to collect or visualize metrics.
1414

15-
## When Do You Need This?
15+
## What Do You Need?
1616

17-
You need a monitoring stack if you want to:
17+
### Required: prometheus-operator
18+
19+
**You MUST install prometheus-operator** before installing Kepler Operator. The operator will fail to reconcile PowerMonitor resources without it.
20+
21+
### Optional: Full Monitoring Stack
22+
23+
You need a complete monitoring stack (Prometheus + Grafana) if you want to:
1824

1925
- Visualize energy consumption metrics in Grafana dashboards
2026
- Query historical power consumption data
2127
- Set up alerts based on energy usage
2228
- Integrate with existing monitoring infrastructure
2329

24-
You can install Kepler Operator without a monitoring stack, but you won't be able to visualize metrics.
30+
You can install only prometheus-operator without Prometheus/Grafana, but Kepler metrics won't be collected or visualized.
2531

2632
## Quick Start: kube-prometheus-stack (Recommended)
2733

0 commit comments

Comments
 (0)