Disable Promethues metrics exporting by default (#789)

Signed-off-by: Yi Chen <[email protected]>

Author: ChenYi015

charts/jobset/README.md

@@ -81,7 +81,7 @@ See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall) for command docum
 | controller.podSecurityContext | object | `{"runAsNonRoot":true,"seccompProfile":{"type":"RuntimeDefault"}}` | Security context of the jobset controller pods. |
 | certManager.enable | bool | `false` | Whether to use cert-manager to generate certificates for the jobset webhook. |
 | certManager.issuerRef | object | `{}` | The reference to the issuer. If empty, self-signed issuer will be created and used. |
-| prometheus.enable | bool | `true` | Whether to enable Prometheus metrics exporting. |
+| prometheus.enable | bool | `false` | Whether to enable Prometheus metrics exporting. |
 
 ## Maintainers
 

charts/jobset/templates/prometheus/service_monitor.yaml

@@ -15,6 +15,9 @@ limitations under the License.
 */ -}}
 
 {{- if .Values.prometheus.enable }}
+{{- if not (.Capabilities.APIVersions.Has "monitoring.coreos.com/v1/ServiceMonitor") }}
+{{- fail "The cluster does not support the required API resource `monitoring.coreos.com/v1/ServiceMonitor`." }}
+{{- end -}}
 apiVersion: monitoring.coreos.com/v1
 kind: ServiceMonitor
 metadata:

charts/jobset/tests/prometheus/service_monitor_test.yaml

@@ -24,7 +24,15 @@ release:
   namespace: jobset-system
 
 tests:
+  - it: Should not create Prometheus ServiceMonitor by default
+    asserts:
+      - hasDocuments:
+          count: 0
+
   - it: Should create Prometheus ServiceMonitor if `prometheus.enable` is `true`
+    capabilities:
+      apiVersions:
+        - monitoring.coreos.com/v1/ServiceMonitor
     set:
       prometheus:
         enable: true
@@ -33,3 +41,11 @@ tests:
           apiVersion: monitoring.coreos.com/v1
           kind: ServiceMonitor
           name: jobset-metrics-service-monitor
+
+  - it: Should fail if the cluster does not support the required API resource `monitoring.coreos.com/v1/ServiceMonitor`
+    set:
+      prometheus:
+        enable: true
+    asserts:
+      - failedTemplate:
+          errorMessage: "The cluster does not support the required API resource `monitoring.coreos.com/v1/ServiceMonitor`."

charts/jobset/tests/prometheus/service_test.yaml

@@ -24,6 +24,11 @@ release:
   namespace: jobset-system
 
 tests:
+  - it: Should not create Prometheus metrics service by default
+    asserts:
+      - hasDocuments:
+          count: 0
+
   - it: Should create Prometheus Service if `prometheus.enable` is `true`
     set:
       prometheus:

charts/jobset/values.yaml

@@ -107,4 +107,4 @@ certManager:
 
 prometheus:
   # -- Whether to enable Prometheus metrics exporting.
-  enable: true
+  enable: false