improve grafana and prometheus logic

fastmachinelearning · Feb 13, 2025 · 512a73d · 512a73d
1 parent 548e16d
commit 512a73d
Show file tree

Hide file tree

Showing 4 changed files with 319 additions and 151 deletions.
diff --git a/helm/supersonic/templates/NOTES.txt b/helm/supersonic/templates/NOTES.txt
@@ -3,6 +3,7 @@
 {{- include "supersonic.validateGrafana" . -}}
 {{- include "supersonic.validateGrafanaAddressConsistency" . -}}
 {{- include "supersonic.validateGrafanaValues" . -}}
+{{- include "supersonic.validatePrometheus" . -}}
 {{- include "supersonic.validatePrometheusAddressConsistency" . -}}
 {{- include "supersonic.validatePrometheusValues" . -}}
 
@@ -25,16 +26,16 @@ SuperSONIC chart successfully installed!
 | Documentation:           https://fastmachinelearning.org/SuperSONIC
 |
 | Uninstall:               helm uninstall {{ .Release.Name }} -n {{ .Release.Namespace }}
-|
 {{- if .Values.envoy.enabled }}
+|
 | gRPC endpoint:           {{ include "supersonic.grpcEndpoint" . }}
 {{- end }}
+{{- if or .Values.prometheus.external.enabled .Values.prometheus.enabled (include "supersonic.prometheusExists" . ) }}
 |
-{{- if or (.Values.prometheus.external.enabled) .Values.prometheus.enabled }}
-| Prometheus UI:           {{ include "supersonic.prometheusUrl" . }}
+| Prometheus UI:           {{ include "supersonic.prometheusDisplayUrl" . }}
 {{- end }}
+{{- if or .Values.grafana.enabled (include "supersonic.grafanaExists" .) }}
 |
-{{- if .Values.grafana.enabled }}
-| Grafana dashboard:       {{ include "supersonic.grafanaUrl" . }}
+| Grafana dashboard:       {{ include "supersonic.grafanaDisplayUrl" . }}
 {{- end }}
 └-----------------------------------------------------------------------------┘
