feat: uiplugin API - new flag for the cluster-health-analyzer

Author: tremes

bundle/manifests/observability.openshift.io_uiplugins.yaml

@@ -186,8 +186,21 @@ spec:
                     - enabled
                     - thanosQuerier
                     type: object
+                  clusterHealthAnalyzer:
+                    description: ClusterHealthAnalyzer feature flag enablement
+                    properties:
+                      enabled:
+                        description: Indicates if the cluster-health-analyzer features
+                          should be enabled.
+                        type: boolean
+                    required:
+                    - enabled
+                    type: object
                   incidents:
-                    description: Incidents feature flag enablement
+                    description: |-
+                      Incidents feature flag enablement
+
+                      Deprecated: Use clusterHealthAnalyzer instead
                     properties:
                       enabled:
                         description: Indicates if incidents-related feature(s) should

deploy/crds/common/observability.openshift.io_uiplugins.yaml

@@ -186,8 +186,21 @@ spec:
                     - enabled
                     - thanosQuerier
                     type: object
+                  clusterHealthAnalyzer:
+                    description: ClusterHealthAnalyzer feature flag enablement
+                    properties:
+                      enabled:
+                        description: Indicates if the cluster-health-analyzer features
+                          should be enabled.
+                        type: boolean
+                    required:
+                    - enabled
+                    type: object
                   incidents:
-                    description: Incidents feature flag enablement
+                    description: |-
+                      Incidents feature flag enablement
+
+                      Deprecated: Use clusterHealthAnalyzer instead
                     properties:
                       enabled:
                         description: Indicates if incidents-related feature(s) should

docs/api.md

@@ -5450,11 +5450,20 @@ Monitoring contains configuration for the monitoring console plugin.
           ACM points to the alertmanager and thanosQuerier instance services of which it should create a proxy to.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b><a href="#uipluginspecmonitoringclusterhealthanalyzer">clusterHealthAnalyzer</a></b></td>
+        <td>object</td>
+        <td>
+          ClusterHealthAnalyzer feature flag enablement<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b><a href="#uipluginspecmonitoringincidents">incidents</a></b></td>
         <td>object</td>
         <td>
-          Incidents feature flag enablement<br/>
+          Incidents feature flag enablement
+
+Deprecated: Use clusterHealthAnalyzer instead<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -5563,13 +5572,42 @@ ThanosQuerier points to the thanos-querier service of which it should create a p
 </table>
 
 
+### UIPlugin.spec.monitoring.clusterHealthAnalyzer
+<sup><sup>[↩ Parent](#uipluginspecmonitoring)</sup></sup>
+
+
+
+ClusterHealthAnalyzer feature flag enablement
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>enabled</b></td>
+        <td>boolean</td>
+        <td>
+          Indicates if the cluster-health-analyzer features should be enabled.<br/>
+        </td>
+        <td>true</td>
+      </tr></tbody>
+</table>
+
+
 ### UIPlugin.spec.monitoring.incidents
 <sup><sup>[↩ Parent](#uipluginspecmonitoring)</sup></sup>
 
 
 
 Incidents feature flag enablement
 
+Deprecated: Use clusterHealthAnalyzer instead
+
 <table>
     <thead>
         <tr>

pkg/apis/uiplugin/v1alpha1/types.go

@@ -161,7 +161,14 @@ type MonitoringConfig struct {
 	// Incidents feature flag enablement
 	//
 	// +kubebuilder:validation:Optional
+	// Deprecated: Use clusterHealthAnalyzer instead
+	// +deprecated
 	Incidents *IncidentsReference `json:"incidents,omitempty"`
+
+	// ClusterHealthAnalyzer feature flag enablement
+	//
+	// +kubebuilder:validation:Optional
+	ClusterHealthAnalyzer ClusterHealthAnalyzerReference `json:"clusterHealthAnalyzer,omitempty"`
 }
 
 // AdvancedClusterManagementReference is used to configure references to the alertmanager and thanosQuerier that should be used
@@ -221,6 +228,14 @@ type IncidentsReference struct {
 	Enabled bool `json:"enabled"`
 }
 
+// ClusterHealthAnalyzerReference is used to configure the cluster health analyzer features.
+type ClusterHealthAnalyzerReference struct {
+	// Indicates if the cluster-health-analyzer features should be enabled.
+	//
+	// +kubebuilder:validation:Required
+	Enabled bool `json:"enabled"`
+}
+
 // UIPluginSpec is the specification for desired state of UIPlugin.
 //
 // +kubebuilder:validation:XValidation:rule="self.type == 'TroubleshootingPanel' || !has(self.troubleshootingPanel)", message="Troubleshooting Panel configuration is only supported with the TroubleshootingPanel type"