[kube-prometheus-stack] Grafana crd datasources

[dzirg44]

Introducing Grafana Datasources as CRDs

Special notes for your reviewer

this PR is a result of #5216
I essence I don't expect any problems but you have to pay attention to 3 things

1. due to the helper usage the sort order in the result yaml config map is broken, I don't think it is a big deal, but let me know if you have any other thoughts

Details

data:
  datasource.yaml: |-
    apiVersion: 1
    datasources:
      - access: proxy
        isDefault: true
        jsonData:
          httpMethod: POST
          timeInterval: 30s
          timeout: null
        name: Prometheus
        type: prometheus
        uid: prometheus
        url: http://prometheus-stack-kube-prom-prometheus.default:9090/
      - access: proxy
        isDefault: false
        jsonData:
          handleGrafanaManagedAlerts: false
          implementation: prometheus
        name: Alertmanager
        type: alertmanager
        uid: alertmanager
        url: http://prometheus-stack-kube-prom-alertmanager.default:9093/

2. the name of name: {{ include "kube-prometheus-stack.fullname" $ }}-{{ include "kube-prometheus-stack.grafana.sanitizeName" $ds.name }} , probably you have a better idea or conventions to name it.

3. default values for

      app.kubernetes.io/instance: grafana
      app.kubernetes.io/name: grafana-operator

I have them in 2 places (values, and the resource), but I often do like this in my charts, but idk if it is appropriate here.
@jkroepke
Also, if I have to mention about it in the documentation - let me know.

Checklist

• DCO signed
• Chart Version bumped
• Title of the PR starts with chart name (e.g. [prometheus-couchdb-exporter])

[jkroepke]

Hi, thanks for split this help. It help at least me to review this with a bit more focus.

To go through the files and leave comments that I have in my mind.

[jkroepke]

This is a suggestion which can be considered as alternative. It's just an option to discuss about if possible and it's not indented as "please use this".

Suggested change

	{{- $defaultDS := dict -}}
	{{- $_ := set $defaultDS "name" .Values.grafana.sidecar.datasources.name -}}
	{{- $_ := set $defaultDS "type" "prometheus" -}}
	{{- $_ := set $defaultDS "uid" .Values.grafana.sidecar.datasources.uid -}}
	{{- $_ := set $defaultDS "url" (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url) -}}
	{{- $_ := set $defaultDS "access" "proxy" -}}
	{{- $_ := set $defaultDS "isDefault" .Values.grafana.sidecar.datasources.isDefaultDatasource -}}
	{{- $_ := set $defaultDS "jsonData" $jsonData -}}
	{{- $defaultDS := (dict
	"name" .Values.grafana.sidecar.datasources.name
	"type" "prometheus"
	"uid" .Values.grafana.sidecar.datasources.uid
	"url" (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url)
	"access" "proxy"
	"isDefault" .Values.grafana.sidecar.datasources.isDefaultDatasource
	"jsonData" $jsonData
	) -}}

[dzirg44]

@jkroepke the main problem here, that if we take your approach we loose the possibility to add comments, because any comments between dict keys break the formatting. At the beginning I implemented it in a way you suggested but later I realized that I cannot make nice conditionals with comments, so I switched to this version.

[jkroepke]

@dzirg44 what the downside of just using plain templating instead put everything logic into the templating syntax?

I still feel not happy, it feel like an unnatural helm template.

Suggested change

	{{- $defaultDS := dict -}}
	{{- $_ := set $defaultDS "name" .Values.grafana.sidecar.datasources.name -}}
	{{- $_ := set $defaultDS "type" "prometheus" -}}
	{{- $_ := set $defaultDS "uid" .Values.grafana.sidecar.datasources.uid -}}
	{{- $_ := set $defaultDS "url" (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url) -}}
	{{- $_ := set $defaultDS "access" "proxy" -}}
	{{- $_ := set $defaultDS "isDefault" .Values.grafana.sidecar.datasources.isDefaultDatasource -}}
	{{- $_ := set $defaultDS "jsonData" $jsonData -}}
	name: {{ .Values.grafana.sidecar.datasources.name }}
	type: prometheus
	uid: {{ .Values.grafana.sidecar.datasources.uid }}
	url: {{ (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url) }}
	access: proxy
	isDefault: {{ .Values.grafana.sidecar.datasources.isDefaultDatasource }}
	{{- with $jsonData }}
	jsonData:
	{{ . | nindent 2 }}
	{{- end }}

[dzirg44]

@jkroepke Can you take a look at the refactored version?
In essence I:

created 3 functions

• kube-prometheus-stack.grafana.datasourceUrl.defaultPrometheus
• kube-prometheus-stack.grafana.datasourceUrl.replica
• kube-prometheus-stack.grafana.datasourceUrl.alertmanager

Converted urlDisplayLabel in exemplarTraceIdDestinations

used coalesce instead of default (can be reverted back) in some cases

timeout - removed (i don't see this parameter in the values or in grafana prometheus datasource api)

Some potential issues:

• exemplarTraceIdDestinations, if I am not mistaken this parameter cannot be omitted so probably the code can be unsafe.
• this code is really weird

{{- $scrapeInterval := .Values.grafana.sidecar.datasources.defaultDatasourceScrapeInterval | default .Values.prometheus.prometheusSpec.scrapeInterval | default "30s" }}

would it be better to set scrapeInterval to 30s in values and remove default?

[jkroepke]

In general it looks good, but I'm not happy how the yaml is generated within the new helper

[jkroepke]

@dzirg44 what the downside of just using plain templating instead put everything logic into the templating syntax?

I still feel not happy, it feel like an unnatural helm template.

Suggested change

	{{- $defaultDS := dict -}}
	{{- $_ := set $defaultDS "name" .Values.grafana.sidecar.datasources.name -}}
	{{- $_ := set $defaultDS "type" "prometheus" -}}
	{{- $_ := set $defaultDS "uid" .Values.grafana.sidecar.datasources.uid -}}
	{{- $_ := set $defaultDS "url" (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url) -}}
	{{- $_ := set $defaultDS "access" "proxy" -}}
	{{- $_ := set $defaultDS "isDefault" .Values.grafana.sidecar.datasources.isDefaultDatasource -}}
	{{- $_ := set $defaultDS "jsonData" $jsonData -}}
	name: {{ .Values.grafana.sidecar.datasources.name }}
	type: prometheus
	uid: {{ .Values.grafana.sidecar.datasources.uid }}
	url: {{ (default (printf "http://%s-prometheus.%s:%v/%s"
	(include "kube-prometheus-stack.fullname" .)
	(include "kube-prometheus-stack.namespace" .)
	.Values.prometheus.service.port
	(trimPrefix "/" .Values.prometheus.prometheusSpec.routePrefix)
	) .Values.grafana.sidecar.datasources.url) }}
	access: proxy
	isDefault: {{ .Values.grafana.sidecar.datasources.isDefaultDatasource }}
	{{- with $jsonData }}
	jsonData:
	{{ . | nindent 2 }}
	{{- end }}