diff --git a/helm/supersonic/templates/_common.tpl b/helm/supersonic/templates/_common.tpl
@@ -0,0 +1,155 @@
+{{/*
+Common helper functions for SuperSONIC services
+*/}}
+
+{{/*
+Get service scheme - takes service type and values as parameters
+*/}}
+{{- define "supersonic.common.getServiceScheme" -}}
+{{- $serviceType := .serviceType -}}
+{{- $values := .values -}}
+{{- if eq $serviceType "prometheus" -}}
+    {{- if $values.prometheus.external.enabled -}}
+        {{- $values.prometheus.external.scheme -}}
+    {{- else if $values.prometheus.enabled -}}
+        {{- if and $values.prometheus.server.ingress.enabled $values.prometheus.server.ingress.tls -}}
+            {{- printf "https" -}}
+        {{- else -}}
+            {{- printf "http" -}}
+        {{- end -}}
+    {{- else -}}
+        {{- printf "https" -}}
+    {{- end -}}
+{{- else if eq $serviceType "grafana" -}}
+    {{- if $values.grafana.enabled -}}
+        {{- if $values.grafana.ingress.enabled -}}
+            {{- if $values.grafana.ingress.tls -}}
+                {{- printf "https" -}}
+            {{- else -}}
+                {{- printf "http" -}}
+            {{- end -}}
+        {{- else -}}
+            {{- printf "http" -}}
+        {{- end -}}
+    {{- else -}}
+        {{- printf "https" -}}
+    {{- end -}}
+{{- else -}}
+    {{- printf "https" -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Check if service exists - takes service name as parameter
+*/}}
+{{- define "supersonic.common.serviceExists" -}}
+{{- $serviceName := .serviceName -}}
+{{- $exists := "" -}}
+{{- if (lookup "apps/v1" "Deployment" .root.Release.Namespace "") -}}
+  {{- range (lookup "apps/v1" "Deployment" .root.Release.Namespace "").items -}}
+    {{- if eq (index .metadata.labels "app.kubernetes.io/name") $serviceName -}}
+      {{- $exists = "true" -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}
+{{- $exists -}}
+{{- end -}}
+
+{{/*
+Get service details - takes service type and root context as parameters
+*/}}
+{{- define "supersonic.common.getServiceDetails" -}}
+{{- $serviceType := .serviceType -}}
+{{- $root := .root -}}
+{{- $defaultPort := .defaultPort | default "80" -}}
+{{- $details := dict "scheme" "http" "port" $defaultPort -}}
+{{- $found := false -}}
+
+{{- /* Try to get details from ingress first */ -}}
+{{- if (lookup "networking.k8s.io/v1" "Ingress" $root.Release.Namespace "") -}}
+  {{- range (lookup "networking.k8s.io/v1" "Ingress" $root.Release.Namespace "").items -}}
+    {{- if eq (index .metadata.labels "app.kubernetes.io/name") $serviceType -}}
+      {{- if .spec.rules -}}
+        {{- $details = merge $details (dict "host" (index .spec.rules 0).host) -}}
+        {{- if .spec.tls -}}
+          {{- $details = merge $details (dict "scheme" "https" "port" "443") -}}
+        {{- else -}}
+          {{- $details = merge $details (dict "port" "80") -}}
+        {{- end -}}
+        {{- $found = true -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}
+
+{{- /* Fall back to service if ingress not found */ -}}
+{{- if (not $found) -}}
+  {{- if (lookup "v1" "Service" $root.Release.Namespace "") -}}
+    {{- range (lookup "v1" "Service" $root.Release.Namespace "").items -}}
+      {{- if eq (index .metadata.labels "app.kubernetes.io/name") $serviceType -}}
+        {{- $details = merge $details (dict "host" (printf "%s.%s.svc.cluster.local" .metadata.name $root.Release.Namespace)) -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}
+
+{{- $details | toJson -}}
+{{- end -}}
+
+{{/*
+Validate service address consistency
+*/}}
+{{- define "supersonic.common.validateAddressConsistency" -}}
+{{- $serviceType := .serviceType -}}
+{{- $values := .values -}}
+{{- $root := .root -}}
+
+{{- if eq $serviceType "prometheus" -}}
+  {{- if and $values.prometheus.enabled $values.prometheus.server.ingress.enabled -}}
+    {{- /* Extract and validate ingress host */ -}}
+    {{- if not $values.prometheus.server.ingress.hosts -}}
+      {{- fail "Parameter missing: prometheus.server.ingress.hosts" -}}
+    {{- end -}}
+    {{- $ingressHost := first $values.prometheus.server.ingress.hosts -}}
+
+    {{- /* Validate TLS host if TLS is enabled */ -}}
+    {{- if $values.prometheus.server.ingress.tls -}}
+      {{- if not (first $values.prometheus.server.ingress.tls).hosts -}}
+        {{- fail "Parameter missing: prometheus.server.ingress.tls[0].hosts" -}}
+      {{- end -}}
+      {{- $tlsHost := first (first $values.prometheus.server.ingress.tls).hosts -}}
+      {{- if ne $ingressHost $tlsHost -}}
+        {{- fail (printf "Mismatched configuration. For internal consistency of SuperSONIC components, please set the following parameter:\nprometheus.server.ingress.tls[0].hosts[0]: %s" $ingressHost) -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+{{- else if eq $serviceType "grafana" -}}
+  {{- if and $values.grafana.enabled $values.grafana.ingress.enabled -}}
+    {{- /* Extract and validate ingress host */ -}}
+    {{- if not $values.grafana.ingress.hosts -}}
+      {{- fail "Parameter missing: grafana.ingress.hosts" -}}
+    {{- end -}}
+    {{- $ingressHost := first $values.grafana.ingress.hosts -}}
+
+    {{- /* Validate TLS host if TLS is enabled */ -}}
+    {{- if $values.grafana.ingress.tls -}}
+      {{- if not (first $values.grafana.ingress.tls).hosts -}}
+        {{- fail "Parameter missing: grafana.ingress.tls[0].hosts" -}}
+      {{- end -}}
+      {{- $tlsHost := first (first $values.grafana.ingress.tls).hosts -}}
+      {{- if ne $ingressHost $tlsHost -}}
+        {{- fail (printf "Mismatched configuration. For internal consistency of SuperSONIC components, please set the following parameter:\ngrafana.ingress.tls[0].hosts[0]: %s" $ingressHost) -}}
+      {{- end -}}
+    {{- end -}}
+
+    {{- /* Validate root_url if specified */ -}}
+    {{- if (index $values.grafana "grafana.ini").server.root_url -}}
+      {{- $rootUrl := (index $values.grafana "grafana.ini").server.root_url -}}
+      {{- $expectedRootUrl := printf "https://%s" $ingressHost -}}
+      {{- if ne $rootUrl $expectedRootUrl -}}
+        {{- fail (printf "Mismatched configuration. For internal consistency of SuperSONIC components, please set the following parameter:\ngrafana.grafana.ini.server.root_url: %s" $expectedRootUrl) -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}
+{{- end -}}