MLE-20428: add labels and annotation in group level (#82)

* MLE-20428: add labels and annotation in group level

* delete annotation used for kubectl apply

* Fix the issue with HAProxy Label

* Working Solution

* fix haproxy selector

* fix update for haproxy service

* fix issue with haproxy updated after creation

* fix haproxy deployment label update

* fix label for all services

* remove debug logging

* fix the bug with update panic

* fix group level label not prompt to services

* update the Helm CRD

* Fix Unit Test Failuer

* tidy code

* add comment out back

* remove excess logging

* uncomment the logic in predicate

* improve timeout for testing

* Fix typo

* add label and annotation sample for complete.yaml

---------

Co-authored-by: Peng Zhou <[email protected]>

Author: pengzhouml

api/v1/marklogiccluster_types.go

@@ -91,7 +91,9 @@ type MarklogicGroups struct {
 	// +kubebuilder:default:=1
 	Replicas *int32 `json:"replicas,omitempty"`
 	// +kubebuilder:validation:Required
-	Name string `json:"name,omitempty"`
+	Name        string            `json:"name,omitempty"`
+	Labels      map[string]string `json:"labels,omitempty"`
+	Annotations map[string]string `json:"annotations,omitempty"`
 	// +kubebuilder:default:={name: "Default", enableXdqpSsl: true}
 	GroupConfig               *GroupConfig                      `json:"groupConfig,omitempty"`
 	Image                     string                            `json:"image,omitempty"`

api/v1/marklogicgroup_types.go

@@ -28,8 +28,10 @@ import (
 // MarklogicGroupSpec defines the desired state of MarklogicGroup
 type MarklogicGroupSpec struct {
 	// +kubebuilder:default:=1
-	Replicas *int32 `json:"replicas,omitempty"`
-	Name     string `json:"name,omitempty"`
+	Replicas    *int32            `json:"replicas,omitempty"`
+	Name        string            `json:"name,omitempty"`
+	Labels      map[string]string `json:"labels,omitempty"`
+	Annotations map[string]string `json:"annotations,omitempty"`
 	// +kubebuilder:default:="cluster.local"
 	ClusterDomain string `json:"clusterDomain,omitempty"`
 	// +kubebuilder:default:="progressofficial/marklogic-db:11.3.0-ubi-rootless"

api/v1/zz_generated.deepcopy.go

@@ -7965,6 +7965,10 @@ spec:
                               x-kubernetes-list-type: atomic
                           type: object
                       type: object
+                    annotations:
+                      additionalProperties:
+                        type: string
+                      type: object
                     groupConfig:
                       default:
                         enableXdqpSsl: true
@@ -9331,6 +9335,10 @@ spec:
                     isBootstrap:
                       default: false
                       type: boolean
+                    labels:
+                      additionalProperties:
+                        type: string
+                      type: object
                     logCollection:
                       properties:
                         enabled:

charts/marklogic-operator-kubernetes/templates/marklogiccluster-crd.yaml

@@ -3243,6 +3243,10 @@ spec:
                         x-kubernetes-list-type: atomic
                     type: object
                 type: object
+              annotations:
+                additionalProperties:
+                  type: string
+                type: object
               auth:
                 properties:
                   adminPassword:
@@ -3310,6 +3314,10 @@ spec:
                   type: object
                   x-kubernetes-map-type: atomic
                 type: array
+              labels:
+                additionalProperties:
+                  type: string
+                type: object
               license:
                 properties:
                   key:

charts/marklogic-operator-kubernetes/templates/marklogicgroup-crd.yaml

@@ -7987,6 +7987,10 @@ spec:
                               x-kubernetes-list-type: atomic
                           type: object
                       type: object
+                    annotations:
+                      additionalProperties:
+                        type: string
+                      type: object
                     groupConfig:
                       default:
                         enableXdqpSsl: true
@@ -9356,6 +9360,10 @@ spec:
                     isBootstrap:
                       default: false
                       type: boolean
+                    labels:
+                      additionalProperties:
+                        type: string
+                      type: object
                     logCollection:
                       properties:
                         enabled:

config/crd/bases/marklogic.progress.com_marklogicclusters.yaml

@@ -3250,6 +3250,10 @@ spec:
                         x-kubernetes-list-type: atomic
                     type: object
                 type: object
+              annotations:
+                additionalProperties:
+                  type: string
+                type: object
               auth:
                 properties:
                   adminPassword:
@@ -3317,6 +3321,10 @@ spec:
                   type: object
                   x-kubernetes-map-type: atomic
                 type: array
+              labels:
+                additionalProperties:
+                  type: string
+                type: object
               license:
                 properties:
                   key:

config/crd/bases/marklogic.progress.com_marklogicgroups.yaml

@@ -195,6 +195,10 @@ spec:
   # additionalVolumeClaimTemplates: []
   markLogicGroups:
   - name: dnode
+    labels:
+      group-level-label: "group-level-label"
+    annotations: 
+      group-level-annotation: "group-level-annotation"
     replicas: 3
     groupConfig:
       name: dnode

config/samples/complete.yaml

@@ -31,6 +31,9 @@ import (
 	"github.com/go-logr/logr"
 	marklogicv1 "github.com/marklogic/marklogic-operator-kubernetes/api/v1"
 	"github.com/marklogic/marklogic-operator-kubernetes/pkg/k8sutil"
+	"reflect"
+	"sigs.k8s.io/controller-runtime/pkg/event"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
 // MarklogicClusterReconciler reconciles a MarklogicCluster object
@@ -81,10 +84,55 @@ func (r *MarklogicClusterReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	return result, nil
 }
 
+func markLogicClusterCreateUpdateDeletePredicate() predicate.Predicate {
+	return predicate.Funcs{
+		CreateFunc: func(e event.CreateEvent) bool {
+			return true // Reconcile on create
+		},
+		UpdateFunc: func(e event.UpdateEvent) bool {
+			switch e.ObjectNew.(type) {
+			case *marklogicv1.MarklogicCluster:
+				oldAnnotations := e.ObjectOld.GetAnnotations()
+				newAnnotations := e.ObjectNew.GetAnnotations()
+				delete(newAnnotations, "banzaicloud.com/last-applied")
+				delete(oldAnnotations, "banzaicloud.com/last-applied")
+				delete(newAnnotations, "kubectl.kubernetes.io/last-applied-configuration")
+				delete(oldAnnotations, "kubectl.kubernetes.io/last-applied-configuration")
+				if !reflect.DeepEqual(oldAnnotations, newAnnotations) {
+					return true // Reconcile if annotations have changed
+				}
+				oldLables := e.ObjectOld.GetLabels()
+				newLabels := e.ObjectNew.GetLabels()
+				if !reflect.DeepEqual(oldLables, newLabels) {
+					return true // Reconcile if labels have changed
+				}
+				// If annotations and labels are the same, check if the spec has changed
+				oldObj := e.ObjectOld.(*marklogicv1.MarklogicCluster)
+				// Check if the spec has changed
+				newObj := e.ObjectNew.(*marklogicv1.MarklogicCluster)
+				if !reflect.DeepEqual(oldObj.Spec, newObj.Spec) {
+					return true // Reconcile if spec has changed
+				}
+			default:
+				return false // Ignore updates for other types
+			}
+			return false // Reconcile on update of MarklogicCluster
+
+		},
+		DeleteFunc: func(e event.DeleteEvent) bool {
+			return true // Reconcile on delete
+		},
+		GenericFunc: func(e event.GenericEvent) bool {
+			return false // Ignore generic events (optional)
+		},
+	}
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *MarklogicClusterReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
 		For(&marklogicv1.MarklogicCluster{}).
+		WithEventFilter(markLogicClusterCreateUpdateDeletePredicate()).
 		Owns(&marklogicv1.MarklogicGroup{}).
 		Complete(r)
 }

internal/controller/marklogiccluster_controller.go

@@ -19,18 +19,20 @@ package controller
 import (
 	"context"
 
+	"github.com/go-logr/logr"
+	marklogicv1 "github.com/marklogic/marklogic-operator-kubernetes/api/v1"
+	"github.com/marklogic/marklogic-operator-kubernetes/pkg/k8sutil"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/tools/record"
+	"reflect"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/event"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-
-	"github.com/go-logr/logr"
-	marklogicv1 "github.com/marklogic/marklogic-operator-kubernetes/api/v1"
-	"github.com/marklogic/marklogic-operator-kubernetes/pkg/k8sutil"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
 
 // MarklogicGroupReconciler reconciles a MarklogicGroup object
@@ -94,12 +96,63 @@ func (r *MarklogicGroupReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 	return result, nil
 }
 
+func markLogicGroupCreateUpdateDeletePredicate() predicate.Predicate {
+	return predicate.Funcs{
+		CreateFunc: func(e event.CreateEvent) bool {
+			return true // Reconcile on create
+		},
+		UpdateFunc: func(e event.UpdateEvent) bool {
+			switch e.ObjectNew.(type) {
+			case *marklogicv1.MarklogicGroup:
+				oldAnnotations := e.ObjectOld.GetAnnotations()
+				newAnnotations := e.ObjectNew.GetAnnotations()
+				delete(newAnnotations, "banzaicloud.com/last-applied")
+				delete(oldAnnotations, "banzaicloud.com/last-applied")
+				delete(newAnnotations, "kubectl.kubernetes.io/last-applied-configuration")
+				delete(oldAnnotations, "kubectl.kubernetes.io/last-applied-configuration")
+				if !reflect.DeepEqual(oldAnnotations, newAnnotations) {
+					return true // Reconcile if annotations have changed
+				}
+				oldLables := e.ObjectOld.GetLabels()
+				newLabels := e.ObjectNew.GetLabels()
+				if !reflect.DeepEqual(oldLables, newLabels) {
+					return true // Reconcile if labels have changed
+				}
+				oldObj := e.ObjectOld.(*marklogicv1.MarklogicGroup)
+				newObj := e.ObjectNew.(*marklogicv1.MarklogicGroup)
+				if !reflect.DeepEqual(oldObj.Spec, newObj.Spec) {
+					return true // Reconcile if the spec has changed
+				}
+				return false
+			case *appsv1.StatefulSet:
+				return true // Reconcile on update of StatefulSet
+			case *corev1.Service:
+				oldObj := e.ObjectOld.(*corev1.Service)
+				newObj := e.ObjectNew.(*corev1.Service)
+				if !reflect.DeepEqual(oldObj.Spec, newObj.Spec) {
+					return true // Reconcile if the spec has changed
+				}
+				return false // Reconcile on update of Service
+			default:
+				return false // Ignore updates for other types
+			}
+		},
+		DeleteFunc: func(e event.DeleteEvent) bool {
+			return true // Reconcile on delete
+		},
+		GenericFunc: func(e event.GenericEvent) bool {
+			return false // Ignore generic events (optional)
+		},
+	}
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *MarklogicGroupReconciler) SetupWithManager(mgr ctrl.Manager) error {
 
 	builder := ctrl.NewControllerManagedBy(mgr).
 		Named("marklogicgroup-controller").
 		For(&marklogicv1.MarklogicGroup{}).
+		WithEventFilter(markLogicGroupCreateUpdateDeletePredicate()).
 		Owns(&appsv1.StatefulSet{}).
 		Owns(&corev1.Service{})