Skip to content

Commit d53c2f4

Browse files
nimrikclaudearikalon1
authored
Update README: replace KRR scan history video with create PR screenshot (#513)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Arik Alon <alon.arik@gmail.com>
1 parent c40fe37 commit d53c2f4

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
![Product Name Screen Shot][product-screenshot]
1313

1414
<div align="center">
15-
<h1 align="center">Kubernetes Resource Recommendations Based on Historical Data</h1>
16-
<h2 align="center">Get recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!</h2>
15+
<h2 align="center">Get Kubernetes Resource Recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!</h2>
1716
<p align="center">
1817
<a href="#installation"><strong>Installation</strong></a>
1918
.
@@ -28,9 +27,6 @@
2827
<a href="https://github.com/robusta-dev/krr/issues">Request Feature</a>
2928
·
3029
<a href="#support">Support</a>
31-
<br />
32-
<br />
33-
<a href="https://trendshift.io/repositories/7087" target="_blank"><img src="https://trendshift.io/api/badge/repositories/7087" alt="robusta-dev%2Fkrr | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
3430
</p>
3531
</div>
3632
<!-- TABLE OF CONTENTS -->
@@ -66,7 +62,7 @@ Robusta KRR (Kubernetes Resource Recommender) is a CLI tool for **optimizing res
6662

6763
### Auto-Apply Mode
6864

69-
**New:** Put right-sizing on auto-pilot by applying recommendations automatically. [Request beta access](https://robusta-dev.typeform.com/krr-auto-apply).
65+
Put right-sizing on auto-pilot by applying recommendations automatically. See the [KRR Enforcer docs](https://github.com/robusta-dev/krr/tree/main/enforcer).
7066

7167
### Data Integrations
7268

@@ -90,6 +86,7 @@ _View instructions for: [Seeing recommendations in a UI](#free-ui-for-krr-recomm
9086
- **Explainability**: [Understand how recommendations were calculated with explanation graphs](#free-krr-ui-on-robusta-saas)
9187
- **Extensible Strategies**: Easily create and use your own strategies for calculating resource recommendations.
9288
- **Free SaaS Platform**: See why KRR recommends what it does, by using the [free Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=features-free-saas-platform).
89+
- **AI-Powered Fixes**: [Generate fixes for KRR recommendations using HolmesGPT](#free-krr-ui-on-robusta-saas) on the Robusta SaaS platform
9390
- **Future Support**: Upcoming versions will support custom resources (e.g. GPUs) and custom metrics.
9491

9592
### How Much Can I Expect to Save with KRR?
@@ -271,11 +268,11 @@ We highly recommend using the [free Robusta SaaS platform](https://platform.robu
271268
- Understand individual app recommendations with app usage history
272269
- Sort and filter recommendations by namespace, priority, and more
273270
- Give devs a YAML snippet to fix the problems KRR finds
274-
- Analyze impact using KRR scan history
271+
- Automatically generate fixes for KRR recommendations using AI and HolmesGPT
275272

276-
<a href="https://www.loom.com/share/49ea188f67c545f0ae98508b448d1a8b">
277-
<img src="https://cdn.loom.com/sessions/thumbnails/49ea188f67c545f0ae98508b448d1a8b-with-play.gif">
278-
</a>
273+
<p align="center">
274+
<img src="./images/krr-create-pr.png" alt="Create PR with AI-generated fix for KRR recommendation" width="450">
275+
</p>
279276

280277
<!-- USAGE EXAMPLES -->
281278

@@ -662,11 +659,8 @@ We highly recommend using the [free Robusta SaaS platform](https://platform.robu
662659
- Understand individual app recommendations with app usage history
663660
- Sort and filter recommendations by namespace, priority, and more
664661
- Give dev's a YAML snippet to fix the problems KRR finds
665-
- Analyze impact using KRR scan history
662+
- Automatically generate fixes for KRR recommendations using AI and HolmesGPT
666663

667-
<a href="https://www.loom.com/share/49ea188f67c545f0ae98508b448d1a8b">
668-
<img src="https://cdn.loom.com/sessions/thumbnails/49ea188f67c545f0ae98508b448d1a8b-with-play.gif">
669-
</a>
670664

671665
</details>
672666

enforcer/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ A mutating webhook server that automatically enforces [KRR (Kubernetes Resource
88
- **Flexible Enforcement Modes**: Support for enforce/ignore modes per workload
99
- **REST API**: Query recommendations via HTTP endpoints
1010

11+
## Prerequisites
12+
13+
The KRR Enforcer requires Robusta (which bundles KRR) to be installed in your cluster, along with a Robusta UI account (free tier available) to store KRR scan results.
14+
15+
Start by installing Robusta in your cluster using the [all-in-one installation guide](https://docs.robusta.dev/master/setup-robusta/installation/all-in-one-installation.html)
16+
17+
Once Robusta is running, you can install the KRR Enforcer as described below.
18+
1119
## Enforcement Modes
1220

1321
Enforcement can be configured globally or on a per-workload basis.
@@ -44,7 +52,6 @@ The webhook uses `failurePolicy: Ignore` by default, meaning if the webhook fail
4452
### Prerequisites
4553
- Helm 3.x
4654
- Prometheus Operator (optional, for metrics collection)
47-
- Robusta UI account - used to store KRR scan results
4855

4956
### Certificate
5057

images/krr-create-pr.png

136 KB
Loading

0 commit comments

Comments
 (0)