237 ignore external mutations for annotations (#239)

akyriako · web-flow · commit e03271a866b5 · 2026-02-16T12:42:12.000+01:00
* added field to ignore annotations, new sts hashing calculation #237 * split sts hashing and update getekeeping to another file #237 * add default app.kubernetes.io labels to facilitate kyverno policy exceptions #237 * rename field, fix null pointer deref for additionalconfdata, bumped charts and manifests #237
diff --git a/Makefile b/Makefile
@@ -52,7 +52,7 @@ OPERATOR_SDK_VERSION ?= v1.38.0
 # Image URL to use all building/pushing image targets
 DOCKER_HUB_NAME ?= $(shell docker info | sed '/Username:/!d;s/.* //')
 IMG_NAME ?= typesense-operator
-IMG_TAG ?= 0.3.8-rc.3
+IMG_TAG ?= 0.3.8-rc.4
 IMG ?= $(DOCKER_HUB_NAME)/$(IMG_NAME):$(IMG_TAG)
 
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
diff --git a/README.md b/README.md
@@ -228,7 +228,7 @@ Join the conversation:
 ## 📦 Project Status
 
 TyKO is an **independently maintained** project (not affiliated with Typesense, Inc.).
-- Latest version: **0.3.8-rc.3**
+- Latest version: **0.3.8-rc.4**
 - Tested on: Kubernetes 1.35 (earliest 1.26), Typesense 30.0 (earliest 26.0)
 - Contributions welcome! See [FAQ](https://akyriako.github.io/typesense-operator-docs/docs/faq) and [Development](https://akyriako.github.io/typesense-operator-docs/docs/development)
 
diff --git a/api/v1alpha1/typesensecluster_types.go b/api/v1alpha1/typesensecluster_types.go
@@ -135,6 +135,10 @@ type TypesenseClusterSpec struct {
 
 	SecurityContext *SecurityContextSpec `json:"securityContext,omitempty"`
 
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:validation:Items:Type=string
+	IgnoreAnnotationsFromExternalMutations []string `json:"ignoreAnnotationsFromExternalMutations,omitempty"`
+
 	// +optional
 	// +kubebuilder:default=false
 	// +kubebuilder:validation:Type=boolean
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/typesense-operator/Chart.yaml b/charts/typesense-operator/Chart.yaml
@@ -14,12 +14,12 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.3.8-rc.3
+version: 0.3.8-rc.4
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.3.8-rc.3"
+appVersion: "0.3.8-rc.4"
 
 maintainers:
   - name: Kyriakos Akriotis
diff --git a/charts/typesense-operator/templates/typesensecluster-crd.yaml b/charts/typesense-operator/templates/typesensecluster-crd.yaml
@@ -1092,6 +1092,10 @@ spec:
                         type: object
                     type: object
                 type: object
+              ignoreAnnotationsFromExternalMutations:
+                items:
+                  type: string
+                type: array
               image:
                 type: string
               imagePullSecrets:
diff --git a/charts/typesense-operator/values.yaml b/charts/typesense-operator/values.yaml
@@ -12,7 +12,7 @@ controllerManager:
         - ALL
     image:
       repository: akyriako78/typesense-operator
-      tag: 0.3.8-rc.3
+      tag: 0.3.8-rc.4
     imagePullPolicy: IfNotPresent
     resources:
       limits:
diff --git a/config/crd/bases/ts.opentelekomcloud.com_typesenseclusters.yaml b/config/crd/bases/ts.opentelekomcloud.com_typesenseclusters.yaml
@@ -1092,6 +1092,10 @@ spec:
                         type: object
                     type: object
                 type: object
+              ignoreAnnotationsFromExternalMutations:
+                items:
+                  type: string
+                type: array
               image:
                 type: string
               imagePullSecrets:
diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml
@@ -5,4 +5,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: akyriako78/typesense-operator
-  newTag: 0.3.8-rc.3
+  newTag: 0.3.8-rc.4
diff --git a/internal/controller/typesensecluster_controller.go b/internal/controller/typesensecluster_controller.go
@@ -157,7 +157,7 @@ func (r *TypesenseClusterReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	}
 
 	// Update strategy: Update the existing objects, if changes are identified in api and peering ports
-	err = r.ReconcileIngress(ctx, ts)
+	err = r.ReconcileIngress(ctx, &ts)
 	if err != nil {
 		cerr := r.setConditionNotReady(ctx, &ts, ConditionReasonIngressNotReady, err)
 		if cerr != nil {
@@ -187,7 +187,7 @@ func (r *TypesenseClusterReconciler) Reconcile(ctx context.Context, req ctrl.Req
 	}
 
 	// Update strategy: Update the whole specs when changes are identified
-	sts, err := r.ReconcileStatefulSet(ctx, &ts)
+	sts, _, err := r.ReconcileStatefulSet(ctx, &ts)
 	if err != nil {
 		cerr := r.setConditionNotReady(ctx, &ts, ConditionReasonStatefulSetNotReady, err)
 		if cerr != nil {
diff --git a/internal/controller/typesensecluster_ingress.go b/internal/controller/typesensecluster_ingress.go
@@ -57,7 +57,7 @@ const (
 
 const clusterIssuerAnnotationKey = "cert-manager.io/cluster-issuer"
 
-func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts tsv1alpha1.TypesenseCluster) (err error) {
+func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts *tsv1alpha1.TypesenseCluster) (err error) {
 	r.logger.V(debugLevel).Info("reconciling ingress")
 
 	ingressName := fmt.Sprintf(ClusterReverseProxyIngress, ts.Name)
@@ -83,23 +83,23 @@ func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts ts
 	if !ingressExists {
 		r.logger.V(debugLevel).Info("creating ingress", "ingress", ingressObjectKey.Name)
 
-		ig, err = r.createIngress(ctx, ingressObjectKey, &ts)
+		ig, err = r.createIngress(ctx, ingressObjectKey, ts)
 		if err != nil {
 			r.logger.Error(err, "creating ingress failed", "ingress", ingressObjectKey.Name)
 			return err
 		}
 	} else {
 		if ts.Spec.Ingress.Host != ig.Spec.Rules[0].Host ||
 			(ts.Spec.Ingress.ClusterIssuer != nil && *ts.Spec.Ingress.ClusterIssuer != ig.Annotations[clusterIssuerAnnotationKey]) ||
-			!apiequality.Semantic.DeepEqual(ts.Spec.Ingress.Annotations, r.getIngressAnnotations(ig)) ||
+			!apiequality.Semantic.DeepEqual(ts.Spec.Ingress.Annotations, r.getIngressAnnotations(ig, ts)) ||
 			(ts.Spec.Ingress.TLSSecretName != nil && *ts.Spec.Ingress.TLSSecretName != ig.Spec.TLS[0].SecretName) ||
 			ts.Spec.Ingress.IngressClassName != *ig.Spec.IngressClassName ||
 			ts.Spec.Ingress.Path != ig.Spec.Rules[0].IngressRuleValue.HTTP.Paths[0].Path ||
 			*ts.Spec.Ingress.PathType != *ig.Spec.Rules[0].IngressRuleValue.HTTP.Paths[0].PathType {
 
 			r.logger.V(debugLevel).Info("updating ingress", "ingress", ingressObjectKey.Name)
 
-			ig, err = r.updateIngress(ctx, *ig, &ts)
+			ig, err = r.updateIngress(ctx, *ig, ts)
 			if err != nil {
 				r.logger.Error(err, "updating ingress failed", "ingress", ingressObjectKey.Name)
 				return err
@@ -126,21 +126,21 @@ func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts ts
 	if !configMapExists {
 		r.logger.V(debugLevel).Info("creating ingress config map", "configmap", configMapObjectKey.Name)
 
-		_, err = r.createIngressConfigMap(ctx, configMapObjectKey, &ts, ig)
+		_, err = r.createIngressConfigMap(ctx, configMapObjectKey, ts, ig)
 		if err != nil {
 			r.logger.Error(err, "creating ingress config map failed", "configmap", configMapObjectKey.Name)
 			return err
 		}
 	} else {
-		shouldUpdate, err := r.shouldUpdateIngressConfigMap(cm, &ts)
+		shouldUpdate, err := r.shouldUpdateIngressConfigMap(cm, ts)
 		if err != nil {
 			return err
 		}
 
 		if shouldUpdate {
 			r.logger.V(debugLevel).Info("updating ingress config map", "configmap", configMapObjectKey.Name)
 
-			_, err = r.updateIngressConfigMap(ctx, cm, &ts)
+			_, err = r.updateIngressConfigMap(ctx, cm, ts)
 			if err != nil {
 				return err
 			}
@@ -166,7 +166,7 @@ func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts ts
 	if !deploymentExists {
 		r.logger.V(debugLevel).Info("creating ingress reverse proxy deployment", "deployment", deploymentObjectKey.Name)
 
-		_, err = r.createIngressDeployment(ctx, deploymentObjectKey, &ts, ig)
+		_, err = r.createIngressDeployment(ctx, deploymentObjectKey, ts, ig)
 		if err != nil {
 			r.logger.Error(err, "creating ingress reverse proxy deployment failed", "deployment", deploymentObjectKey.Name)
 			return err
@@ -255,14 +255,14 @@ func (r *TypesenseClusterReconciler) ReconcileIngress(ctx context.Context, ts ts
 	if !serviceExists {
 		r.logger.V(debugLevel).Info("creating ingress reverse proxy service", "service", serviceNameObjectKey.Name)
 
-		_, err = r.createIngressService(ctx, serviceNameObjectKey, &ts, ig)
+		_, err = r.createIngressService(ctx, serviceNameObjectKey, ts, ig)
 		if err != nil {
 			r.logger.Error(err, "creating ingress reverse proxy service failed", "service", serviceNameObjectKey.Name)
 			return err
 		}
 	} else {
 		if !apiequality.Semantic.DeepEqual(service.Annotations, ts.Spec.Ingress.ServiceAnnotations) {
-			err = r.updateIngressService(ctx, service, &ts)
+			err = r.updateIngressService(ctx, service, ts)
 			if err != nil {
 				r.logger.Error(err, "updating ingress reverse proxy service failed", "service", serviceNameObjectKey.Name)
 				return err
@@ -388,8 +388,9 @@ func (r *TypesenseClusterReconciler) deleteIngress(ctx context.Context, ig *netw
 	return nil
 }
 
-func (r *TypesenseClusterReconciler) getIngressAnnotations(ig *networkingv1.Ingress) map[string]string {
-	filtered := filterAnnotations(ig.Annotations, clusterIssuerAnnotationKey, rancherDomainAnnotationKey)
+func (r *TypesenseClusterReconciler) getIngressAnnotations(ig *networkingv1.Ingress, ts *tsv1alpha1.TypesenseCluster) map[string]string {
+	filters := append([]string{clusterIssuerAnnotationKey, rancherDomainAnnotationKey}, ts.Spec.IgnoreAnnotationsFromExternalMutations...)
+	filtered := filterAnnotations(ig.Annotations, filters...)
 	return filtered
 }
 
diff --git a/internal/controller/typesensecluster_quorum.go b/internal/controller/typesensecluster_quorum.go
@@ -349,7 +349,7 @@ func (r *TypesenseClusterReconciler) updatePodReadinessGate(ctx context.Context,
 	pod := &v1.Pod{}
 	err := r.Get(ctx, podObjectKey, pod)
 	if err != nil {
-		r.logger.Error(err, fmt.Sprintf("unable to fetch statefulset pod: %s", podObjectKey.Name))
+		r.logger.Error(err, fmt.Sprintf("unable to fetch pod: %s", podObjectKey.Name))
 		return nil
 	}
 
diff --git a/internal/controller/typesensecluster_statefulset.go b/internal/controller/typesensecluster_statefulset.go
diff --git a/internal/controller/typesensecluster_statefulset_hash.go b/internal/controller/typesensecluster_statefulset_hash.go
diff --git a/internal/controller/utils.go b/internal/controller/utils.go
