move secrets reconciler to generic

Author: odacremolbap

pkg/apis/eventing/v1alpha1/interfaces.go

@@ -0,0 +1,17 @@
+package v1alpha1
+
+import (
+	"knative.dev/pkg/kmeta"
+)
+
+type ReconcilableBroker interface {
+	kmeta.OwnerRefable
+
+	GetReconcilableBrokerStatus() ReconcilableBrokerStatus
+	GetOwnedObjectsPrefix() string
+}
+
+type ReconcilableBrokerStatus interface {
+	MarkConfigSecretFailed(reason, messageFormat string, messageA ...interface{})
+	MarkConfigSecretReady()
+}

pkg/apis/eventing/v1alpha1/memory_lifecycle.go

@@ -49,6 +49,17 @@ func (t *MemoryBroker) GetStatus() *duckv1.Status {
 	return &t.Status.Status
 }
 
+// GetReconcilableBrokerStatus returns a status interface that allows generic reconciler
+// to manage it.
+func (t *MemoryBroker) GetReconcilableBrokerStatus() ReconcilableBrokerStatus {
+	return &t.Status
+}
+
+// GetOwnedObjectsPrefix returns a prefix string to be used for created/owned objects.
+func (t *MemoryBroker) GetOwnedObjectsPrefix() string {
+	return "rb"
+}
+
 // GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.
 func (b *MemoryBroker) GetConditionSet() apis.ConditionSet {
 	memoryBrokerCondSetLock.RLock()

pkg/apis/eventing/v1alpha1/memory_types.go

@@ -7,7 +7,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	duckv1 "knative.dev/pkg/apis/duck/v1"
-	"knative.dev/pkg/kmeta"
 )
 
 // +genclient
