diff --git a/README.md b/README.md index c5f8d7c1..4bba71ac 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ . How KRR works . - Free KRR UI + KRR UI
Usage ยท @@ -77,16 +77,16 @@ _View Instructions for: [Prometheus](#prometheus-victoria-metrics-and-thanos-aut [![Used to receive information from KRR](./images/krr-other-integrations.svg)](#integrations) -_View instructions for: [Seeing recommendations in a UI](#free-ui-for-krr-recommendations), [Sending recommendations to Slack](#slack-notification), [Setting up KRR as a k9s plugin](#k9s-plugin), [Azure Blob Storage Export with Teams Notification](#azure-blob-teams-integration)_ +_View instructions for: [Seeing recommendations in a UI](#ui-for-krr-recommendations), [Sending recommendations to Slack](#slack-notification), [Setting up KRR as a k9s plugin](#k9s-plugin), [Azure Blob Storage Export with Teams Notification](#azure-blob-teams-integration)_ ### Features -- **No Agent Required**: Run a CLI tool on your local machine for immediate results. (Or run in-cluster for weekly [Slack reports](#slack-integration).) +- **No Agent Required**: Run a CLI tool on your local machine for immediate results. (Or run in-cluster for weekly [Slack reports](#slack-notification).) - **Prometheus Integration**: Get recommendations based on the data you already have -- **Explainability**: [Understand how recommendations were calculated with explanation graphs](#free-krr-ui-on-robusta-saas) +- **Explainability**: [Understand how recommendations were calculated with explanation graphs](#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). -- **Agentic Cost Savings**: Go beyond KRR's rule-based recommendations with [HolmesGPT](#free-krr-ui-on-robusta-saas) โ€” an AI agent that investigates your cluster to find and fix cost-saving opportunities, and generates fixes for KRR's recommendations. +- **SaaS Platform**: See why KRR recommends what it does, by using the [Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=features-saas-platform). +- **Agentic Cost Savings**: Go beyond KRR's rule-based recommendations with [HolmesGPT](#krr-ui-on-robusta-saas) โ€” an AI agent that investigates your cluster to find and fix cost-saving opportunities, and generates fixes for KRR's recommendations. - **Future Support**: Upcoming versions will support custom resources (e.g. GPUs) and custom metrics. ### How Much Can I Expect to Save with KRR? @@ -108,9 +108,9 @@ Read more about [how KRR works](#how-krr-works) | Installation Location ๐ŸŒ | โœ… Not required to be installed inside the cluster, can be used on your own device, connected to a cluster | โŒ Must be installed inside the cluster | | Workload Configuration ๐Ÿ”ง | โœ… No need to configure a VPA object for each workload | โŒ Requires VPA object configuration for each workload | | Immediate Results โšก | โœ… Gets results immediately (given Prometheus is running) | โŒ Requires time to gather data and provide recommendations | -| Reporting ๐Ÿ“Š | โœ… Json, CSV, Markdown, [Web UI](#free-ui-for-krr-recommendations), and more! | โŒ Not supported | +| Reporting ๐Ÿ“Š | โœ… Json, CSV, Markdown, [Web UI](#ui-for-krr-recommendations), and more! | โŒ Not supported | | Extensibility ๐Ÿ”ง | โœ… Add your own strategies with few lines of Python | :warning: Limited extensibility | -| Explainability ๐Ÿ“– | โœ… [See graphs explaining the recommendations](#free-krr-ui-on-robusta-saas) | โŒ Not supported | +| Explainability ๐Ÿ“– | โœ… [See graphs explaining the recommendations](#krr-ui-on-robusta-saas) | โŒ Not supported | | Custom Metrics ๐Ÿ“ | ๐Ÿ”„ Support in future versions | โŒ Not supported | | Custom Resources ๐ŸŽ›๏ธ | ๐Ÿ”„ Support in future versions (e.g., GPU) | โŒ Not supported | | Autoscaling ๐Ÿ”€ | ๐Ÿ”„ Support in future versions | โœ… Automatic application of recommendations | @@ -194,7 +194,7 @@ We do **not** recommend installing KRR from source in airgapped environments due In-Cluster Apart from running KRR as a CLI tool you can also run KRR inside your cluster. We suggest installing KRR via the Robusta Platform -. It gives you a free UI with some features like the following +. It gives you a UI with some features like the following * View application usage history graphs on which recommendations are based. * Get application, namespace and cluster level recommendations. * YAML configuration to apply the suggested recommendation and more @@ -242,7 +242,7 @@ All above examples show running command as `krr ...`, replace it with `python kr ### Additional Options -- [View KRR Reports in a Web UI](#free-ui-for-krr-recommendations) +- [View KRR Reports in a Web UI](#ui-for-krr-recommendations) - [Receive KRR Reports Weekly in Slack](#slack-notification) ### Environment-Specific Instructions @@ -261,9 +261,9 @@ Setup KRR for... If your llm provider url uses a certificate from a custom CA, in order to trust it, base-64 encode the certificate, and store it in an environment variable named ``CERTIFICATE`` -## Free KRR UI on Robusta SaaS +## KRR UI on Robusta SaaS -We highly recommend using the [free Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=free-krr-ui-robusta-saas-platform). You can: +We highly recommend using the [Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=krr-ui-robusta-saas-platform). You can: - Understand individual app recommendations with app usage history - Sort and filter recommendations by namespace, priority, and more @@ -473,7 +473,7 @@ Robusta KRR uses the following Prometheus queries to gather usage data: [_Need to customize the metrics? Tell us and we'll add support._](https://github.com/robusta-dev/krr/issues/new) -Get a free breakdown of KRR recommendations in the [Robusta SaaS](#free-krr-ui-on-robusta-saas). +Get a breakdown of KRR recommendations in the [Robusta SaaS](#krr-ui-on-robusta-saas). ### Algorithm @@ -653,10 +653,10 @@ For discovering Prometheus it scans services for those labels: ## Integrations -
-Free UI for KRR recommendations +
+UI for KRR recommendations -We highly recommend using the [free Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=integrations-free-robusta-saas-platform). You can: +We highly recommend using the [Robusta SaaS platform](https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=integrations-robusta-saas-platform). You can: - Understand individual app recommendations with app usage history - Sort and filter recommendations by namespace, priority, and more @@ -858,7 +858,7 @@ Distributed under the MIT License. See [LICENSE.txt](https://github.com/robusta- ## Support -If you have any questions, feel free to contact **support@robusta.dev** or message us on [robustacommunity.slack.com](https://bit.ly/robusta-slack) +If you have any questions, contact **support@robusta.dev** or message us on [robustacommunity.slack.com](https://bit.ly/robusta-slack)

(back to top)