diff --git a/README.md b/README.md index d54dabeb..faf74fdf 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,7 @@ ![Product Name Screen Shot][product-screenshot]
-

Kubernetes Resource Recommendations Based on Historical Data

-

Get recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!

+

Get Kubernetes Resource Recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!

Installation . @@ -28,9 +27,6 @@ Request Feature ยท Support -
-
- robusta-dev%2Fkrr | Trendshift

@@ -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 @@ -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? @@ -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 - - - +

+ Create PR with AI-generated fix for KRR recommendation +

@@ -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 - - - diff --git a/enforcer/README.md b/enforcer/README.md index fb886398..496ed008 100644 --- a/enforcer/README.md +++ b/enforcer/README.md @@ -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. @@ -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 diff --git a/images/krr-create-pr.png b/images/krr-create-pr.png new file mode 100644 index 00000000..cf0e409f Binary files /dev/null and b/images/krr-create-pr.png differ