summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSerdar Köktaş <contact@serdarkoktas.com>2023-09-14 16:09:33 +0200
committerSerdar Köktaş <contact@serdarkoktas.com>2023-09-14 16:09:33 +0200
commitf02b341dcb8323809b57a8a1279983a875da98d0 (patch)
tree0e8de96bfc8a834e663e7a241affe1acfe385be5 /README.md
parente243200f498d7b68c9d5ae0ac64c70f7aee4165b (diff)
doc: adds grafana cloud instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8b7a40c..4e4145d 100644
--- a/README.md
+++ b/README.md
@@ -62,7 +62,7 @@
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.
-_Supports: [Prometheus](#prometheus-victoria-metrics-and-thanos-auto-discovery), [Thanos](#prometheus-victoria-metrics-and-thanos-auto-discovery), [Victoria Metrics](#prometheus-victoria-metrics-and-thanos-auto-discovery), [EKS](#eks-managed-prometheus), [Azure](#azure-managed-prometheus) and [Coralogix](#coralogix-managed-prometheus)_
+_Supports: [Prometheus](#prometheus-victoria-metrics-and-thanos-auto-discovery), [Thanos](#prometheus-victoria-metrics-and-thanos-auto-discovery), [Victoria Metrics](#prometheus-victoria-metrics-and-thanos-auto-discovery), [EKS](#eks-managed-prometheus), [Azure](#azure-managed-prometheus), [Coralogix](#coralogix-managed-prometheus) and [Grafana Cloud](#grafana-cloud-managed-prometheus)_
### Features
@@ -423,6 +423,19 @@ python krr.py simple -p "https://prom-api.coralogix..." --coralogix_token
<p align="right">(<a href="#readme-top">back to top</a>)</p>
+## 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
+```
+
+<p ><a href="#scanning-with-a-centralized-prometheus">See here about configuring labels for centralized prometheus</a></p>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
<!-- Formatters -->
## Available formatters