prometheus-community / helm-charts

Prometheus community Helm charts
Apache License 2.0
4.97k stars 4.98k forks source link

[kube-prometheus-stack] Clarify chart is not 100% faithful to `kube-prometheus` #4741

Open d4nyll opened 1 month ago

d4nyll commented 1 month ago

Is your feature request related to a problem ?

Based on the name of the chart kube-prometheus-stack and the first line of the README.md:

Installs the kube-prometheus stack...

It gives the impression that the chart will install everything in the list in the kube-prometheus README.md, namely:

Components included in this package:

However, kube-prometheus-stack does not include the Prometheus Adapter nor blackbox-exporter, but does include prometheus-windows-exporter.

Describe the solution you'd like.

Change the README.md to be explicit about these caveats.

Describe alternatives you've considered.

Rename the chart to dissociate itself from kube-prometheus

Additional context.

It can avoid issues like https://github.com/prometheus-community/helm-charts/issues/1974 where someone expects Prometheus Adapter to be installed when, in reality, it isn't.

jkroepke commented 1 month ago

Would you iike to create an PR here?