[FEATURE] helm: Monitoring options added

Enable optional monitoring based on metrics implementation for operator- controller & server. Controller: - Provide configuration for enabling detailed operational metrics. Release: Bump up version before release.
SAP · Nov 13, 2024 · 2e74dc3 · 2e74dc3
1 parent d0dea78
commit 2e74dc3
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 3 deletions.
diff --git a/chart/Chart.yaml b/chart/Chart.yaml
@@ -1,5 +1,5 @@
 apiVersion: v2
 description: Helm chart to deploy CAP Operator https://sap.github.io/cap-operator/
 name: cap-operator
-version: 0.10.2
-appVersion: 0.10.0
+version: 0.11.0
+appVersion: 0.11.0
diff --git a/chart/README.md b/chart/README.md
@@ -1,6 +1,6 @@
 # cap-operator
 
-![Version: 0.10.1](https://img.shields.io/badge/Version-0.10.1-informational?style=flat-square) ![AppVersion: 0.10.0](https://img.shields.io/badge/AppVersion-0.10.0-informational?style=flat-square)
+![Version: 0.11.0](https://img.shields.io/badge/Version-0.11.0-informational?style=flat-square) ![AppVersion: 0.11.0](https://img.shields.io/badge/AppVersion-0.11.0-informational?style=flat-square)
 
 Helm chart to deploy CAP Operator https://sap.github.io/cap-operator/
 
@@ -19,6 +19,8 @@ Helm chart to deploy CAP Operator https://sap.github.io/cap-operator/
 | topologySpreadConstraints | list | `[]` | Default topology spread constraints (can be overwritten on component level) |
 | podLabels | object | `{}` | Additional pod labels for all components |
 | podAnnotations | object | `{}` | Additional pod annotations for all components |
+| monitoring | object | `{"enabled":false}` | Monitoring configuration for all components |
+| monitoring.enabled | bool | `false` | Optionally enable Prometheus monitoring for all components (disabled by default) |
 | controller.replicas | int | `1` | Replicas |
 | controller.image.repository | string | `"ghcr.io/sap/cap-operator/controller"` | Image repository |
 | controller.image.tag | string | `""` | Image tag |
@@ -40,6 +42,7 @@ Helm chart to deploy CAP Operator https://sap.github.io/cap-operator/
 | controller.volumes | list | `[]` | Optionally specify list of additional volumes for the controller pod(s) |
 | controller.volumeMounts | list | `[]` | Optionally specify list of additional volumeMounts for the controller container(s) |
 | controller.dnsTarget | string | `""` | The dns target mentioned on the public ingress gateway service used in the cluster |
+| controller.detailedOperationalMetrics | bool | `false` | Optionally enable detailed opertational metrics for the controller by setting this to true |
 | controller.versionMonitoring.prometheusAddress | string | `""` | The URL of the Prometheus server from which metrics related to managed application versions can be queried  |
 | controller.versionMonitoring.metricsEvaluationInterval | string | `"1h"` | The duration (example 2h) after which versions are evaluated for deletion; based on specified workload metrics |
 | controller.versionMonitoring.promClientAcquireRetryDelay | string | `"1h"` | The duration (example 10m) to wait before retrying to acquire Prometheus client and verify connection, after a failed attempt |

diff --git a/chart/templates/controller-deployment.yaml b/chart/templates/controller-deployment.yaml
@@ -69,6 +69,8 @@ spec:
           resources:
             {{- toYaml .Values.controller.resources | nindent 12 }}
           env:
+            - name: DETAILED_OPERATIONAL_METRICS
+              value: "{{ .Values.controller.detailedOperationalMetrics }}"
             - name: CERT_MANAGER
               value: {{ .Capabilities.APIVersions.Has "cert.gardener.cloud/v1alpha1" | ternary "gardener" "cert-manager.io" }}
             - name: DNS_MANAGER
@@ -95,4 +97,45 @@ spec:
           volumeMounts:
             {{- toYaml . | nindent 12 }}
           {{- end }}
+          ports:
+            - name: metrics-port
+              containerPort: 9090
+              protocol: TCP
       serviceAccountName: {{.Release.Name}}-controller
+---
+kind: Service
+apiVersion: v1
+metadata:
+  name: {{.Release.Name}}-controller
+  labels:
+    operator.sme.sap.com/app: controller
+    operator.sme.sap.com/category: controller
+    operator.sme.sap.com/release: {{.Release.Name}}
+spec:
+  ports:
+    - name: metrics-http
+      protocol: TCP
+      port: 9090
+      targetPort: metrics-port
+  selector:
+    operator.sme.sap.com/app: controller
+    operator.sme.sap.com/category: controller
+    operator.sme.sap.com/release: {{.Release.Name}}
+---
+{{- if .Values.monitoring.enabled }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{.Release.Name}}-controller
+  labels:
+    operator.sme.sap.com/app: controller
+    operator.sme.sap.com/category: controller
+    operator.sme.sap.com/release: {{.Release.Name}}
+spec:
+  selector:
+    matchLabels:
+      operator.sme.sap.com/app: controller
+      operator.sme.sap.com/category: controller
+  endpoints:
+  - port: metrics-http
+{{- end }}
diff --git a/chart/templates/server-deployment.yaml b/chart/templates/server-deployment.yaml
@@ -77,6 +77,9 @@ spec:
             - name: server-port
               containerPort: 4000
               protocol: TCP
+            - name: metrics-port
+              containerPort: 9090
+              protocol: TCP
       serviceAccountName: {{.Release.Name}}-subscription-server
 ---
 kind: Service
@@ -93,7 +96,29 @@ spec:
       protocol: TCP
       port: {{.Values.subscriptionServer.port}}
       targetPort: server-port
+    - name: metrics-http
+      protocol: TCP
+      port: 9090
+      targetPort: metrics-port
   selector:
     operator.sme.sap.com/app: subscription-server
     operator.sme.sap.com/category: controller
     operator.sme.sap.com/release: {{.Release.Name}}
+---
+{{- if .Values.monitoring.enabled }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{.Release.Name}}-subscription-server
+  labels:
+    operator.sme.sap.com/app: subscription-server
+    operator.sme.sap.com/category: controller
+    operator.sme.sap.com/release: {{.Release.Name}}
+spec:
+  selector:
+    matchLabels:
+      operator.sme.sap.com/app: subscription-server
+      operator.sme.sap.com/category: controller
+  endpoints:
+  - port: metrics-http
+{{- end }}
diff --git a/chart/values.yaml b/chart/values.yaml
@@ -21,6 +21,10 @@ topologySpreadConstraints: []
 podLabels: {}
 # -- Additional pod annotations for all components
 podAnnotations: {}
+# -- Monitoring configuration for all components
+monitoring:
+  # -- Optionally enable Prometheus monitoring for all components (disabled by default)
+  enabled: false
 
 controller:
   # -- Replicas
@@ -69,6 +73,8 @@ controller:
   volumeMounts: []
   # -- The dns target mentioned on the public ingress gateway service used in the cluster
   dnsTarget: ""
+  # -- Optionally enable detailed opertational metrics for the controller by setting this to true
+  detailedOperationalMetrics: false
   versionMonitoring:
     # -- The URL of the Prometheus server from which metrics related to managed application versions can be queried 
     prometheusAddress: ""