diff options
| author | Natan Yellin <aantn@users.noreply.github.com> | 2024-01-11 11:28:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-11 11:28:25 +0200 |
| commit | 648421205c4482d2a884f35fdb32525b52736278 (patch) | |
| tree | 6cc72d53c825d8e9e1b57df74749fb4066cef5e3 /README.md | |
| parent | 45950a753eebbd5c510fba64e6ec7ae7e708e665 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 7 insertions, 2 deletions
@@ -103,10 +103,14 @@ Read more about [how KRR works](#how-krr-works) and [KRR vs Kubernetes VPA](#dif ### Requirements -KRR requires you to have Prometheus. +KRR requires Prometheus and [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics). -Additionally to that, [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) needs to be running on your cluster, as KRR is dependant on those metrics: +<details> + <summary>Which metrics does KRR need?</summary> +No setup is required if you use kube-prometheus-stack or <a href="https://docs.robusta.dev/master/configuration/alertmanager-integration/embedded-prometheus.html">Robusta's Embedded Prometheus</a>. +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` @@ -114,6 +118,7 @@ Additionally to that, [kube-state-metrics](https://github.com/kubernetes/kube-st - `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._ +</details> ### Installation Methods |