Harmonize reconciler logic and improve logging

.github/workflows/lint.yml

@@ -17,4 +17,4 @@ jobs:
     - name: golangci-lint
       uses: golangci/golangci-lint-action@v9
       with:
-        version: v2.5
+        version: v2.6

Makefile

@@ -201,7 +201,7 @@ CONTROLLER_TOOLS_VERSION ?= v0.17.1
 ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
 #ENVTEST_K8S_VERSION is the version of Kubernetes to use for setting up ENVTEST binaries (i.e. 1.31)
 ENVTEST_K8S_VERSION ?= $(shell go list -m -f "{{ .Version }}" k8s.io/api | awk -F'[v.]' '{printf "1.%d.%d",$$3, $$2}')
-GOLANGCI_LINT_VERSION ?= v2.1
+GOLANGCI_LINT_VERSION ?= v2.6
 ADDLICENSE_VERSION ?= v1.1.1
 GOIMPORTS_VERSION ?= v0.31.0
 GEN_CRD_API_REFERENCE_DOCS_VERSION ?= v0.3.0

cmdutils/suite_test.go

@@ -59,7 +59,7 @@ var _ = BeforeSuite(func() {
 		// Note that you must have the required binaries setup under the bin directory to perform
 		// the tests directly. When we run make test it will be setup and used automatically.
 		BinaryAssetsDirectory: filepath.Join("..", "bin", "k8s",
-			fmt.Sprintf("1.31.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
+			fmt.Sprintf("1.34.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
 	}
 
 	sourceCfg, err := sourceEnv.Start()
@@ -89,7 +89,7 @@ var _ = BeforeSuite(func() {
 		// Note that you must have the required binaries setup under the bin directory to perform
 		// the tests directly. When we run make test it will be setup and used automatically.
 		BinaryAssetsDirectory: filepath.Join("..", "bin", "k8s",
-			fmt.Sprintf("1.31.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
+			fmt.Sprintf("1.34.0-%s-%s", runtime.GOOS, runtime.GOARCH)),
 	}
 
 	// cfg is defined in this file globally.

docs/api-reference/api.md

@@ -48,7 +48,7 @@ string
 <td>
 <code>metadata</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -86,7 +86,7 @@ string
 <td>
 <code>ignitionSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -168,7 +168,7 @@ string
 <td>
 <code>metadata</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#objectmeta-v1-meta">
 Kubernetes meta/v1.ObjectMeta
 </a>
 </em>
@@ -272,7 +272,7 @@ string
 <td>
 <code>ignitionSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -285,7 +285,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>ipxeScriptSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -342,7 +342,7 @@ string
 <td>
 <code>ignitionSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -432,7 +432,7 @@ HTTPBootConfigState
 <td>
 <code>conditions</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#condition-v1-meta">
 []Kubernetes meta/v1.Condition
 </a>
 </em>
@@ -540,7 +540,7 @@ string
 <td>
 <code>ignitionSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -553,7 +553,7 @@ Kubernetes core/v1.LocalObjectReference
 <td>
 <code>ipxeScriptSecretRef</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#localobjectreference-v1-core">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core">
 Kubernetes core/v1.LocalObjectReference
 </a>
 </em>
@@ -622,7 +622,7 @@ IPXEBootConfigState
 <td>
 <code>conditions</code><br/>
 <em>
-<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta">
+<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#condition-v1-meta">
 []Kubernetes meta/v1.Condition
 </a>
 </em>

hack/api-reference/config.json

@@ -21,7 +21,7 @@
     },
     {
       "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
-      "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
+      "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
     }
   ],
   "typeDisplayNamePrefixOverrides": {

internal/controller/httpbootconfig_controller.go

@@ -13,7 +13,6 @@ import (
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
-	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
 	"github.com/go-logr/logr"
@@ -32,55 +31,53 @@ type HTTPBootConfigReconciler struct {
 //+kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch
 
 func (r *HTTPBootConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	log := log.FromContext(ctx)
-
-	HTTPBootConfig := &bootv1alpha1.HTTPBootConfig{}
-	if err := r.Get(ctx, req.NamespacedName, HTTPBootConfig); err != nil {
+	log := ctrl.LoggerFrom(ctx)
+	config := &bootv1alpha1.HTTPBootConfig{}
+	if err := r.Get(ctx, req.NamespacedName, config); err != nil {
 		return ctrl.Result{}, client.IgnoreNotFound(err)
 	}
-
-	return r.reconcileExists(ctx, log, HTTPBootConfig)
+	return r.reconcileExists(ctx, log, config)
 }
 
-func (r *HTTPBootConfigReconciler) reconcileExists(ctx context.Context, log logr.Logger, HTTPBootConfig *bootv1alpha1.HTTPBootConfig) (ctrl.Result, error) {
-	if !HTTPBootConfig.DeletionTimestamp.IsZero() {
-		return r.delete(ctx, log, HTTPBootConfig)
+func (r *HTTPBootConfigReconciler) reconcileExists(ctx context.Context, log logr.Logger, config *bootv1alpha1.HTTPBootConfig) (ctrl.Result, error) {
+	if !config.DeletionTimestamp.IsZero() {
+		return r.delete(ctx, log, config)
 	}
-
-	return r.reconcile(ctx, log, HTTPBootConfig)
+	return r.reconcile(ctx, log, config)
 }
 
-func (r *HTTPBootConfigReconciler) reconcile(ctx context.Context, log logr.Logger, HTTPBootConfig *bootv1alpha1.HTTPBootConfig) (ctrl.Result, error) {
+func (r *HTTPBootConfigReconciler) reconcile(ctx context.Context, log logr.Logger, config *bootv1alpha1.HTTPBootConfig) (ctrl.Result, error) {
+	log.V(1).Info("Reconciling HTTPBootConfig")
+
 	log.V(1).Info("Ensuring Ignition")
-	state, ignitionErr := r.ensureIgnition(ctx, log, HTTPBootConfig)
-	if ignitionErr != nil {
-		patchError := r.patchStatus(ctx, HTTPBootConfig, state)
-		if patchError != nil {
-			return ctrl.Result{}, fmt.Errorf("failed to patch status %w %w", ignitionErr, patchError)
+	state, err := r.ensureIgnition(ctx, log, config)
+	if err != nil {
+		if err := r.patchStatus(ctx, config, state); err != nil {
+			return ctrl.Result{}, err
 		}
-
-		log.V(1).Info("Failed to Ensure Ignition", "Error", ignitionErr)
+		log.V(1).Info("Failed to Ensure Ignition", "Error", err)
 		return ctrl.Result{}, nil
 	}
+	log.V(1).Info("Ensured Ignition")
 
-	patchErr := r.patchStatus(ctx, HTTPBootConfig, state)
-	if patchErr != nil {
-		return ctrl.Result{}, fmt.Errorf("failed to patch status %w", patchErr)
+	if err := r.patchStatus(ctx, config, state); err != nil {
+		return ctrl.Result{}, err
 	}
 
+	log.V(1).Info("Reconciled HTTPBootConfig")
 	return ctrl.Result{}, nil
 }
 
-func (r *HTTPBootConfigReconciler) ensureIgnition(ctx context.Context, _ logr.Logger, HTTPBootConfig *bootv1alpha1.HTTPBootConfig) (bootv1alpha1.HTTPBootConfigState, error) {
+func (r *HTTPBootConfigReconciler) ensureIgnition(ctx context.Context, _ logr.Logger, config *bootv1alpha1.HTTPBootConfig) (bootv1alpha1.HTTPBootConfigState, error) {
 	// Verify if the IgnitionRef is set, and it has the intended data key.
-	if HTTPBootConfig.Spec.IgnitionSecretRef != nil {
-		IgnitionSecret := &corev1.Secret{}
-		if err := r.Get(ctx, client.ObjectKey{Name: HTTPBootConfig.Spec.IgnitionSecretRef.Name, Namespace: HTTPBootConfig.Namespace}, IgnitionSecret); err != nil {
+	if config.Spec.IgnitionSecretRef != nil {
+		ignitionSecret := &corev1.Secret{}
+		if err := r.Get(ctx, client.ObjectKey{Name: config.Spec.IgnitionSecretRef.Name, Namespace: config.Namespace}, ignitionSecret); err != nil {
 			return bootv1alpha1.HTTPBootConfigStateError, err
-			// TODO: Add some validation steps to ensure that the IgntionData is compliant, if necessary.
+			// TODO: Add some validation steps to ensure that the IgnitionData is compliant, if necessary.
 			// Assume for now, that it's going to json format.
 		}
-		if IgnitionSecret.Data[bootv1alpha1.DefaultIgnitionKey] == nil {
+		if ignitionSecret.Data[bootv1alpha1.DefaultIgnitionKey] == nil {
 			return bootv1alpha1.HTTPBootConfigStateError, fmt.Errorf("ignition data is missing")
 		}
 	}
@@ -93,64 +90,61 @@ func (r *HTTPBootConfigReconciler) delete(_ context.Context, log logr.Logger, _
 
 	// TODO
 
+	log.V(1).Info("Deleted HTTPBootConfig")
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
-func (r *HTTPBootConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	return ctrl.NewControllerManagedBy(mgr).
-		For(&bootv1alpha1.HTTPBootConfig{}).
-		Watches(
-			&corev1.Secret{},
-			handler.EnqueueRequestsFromMapFunc(r.enqueueHTTPBootConfigReferencingIgnitionSecret),
-		).
-		Complete(r)
-}
-
-func (r *HTTPBootConfigReconciler) patchStatus(
-	ctx context.Context,
-	HTTPBootConfig *bootv1alpha1.HTTPBootConfig,
-	state bootv1alpha1.HTTPBootConfigState,
-) error {
-	if HTTPBootConfig.Status.State == state {
+func (r *HTTPBootConfigReconciler) patchStatus(ctx context.Context, config *bootv1alpha1.HTTPBootConfig, state bootv1alpha1.HTTPBootConfigState) error {
+	if config.Status.State == state {
 		return nil
 	}
 
-	base := HTTPBootConfig.DeepCopy()
-	HTTPBootConfig.Status.State = state
+	base := config.DeepCopy()
+	config.Status.State = state
 
-	if err := r.Status().Patch(ctx, HTTPBootConfig, client.MergeFrom(base)); err != nil {
-		return fmt.Errorf("error patching HTTPBootConfig: %w", err)
+	if err := r.Status().Patch(ctx, config, client.MergeFrom(base)); err != nil {
+		return err
 	}
 	return nil
 }
 
 func (r *HTTPBootConfigReconciler) enqueueHTTPBootConfigReferencingIgnitionSecret(ctx context.Context, secret client.Object) []reconcile.Request {
-	log := log.Log.WithValues("secret", secret.GetName())
+	log := ctrl.LoggerFrom(ctx)
 	secretObj, ok := secret.(*corev1.Secret)
 	if !ok {
 		log.Error(nil, "cant decode object into Secret", secret)
 		return nil
 	}
 
-	list := &bootv1alpha1.HTTPBootConfigList{}
-	if err := r.List(ctx, list, client.InNamespace("")); err != nil {
-		log.Error(err, "failed to list HTTPBootConfig for secret", secret)
+	configList := &bootv1alpha1.HTTPBootConfigList{}
+	if err := r.List(ctx, configList, client.InNamespace("")); err != nil {
+		log.Error(err, "failed to list HTTPBootConfig for Secret", "Secret", client.ObjectKeyFromObject(secretObj))
 		return nil
 	}
 
 	var requests []reconcile.Request
-	for _, HTTPBootConfig := range list.Items {
-		if HTTPBootConfig.Spec.IgnitionSecretRef != nil &&
-			HTTPBootConfig.Spec.IgnitionSecretRef.Name == secretObj.Name &&
-			HTTPBootConfig.Namespace == secretObj.Namespace {
+	for _, config := range configList.Items {
+		if config.Spec.IgnitionSecretRef != nil &&
+			config.Spec.IgnitionSecretRef.Name == secretObj.Name &&
+			config.Namespace == secretObj.Namespace {
 			requests = append(requests, reconcile.Request{
 				NamespacedName: types.NamespacedName{
-					Name:      HTTPBootConfig.Name,
-					Namespace: HTTPBootConfig.Namespace,
+					Name:      config.Name,
+					Namespace: config.Namespace,
 				},
 			})
 		}
 	}
 	return requests
 }
+
+// SetupWithManager sets up the controller with the Manager.
+func (r *HTTPBootConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewControllerManagedBy(mgr).
+		For(&bootv1alpha1.HTTPBootConfig{}).
+		Watches(
+			&corev1.Secret{},
+			handler.EnqueueRequestsFromMapFunc(r.enqueueHTTPBootConfigReferencingIgnitionSecret),
+		).
+		Complete(r)
+}