feat: context aware reconcilers

Signed-off-by: Peter Wilcsinszky <[email protected]>

Author: pepov

controllers/logging/logging_controller.go

@@ -144,8 +144,8 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		}
 	}()
 
-	reconcilers := []resources.ComponentReconciler{
-		model.NewValidationReconciler(ctx, r.Client, loggingResources, &secretLoaderFactory{Client: r.Client, Path: fluentd.OutputSecretPath}),
+	reconcilers := []resources.ContextAwareComponentReconciler{
+		model.NewValidationReconciler(r.Client, loggingResources, &secretLoaderFactory{Client: r.Client, Path: fluentd.OutputSecretPath}),
 	}
 
 	if logging.Spec.FluentdSpec != nil && logging.Spec.SyslogNGSpec != nil {
@@ -158,7 +158,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		fluentdConfig, secretList, err := r.clusterConfigurationFluentd(loggingResources)
 		if err != nil {
 			// TODO: move config generation into Fluentd reconciler
-			reconcilers = append(reconcilers, func() (*reconcile.Result, error) {
+			reconcilers = append(reconcilers, func(ctx context.Context) (*reconcile.Result, error) {
 				return &reconcile.Result{}, err
 			})
 		} else {
@@ -173,7 +173,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		syslogNGConfig, secretList, err := r.clusterConfigurationSyslogNG(loggingResources)
 		if err != nil {
 			// TODO: move config generation into Syslog-NG reconciler
-			reconcilers = append(reconcilers, func() (*reconcile.Result, error) {
+			reconcilers = append(reconcilers, func(ctx context.Context) (*reconcile.Result, error) {
 				return &reconcile.Result{}, err
 			})
 		} else {
@@ -238,7 +238,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	}
 
 	for _, rec := range reconcilers {
-		result, err := rec()
+		result, err := rec(ctx)
 		if err != nil {
 			return reconcile.Result{}, err
 		}

pkg/resources/fluentbit/fluentbit.go

@@ -15,6 +15,8 @@
 package fluentbit
 
 import (
+	"context"
+
 	"emperror.dev/errors"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -112,7 +114,7 @@ func New(client client.Client,
 }
 
 // Reconcile reconciles the fluentBit resource
-func (r *Reconciler) Reconcile() (*reconcile.Result, error) {
+func (r *Reconciler) Reconcile(ctx context.Context) (*reconcile.Result, error) {
 	if err := v1beta1.FluentBitDefaults(r.fluentbitSpec); err != nil {
 		return nil, err
 	}

pkg/resources/fluentd/fluentd.go

@@ -98,8 +98,7 @@ func New(client client.Client, log logr.Logger,
 }
 
 // Reconcile reconciles the fluentd resource
-func (r *Reconciler) Reconcile() (*reconcile.Result, error) {
-	ctx := context.Background()
+func (r *Reconciler) Reconcile(ctx context.Context) (*reconcile.Result, error) {
 	patchBase := client.MergeFrom(r.Logging.DeepCopy())
 
 	objects := []resources.Resource{

pkg/resources/model/reconciler.go

@@ -23,20 +23,20 @@ import (
 	"emperror.dev/errors"
 	"github.com/cisco-open/operator-tools/pkg/secret"
 	"github.com/cisco-open/operator-tools/pkg/utils"
-	loggingv1beta1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
+	loggingv1beta1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
+
 	"github.com/kube-logging/logging-operator/pkg/mirror"
 )
 
 func NewValidationReconciler(
-	ctx context.Context,
 	repo client.StatusClient,
 	resources LoggingResources,
 	secrets SecretLoaderFactory,
-) func() (*reconcile.Result, error) {
-	return func() (*reconcile.Result, error) {
+) func(ctx context.Context) (*reconcile.Result, error) {
+	return func(ctx context.Context) (*reconcile.Result, error) {
 		var patchRequests []patchRequest
 		registerForPatching := func(obj client.Object) {
 			patchRequests = append(patchRequests, patchRequest{

pkg/resources/nodeagent/nodeagent.go

@@ -15,6 +15,7 @@
 package nodeagent
 
 import (
+	"context"
 	"fmt"
 
 	"emperror.dev/errors"
@@ -292,7 +293,7 @@ type nodeAgentInstance struct {
 }
 
 // Reconcile reconciles the InlineNodeAgent resource
-func (r *Reconciler) Reconcile() (*reconcile.Result, error) {
+func (r *Reconciler) Reconcile(_ context.Context) (*reconcile.Result, error) {
 	combinedResult := reconciler.CombinedResult{}
 	for name, userDefinedAgent := range r.agents {
 		result, err := r.processAgent(name, userDefinedAgent)

pkg/resources/reconciler.go

@@ -15,6 +15,8 @@
 package resources
 
 import (
+	"context"
+
 	"github.com/cisco-open/operator-tools/pkg/reconciler"
 	"github.com/go-logr/logr"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -24,6 +26,8 @@ import (
 // ComponentReconciler reconciler interface
 type ComponentReconciler func() (*reconcile.Result, error)
 
+type ContextAwareComponentReconciler func(context.Context) (*reconcile.Result, error)
+
 // Resource redeclaration of function with return type kubernetes Object
 type Resource func() (runtime.Object, reconciler.DesiredState, error)
 

pkg/resources/syslogng/syslogng.go

@@ -102,8 +102,7 @@ func New(
 }
 
 // Reconcile reconciles the syslog-ng resource
-func (r *Reconciler) Reconcile() (*reconcile.Result, error) {
-	ctx := context.Background()
+func (r *Reconciler) Reconcile(ctx context.Context) (*reconcile.Result, error) {
 	patchBase := client.MergeFrom(r.Logging.DeepCopy())
 
 	for _, res := range []resources.Resource{