Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
![Product Name Screen Shot][product-screenshot]

<div align="center">
<h1 align="center">Kubernetes Resource Recommendations Based on Historical Data</h1>
<h2 align="center">Get recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!</h2>
<h2 align="center">Get Kubernetes Resource Recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!</h2>
<p align="center">
<a href="#installation"><strong>Installation</strong></a>
.
Expand All @@ -28,9 +27,6 @@
<a href="https://github.com/robusta-dev/krr/issues">Request Feature</a>
·
<a href="#support">Support</a>
<br />
<br />
<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>
</p>
</div>
<!-- TABLE OF CONTENTS -->
Expand Down Expand Up @@ -66,7 +62,7 @@ Robusta KRR (Kubernetes Resource Recommender) is a CLI tool for **optimizing res

### Auto-Apply Mode

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

### Data Integrations

Expand All @@ -90,6 +86,7 @@ _View instructions for: [Seeing recommendations in a UI](#free-ui-for-krr-recomm
- **Explainability**: [Understand how recommendations were calculated with explanation graphs](#free-krr-ui-on-robusta-saas)
- **Extensible Strategies**: Easily create and use your own strategies for calculating resource recommendations.
- **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).
- **AI-Powered Fixes**: [Generate fixes for KRR recommendations using HolmesGPT](#free-krr-ui-on-robusta-saas) on the Robusta SaaS platform
- **Future Support**: Upcoming versions will support custom resources (e.g. GPUs) and custom metrics.

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

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

<!-- USAGE EXAMPLES -->

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

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

</details>

Expand Down
9 changes: 8 additions & 1 deletion enforcer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ A mutating webhook server that automatically enforces [KRR (Kubernetes Resource
- **Flexible Enforcement Modes**: Support for enforce/ignore modes per workload
- **REST API**: Query recommendations via HTTP endpoints

## Prerequisites

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.

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)

Once Robusta is running, you can install the KRR Enforcer as described below.

## Enforcement Modes

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

### Certificate

Expand Down
Binary file added images/krr-create-pr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading