feat(deps): hydra-maester - add metrics support (ory#780)

* feat(hydra-maester): Add metrics support

* feat: add new variant of values with the metrics support for automated verification

Author: embaya

hacks/values/hydra-maester/default.yaml

@@ -19,3 +19,13 @@ deployment:
   extraVolumeMounts:
     - name: "test-volume"
       mountPath: /test-volume
+service:
+  metrics:
+    enabled: true
+    annotations:
+      ory.sh/test-annotations: "true"
+serviceMonitor:
+  labels:
+    release: "prometheus"
+  tlsConfig:
+    insecureSkipVerify: true

helm/charts/hydra-maester/templates/deployment.yaml

@@ -59,7 +59,7 @@ spec:
           command:
             - /manager
           args:
-            - --metrics-addr=127.0.0.1:8080
+            - --metrics-addr={{ if .Values.service.metrics.enabled }}0.0.0.0{{ else }}127.0.0.1{{ end }}:{{ .Values.service.metrics.port }}
             - --hydra-url={{ required "scheme is required" .Values.adminService.scheme }}://{{ .Values.adminService.name | default ( include "hydra-maester.adminService" . ) }}
             - --hydra-port={{ required "port must be set and non-empty" .Values.adminService.port }}
             {{- with .Values.adminService.endpoint }}
@@ -96,6 +96,12 @@ spec:
           securityContext:
             {{- toYaml .Values.deployment.securityContext | nindent 12 }}
           {{- end }}
+          ports:
+            {{- if .Values.service.metrics.enabled }}
+            - name: {{ .Values.service.metrics.name }}
+              containerPort: {{ .Values.service.metrics.port }}
+              protocol: TCP
+            {{- end }}
       serviceAccountName: {{ include "hydra-maester.fullname" . }}-account
       automountServiceAccountToken: {{ .Values.deployment.automountServiceAccountToken }}
       {{- if .Values.priorityClassName }}

helm/charts/hydra-maester/templates/service-metrics.yaml

@@ -0,0 +1,29 @@
+{{- if .Values.service.metrics.enabled }}
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "hydra-maester.fullname" . }}-metrics
+  namespace: {{ .Release.Namespace }}
+  labels:
+    app.kubernetes.io/component: metrics
+    {{- include "hydra-maester.labels" . | nindent 4 }}
+  {{- with .Values.service.metrics.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  type: {{ .Values.service.metrics.type }}
+  {{- if eq .Values.service.metrics.type "LoadBalancer" }}
+  {{- with .Values.service.metrics.loadBalancerIP }}
+  loadBalancerIP: {{ . }}
+  {{- end }}
+  {{- end }}
+  ports:
+    - port: {{ .Values.service.metrics.port }}
+      targetPort: {{ .Values.service.metrics.name }}
+      protocol: TCP
+      name: {{ .Values.service.metrics.name }}
+  selector:
+    app.kubernetes.io/name: {{ include "hydra-maester.fullname" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}
+{{ end }}

helm/charts/hydra-maester/templates/service-monitor.yaml

@@ -0,0 +1,33 @@
+{{- if and (.Capabilities.APIVersions.Has "monitoring.coreos.com/v1") (.Values.service.metrics.enabled) }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "hydra-maester.fullname" . }}-metrics
+  namespace: {{ .Release.Namespace }}
+  labels:
+    app.kubernetes.io/component: metrics
+    {{- include "hydra-maester.labels" . | nindent 4 }}
+    {{- with .Values.serviceMonitor.labels }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
+  {{- with .Values.service.metrics.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  endpoints:
+    - path: /metrics
+      port: {{ .Values.service.metrics.name }}
+      scheme: {{ .Values.serviceMonitor.scheme }}
+      interval: {{ .Values.serviceMonitor.scrapeInterval }}
+      scrapeTimeout: {{ .Values.serviceMonitor.scrapeTimeout }}
+      {{- with .Values.serviceMonitor.tlsConfig }}
+      tlsConfig:
+        {{- toYaml . | nindent 6 }}
+      {{- end }}
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "hydra-maester.fullname" . }}
+      app.kubernetes.io/instance: {{ .Release.Name }}
+      app.kubernetes.io/component: metrics
+{{- end }}

helm/charts/hydra-maester/values.yaml

@@ -157,3 +157,29 @@ pdb:
   spec:
     minAvailable: ""
     maxUnavailable: ""
+
+## -- Service configurations
+service:
+  ## -- Metrics service
+  metrics:
+    enabled: false
+    type: ClusterIP
+    ## -- The load balancer IP
+    loadBalancerIP: ""
+    name: http-metrics
+    port: 8080
+    annotations: {}
+
+## -- Parameters for the Prometheus ServiceMonitor objects.
+# Reference: https://docs.openshift.com/container-platform/4.6/rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.html
+serviceMonitor:
+  # -- HTTP scheme to use for scraping.
+  scheme: http
+  # -- Interval at which metrics should be scraped
+  scrapeInterval: 60s
+  # -- Timeout after which the scrape is ended
+  scrapeTimeout: 30s
+  # -- Provide additional labels to the ServiceMonitor resource metadata
+  labels: {}
+  # -- TLS configuration to use when scraping the endpoint
+  tlsConfig: {}