Merge pull request #850 from csauoss/servicemonitor-custom-labels

changes to allow custom labels for ServiceMonitor

Author: rahulait

api/nvidia/v1/clusterpolicy_types.go

@@ -136,6 +136,44 @@ const (
 	Kata SandboxWorkloadsMode = "kata"
 )
 
+// ServiceMonitorConfig defines configuration options for the ServiceMonitor
+// deployed for NVIDIA GPU Operator resources
+type ServiceMonitorConfig struct {
+	// Enabled indicates if ServiceMonitor is deployed
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Enable deployment of ServiceMonitor"
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
+	Enabled *bool `json:"enabled,omitempty"`
+
+	// Interval at which metrics should be scraped. If not specified, Prometheus’ global scrape interval is used.
+	// Supported units: y, w, d, h, m, s, ms
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Interval at which metrics should be scraped"
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:text"
+	Interval promv1.Duration `json:"interval,omitempty"`
+
+	// HonorLabels chooses the metric’s labels on collisions with target labels.
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Choose the metric's label on collisions with target labels"
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
+	HonorLabels *bool `json:"honorLabels,omitempty"`
+
+	// AdditionalLabels to add to ServiceMonitor instance
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Additional labels to add to ServiceMonitor instance"
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:text"
+	AdditionalLabels map[string]string `json:"additionalLabels,omitempty"`
+
+	// Relabelings allows to rewrite labels on metric sets
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Relabelings allows to rewrite labels on metric sets"
+	Relabelings []*promv1.RelabelConfig `json:"relabelings,omitempty"`
+}
+
+// The Alias for backward compatibility
+// This points the old name to the new struct definition
+type DCGMExporterServiceMonitorConfig = ServiceMonitorConfig
+
 // OperatorSpec describes configuration options for the operator
 type OperatorSpec struct {
 	// Deprecated: DefaultRuntime is no longer used by the gpu-operator. This is instead, detected at runtime.
@@ -155,13 +193,23 @@ type OperatorSpec struct {
 	// queryable and should be preserved when modifying objects.
 	Annotations map[string]string `json:"annotations,omitempty"`
 
+	// Metrics configuration for NVIDIA GPU Operator
+	Metrics OperatorMetricsSpec `json:"metrics,omitempty"`
+
 	// UseOpenShiftDriverToolkit indicates if DriverToolkit image should be used on OpenShift to build and install driver modules
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="On OpenShift, enable DriverToolkit image to build and install driver modules"
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
 	UseOpenShiftDriverToolkit *bool `json:"use_ocp_driver_toolkit,omitempty"`
 }
 
+type OperatorMetricsSpec struct {
+	// Optional: ServiceMonitor configuration for NVIDIA GPU Operator
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
+	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="ServiceMonitor configuration for NVIDIA GPU Operator"
+	ServiceMonitor *ServiceMonitorConfig `json:"serviceMonitor,omitempty"`
+}
+
 // HostPathsSpec defines various paths on the host needed by GPU Operator components
 type HostPathsSpec struct {
 	// RootFS represents the path to the root filesystem of the host.
@@ -994,7 +1042,7 @@ type DCGMExporterSpec struct {
 	// Optional: ServiceMonitor configuration for NVIDIA DCGM Exporter
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="ServiceMonitor configuration for NVIDIA DCGM Exporter"
-	ServiceMonitor *DCGMExporterServiceMonitorConfig `json:"serviceMonitor,omitempty"`
+	ServiceMonitor *ServiceMonitorConfig `json:"serviceMonitor,omitempty"`
 
 	// Optional: Service configuration for NVIDIA DCGM Exporter
 	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
@@ -1066,40 +1114,6 @@ type DCGMExporterServiceConfig struct {
 	InternalTrafficPolicy *corev1.ServiceInternalTrafficPolicy `json:"internalTrafficPolicy,omitempty"`
 }
 
-// DCGMExporterServiceMonitorConfig defines configuration options for the ServiceMonitor
-// deployed for DCGM Exporter
-type DCGMExporterServiceMonitorConfig struct {
-	// Enabled indicates if ServiceMonitor is deployed for NVIDIA DCGM Exporter
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Enable deployment of NVIDIA DCGM Exporter ServiceMonitor"
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
-	Enabled *bool `json:"enabled,omitempty"`
-
-	// Interval which metrics should be scraped from NVIDIA DCGM Exporter. If not specified Prometheus’ global scrape interval is used.
-	// Supported units: y, w, d, h, m, s, ms
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Interval which metrics should be scraped from NVDIA DCGM Exporter"
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:text"
-	Interval promv1.Duration `json:"interval,omitempty"`
-
-	// HonorLabels chooses the metric’s labels on collisions with target labels.
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Choose the metric's label on collisions with target labels"
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
-	HonorLabels *bool `json:"honorLabels,omitempty"`
-
-	// AdditionalLabels to add to ServiceMonitor instance for NVIDIA DCGM Exporter
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Additional labels to add to ServiceMonitor instance for NVIDIA DCGM Exporter"
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.x-descriptors="urn:alm:descriptor:com.tectonic.ui:text"
-	AdditionalLabels map[string]string `json:"additionalLabels,omitempty"`
-
-	// Relabelings allows to rewrite labels on metric sets for NVIDIA DCGM Exporter
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors=true
-	// +operator-sdk:gen-csv:customresourcedefinitions.specDescriptors.displayName="Relabelings allows to rewrite labels on metric sets for NVIDIA DCGM Exporter"
-	Relabelings []*promv1.RelabelConfig `json:"relabelings,omitempty"`
-}
-
 // DCGMSpec defines the properties for NVIDIA DCGM deployment
 type DCGMSpec struct {
 	// Enabled indicates if deployment of NVIDIA DCGM Hostengine as a separate pod is enabled.
@@ -2371,10 +2385,10 @@ func (dcgm *DCGMSpec) IsEnabled() bool {
 	return *dcgm.Enabled
 }
 
-// IsEnabled returns true if ServiceMonitor for DCGM Exporter is enabled through gpu-operator
-func (sm *DCGMExporterServiceMonitorConfig) IsEnabled() bool {
+// IsEnabled returns true if ServiceMonitor is enabled through gpu-operator
+func (sm *ServiceMonitorConfig) IsEnabled() bool {
 	if sm.Enabled == nil {
-		// ServiceMonitor for DCGM Exporter is disabled by default
+		// ServiceMonitor is disabled by default
 		return false
 	}
 	return *sm.Enabled