Skip to content

Commit a94243a

Browse files
committed
docs: add helm deployment in quick start
Signed-off-by: vprashar2929 <[email protected]>
1 parent 765dc67 commit a94243a

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,43 @@ accurate energy consumption monitoring for cloud-native workloads.
5656

5757
> **📖 For comprehensive installation instructions, troubleshooting, and advanced deployment options, see our [Installation Guide](docs/user/installation.md)**
5858
59-
### ⚡ Quick Start
59+
### ⚡ Quick Start (Kubernetes with Helm)
60+
61+
```sh
62+
# 1. Install Kepler using Helm from OCI registry
63+
helm install kepler oci://quay.io/sustainable_computing_io/charts/kepler \
64+
--namespace kepler \
65+
--create-namespace
66+
67+
# Wait for Kepler pods to be running
68+
kubectl wait --for=condition=ready --timeout=120s pod -n kepler --all
69+
70+
# 2. Verify installation
71+
kubectl get pods -n kepler
72+
73+
# 3. Access metrics (port-forward)
74+
kubectl port-forward -n kepler svc/kepler 28282:28282
75+
76+
# Test metrics endpoint
77+
curl http://localhost:28282/metrics | grep kepler_node_cpu_watts
78+
```
79+
80+
> **📋 For Production Deployments:** Consider using the [Kepler Operator](https://github.com/sustainable-computing-io/kepler-operator#-getting-started) for advanced lifecycle management and operational capabilities.
81+
82+
**Next Steps:**
83+
84+
To ensure Kepler is working correctly and to visualize the metrics:
85+
86+
- **[Verify Metrics Collection](docs/user/installation.md#verify-metrics-collection)** - Verify power consumption metrics are being collected
87+
- **[Configuration Options](docs/user/configuration.md)** - Customize Kepler deployment
88+
- **[Helm Updates & Management](docs/user/helm-updates.md)** - Learn how to upgrade and manage Kepler with Helm
89+
90+
**Need Help?**
91+
92+
- [Installation Guide](docs/user/installation.md) - Detailed prerequisites, configuration options, and installation steps
93+
- [Metrics Documentation](docs/user/metrics.md) - Available metrics and their descriptions
94+
95+
### 🔧 Other Installation Methods
6096

6197
Choose your preferred method:
6298

@@ -67,8 +103,10 @@ make build && sudo ./bin/kepler
67103
# ✨ Docker Compose (with Prometheus & Grafana)
68104
cd compose/dev && docker-compose up -d
69105

70-
# 🐳 Kubernetes
71-
helm install kepler manifests/helm/kepler/ --namespace kepler --create-namespace
106+
# 🐳 Kubernetes with Kustomize
107+
kubectl kustomize manifests/k8s | \
108+
sed -e "s|<KEPLER_IMAGE>|quay.io/sustainable_computing_io/kepler:latest|g" | \
109+
kubectl apply --server-side --force-conflicts -f -
72110
```
73111

74112
## 📖 Documentation

0 commit comments

Comments
 (0)