create BIOSSetting Flows Resource and Controller

Author: nagadeesh-nagaraja

PROJECT

@@ -90,4 +90,12 @@ resources:
   webhooks:
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: ironcore.dev
+  group: metal
+  kind: BIOSSettingsFlow
+  path: github.com/ironcore-dev/metal-operator/api/v1alpha1
+  version: v1alpha1
 version: "3"

api/v1alpha1/biossettings_types.go

@@ -18,6 +18,15 @@ type BIOSSettingsSpec struct {
 	// +optional
 	SettingsMap map[string]string `json:"settings,omitempty"`
 
+	// SettingUpdatePolicy dictates how the settings are applied.
+	// if 'Sequence', the BIOSSettings resource will enter 'Waiting' state after applying the settings
+	// if 'OneShotUpdate' the BIOSSettings resource will enter 'Completed' state after applying the settings
+	SettingUpdatePolicy SettingUpdatePolicy `json:"settingUpdatePolicy,omitempty"`
+
+	// CurrentSettingPriority specifies the number of sequence left to complete the settings workflow
+	// used in conjunction with SettingUpdatePolicy and BIOSSettingFlow
+	CurrentSettingPriority int32 `json:"currentSettingPriority,omitempty"`
+
 	// ServerRef is a reference to a specific server to apply bios setting on.
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="serverRef is immutable"
 	ServerRef *corev1.LocalObjectReference `json:"serverRef,omitempty"`
@@ -35,6 +44,8 @@ type BIOSSettingsState string
 const (
 	// BIOSSettingsStatePending specifies that the bios setting maintenance is waiting
 	BIOSSettingsStatePending BIOSSettingsState = "Pending"
+	// BIOSSettingsStateInWaiting specifies that the BIOSSetting Controller is updating the settings
+	BIOSSettingsStateInWaiting BIOSSettingsState = "Waiting"
 	// BIOSSettingsStateInProgress specifies that the BIOSSetting Controller is updating the settings
 	BIOSSettingsStateInProgress BIOSSettingsState = "InProgress"
 	// BIOSSettingsStateApplied specifies that the bios setting maintenance has been completed.
@@ -43,6 +54,13 @@ const (
 	BIOSSettingsStateFailed BIOSSettingsState = "Failed"
 )
 
+type SettingUpdatePolicy string
+
+const (
+	SequencialUpdate SettingUpdatePolicy = "Sequence"
+	OneShotUpdate    SettingUpdatePolicy = "OneShotUpdate"
+)
+
 type BIOSSettingUpdateState string
 
 const (
@@ -63,12 +81,15 @@ type BIOSSettingsStatus struct {
 	State BIOSSettingsState `json:"state,omitempty"`
 	// UpdateSettingState represents the current state of the bios setting update task.
 	UpdateSettingState BIOSSettingUpdateState `json:"updateSettingState,omitempty"`
+	// AppliedSettingPriority specifies the number of sequence left to complete the settings workflow
+	// used in conjunction with SettingUpdatePolicy and BIOSSettingFlow Resource
+	AppliedSettingPriority int32 `json:"appliedSettingPriority,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:scope=Cluster
-// +kubebuilder:printcolumn:name="BIOSVersion",type=string,JSONPath=`.spec.biosSettings.version`
+// +kubebuilder:printcolumn:name="BIOSVersion",type=string,JSONPath=`.spec.version`
 // +kubebuilder:printcolumn:name="ServerRef",type=string,JSONPath=`.spec.serverRef.name`
 // +kubebuilder:printcolumn:name="ServerMaintenanceRef",type=string,JSONPath=`.spec.serverMaintenanceRef.name`
 // +kubebuilder:printcolumn:name="State",type="string",JSONPath=`.status.state`

api/v1alpha1/biossettingsflow_types.go

@@ -0,0 +1,84 @@
+// SPDX-FileCopyrightText: 2025 SAP SE or an SAP affiliate company and IronCore contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// BIOSSettingsState specifies the current state of the BIOS maintenance.
+type BIOSSettingsFlowState string
+
+const (
+	// BIOSSettingsFlowStatePending specifies that the bios setting maintenance is waiting
+	BIOSSettingsFlowStatePending BIOSSettingsFlowState = "Pending"
+	// BIOSSettingsFlowStateInProgress specifies that the BIOSSetting Controller is updating the settings
+	BIOSSettingsFlowStateInProgress BIOSSettingsFlowState = "InProgress"
+	// BIOSSettingsFlowStateApplied specifies that the bios setting maintenance has been completed.
+	BIOSSettingsFlowStateApplied BIOSSettingsFlowState = "Applied"
+	// BIOSSettingsFlowStateFailed specifies that the bios setting maintenance has failed.
+	BIOSSettingsFlowStateFailed BIOSSettingsFlowState = "Failed"
+)
+
+// BIOSSettingsFlowSpec defines the desired state of BIOSSettingsFlow.
+type BIOSSettingsFlowSpec struct {
+	// Version contains software (eg: BIOS, BMC) version this settings applies to
+	// +required
+	Version string `json:"version"`
+
+	// SettingsFlow contains BIOS settings sequence to apply on the BIOS in given order
+	// +optional
+	SettingsFlow []SettingsFlowItem `json:"settingsFlow,omitempty"`
+
+	// ServerRef is a reference to a specific server to apply bios setting on.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="serverRef is immutable"
+	ServerRef *corev1.LocalObjectReference `json:"serverRef,omitempty"`
+
+	// ServerMaintenancePolicy is maintenance policy to be enforced on the server.
+	ServerMaintenancePolicy ServerMaintenancePolicy `json:"serverMaintenancePolicy,omitempty"`
+}
+
+type SettingsFlowItem struct {
+	Settings map[string]string `json:"settings,omitempty"`
+	// Priority defines the order of applying the settings
+	// any int greater than 0. lower number have higher Priority (ie; lower number is applied first)
+	Priority int32 `json:"priority"`
+}
+
+// BIOSSettingsFlowStatus defines the observed state of BIOSSettingsFlow.
+type BIOSSettingsFlowStatus struct {
+	// State represents the current state of the bios configuration task.
+	State BIOSSettingsFlowState `json:"state,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:scope=Cluster
+// +kubebuilder:printcolumn:name="BIOSVersion",type=string,JSONPath=`.spec.version`
+// +kubebuilder:printcolumn:name="ServerRef",type=string,JSONPath=`.spec.serverRef.name`
+// +kubebuilder:printcolumn:name="State",type="string",JSONPath=`.status.state`
+// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
+
+// BIOSSettingsFlow is the Schema for the biossettingsflows API.
+type BIOSSettingsFlow struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   BIOSSettingsFlowSpec   `json:"spec,omitempty"`
+	Status BIOSSettingsFlowStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+
+// BIOSSettingsFlowList contains a list of BIOSSettingsFlow.
+type BIOSSettingsFlowList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []BIOSSettingsFlow `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&BIOSSettingsFlow{}, &BIOSSettingsFlowList{})
+}

api/v1alpha1/zz_generated.deepcopy.go

@@ -410,6 +410,13 @@ func main() { // nolint: gocyclo
 			os.Exit(1)
 		}
 	}
+	if err = (&controller.BIOSSettingsFlowReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}).SetupWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "BIOSSettingsFlow")
+		os.Exit(1)
+	}
 	//+kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {

cmd/manager/main.go

@@ -15,7 +15,7 @@ spec:
   scope: Cluster
   versions:
   - additionalPrinterColumns:
-    - jsonPath: .spec.biosSettings.version
+    - jsonPath: .spec.version
       name: BIOSVersion
       type: string
     - jsonPath: .spec.serverRef.name
@@ -55,6 +55,12 @@ spec:
           spec:
             description: BIOSSettingsSpec defines the desired state of BIOSSettings.
             properties:
+              currentSettingPriority:
+                description: |-
+                  CurrentSettingPriority specifies the number of sequence left to complete the settings workflow
+                  used in conjunction with SettingUpdatePolicy and BIOSSettingFlow
+                format: int32
+                type: integer
               serverMaintenancePolicy:
                 description: ServerMaintenancePolicy is maintenance policy to be enforced
                   on the server.
@@ -121,6 +127,12 @@ spec:
                 x-kubernetes-validations:
                 - message: serverRef is immutable
                   rule: self == oldSelf
+              settingUpdatePolicy:
+                description: |-
+                  SettingUpdatePolicy dictates how the settings are applied.
+                  if 'Sequence', the BIOSSettings resource will enter 'Waiting' state after applying the settings
+                  if 'OneShotUpdate' the BIOSSettings resource will enter 'Completed' state after applying the settings
+                type: string
               settings:
                 additionalProperties:
                   type: string
@@ -137,6 +149,12 @@ spec:
           status:
             description: BIOSSettingsStatus defines the observed state of BIOSSettings.
             properties:
+              appliedSettingPriority:
+                description: |-
+                  AppliedSettingPriority specifies the number of sequence left to complete the settings workflow
+                  used in conjunction with SettingUpdatePolicy and BIOSSettingFlow Resource
+                format: int32
+                type: integer
               state:
                 description: State represents the current state of the bios configuration
                   task.