feat: Implement BMCSettingsSet controller with reconciliation logic #471

davidgrun · 2025-09-16T07:37:57Z

Added BMCSettingsSetReconciler to manage BMCSettingsSet resources.

fixes: #419

PROJECT

internal/controller/bmcsettingsset_controller.go

nagadeesh-nagaraja · 2025-10-21T10:43:46Z

internal/controller/bmcsettingsset_controller.go

+			//avoid unnecessary updates
+			if r.refsAreEqual(bmcSettingsCopy.Spec.ServerMaintenanceRefs, mergedRefs) &&
+				r.templatesAreEqual(&bmcSettingsCopy.Spec.BMCSettingsTemplate, bmcSettingsTemplate) {
+				log.V(2).Info("No changes needed for BMCSettings", "BMCSettings", bmcSettingsCopy.Name)
+				return nil
+			}


isnt this duplicate?
the method CreateOrPatch already checks before updating/patching the resources.

correct removed the duplicate check and the unnecessary functions for check this in the new pr

internal/controller/bmcsettingsset_controller.go

- Added BMCSettingsSetReconciler to manage BMCSettingsSet resources. - Implemented reconciliation logic for creating, updating, and deleting BMCSettings based on BMC resources. - Introduced finalizer handling for BMCSettingsSet to manage cleanup during deletion. - Added methods to handle owned BMCSettings and update their status based on the reconciliation state. - Implemented logic to create missing BMCSettings and delete orphaned ones. - Added tests for BMCSettingsSet controller to ensure correct reconciliation behavior. test: Add unit tests for BMCSettingsSet controller - Created comprehensive tests for BMCSettingsSet controller to validate reconciliation logic. - Ensured correct behavior when BMC resources are created, updated, or deleted. - Verified that BMCSettings are generated correctly based on BMC labels. - Added tests for updating BMCSettingsSet and ensuring status updates are reflected. chore: Update test suite to include BMCSettingsSet reconciler - Modified suite_test.go to register BMCSettingsSetReconciler with the test manager. - Ensured all resources are cleaned up after tests, including BMCSettingsSet. fix: Update BMCSettings webhook to include BMCSettingsTemplate - Refactored BMCSettingsSpec to include BMCSettingsTemplate for better structure. - Updated webhook tests to validate the new structure of BMCSettings resources.

…cumentation and tests. To ensure make and lint works

…ing; adjust RBAC roles and CRD version

…enanceRefs filtering logic with clientutils.ListAndFilter

…fs and simplifying patch logic

api/v1alpha1/bmcsettings_types.go

internal/controller/bmcsettingsset_controller.go

internal/controller/bmcsettingsset_controller_test.go

… in CRD Add an update in BMCSettingSet test to check the patch Mechanism

…prove server state handling. For this use the new server claim handling Update biossettings_controller_test: add const for bar variable that go lint works correctly

nagadeesh-nagaraja · 2025-11-11T09:07:12Z

internal/controller/bmcsettingsset_controller_test.go

+			Eventually(Update(serverClaim02, func() {
+				metautils.SetAnnotation(serverClaim02, metalv1alpha1.ServerMaintenanceApprovalKey, "true")
+			})).Should(Succeed())
+
+			Eventually(Object(bmcSettings02)).Should(SatisfyAny(
+				HaveField("Status.State", metalv1alpha1.BMCSettingsStateInProgress),
+				HaveField("Status.State", metalv1alpha1.BMCSettingsStateApplied),
+			))
+
+			Eventually(Object(bmcSettings02)).Should(SatisfyAll(
+				HaveField("Status.State", metalv1alpha1.BMCSettingsStateApplied),
+			))


duplicate code?

nagadeesh-nagaraja · 2025-11-11T09:08:02Z

internal/controller/suite_test.go

 	RunSpecs(t, "Controller Suite")
 }

