search

robusta-dev / krr

Prometheus-based Kubernetes Resource Recommendations
MIT License
3.05k stars 160 forks source link
cost-control cost-saving finops kubectl kubernetes metrics monitoring prometheus rightsizing vpa

readme

Product Name Screen Shot

Kubernetes Resource Recommendations Based on Historical Data

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

Installation . How KRR works . Slack Integration . Free KRR UI
Usage · Report Bug · Request Feature · Support
Like KRR? Please ⭐ this repository to show your support!

About The Project

Robusta KRR (Kubernetes Resource Recommender) is a CLI tool for optimizing resource allocation in Kubernetes clusters. It gathers pod usage data from Prometheus and recommends requests and limits for CPU and memory. This reduces costs and improves performance.

Data Integrations

Used to send data to KRR

View Instructions for: Prometheus, Thanos, Victoria Metrics, Google Managed Prometheus, Amazon Managed Prometheus, Azure Managed Prometheus, Coralogix,Grafana Cloud and Grafana Mimir

Reporting Integrations

Used to receive information from KRR

View instructions for: Seeing recommendations in a UI, Sending recommendations to Slack, Setting up KRR as a k9s plugin

Features

How Much Can I Expect to Save with KRR?

According to a recent Sysdig study, on average, Kubernetes clusters have:

By right-sizing your containers with KRR, you can save an average of 69% on cloud costs.

Read more about how KRR works

Difference with Kubernetes VPA

Feature 🛠️ Robusta KRR 🚀 Kubernetes VPA 🌐
Resource Recommendations 💡 ✅ CPU/Memory requests and limits ✅ CPU/Memory requests and limits
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, and more! ❌ Not supported
Extensibility 🔧 ✅ Add your own strategies with few lines of Python :warning: Limited extensibility
Explainability 📖 ✅ See graphs explaining the recommendations ❌ 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
Default History 🕒 14 days 8 days
Supports HPA 🔥 ✅ Enable using --allow-hpa flag ❌ Not supported

Installation

Requirements

KRR requires Prometheus 2.26+, kube-state-metrics & cAdvisor.

Which metrics does KRR need? No setup is required if you use kube-prometheus-stack or Robusta's Embedded Prometheus. If you have a different setup, make sure the following metrics exist: - `container_cpu_usage_seconds_total` - `container_memory_working_set_bytes` - `kube_replicaset_owner` - `kube_pod_owner` - `kube_pod_status_phase` _Note: If one of last three metrics is absent KRR will still work, but it will only consider currently-running pods when calculating recommendations. Historic pods that no longer exist in the cluster will not be taken into consideration._

Installation Methods

