Skip to content

Commit

Permalink
Dropdowns
Browse files Browse the repository at this point in the history
  • Loading branch information
pavangudiwada committed Jan 11, 2024
1 parent 6ae218b commit 120ce8e
Showing 1 changed file with 41 additions and 32 deletions.
73 changes: 41 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,26 +66,16 @@ Robusta KRR (Kubernetes Resource Recommender) is a CLI tool for optimizing resou

[![Used to send data to KRR](./images/krr-datasources.svg)](#data-source-integrations)

View Instructions for:
* [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)

* [Google Managed Prometheus](./docs/google-cloud-managed-service-for-prometheus.md)
* [Amazon Managed Prometheus](#amazon-managed-prometheus)
* [Azure Managed Prometheus](#azure-managed-prometheus)
* [Coralogix](#coralogix-managed-prometheus)
* [Grafana Cloud](#grafana-cloud-managed-prometheus)
_View Instructions for: [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), [Google Managed Prometheus](./docs/google-cloud-managed-service-for-prometheus.md), [Amazon Managed Prometheus](#amazon-managed-prometheus), [Azure Managed Prometheus](#azure-managed-prometheus), [Coralogix](#coralogix-managed-prometheus) and [Grafana Cloud](#grafana-cloud-managed-prometheus)_



### Get Recommendations

[![Used to receive information from KRR](./images/krr-other-integrations.svg)](#data-source-integrations)

View instructions for:

* [Seeing recommendations in a UI](#integrations)
* [Sending recommendations to Slack](#integrations)
* [Setting up KRR as a k9s plugin](#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)

### Features

Expand Down Expand Up @@ -380,8 +370,10 @@ Find about how KRR tries to find the default Prometheus to connect <a href="#pro

## Data Source Integrations

<details>
<summary>Prometheus, Victoria Metrics and Thanos auto-discovery</summary>
<details><summary>

#### Prometheus, Victoria Metrics and Thanos auto-discovery
</summary>

By default, KRR will try to auto-discover the running Prometheus Victoria Metrics and Thanos.
For discovering Prometheus it scans services for those labels:
Expand Down Expand Up @@ -420,8 +412,10 @@ If none of those labels result in finding Prometheus, Victoria Metrics or Thanos

</details>

<details>
<summary>Scanning with a Centralized Prometheus</summary>
<details><summary>

#### Scanning with a Centralized Prometheus
</summary>

If your Prometheus monitors multiple clusters we require the label you defined for your cluster in Prometheus.

Expand All @@ -436,8 +430,10 @@ You may also need the `-p` flag to explicitly give Prometheus' URL.
</details>


<details>
<summary>Azure Managed Prometheus</summary>
<details><summary>

#### Azure Managed Prometheus
</summary>

For Azure managed Prometheus you need to generate an access token, which can be done by running the following command:

Expand All @@ -460,8 +456,10 @@ python krr.py simple --namespace default -p PROMETHEUS_URL --prometheus-auth-hea
</details>


<details>
<summary> Amazon Managed Prometheus </summary>
<details><summary>

#### Amazon Managed Prometheus
</summary>

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

Expand All @@ -484,8 +482,11 @@ Additional optional parameters are:
<p align="right">(<a href="#readme-top">back to top</a>)</p>
</details>

<details>
<summary>Coralogix Managed Prometheus</summary>

<details><summary>

#### Coralogix Managed Prometheus
</summary>

For Coralogix managed Prometheus you need to specify your Prometheus link and add the flag coralogix_token with your Logs Query Key

Expand All @@ -498,8 +499,10 @@ python krr.py simple -p "https://prom-api.coralogix..." --coralogix_token
<p align="right">(<a href="#readme-top">back to top</a>)</p>
</details>

<details>
<summary> Grafana Cloud Managed Prometheus </summary>
<details><summary>

#### Grafana Cloud Managed Prometheus
</summary>

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.

Expand All @@ -517,8 +520,10 @@ python krr.py simple -p $PROM_URL --prometheus-auth-header "Bearer ${PROM_USER}:

## Integrations

<details>
<summary> Free UI for KRR recommendations </summary>
<details><summary>

#### Free UI for KRR recommendations
</summary>

With the [free Robusta SaaS platform](https://home.robusta.dev/) you can:

Expand All @@ -530,8 +535,10 @@ With the [free Robusta SaaS platform](https://home.robusta.dev/) you can:

</details>

<details>
<summary> Slack Notification</summary>
<details><summary>

#### Slack Notification
</summary>

Put cost savings on autopilot. Get notified in Slack about recommendations above X%. Send a weekly global report, or one report per team.

Expand Down Expand Up @@ -568,8 +575,10 @@ customPlaybooks:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

</details>
<details>
<summary>k9s Plugin </summary>
<details><summary>

#### k9s Plugin
</summary>

Install our k9s Plugin to get recommendations directly in deployments/daemonsets/statefulsets views.

Expand Down

0 comments on commit 120ce8e

Please sign in to comment.