Merge pull request #371 from sthaha/fix-redfish-crash

fix(redfish): skip internals without redfish secret
sustainable-computing-io · Mar 11, 2024 · 978ea73 · 978ea73
2 parents ef88a4d + 7fd0828
commit 978ea73
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 2 deletions.
diff --git a/bundle/manifests/kepler-operator.clusterserviceversion.yaml b/bundle/manifests/kepler-operator.clusterserviceversion.yaml
@@ -27,7 +27,7 @@ metadata:
     capabilities: Basic Install
     categories: Monitoring
     containerImage: quay.io/sustainable_computing_io/kepler-operator:0.10.0
-    createdAt: "2024-03-11T03:26:22Z"
+    createdAt: "2024-03-11T09:21:02Z"
     description: 'Deploys and Manages Kepler on Kubernetes '
     operators.operatorframework.io/builder: operator-sdk-v1.27.0
     operators.operatorframework.io/internal-objects: |-

diff --git a/bundle/manifests/kepler.system.sustainable.computing.io_keplerinternals.yaml b/bundle/manifests/kepler.system.sustainable.computing.io_keplerinternals.yaml
@@ -225,12 +225,15 @@ spec:
                     description: RedfishSpec for connecting to Redfish API
                     properties:
                       probeInterval:
+                        default: 60s
                         description: ProbeInterval controls how frequently power info
                           is queried from Redfish
                         type: string
                       secretRef:
                         description: SecretRef refers to the name of secret which
                           contains credentials to initialize RedfishClient
+                        maxLength: 63
+                        minLength: 1
                         type: string
                       skipSSLVerify:
                         default: false

diff --git a/bundle/manifests/kepler.system.sustainable.computing.io_keplers.yaml b/bundle/manifests/kepler.system.sustainable.computing.io_keplers.yaml
@@ -143,12 +143,15 @@ spec:
                     description: RedfishSpec for connecting to Redfish API
                     properties:
                       probeInterval:
+                        default: 60s
                         description: ProbeInterval controls how frequently power info
                           is queried from Redfish
                         type: string
                       secretRef:
                         description: SecretRef refers to the name of secret which
                           contains credentials to initialize RedfishClient
+                        maxLength: 63
+                        minLength: 1
                         type: string
                       skipSSLVerify:
                         default: false

diff --git a/config/crd/bases/kepler.system.sustainable.computing.io_keplerinternals.yaml b/config/crd/bases/kepler.system.sustainable.computing.io_keplerinternals.yaml
@@ -225,12 +225,15 @@ spec:
                     description: RedfishSpec for connecting to Redfish API
                     properties:
                       probeInterval:
+                        default: 60s
                         description: ProbeInterval controls how frequently power info
                           is queried from Redfish
                         type: string
                       secretRef:
                         description: SecretRef refers to the name of secret which
                           contains credentials to initialize RedfishClient
+                        maxLength: 63
+                        minLength: 1
                         type: string
                       skipSSLVerify:
                         default: false

diff --git a/config/crd/bases/kepler.system.sustainable.computing.io_keplers.yaml b/config/crd/bases/kepler.system.sustainable.computing.io_keplers.yaml
@@ -133,12 +133,15 @@ spec:
                     description: RedfishSpec for connecting to Redfish API
                     properties:
                       probeInterval:
+                        default: 60s
                         description: ProbeInterval controls how frequently power info
                           is queried from Redfish
                         type: string
                       secretRef:
                         description: SecretRef refers to the name of secret which
                           contains credentials to initialize RedfishClient
+                        maxLength: 63
+                        minLength: 1
                         type: string
                       skipSSLVerify:
                         default: false

diff --git a/docs/api.md b/docs/api.md
@@ -300,6 +300,8 @@ RedfishSpec for connecting to Redfish API
         <td>string</td>
         <td>
           ProbeInterval controls how frequently power info is queried from Redfish<br/>
+          <br/>
+            <i>Default</i>: 60s<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -1714,6 +1716,8 @@ RedfishSpec for connecting to Redfish API
         <td>string</td>
         <td>
           ProbeInterval controls how frequently power info is queried from Redfish<br/>
+          <br/>
+            <i>Default</i>: 60s<br/>
         </td>
         <td>false</td>
       </tr><tr>

diff --git a/pkg/api/v1alpha1/kepler_types.go b/pkg/api/v1alpha1/kepler_types.go
@@ -41,10 +41,15 @@ type ExporterDeploymentSpec struct {
 // RedfishSpec for connecting to Redfish API
 type RedfishSpec struct {
 	// SecretRef refers to the name of secret which contains credentials to initialize RedfishClient
+	// +required
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=63
 	SecretRef string `json:"secretRef"`
 
 	// ProbeInterval controls how frequently power info is queried from Redfish
 	// +optional
+	// +kubebuilder:default:="60s"
 	ProbeInterval metav1.Duration `json:"probeInterval,omitempty"`
 
 	// SkipSSLVerify controls if RedfishClient will skip verifying server

diff --git a/pkg/controllers/kepler_internal.go b/pkg/controllers/kepler_internal.go
@@ -91,7 +91,10 @@ func (r *KeplerInternalReconciler) SetupWithManager(mgr ctrl.Manager) error {
 // mapSecretToRequests returns the reconcile requests for kepler-internal objects for which an associated redfish secret has been changed.
 func (r *KeplerInternalReconciler) mapSecretToRequests(ctx context.Context, object client.Object) []reconcile.Request {
 
-	secret, _ := object.(*corev1.Secret)
+	secret, ok := object.(*corev1.Secret)
+	if !ok {
+		return nil
+	}
 
 	ks := v1alpha1.KeplerInternalList{}
 	if err := r.List(ctx, &ks); err != nil {
@@ -101,6 +104,11 @@ func (r *KeplerInternalReconciler) mapSecretToRequests(ctx context.Context, obje
 	requests := []reconcile.Request{}
 	for _, ki := range ks.Items {
 		ex := ki.Spec.Exporter
+
+		if ex.Redfish == nil {
+			continue
+		}
+
 		if ex.Redfish.SecretRef == secret.GetName() &&
 			ex.Deployment.Namespace == secret.GetNamespace() {
 			requests = append(requests, reconcile.Request{