Brew (Mac/Linux) 1. Add our tap: ```sh brew tap robusta-dev/homebrew-krr ``` 2. Install KRR: ```sh brew install krr ``` 3. Check that installation was successful: ```sh krr --help ``` 4. Run KRR (first launch might take a little longer): ```sh krr simple ```
Windows You can install using brew (see above) on [WSL2](https://docs.brew.sh/Homebrew-on-Linux), or install from source (see below).
Docker image, binaries, and airgapped installation (offline environments) You can download pre-built binaries from Releases or use the prebuilt Docker container. For example, the container for version 1.8.3 is: ``` us-central1-docker.pkg.dev/genuine-flight-317411/devel/krr:v1.8.3 ``` We do **not** recommend installing KRR from source in airgapped environments due to the headache of installing Python dependencies. Use one of the above methods instead and contact us (via Slack, GitHub issues, or email) if you need assistance.
From Source 1. Make sure you have [Python 3.9](https://www.python.org/downloads/) (or greater) installed 2. Clone the repo: ```sh git clone https://github.com/robusta-dev/krr ``` 3. Navigate to the project root directory (`cd ./krr`) 4. Install requirements: ```sh pip install -r requirements.txt ``` 5. Run the tool: ```sh python krr.py --help ``` Notice that using source code requires you to run as a python script, when installing with brew allows to run `krr`. All above examples show running command as `krr ...`, replace it with `python krr.py ...` if you are using a manual installation.

Additional Options

Environment-Specific Instructions

Setup KRR for...

(back to top)

Trusting custom Certificate Authority (CA) certificate:

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

We highly recommend using the free Robusta SaaS platform. You can:

Usage

Basic usage ```sh krr simple ```
Tweak the recommendation algorithm (strategy) Most helpful flags: - `--cpu-min` Sets the minimum recommended cpu value in millicores - `--mem-min` Sets the minimum recommended memory value in MB - `--history_duration` The duration of the Prometheus history data to use (in hours) More specific information on Strategy Settings can be found using ```sh krr simple --help ```
Giving an Explicit Prometheus URL If your Prometheus is not auto-connecting, you can use `kubectl port-forward` for manually forwarding Prometheus. For example, if you have a Prometheus Pod called `kube-prometheus-st-prometheus-0`, then run this command to port-forward it: ```sh kubectl port-forward pod/kube-prometheus-st-prometheus-0 9090 ``` Then, open another terminal and run krr in it, giving an explicit Prometheus url: ```sh krr simple -p http://127.0.0.1:9090 ```
Run on specific namespaces List as many namespaces as you want with `-n` (in this case, `default` and `ingress-nginx`) ```sh krr simple -n default -n ingress-nginx ``` The -n flag also supports regex matches like -n kube-.*. To use regexes, you must have permissions to list namespaces in the target cluster. ```sh krr simple -n default -n 'ingress-.*' ``` See [example ServiceAccount and RBAC permissions](./tests/single_namespace_permissions.yaml)
Run on workloads filtered by label Use a label selector ```sh python krr.py simple --selector 'app.kubernetes.io/instance in (robusta, ingress-nginx)' ```
Override the kubectl context By default krr will run in the current context. If you want to run it in a different context: ```sh krr simple -c my-cluster-1 -c my-cluster-2 ```
Output formats for reporting (JSON, YAML, CSV, and more) Currently KRR ships with a few formatters to represent the scan data: - `table` - a pretty CLI table used by default, powered by [Rich](https://github.com/Textualize/rich) library - `json` - `yaml` - `pprint` - data representation from python's pprint library - `csv` - export data to a csv file in the current directory - `html` To run a strategy with a selected formatter, add a `-f` flag. Usually this should be combined with `--fileoutput ` to write clean output to file without logs: ```sh krr simple -f json --fileoutput krr-report.json ``` If you prefer, you can also use `--logtostderr` to get clean formatted output in one file and error logs in another: ```sh krr simple --logtostderr -f json > result.json 2> logs-and-errors.log ```
Centralized Prometheus (multi-cluster)

See below on filtering output from a centralized prometheus, so it matches only one cluster

Prometheus Authentication KRR supports all known authentication schemes for Prometheus, VictoriaMetrics, Coralogix, and other Prometheus compatible metric stores. Refer to `krr simple --help`, and look at the flags `--prometheus-url`, `--prometheus-auth-header`, `--prometheus-headers` `--prometheus-ssl-enabled`, `--coralogix-token`, and the various `--eks-*` flags. If you need help, contact us on Slack, email, or by opening a GitHub issue.
Debug mode If you want to see additional debug logs: ```sh krr simple -v ```

(back to top)

How KRR works

Metrics Gathering

Robusta KRR uses the following Prometheus queries to gather usage data:

Need to customize the metrics? Tell us and we'll add support.

Get a free breakdown of KRR recommendations in the Robusta SaaS.

Algorithm

By default, we use a simple strategy to calculate resource recommendations. It is calculated as follows (The exact numbers can be customized in CLI arguments):

Prometheus connection

Find about how KRR tries to find the default Prometheus to connect here.

(back to top)

Data Source Integrations

Prometheus, Victoria Metrics and Thanos auto-discovery By default, KRR will try to auto-discover the running Prometheus Victoria Metrics and Thanos. For discovering Prometheus it scans services for those labels: ```python "app=kube-prometheus-stack-prometheus" "app=prometheus,component=server" "app=prometheus-server" "app=prometheus-operator-prometheus" "app=rancher-monitoring-prometheus" "app=prometheus-prometheus" ``` For Thanos its these labels: ```python "app.kubernetes.io/component=query,app.kubernetes.io/name=thanos", "app.kubernetes.io/name=thanos-query", "app=thanos-query", "app=thanos-querier", ``` And for Victoria Metrics its the following labels: ```python "app.kubernetes.io/name=vmsingle", "app.kubernetes.io/name=victoria-metrics-single", "app.kubernetes.io/name=vmselect", "app=vmselect", ``` If none of those labels result in finding Prometheus, Victoria Metrics or Thanos, you will get an error and will have to pass the working url explicitly (using the `-p` flag).

(back to top)

Scanning with a Centralized Prometheus If your Prometheus monitors multiple clusters we require the label you defined for your cluster in Prometheus. For example, if your cluster has the Prometheus label `cluster: "my-cluster-name"`, then run this command: ```sh krr.py simple --prometheus-label cluster -l my-cluster-name ``` You may also need the `-p` flag to explicitly give Prometheus' URL.
Azure Managed Prometheus For Azure managed Prometheus you need to generate an access token, which can be done by running the following command: ```sh # If you are not logged in to Azure, uncomment out the following line # az login AZURE_BEARER=$(az account get-access-token --resource=https://prometheus.monitor.azure.com --query accessToken --output tsv); echo $AZURE_BEARER ``` Than run the following command with PROMETHEUS_URL substituted for your Azure Managed Prometheus URL: ```sh python krr.py simple --namespace default -p PROMETHEUS_URL --prometheus-auth-header "Bearer $AZURE_BEARER" ```

See here about configuring labels for centralized prometheus

(back to top)

Google Managed Prometheus (GMP) Please find the detailed GMP usage instructions [here](https://github.com/robusta-dev/krr/blob/main/docs/google-cloud-managed-service-for-prometheus.md)

(back to top)

Amazon Managed Prometheus For Amazon Managed Prometheus you need to add your Prometheus link and the flag --eks-managed-prom and krr will automatically use your aws credentials ```sh python krr.py simple -p "https://aps-workspaces.REGION.amazonaws.com/workspaces/..." --eks-managed-prom ``` Additional optional parameters are: ```sh --eks-profile-name PROFILE_NAME_HERE # to specify the profile to use from your config --eks-access-key ACCESS_KEY # to specify your access key --eks-secret-key SECRET_KEY # to specify your secret key --eks-service-name SERVICE_NAME # to use a specific service name in the signature --eks-managed-prom-region REGION_NAME # to specify the region the Prometheus is in ```

See here about configuring labels for centralized prometheus

(back to top)

Coralogix Managed Prometheus For Coralogix managed Prometheus you need to specify your Prometheus link and add the flag coralogix_token with your Logs Query Key ```sh python krr.py simple -p "https://prom-api.coralogix..." --coralogix_token ```

See here about configuring labels for centralized prometheus

(back to top)

Grafana Cloud Managed Prometheus For Grafana Cloud managed Prometheus you need to specify Prometheus link, Prometheus user, and an access token of your Grafana Cloud stack. The Prometheus link and user for the stack can be found on the Grafana Cloud Portal. An access token with a `metrics:read` scope can also be created using Access Policies on the same portal. Next, run the following command, after setting the values of PROM_URL, PROM_USER, and PROM_TOKEN variables with your Grafana Cloud stack's Prometheus link, Prometheus user, and access token. ```sh python krr.py simple -p $PROM_URL --prometheus-auth-header "Bearer ${PROM_USER}:${PROM_TOKEN}" --prometheus-ssl-enabled ```

See here about configuring labels for centralized prometheus

(back to top)

Grafana Mimir auto-discovery By default, KRR will try to auto-discover the running Grafana Mimir. For discovering Prometheus it scans services for those labels: ```python "app.kubernetes.io/name=mimir,app.kubernetes.io/component=query-frontend" ```

(back to top)

Integrations

Free UI for KRR recommendations We highly recommend using the [free Robusta SaaS platform](https://platform.robusta.dev/signup/?utm_source=github&utm_medium=krr-readme). You can: - 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
Slack Notification Put cost savings on autopilot. Get notified in Slack about recommendations above X%. Send a weekly global report, or one report per team. ![Slack Screen Shot][slack-screenshot] ### Prerequisites - A Slack workspace ### Setup 1. [Install Robusta with Helm to your cluster and configure slack](https://docs.robusta.dev/master/installation.html) 2. Create your KRR slack playbook by adding the following to `generated_values.yaml`: ``` customPlaybooks: # Runs a weekly krr scan on the namespace devs-namespace and sends it to the configured slack channel customPlaybooks: - triggers: - on_schedule: fixed_delay_repeat: repeat: -1 # number of times to run or -1 to run forever seconds_delay: 604800 # 1 week actions: - krr_scan: args: "--namespace devs-namespace" ## KRR args here sinks: - "main_slack_sink" # slack sink you want to send the report to here ``` 3. Do a Helm upgrade to apply the new values: `helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=`

(back to top)

k9s Plugin Install our k9s Plugin to get recommendations directly in deployments/daemonsets/statefulsets views. Plugin: [resource recommender](https://github.com/derailed/k9s/blob/master/plugins/resource-recommendations.yaml) Installation instructions: [k9s docs](https://k9scli.io/topics/plugins/)

Creating a Custom Strategy/Formatter

Look into the examples directory for examples on how to create a custom strategy/formatter.

(back to top)

Testing

We use pytest to run tests.

  1. Install the project manually (see above)
  2. Navigate to the project root directory
  3. Install poetry
  4. Install dev dependencies:
poetry install --group dev
  1. Install robusta_krr as editable dependency:
pip install -e .
  1. Run the tests:
poetry run pytest

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Support

If you have any questions, feel free to contact support@robusta.dev or message us on robustacommunity.slack.com

(back to top)