+func DeleteAllMetalResources(ctx context.Context, namespace string) {


this was removed recently, can we switch to have the newer method and remove this code?

Nuckal777

Thanks. 👍 PR needs a rebase and the test need to be adjusted due to the removal of DeleteAllMetalResources(). Also, I would consider removing support for ServerMaintenanceRefs on the BMCSettingsSet. It complicates the code a lot and for practical uses I would imagine most people would just like to apply the set and have ServerMaintenances be automatically managed, instead of micro-managing them.

Nuckal777 · 2025-11-17T16:09:33Z

config/samples/metal_v1alpha1_bmcsettingsset.yaml

+          foo: bar 
+          foo2: bar2


Indentation is off. Newline at the end of the file would also be appreciated.

Nuckal777 · 2025-11-17T16:10:58Z

internal/controller/biossettings_controller_test.go

+// added const field for go linting
+const (
+	testBarValue = "bar"
+)
+


Probably, we should not run the goconst (?) linter on the test files, instead of introducing an inconsistently used constant.

Nuckal777 · 2025-11-17T16:12:55Z

internal/controller/bmcsettingsset_controller.go

+		if bmcSettings.Status.State != metalv1alpha1.BMCSettingsStateInProgress {
+			delTableBMCSettings[bmcSettings.Name] = struct{}{}
+		} else if len(bmcSettings.Spec.ServerMaintenanceRefs) == 0 {
+			// If no ServerMaintenanceRefs is set, the BMCSettings is not actively being processed
+			delTableBMCSettings[bmcSettings.Name] = struct{}{}
+		}


Please unify both checks in a single if block.

Nuckal777 · 2025-11-17T16:15:28Z

internal/controller/bmcsettingsset_controller.go

+		var serverMaintenanceRefsMerged []metalv1alpha1.ServerMaintenanceRefItem
+		if len(serverMaintenancesRefsCreated) > 0 && len(serverMaintenanceRefsProvided) > 0 {


Shouldn't both list contain non-overlapping sets of maintenances (serverMaintenanceRefsCreated = refsOnBMCSettingsObject - refsProvidedOnBMCSettingsSet)? If yes, the special handling for merging these can be removed.

@Nuckal777 I do not think that is always the case, user might end up providing a new maintenanceRef after child object has created one... ?

Nuckal777 · 2025-11-17T16:30:25Z

internal/controller/bmcsettingsset_controller.go

+
+	serverMaintenanceRefs := []metalv1alpha1.ServerMaintenanceRefItem{}
+	for _, serverMaintenance := range serverMaintenanceList.Items {
+		if ref, exists := serverMaintenanceRefMap[serverMaintenance.Name]; exists {


Is a negation missing here by chance?

davidgrun added api-change area/metal-automation labels Sep 16, 2025

github-project-automation bot added this to Roadmap Sep 16, 2025

github-actions bot added the size/XXL label Sep 16, 2025

davidgrun mentioned this pull request Sep 16, 2025

Add BMCSettingSet type and controller #419

Open

github-actions bot added the documentation Improvements or additions to documentation label Sep 16, 2025

nagadeesh-nagaraja reviewed Sep 16, 2025

View reviewed changes

github-actions bot added size/XL and removed size/XXL labels Oct 20, 2025

davidgrun force-pushed the BMCSettingsSet branch from 27d9690 to fa7c2fa Compare October 21, 2025 07:20

github-actions bot added size/XXL and removed size/XL labels Oct 21, 2025

nagadeesh-nagaraja reviewed Oct 21, 2025

View reviewed changes

davidgrun added 4 commits October 28, 2025 10:46

feat: Add BMCSettingsSet CRD and associated RBAC roles; update API do…

4b380e8

…cumentation and tests. To ensure make and lint works

Update BMCSettingsSet controller to handle ServerMaintenanceRefs merg…

e9c8b1b

…ing; adjust RBAC roles and CRD version

refactor: Remove unnecessary equality checks and simplify ServerMaint…

22f5cc3

…enanceRefs filtering logic with clientutils.ListAndFilter

davidgrun force-pushed the BMCSettingsSet branch from b98ae3d to 22f5cc3 Compare October 28, 2025 12:27

davidgrun added 2 commits November 4, 2025 11:25

refactor: Enhance BMCSettings handling by merging ServerMaintenanceRe…

b385fd7

…fs and simplifying patch logic

Merge remote-tracking branch 'origin' into BMCSettingsSet

209417c

nagadeesh-nagaraja reviewed Nov 4, 2025

View reviewed changes

davidgrun added 2 commits November 10, 2025 14:19

refactor: Update BMCRef validation message and enforce required field…

09c44c7

… in CRD Add an update in BMCSettingSet test to check the patch Mechanism

Merge remote-tracking branch 'origin' into BMCSettingsSet

36c2f98

davidgrun self-assigned this Nov 10, 2025

Update BMCSettingsSet tests to use corev1.LocalObjectReference and im…

dcf85fc

…prove server state handling. For this use the new server claim handling Update biossettings_controller_test: add const for bar variable that go lint works correctly

nagadeesh-nagaraja approved these changes Nov 11, 2025

View reviewed changes

nagadeesh-nagaraja reviewed Nov 11, 2025

View reviewed changes

Nuckal777 reviewed Nov 17, 2025

View reviewed changes

		var serverMaintenanceRefsMerged []metalv1alpha1.ServerMaintenanceRefItem
		if len(serverMaintenancesRefsCreated) > 0 && len(serverMaintenanceRefsProvided) > 0 {

feat: Implement BMCSettingsSet controller with reconciliation logic #471

Are you sure you want to change the base?

feat: Implement BMCSettingsSet controller with reconciliation logic #471

Uh oh!

Conversation

davidgrun commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nuckal777 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

davidgrun commented Sep 16, 2025 •

edited

Loading