Add support for prometheus

[ric-plt/ric-dep.git] / helm / infrastructure / subcharts / prometheus / charts / kube-state-metrics / templates / NOTES.txt

diff --git a/helm/infrastructure/subcharts/prometheus/charts/kube-state-metrics/templates/NOTES.txt b/helm/infrastructure/subcharts/prometheus/charts/kube-state-metrics/templates/NOTES.txt
new file mode 100644 (file)
index 0000000..5a646e0
--- /dev/null
+++ b/helm/infrastructure/subcharts/prometheus/charts/kube-state-metrics/templates/NOTES.txt
@@ -0,0 +1,10 @@
+kube-state-metrics is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects.
+The exposed metrics can be found here:
+https://github.com/kubernetes/kube-state-metrics/blob/master/docs/README.md#exposed-metrics
+
+The metrics are exported on the HTTP endpoint /metrics on the listening port.
+In your case, {{ template "kube-state-metrics.fullname" . }}.{{ template "kube-state-metrics.namespace" . }}.svc.cluster.local:{{ .Values.service.port }}/metrics
+
+They are served either as plaintext or protobuf depending on the Accept header.
+They are designed to be consumed either by Prometheus itself or by a scraper that is compatible with scraping a Prometheus client endpoint.
+