CLI Option for naming servers as the BMC objects

While the redfish standard supports an API with multiple
systems managed by one endpoint (such as Cisco IMC and others),
an often use-case is to communicate with the BMC directly.

In Netbox, one usually models the system managed by the BMC
and the BMC itself is just an attribute on the system.

The expectation in these circumstances is, that the Server
is not a child of the BMC (i.e. suffix -system-0), but
they are both belonging to the same server (i.e. have the same
name).

The CLI option disable-server-name-suffix allows one to opt-in into the
logic that such a Server should be named as the BMC.

Author: fwiesel

api/v1alpha1/zz_generated.deepcopy.go

@@ -82,6 +82,7 @@ func main() { // nolint: gocyclo
 		discoveryTimeout                   time.Duration
 		serverMaxConcurrentReconciles      int
 		serverClaimMaxConcurrentReconciles int
+		disableServerNameSuffix            bool
 	)
 
 	flag.IntVar(&serverMaxConcurrentReconciles, "server-max-concurrent-reconciles", 5,
@@ -128,6 +129,8 @@ func main() { // nolint: gocyclo
 		"If set the metrics endpoint is served securely")
 	flag.BoolVar(&enableHTTP2, "enable-http2", false,
 		"If set, HTTP/2 will be enabled for the metrics and webhook servers")
+	flag.BoolVar(&disableServerNameSuffix, "disable-server-name-suffix", false,
+		"If set, will drop the suffix -system-0 for servers, if there is only one system known to the BMC")
 	opts := zap.Options{
 		Development: true,
 	}
@@ -299,9 +302,10 @@ func main() { // nolint: gocyclo
 		os.Exit(1)
 	}
 	if err = (&controller.BMCReconciler{
-		Client:   mgr.GetClient(),
-		Scheme:   mgr.GetScheme(),
-		Insecure: insecure,
+		Client:                  mgr.GetClient(),
+		Scheme:                  mgr.GetScheme(),
+		Insecure:                insecure,
+		DisableServerNameSuffix: disableServerNameSuffix,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "BMC")
 		os.Exit(1)

cmd/manager/main.go

@@ -31,9 +31,10 @@ const BMCFinalizer = "metal.ironcore.dev/bmc"
 // BMCReconciler reconciles a BMC object
 type BMCReconciler struct {
 	client.Client
-	Scheme            *runtime.Scheme
-	Insecure          bool
-	BMCPollingOptions bmc.Options
+	Scheme                  *runtime.Scheme
+	Insecure                bool
+	BMCPollingOptions       bmc.Options
+	DisableServerNameSuffix bool
 }
 
 //+kubebuilder:rbac:groups=metal.ironcore.dev,resources=endpoints,verbs=get;list;watch
@@ -161,9 +162,15 @@ func (r *BMCReconciler) discoverServers(ctx context.Context, log logr.Logger, bm
 	}
 
 	var errs []error
+	serverCount := len(servers)
+	useShortServerName := serverCount == 1 && r.DisableServerNameSuffix
 	for i, s := range servers {
 		server := &metalv1alpha1.Server{}
-		server.Name = bmcutils.GetServerNameFromBMCandIndex(i, bmcObj)
+		if useShortServerName {
+			server.Name = bmcObj.Name
+		} else {
+			server.Name = bmcutils.GetServerNameFromBMCandIndex(i, bmcObj)
+		}
 
 		opResult, err := controllerutil.CreateOrPatch(ctx, r.Client, server, func() error {
 			metautils.SetLabels(server, bmcObj.Labels)