feat(metrics-operator): add helm value to disable APIService installation (#2607)

Signed-off-by: Geoffrey Israel <[email protected]>
Co-authored-by: Florian Bacher <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Co-authored-by: odubajDT <[email protected]>
Signed-off-by: David Ahmadov <[email protected]>

Author: 4 people

.github/actions/spelling/expect.txt

@@ -28,6 +28,7 @@ annadreal
 apicommon
 apierr
 apierrors
+apiservice
 APIURL
 apk
 appcreationrequest

.github/scripts/.helm-tests/default/result.yaml

@@ -9265,6 +9265,8 @@ spec:
               fieldPath: metadata.name
         - name: EXPOSE_KEPTN_METRICS
           value: "true"
+        - name: ENABLE_CUSTOM_METRICS_API_SERVICE
+          value: "true"
         - name: METRICS_CONTROLLER_LOG_LEVEL
           value: "0"
         - name: ANALYSIS_CONTROLLER_LOG_LEVEL

.github/scripts/.helm-tests/metrics-only-with-apiservice-disabled/result.yaml

@@ -0,0 +1,14 @@
+certManager:
+  enabled: false
+lifecycleOperator:
+  enabled: false
+metricsOperator:
+  enabled: true
+  image:
+    tag: v0.0.0
+  customMetricsAPIService:
+    enabled: "false"
+
+global:
+  commonLabels:
+    app.kubernetes.io/version: vmyversion

.github/scripts/.helm-tests/metrics-only-with-apiservice-disabled/values.yaml

@@ -2308,6 +2308,8 @@ spec:
               fieldPath: metadata.name
         - name: EXPOSE_KEPTN_METRICS
           value: "true"
+        - name: ENABLE_CUSTOM_METRICS_API_SERVICE
+          value: "true"
         - name: METRICS_CONTROLLER_LOG_LEVEL
           value: "0"
         - name: ANALYSIS_CONTROLLER_LOG_LEVEL

.github/scripts/.helm-tests/metrics-only/result.yaml

@@ -2564,6 +2564,8 @@ spec:
               fieldPath: metadata.name
         - name: EXPOSE_KEPTN_METRICS
           value: "true"
+        - name: ENABLE_CUSTOM_METRICS_API_SERVICE
+          value: "true"
         - name: METRICS_CONTROLLER_LOG_LEVEL
           value: "0"
         - name: ANALYSIS_CONTROLLER_LOG_LEVEL

.github/scripts/.helm-tests/metrics-with-certs/result.yaml

@@ -56,6 +56,7 @@ Prometheus, Dynatrace, DataDog and K8s metric server...
 | `annotations`                          | add deployment level annotations                                                                                                                              | `{}`                |
 | `podAnnotations`                       | adds pod level annotations                                                                                                                                    | `{}`                |
 | `kubernetesClusterDomain`              | overrides cluster.local                                                                                                                                       | `cluster.local`     |
+| `customMetricsAPIService.enabled`      | enable/disable the K8s APIService installation                                                                                                                | `true`              |
 
 ### Keptn Metrics Operator controller
 

metrics-operator/chart/README.md

@@ -47,6 +47,8 @@ spec:
               fieldPath: metadata.name
         - name: EXPOSE_KEPTN_METRICS
           value: {{ .Values.env.exposeKeptnMetrics | quote }}
+        - name: ENABLE_CUSTOM_METRICS_API_SERVICE
+          value: {{ .Values.customMetricsAPIService.enabled | quote }}
         - name: METRICS_CONTROLLER_LOG_LEVEL
           value: {{ .Values.env.metricsControllerLogLevel | quote
             }}

metrics-operator/chart/templates/deployment.yaml

@@ -1,3 +1,4 @@
+{{- if eq .Values.customMetricsAPIService.enabled "true" }}
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:
@@ -13,4 +14,5 @@ roleRef:
 subjects:
 - kind: ServiceAccount
   name: horizontal-pod-autoscaler
-  namespace: '{{ .Release.Namespace }}'
+  namespace: '{{ .Release.Namespace }}'
+{{- end }}

metrics-operator/chart/templates/metrics-operator-hpa-controller-rbac.yaml

@@ -1,3 +1,4 @@
+{{- if eq .Values.customMetricsAPIService.enabled "true" }}
 apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
@@ -14,4 +15,5 @@ spec:
     name: 'metrics-operator-service'
     namespace: '{{ .Release.Namespace }}'
   version: v1beta1
-  versionPriority: 100
+  versionPriority: 100
+{{- end }}

metrics-operator/chart/templates/v1beta1.custom.metrics.k8s.io.yaml

@@ -1,3 +1,4 @@
+{{- if eq .Values.customMetricsAPIService.enabled "true" }}
 apiVersion: apiregistration.k8s.io/v1
 kind: APIService
 metadata:
@@ -14,4 +15,5 @@ spec:
     name: 'metrics-operator-service'
     namespace: '{{ .Release.Namespace }}'
   version: v1beta2
-  versionPriority: 200
+  versionPriority: 200
+{{- end }}

metrics-operator/chart/templates/v1beta2.custom.metrics.k8s.io.yaml

@@ -93,6 +93,9 @@ annotations: {}
 podAnnotations: {}
 ## @param     kubernetesClusterDomain overrides cluster.local
 kubernetesClusterDomain: cluster.local
+customMetricsAPIService:
+## @param   customMetricsAPIService.enabled enable/disable the K8s APIService installation
+  enabled: "true"
 
 ## @section Keptn Metrics Operator controller
 ## @extra   containerSecurityContext Sets security context privileges

metrics-operator/chart/values.yaml

@@ -65,6 +65,8 @@ spec:
                   fieldPath: metadata.name
             - name: EXPOSE_KEPTN_METRICS
               value: "true"
+            - name: ENABLE_CUSTOM_METRICS_API_SERVICE
+              value: "true"
             - name: ENABLE_ANALYSIS
               value: "true"
             - name: METRICS_CONTROLLER_LOG_LEVEL

metrics-operator/config/manager/manager.yaml

@@ -72,6 +72,7 @@ type envConfig struct {
 	KeptnMetricControllerLogLevel int    `envconfig:"METRICS_CONTROLLER_LOG_LEVEL" default:"0"`
 	AnalysisControllerLogLevel    int    `envconfig:"ANALYSIS_CONTROLLER_LOG_LEVEL" default:"0"`
 	ExposeKeptnMetrics            bool   `envconfig:"EXPOSE_KEPTN_METRICS" default:"true"`
+	EnableCustomMetricsAPIService bool   `envconfig:"ENABLE_CUSTOM_METRICS_API_SERVICE" default:"true"`
 }
 
 //nolint:gocyclo,funlen
@@ -133,9 +134,10 @@ func main() {
 		return
 	}
 
-	// Start the custom metrics adapter
-	go startCustomMetricsAdapter(env.PodNamespace)
-
+	if env.EnableCustomMetricsAPIService {
+		// Start the custom metrics adapter
+		go startCustomMetricsAdapter(env.PodNamespace)
+	}
 	disableCacheFor := []ctrlclient.Object{&corev1.Secret{}}
 
 	opt := ctrl.Options{
@@ -182,6 +184,7 @@ func main() {
 
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
+
 	keptnserver.StartServerManager(ctx, mgr.GetClient(), openfeature.NewClient("keptn"), env.ExposeKeptnMetrics, metricServerTickerInterval)
 
 	metricsLogger := ctrl.Log.WithName("KeptnMetric Controller")