@@ -36,8 +35,8 @@ type MemoryBroker struct {
 var (
 	// Make sure this is a kubernetes object.
 	_ runtime.Object = (*MemoryBroker)(nil)
-	// Check that we can create OwnerReferences with this object.
-	_ kmeta.OwnerRefable = (*MemoryBroker)(nil)
+	// Check that we can reconcile this object as a Broker.
+	_ ReconcilableBroker = (*MemoryBroker)(nil)
 	// Check that the type conforms to the duck Knative Resource shape.
 	_ duckv1.KRShaped = (*MemoryBroker)(nil)
 )

pkg/apis/eventing/v1alpha1/redisbroker_lifecycle.go

@@ -57,6 +57,17 @@ func (t *RedisBroker) GetStatus() *duckv1.Status {
 	return &t.Status.Status
 }
 
+// GetReconcilableBrokerStatus returns a status interface that allows generic reconciler
+// to manage it.
+func (t *RedisBroker) GetReconcilableBrokerStatus() ReconcilableBrokerStatus {
+	return &t.Status
+}
+
+// GetOwnedObjectsPrefix returns a prefix string to be used for created/owned objects.
+func (t *RedisBroker) GetOwnedObjectsPrefix() string {
+	return "rb"
+}
+
 // GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.
 func (b *RedisBroker) GetConditionSet() apis.ConditionSet {
 	redisBrokerCondSetLock.RLock()

pkg/apis/eventing/v1alpha1/redisbroker_types.go

@@ -8,7 +8,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	duckv1 "knative.dev/pkg/apis/duck/v1"
-	"knative.dev/pkg/kmeta"
 )
 
 // +genclient
@@ -37,8 +36,8 @@ type RedisBroker struct {
 var (
 	// Make sure this is a kubernetes object.
 	_ runtime.Object = (*RedisBroker)(nil)
-	// Check that we can create OwnerReferences with this object.
-	_ kmeta.OwnerRefable = (*RedisBroker)(nil)
+	// Check that we can reconcile this object as a Broker.
+	_ ReconcilableBroker = (*RedisBroker)(nil)
 	// Check that the type conforms to the duck Knative Resource shape.
 	_ duckv1.KRShaped = (*RedisBroker)(nil)
 )

pkg/reconciler/common/common.go

@@ -0,0 +1,11 @@
+package common
+
+import (
+	"strings"
+
+	"knative.dev/pkg/kmeta"
+)
+
+func AppAnnotationValue(or kmeta.OwnerRefable) string {
+	return strings.ToLower(or.GetGroupVersionKind().Kind)
+}

pkg/reconciler/events.go renamed to pkg/reconciler/common/events.go

@@ -1,25 +1,20 @@
 // Copyright 2022 TriggerMesh Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-package reconciler
+package common
 
 // Reasons for API Events
 const (
-	// // ReasonRBACCreate indicates that an RBAC object was successfully created.
-	// ReasonRBACCreate = "CreateRBAC"
-	// // ReasonRBACUpdate indicates that an RBAC object was successfully updated.
-	// ReasonRBACUpdate = "UpdateRBAC"
-	// // ReasonFailedRBACCreate indicates that the creation of an RBAC object failed.
-	// ReasonFailedRBACCreate = "FailedRBACCreate"
-	// // ReasonFailedRBACUpdate indicates that the update of an RBAC object failed.
-	// ReasonFailedRBACUpdate = "FailedRBACUpdate"
-
 	ReasonDeploymentCreate       = "CreateDeployment"
 	ReasonDeploymentUpdate       = "UpdateDeployment"
 	ReasonFailedDeploymentGet    = "FailedDeploymentGet"
 	ReasonFailedDeploymentCreate = "FailedDeploymentCreate"
 	ReasonFailedDeploymentUpdate = "FailedDeploymentUpdate"
 
+	ReasonFailedSecretGet    = "FailedSecretGet"
+	ReasonFailedSecretCreate = "FailedSecretCreate"
+	ReasonFailedSecretUpdate = "FailedSecretUpdate"
+
 	ReasonFailedServiceAccountGet    = "FailedServiceAccountGet"
 	ReasonFailedServiceAccountCreate = "FailedServiceAccountCreate"
 	ReasonFailedRoleBindingGet       = "FailedRoleBindingGet"

pkg/reconciler/redisbroker/reconcile_secret.go renamed to pkg/reconciler/common/reconcile_secret.go

@@ -1,4 +1,4 @@
-package redisbroker
+package common
 
 import (
 	"context"
@@ -20,33 +20,39 @@ import (
 
 	"github.com/triggermesh/brokers/pkg/config/broker"
 
-	eventingv1alpha1 "github.com/triggermesh/triggermesh-core/pkg/apis/eventing/v1alpha1"
+	"github.com/triggermesh/triggermesh-core/pkg/apis/eventing/v1alpha1"
 	eventingv1alpha1listers "github.com/triggermesh/triggermesh-core/pkg/client/generated/listers/eventing/v1alpha1"
-	"github.com/triggermesh/triggermesh-core/pkg/reconciler"
 	"github.com/triggermesh/triggermesh-core/pkg/reconciler/resources"
 	"github.com/triggermesh/triggermesh-core/pkg/reconciler/semantic"
 )
 
 const (
-	secretResourceSuffix = "rb-config"
-	configSecretKey      = "config"
+	ConfigSecretKey = "config"
 )
 
+var (
+	secretResourceSuffix = "config"
+)
+
+type SecretReconciler interface {
+	Reconcile(ctx context.Context, rb v1alpha1.ReconcilableBroker) (*corev1.Secret, error)
+}
+
 type secretReconciler struct {
 	client        kubernetes.Interface
 	secretLister  corev1listers.SecretLister
 	triggerLister eventingv1alpha1listers.TriggerLister
 }
 
-func newSecretReconciler(ctx context.Context, secretLister corev1listers.SecretLister, triggerLister eventingv1alpha1listers.TriggerLister) secretReconciler {
-	return secretReconciler{
+func NewSecretReconciler(ctx context.Context, secretLister corev1listers.SecretLister, triggerLister eventingv1alpha1listers.TriggerLister) SecretReconciler {
+	return &secretReconciler{
 		client:        k8sclient.Get(ctx),
 		secretLister:  secretLister,
 		triggerLister: triggerLister,
 	}
 }
 
-func (r *secretReconciler) reconcile(ctx context.Context, rb *eventingv1alpha1.RedisBroker) (*corev1.Secret, error) {
+func (r *secretReconciler) Reconcile(ctx context.Context, rb v1alpha1.ReconcilableBroker) (*corev1.Secret, error) {
 	desired, err := r.buildConfigSecret(ctx, rb)
 	if err != nil {
 		return nil, err
@@ -62,48 +68,51 @@ func (r *secretReconciler) reconcile(ctx context.Context, rb *eventingv1alpha1.R
 			current, err = r.client.CoreV1().Secrets(desired.Namespace).Update(ctx, desired, metav1.UpdateOptions{})
 			if err != nil {
 				fullname := types.NamespacedName{Namespace: desired.Namespace, Name: desired.Name}
-				logging.FromContext(ctx).Error("Unable to update the secret", zap.String("secret", fullname.String()), zap.Error(err))
-				rb.Status.MarkRedisDeploymentFailed(reconciler.ReasonFailedDeploymentUpdate, "Failed to update Redis deployment")
+				logging.FromContext(ctx).Error("Unable to update secret", zap.String("secret", fullname.String()), zap.Error(err))
+				rb.GetReconcilableBrokerStatus().MarkConfigSecretFailed(ReasonFailedSecretUpdate, "Failed to update config from secret")
 
-				return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, reconciler.ReasonFailedDeploymentUpdate,
-					"Failed to get Redis deployment %s: %w", fullname, err)
+				return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedSecretUpdate,
+					"Failed to update config from secret %s: %w", fullname, err)
 			}
 		}
 
 	case !apierrs.IsNotFound(err):
-		// An error occurred retrieving current deployment.
+		// An error occurred retrieving current secret.
 		fullname := types.NamespacedName{Namespace: desired.Namespace, Name: desired.Name}
-		logging.FromContext(ctx).Error("Unable to get the deployment", zap.String("deployment", fullname.String()), zap.Error(err))
-		rb.Status.MarkRedisDeploymentFailed(reconciler.ReasonFailedDeploymentGet, "Failed to get Redis deployment")
+		logging.FromContext(ctx).Error("Unable to get secret", zap.String("secret", fullname.String()), zap.Error(err))
+		rb.GetReconcilableBrokerStatus().MarkConfigSecretFailed(ReasonFailedSecretGet, "Failed to get config from secret")
 
-		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, reconciler.ReasonFailedDeploymentGet,
-			"Failed to get Redis deployment %s: %w", fullname, err)
+		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedSecretGet,
+			"Failed to get config from secret %s: %w", fullname, err)
 
 	default:
-		// The deployment has not been found, create it.
+		// The secret has not been found, create it.
 		current, err = r.client.CoreV1().Secrets(desired.Namespace).Create(ctx, desired, metav1.CreateOptions{})
 		if err != nil {
 			fullname := types.NamespacedName{Namespace: desired.Namespace, Name: desired.Name}
-			logging.FromContext(ctx).Error("Unable to create the deployment", zap.String("deployment", fullname.String()), zap.Error(err))
-			rb.Status.MarkRedisDeploymentFailed(reconciler.ReasonFailedDeploymentCreate, "Failed to create Redis deployment")
+			logging.FromContext(ctx).Error("Unable to create secret", zap.String("secret", fullname.String()), zap.Error(err))
+			rb.GetReconcilableBrokerStatus().MarkConfigSecretFailed(ReasonFailedSecretCreate, "Failed to create secret for config")
 
-			return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, reconciler.ReasonFailedDeploymentCreate,
-				"Failed to create Redis deployment %s: %w", fullname, err)
+			return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedSecretCreate,
+				"Failed to create secret for config %s: %w", fullname, err)
 		}
 	}
 
-	rb.Status.MarkConfigSecretReady()
+	rb.GetReconcilableBrokerStatus().MarkConfigSecretReady()
 
 	return current, nil
 }
 
-func (r *secretReconciler) buildConfigSecret(ctx context.Context, rb *eventingv1alpha1.RedisBroker) (*corev1.Secret, error) {
-	triggers, err := r.triggerLister.Triggers(rb.Namespace).List(labels.Everything())
+func (r *secretReconciler) buildConfigSecret(ctx context.Context, rb v1alpha1.ReconcilableBroker) (*corev1.Secret, error) {
+	meta := rb.GetObjectMeta()
+	ns, name := meta.GetNamespace(), meta.GetName()
+
+	triggers, err := r.triggerLister.Triggers(ns).List(labels.Everything())
 	if err != nil {
 		logging.FromContext(ctx).Error("Unable to list triggers at namespace", zap.Error(err))
-		rb.Status.MarkConfigSecretFailed(reconciler.ReasonFailedTriggerList, "Failed to list triggers")
+		rb.GetReconcilableBrokerStatus().MarkConfigSecretFailed(ReasonFailedTriggerList, "Failed to list triggers")
 
-		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, reconciler.ReasonFailedTriggerList,
+		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedTriggerList,
 			"Failed to list triggers: %w", err)
 	}
 
@@ -166,19 +175,21 @@ func (r *secretReconciler) buildConfigSecret(ctx context.Context, rb *eventingv1
 	b, err := yaml.Marshal(cfg)
 	if err != nil {
 		logging.FromContext(ctx).Error("Unable to marshal configuration into YAML", zap.Error(err))
-		rb.Status.MarkConfigSecretFailed(reconciler.ReasonFailedConfigSerialize, "Failed to serialize configuration")
+		rb.GetReconcilableBrokerStatus().MarkConfigSecretFailed(ReasonFailedConfigSerialize, "Failed to serialize configuration")
 
-		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, reconciler.ReasonFailedConfigSerialize,
+		return nil, pkgreconciler.NewEvent(corev1.EventTypeWarning, ReasonFailedConfigSerialize,
 			"Failed to serialize configuration: %w", err)
 	}
 
-	return resources.NewSecret(rb.Namespace, rb.Name+"-"+secretResourceSuffix,
+	sn := name + "-" + rb.GetOwnedObjectsPrefix() + "-" + secretResourceSuffix
+
+	return resources.NewSecret(ns, sn,
 		resources.SecretWithMetaOptions(
-			resources.MetaAddLabel(resources.AppNameLabel, appAnnotationValue),
+			resources.MetaAddLabel(resources.AppNameLabel, AppAnnotationValue(rb)),
 			resources.MetaAddLabel(resources.AppComponentLabel, "broker-config"),
 			resources.MetaAddLabel(resources.AppPartOfLabel, resources.PartOf),
 			resources.MetaAddLabel(resources.AppManagedByLabel, resources.ManagedBy),
-			resources.MetaAddLabel(resources.AppInstanceLabel, rb.Name+"-"+secretResourceSuffix),
-			resources.MetaAddOwner(rb, rb.GetGroupVersionKind())),
-		resources.SecretSetData(configSecretKey, b)), nil
+			resources.MetaAddLabel(resources.AppInstanceLabel, sn),
+			resources.MetaAddOwner(meta, rb.GetGroupVersionKind())),
+		resources.SecretSetData(ConfigSecretKey, b)), nil
 }

pkg/reconciler/memorybroker/reconciler.go

@@ -0,0 +1,77 @@
+// Copyright 2022 TriggerMesh Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+package memorybroker
+
+import (
+	"context"
+	"strconv"
+
+	"go.uber.org/zap"
+	v1 "k8s.io/api/core/v1"
+	"k8s.io/client-go/kubernetes"
+
+	"knative.dev/pkg/apis"
+	"knative.dev/pkg/logging"
+	"knative.dev/pkg/network"
+	"knative.dev/pkg/reconciler"
+
+	eventingv1alpha1 "github.com/triggermesh/triggermesh-core/pkg/apis/eventing/v1alpha1"
+	"github.com/triggermesh/triggermesh-core/pkg/reconciler/common"
+)
+
+const (
+	appAnnotationValue = "memorybroker"
+)
+
+type Reconciler struct {
+	kubeClientSet    kubernetes.Interface
+	secretReconciler common.SecretReconciler
+	// secretReconciler secretReconciler
+	// memoryReconciler  memoryReconciler
+	// brokerReconciler brokerReconciler
+	// saReconciler     serviceAccountReconciler
+}
+
+func (r *Reconciler) ReconcileKind(ctx context.Context, rb *eventingv1alpha1.MemoryBroker) reconciler.Event {
+	logging.FromContext(ctx).Infow("Reconciling", zap.Any("Broker", *rb))
+
+	// Make sure the Memory deployment and service exists.
+	_, memorySvc, err := r.memoryReconciler.reconcile(ctx, rb)
+	if err != nil {
+		return err
+	}
+
+	// Iterate triggers and create secret.
+	secret, err := r.secretReconciler.Reconcile(ctx, rb)
+	if err != nil {
+		return err
+	}
+
+	// Make sure the Broker service account and roles exists.
+	sa, _, err := r.saReconciler.reconcile(ctx, rb)
+	if err != nil {
+		return err
+	}
+
+	// Make sure the Broker deployment for Memory exists and that it points to the Memory service.
+	_, brokerSvc, err := r.brokerReconciler.reconcile(ctx, rb, sa, memorySvc, secret)
+	if err != nil {
+		return err
+	}
+
+	// Set address to the Broker service.
+	rb.Status.SetAddress(getSericeAddress(brokerSvc))
+
+	return nil
+}
+
+func getSericeAddress(svc *v1.Service) *apis.URL {
+	var port string
+	if svc.Spec.Ports[0].Port != 80 {
+		port = ":" + strconv.Itoa(int(svc.Spec.Ports[0].Port))
+	}
+
+	return apis.HTTP(
+		network.GetServiceHostname(svc.Name, svc.Namespace) + port)
+}

pkg/reconciler/redisbroker/controller.go

@@ -30,6 +30,7 @@ import (
 	rbinformer "github.com/triggermesh/triggermesh-core/pkg/client/generated/injection/informers/eventing/v1alpha1/redisbroker"
 	trginformer "github.com/triggermesh/triggermesh-core/pkg/client/generated/injection/informers/eventing/v1alpha1/trigger"
 	rbreconciler "github.com/triggermesh/triggermesh-core/pkg/client/generated/injection/reconciler/eventing/v1alpha1/redisbroker"
+	"github.com/triggermesh/triggermesh-core/pkg/reconciler/common"
 	"github.com/triggermesh/triggermesh-core/pkg/reconciler/resources"
 )
 
@@ -67,7 +68,8 @@ func NewController(
 
 	r := &Reconciler{
 		kubeClientSet:    kubeclient.Get(ctx),
-		secretReconciler: newSecretReconciler(ctx, secretInformer.Lister(), trgInformer.Lister()),
+		secretReconciler: common.NewSecretReconciler(ctx, secretInformer.Lister(), trgInformer.Lister()),
+		// newSecretReconciler(ctx, secretInformer.Lister(), trgInformer.Lister()),
 		redisReconciler: redisReconciler{
 			client:           kubeclient.Get(ctx),
 			deploymentLister: deploymentInformer.Lister(),
@@ -114,7 +116,7 @@ func NewController(
 	endpointsInformer.Informer().AddEventHandler(cache.FilteringResourceEventHandler{
 		FilterFunc: func(obj interface{}) bool {
 			ep, ok := obj.(*corev1.Endpoints)
-			if !ok || ep.Labels != nil || ep.Labels[resources.AppNameLabel] == appAnnotationValue {
+			if !ok || ep.Labels != nil || ep.Labels[resources.AppNameLabel] == common.AppAnnotationValue(rb) {
 				return false
 			}