update variable name as review comments suggested

Author: nagadeesh-nagaraja

api/v1alpha1/constants.go

@@ -27,8 +27,8 @@ const (
 
 	// OperationSkipBootConfiguration indicates which boot configuration operation should be skipped.
 	OperationSkipBootConfiguration = "metal.ironcore.dev/operation-skip-boot-configuration"
-	// OperationBootConfigurationSkip skips the boot configuration if set to this value.
-	OperationBootConfigurationSkip = "skip"
+	// SkipBootConfiguration skips the boot configuration if set to this value.
+	SkipBootConfiguration = "skip"
 	// OperationAnnotationForceReset forces a reset before next operation
 	OperationAnnotationForceReset = "ForceReset"
 )

api/v1alpha1/servermaintenance_types.go

@@ -24,17 +24,17 @@ type ServerBootConfigurationTemplate struct {
 	Name string `json:"name"`
 
 	// BootType specifies the type of boot configuration.
-	// It can be either "Oneoff" or "Persistent". If not specified, it defaults to "Persistent".
+	// It can be either "OneOff" or "Persistent". If not specified, it defaults to "Persistent".
 	// "Persistent" will set the configuration reboot the server before setting the server to the desired power state mentioned in spec.
 	//
-	// "Oneoff" will set the configuration to boot once. next boot-up will boot into default boot order.
+	// "OneOff" will set the configuration to boot once. next boot-up will boot into default boot order.
 	// if power state mentioned in spec is "PowerOn", server will be powered on and will boot into the configuration.
 	// if power state is "PowerOff", server will be powered off and will boot into the configuration on next power on.
 	//
-	// +kubebuilder:validation:Enum=Oneoff;Persistent
+	// +kubebuilder:validation:Enum=OneOff;Persistent
 	// +optional
 	// +kubebuilder:default=Persistent
-	Boottype BootType `json:"bootType,omitempty"`
+	BootType BootType `json:"bootType,omitempty"`
 
 	// Parameters specify the parameters to be used for rendering the boot configuration.
 	// +required
@@ -45,7 +45,7 @@ type BootType string
 
 const (
 	// BootTypeOneOff indicates that the server should boot into this configuration one time.
-	BootTypeOneOff BootType = "Oneoff"
+	BootTypeOneOff BootType = "OneOff"
 	// BootTypePersistent indicates that the server should boot into this configuration continuously.
 	BootTypePersistent BootType = "Persistent"
 )
@@ -84,7 +84,9 @@ type ServerMaintenanceStatus struct {
 	// State specifies the current state of the server maintenance.
 	State ServerMaintenanceState `json:"state,omitempty"`
 
-	// BootOrder specifies the boot order of the server before maintenance.
+	// BootOrderStatus specifies the boot order of the server before maintenance.
+	// is used to store the boot order of server before it is changed for maintenance.
+	// used only with BootType Persistent.
 	// +optional
 	BootOrderStatus *ServerMaintenanceBootOrder `json:"bootOrderStatus,omitempty"`
 }

config/crd/bases/metal.ironcore.dev_servermaintenances.yaml

@@ -70,14 +70,14 @@ spec:
                     default: Persistent
                     description: |-
                       BootType specifies the type of boot configuration.
-                      It can be either "Oneoff" or "Persistent". If not specified, it defaults to "Persistent".
+                      It can be either "OneOff" or "Persistent". If not specified, it defaults to "Persistent".
                       "Persistent" will set the configuration reboot the server before setting the server to the desired power state mentioned in spec.
 
-                      "Oneoff" will set the configuration to boot once. next boot-up will boot into default boot order.
+                      "OneOff" will set the configuration to boot once. next boot-up will boot into default boot order.
                       if power state mentioned in spec is "PowerOn", server will be powered on and will boot into the configuration.
                       if power state is "PowerOff", server will be powered off and will boot into the configuration on next power on.
                     enum:
-                    - Oneoff
+                    - OneOff
                     - Persistent
                     type: string
                   name:
@@ -156,8 +156,10 @@ spec:
             description: ServerMaintenanceStatus defines the observed state of a ServerMaintenance
             properties:
               bootOrderStatus:
-                description: BootOrder specifies the boot order of the server before
-                  maintenance.
+                description: |-
+                  BootOrderStatus specifies the boot order of the server before maintenance.
+                  is used to store the boot order of server before it is changed for maintenance.
+                  used only with BootType Persistent.
                 properties:
                   defaultBootOrder:
                     description: DefaultBootOrder specifies the default boot order

dist/chart/templates/crd/metal.ironcore.dev_servermaintenances.yaml

@@ -76,14 +76,14 @@ spec:
                     default: Persistent
                     description: |-
                       BootType specifies the type of boot configuration.
-                      It can be either "Oneoff" or "Persistent". If not specified, it defaults to "Persistent".
+                      It can be either "OneOff" or "Persistent". If not specified, it defaults to "Persistent".
                       "Persistent" will set the configuration reboot the server before setting the server to the desired power state mentioned in spec.
 
-                      "Oneoff" will set the configuration to boot once. next boot-up will boot into default boot order.
+                      "OneOff" will set the configuration to boot once. next boot-up will boot into default boot order.
                       if power state mentioned in spec is "PowerOn", server will be powered on and will boot into the configuration.
                       if power state is "PowerOff", server will be powered off and will boot into the configuration on next power on.
                     enum:
-                    - Oneoff
+                    - OneOff
                     - Persistent
                     type: string
                   name:
@@ -162,8 +162,10 @@ spec:
             description: ServerMaintenanceStatus defines the observed state of a ServerMaintenance
             properties:
               bootOrderStatus:
-                description: BootOrder specifies the boot order of the server before
-                  maintenance.
+                description: |-
+                  BootOrderStatus specifies the boot order of the server before maintenance.
+                  is used to store the boot order of server before it is changed for maintenance.
+                  used only with BootType Persistent.
                 properties:
                   defaultBootOrder:
                     description: DefaultBootOrder specifies the default boot order

internal/controller/servermaintenance_controller.go

@@ -215,7 +215,7 @@ func (r *ServerMaintenanceReconciler) handlePrepareMaintenanceState(ctx context.
 	// implication of skipping is that the server will still continue to run the OS during Maintenance
 	// might be subjected to reboots
 	val, found := serverMaintenance.GetAnnotations()[metalv1alpha1.OperationSkipBootConfiguration]
-	if config == nil && (!found || val != metalv1alpha1.OperationBootConfigurationSkip) {
+	if config == nil && (!found || val != metalv1alpha1.SkipBootConfiguration) {
 		log.V(1).Info("No ServerBootConfigurationTemplate boot configuration", "Server", server.Name)
 		_, err = r.patchMaintenanceState(ctx, serverMaintenance, metalv1alpha1.ServerMaintenanceStateFailed)
 		return ctrl.Result{}, err
@@ -445,7 +445,7 @@ func (r *ServerMaintenanceReconciler) configureBootOrder(ctx context.Context, lo
 	}
 	defer bmcClient.Logout()
 
-	switch maintenance.Spec.ServerBootConfigurationTemplate.Boottype {
+	switch maintenance.Spec.ServerBootConfigurationTemplate.BootType {
 	case metalv1alpha1.BootTypeOneOff:
 		// note: with this option, the next server boot up will enter pxe boot.
 		// if Maintenance Spec.ServerPower is PowerOn, server will be powered on and will boot into pxe
@@ -531,7 +531,7 @@ func (r *ServerMaintenanceReconciler) configureBootOrder(ctx context.Context, lo
 			}
 			log.V(1).Info("Configured boot order for server",
 				"Server", server.Name,
-				"BootType", maintenance.Spec.ServerBootConfigurationTemplate.Boottype,
+				"BootType", maintenance.Spec.ServerBootConfigurationTemplate.BootType,
 				"BootOrder", bootOrderChanged)
 			// save the current boot order to revert back after maintenance
 			status := &metalv1alpha1.ServerMaintenanceBootOrder{
@@ -558,7 +558,7 @@ func (r *ServerMaintenanceReconciler) configureBootOrder(ctx context.Context, lo
 		log.V(1).Info("wait for boot order to be set on server", "Server", server.Name)
 		return true, nil
 	default:
-		return false, fmt.Errorf("unknown boot type: %s", maintenance.Spec.ServerBootConfigurationTemplate.Boottype)
+		return false, fmt.Errorf("unknown boot type: %s", maintenance.Spec.ServerBootConfigurationTemplate.BootType)
 	}
 }