Use Coherence resource generation instead of calculating a hash (#724)

Author: thegridman

.github/workflows/compatibility-tests.yaml

@@ -1,4 +1,4 @@
-# Copyright 2019, 2024, Oracle Corporation and/or its affiliates.  All rights reserved.
+# Copyright 2019, 2025, Oracle Corporation and/or its affiliates.  All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # http://oss.oracle.com/licenses/upl.
 
@@ -37,6 +37,7 @@ jobs:
       fail-fast: false
       matrix:
         compatibilityVersion:
+        - 3.4.3
         - 3.4.2
         - 3.4.1
         - 3.4.0
@@ -45,10 +46,11 @@ jobs:
         - 3.3.3
         - 3.3.2
         - 3.3.1
-        - 3.3.0
-        - 3.2.11
-        - 3.2.10
         include:
+        - compatibilityVersion: 3.4.3
+          coherence-image: "ghcr.io/oracle/coherence-ce:14.1.2-0-1"
+          compatibilitySelector: control-plane=coherence
+          k8s: kindest/node:v1.32.2@sha256:f226345927d7e348497136874b6d207e0b32cc52154ad8323129352923a3142f
         - compatibilityVersion: 3.4.2
           coherence-image: "ghcr.io/oracle/coherence-ce:14.1.2-0-1"
           compatibilitySelector: control-plane=coherence
@@ -81,18 +83,6 @@ jobs:
           coherence-image: "ghcr.io/oracle/coherence-ce:22.06.10"
           compatibilitySelector: control-plane=coherence
           k8s: kindest/node:v1.27.3@sha256:3966ac761ae0136263ffdb6cfd4db23ef8a83cba8a463690e98317add2c9ba72
-        - compatibilityVersion: 3.3.0
-          coherence-image: "ghcr.io/oracle/coherence-ce:22.06.10"
-          compatibilitySelector: control-plane=coherence
-          k8s: kindest/node:v1.27.3@sha256:3966ac761ae0136263ffdb6cfd4db23ef8a83cba8a463690e98317add2c9ba72
-        - compatibilityVersion: 3.2.11
-          coherence-image: "ghcr.io/oracle/coherence-ce:22.06.10"
-          compatibilitySelector: control-plane=coherence
-          k8s: kindest/node:v1.26.6@sha256:6e2d8b28a5b601defe327b98bd1c2d1930b49e5d8c512e1895099e4504007adb
-        - compatibilityVersion: 3.2.10
-          coherence-image: "ghcr.io/oracle/coherence-ce:22.06.10"
-          compatibilitySelector: control-plane=coherence
-          k8s: kindest/node:v1.26.6@sha256:6e2d8b28a5b601defe327b98bd1c2d1930b49e5d8c512e1895099e4504007adb
 
     steps:
     - uses: actions/checkout@v4

Makefile

@@ -771,17 +771,19 @@ manifests: $(BUILD_TARGETS)/manifests ## Generate the CustomResourceDefinition a
 $(BUILD_TARGETS)/manifests: $(BUILD_PROPS) config/crd/bases/coherence.oracle.com_coherence.yaml docs/about/04_coherence_spec.adoc $(MANIFEST_FILES) $(BUILD_MANIFESTS_PKG)
 	touch $(BUILD_TARGETS)/manifests
 
-config/crd/bases/coherence.oracle.com_coherence.yaml: $(TOOLS_BIN)/kustomize $(API_GO_FILES) $(TOOLS_BIN)/controller-gen
+config/crd/bases/coherence.oracle.com_coherence.yaml: $(TOOLS_BIN)/kustomize $(API_GO_FILES) $(TOOLS_BIN)/controller-gen get-yq
 	$(CONTROLLER_GEN) "crd:crdVersions={v1}" \
 	  rbac:roleName=manager-role paths="{./api/...,./controllers/...}" \
 	  output:crd:dir=config/crd/bases
 	cp -R config/crd/ config/crd-small
 	$(CONTROLLER_GEN) "crd:crdVersions={v1},maxDescLen=0" \
 	  rbac:roleName=manager-role paths="{./api/...,./controllers/...}" \
 	  output:crd:dir=config/crd-small/bases
-	cd config/crd && $(KUSTOMIZE) edit add label "app.kubernetes.io/version:$(VERSION)" -f
-	$(KUSTOMIZE) build config/crd -o $(BUILD_ASSETS)/
-	cd config/crd-small && $(KUSTOMIZE) edit add label "app.kubernetes.io/version:$(VERSION)" -f
+	$(YQ) eval -i '.metadata.labels["app.kubernetes.io/version"] = "$(VERSION)"' config/crd/bases/coherence.oracle.com_coherence.yaml
+	$(YQ) eval -i '.metadata.labels["app.kubernetes.io/version"] = "$(VERSION)"' config/crd/bases/coherence.oracle.com_coherencejob.yaml
+	$(YQ) eval -i '.metadata.labels["app.kubernetes.io/version"] = "$(VERSION)"' config/crd-small/bases/coherence.oracle.com_coherence.yaml
+	$(YQ) eval -i '.metadata.labels["app.kubernetes.io/version"] = "$(VERSION)"' config/crd-small/bases/coherence.oracle.com_coherencejob.yaml
+	$(KUSTOMIZE) build config/crd-small -o $(BUILD_ASSETS)/
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Generate the config.json file used by the Operator for default configuration values
@@ -1228,7 +1230,7 @@ oc-login:
 test-operator: export CGO_ENABLED = 0
 test-operator: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
 test-operator: export OPERATOR_IMAGE := $(OPERATOR_IMAGE)
-test-operator: $(BUILD_PROPS) $(BUILD_TARGETS)/manifests $(BUILD_TARGETS)/generate gotestsum  ## Run the Operator unit tests
+test-operator: $(BUILD_PROPS) $(BUILD_TARGETS)/manifests $(BUILD_TARGETS)/generate install-crds gotestsum  ## Run the Operator unit tests
 	@echo "Running operator tests"
 	$(GOTESTSUM) --format standard-verbose --junitfile $(TEST_LOGS_DIR)/operator-test.xml \
 	  -- $(GO_TEST_FLAGS) -v ./api/... ./controllers/... ./pkg/...
@@ -1393,7 +1395,7 @@ e2e-k3d-test: export MVN_VERSION := $(MVN_VERSION)
 e2e-k3d-test: export OPERATOR_IMAGE := $(OPERATOR_IMAGE)
 e2e-k3d-test: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
 e2e-k3d-test: export SKIP_SPRING_CNBP := $(SKIP_SPRING_CNBP)
-e2e-k3d-test: reset-namespace create-ssl-secrets gotestsum undeploy   ## Run the Operator end-to-end 'local' functional tests using a local Operator instance
+e2e-k3d-test: reset-namespace create-ssl-secrets gotestsum undeploy install-crds ensure-pull-secret ## Run the Operator end-to-end 'local' functional tests using a local Operator instance
 	$(GOTESTSUM) --format standard-verbose --junitfile $(TEST_LOGS_DIR)/operator-e2e-k3d-test.xml \
 	  -- $(GO_TEST_FLAGS_E2E) ./test/e2e/large-cluster/...
 
@@ -1416,7 +1418,7 @@ e2e-client-test: export VERSION := $(VERSION)
 e2e-client-test: export MVN_VERSION := $(MVN_VERSION)
 e2e-client-test: export OPERATOR_IMAGE := $(OPERATOR_IMAGE)
 e2e-client-test: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
-e2e-client-test: build-client-image reset-namespace create-ssl-secrets gotestsum undeploy   ## Run the end-to-end Coherence client tests using a local Operator deployment
+e2e-client-test: build-client-image reset-namespace create-ssl-secrets gotestsum undeploy install-crds ensure-pull-secret  ## Run the end-to-end Coherence client tests using a local Operator deployment
 	$(GOTESTSUM) --format standard-verbose --junitfile $(TEST_LOGS_DIR)/operator-e2e-client-test.xml \
 	  -- $(GO_TEST_FLAGS_E2E) ./test/e2e/clients/...
 
@@ -1432,7 +1434,7 @@ e2e-helm-test: export COHERENCE_IMAGE_REGISTRY := $(COHERENCE_IMAGE_REGISTRY)
 e2e-helm-test: export COHERENCE_IMAGE_NAME := $(COHERENCE_IMAGE_NAME)
 e2e-helm-test: export COHERENCE_IMAGE_TAG := $(COHERENCE_IMAGE_TAG)
 e2e-helm-test: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
-e2e-helm-test: $(BUILD_PROPS) $(BUILD_HELM)/coherence-operator-$(VERSION).tgz reset-namespace gotestsum  ## Run the Operator Helm chart end-to-end functional tests
+e2e-helm-test: $(BUILD_PROPS) $(BUILD_HELM)/coherence-operator-$(VERSION).tgz uninstall-crds reset-namespace gotestsum  ## Run the Operator Helm chart end-to-end functional tests
 	$(GOTESTSUM) --format standard-verbose --junitfile $(TEST_LOGS_DIR)/operator-e2e-helm-test.xml \
 	  -- $(GO_TEST_FLAGS_E2E) ./test/e2e/helm/...
 
@@ -1449,7 +1451,7 @@ e2e-helm-test: $(BUILD_PROPS) $(BUILD_HELM)/coherence-operator-$(VERSION).tgz re
 # ----------------------------------------------------------------------------------------------------------------------
 .PHONY: e2e-prometheus-test
 e2e-prometheus-test: export MF = $(MAKEFLAGS)
-e2e-prometheus-test: reset-namespace install-prometheus create-ssl-secrets deploy-and-wait   ## Run the Operator metrics/Prometheus end-to-end functional tests
+e2e-prometheus-test: reset-namespace install-prometheus create-ssl-secrets ensure-pull-secret deploy-and-wait  ## Run the Operator metrics/Prometheus end-to-end functional tests
 	$(MAKE) run-prometheus-test $${MF} \
 	; rc=$$? \
 	; $(MAKE) uninstall-prometheus $${MF} \
@@ -1491,7 +1493,7 @@ run-prometheus-test: gotestsum
 # These tests will use whichever k8s cluster the local environment is pointing to.
 # ----------------------------------------------------------------------------------------------------------------------
 .PHONY: compatibility-test
-compatibility-test: undeploy build-all-images $(BUILD_HELM)/coherence-operator-$(VERSION).tgz undeploy clean-namespace reset-namespace gotestsum just-compatibility-test  ## Run the Operator backwards compatibility tests
+compatibility-test: undeploy build-all-images helm-chart undeploy clean-namespace reset-namespace ensure-pull-secret gotestsum just-compatibility-test  ## Run the Operator backwards compatibility tests
 
 .PHONY: just-compatibility-test
 just-compatibility-test: export CGO_ENABLED = 0
@@ -1547,7 +1549,7 @@ certification-test: install-certification     ## Run the Operator Kubernetes ver
 # Install the Operator prior to running compatibility tests.
 # ----------------------------------------------------------------------------------------------------------------------
 .PHONY: install-certification
-install-certification: $(BUILD_TARGETS)/build-operator prepare-network-policies reset-namespace create-ssl-secrets deploy-and-wait
+install-certification: $(BUILD_TARGETS)/build-operator prepare-network-policies reset-namespace create-ssl-secrets ensure-pull-secret deploy-and-wait
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Executes the Go end-to-end Operator certification tests.
@@ -1745,8 +1747,8 @@ cleanup-coherence-compatibility: undeploy uninstall-crds clean-namespace
 # configured to use.
 # ----------------------------------------------------------------------------------------------------------------------
 .PHONY: install-crds
-install-crds: prepare-deploy uninstall-crds  ## Install the CRDs
-	$(KUSTOMIZE) build $(BUILD_DEPLOY)/crd | $(KUBECTL_CMD) create -f -
+install-crds: prepare-deploy  ## Install the CRDs
+	$(KUSTOMIZE) build $(BUILD_DEPLOY)/crd-small | $(KUBECTL_CMD) apply -f -
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Uninstall CRDs from Kubernetes.
@@ -1761,6 +1763,22 @@ uninstall-crds: $(BUILD_TARGETS)/manifests  ## Uninstall the CRDs
 	$(KUSTOMIZE) build $(BUILD_DEPLOY)/crd | $(KUBECTL_CMD) delete --force -f - || true
 	@echo "Uninstall CRDs completed"
 
+
+.PHONY: helm-patch-crd
+helm-patch-crd:
+	$(KUBECTL_CMD) patch customresourcedefinition coherence.coherence.oracle.com \
+		--patch '{"metadata": {"labels": {"app.kubernetes.io/managed-by": "Helm"}}}'
+	$(KUBECTL_CMD) patch customresourcedefinition coherence.coherence.oracle.com \
+		--patch '{"metadata": {"annotations": {"meta.helm.sh/release-name": "operator"}}}'
+	$(KUBECTL_CMD) patch customresourcedefinition coherence.coherence.oracle.com \
+		--patch '{"metadata": {"annotations": {"meta.helm.sh/release-namespace": "operator-test"}}}'
+	$(KUBECTL_CMD) patch customresourcedefinition coherencejob.coherence.oracle.com \
+		--patch '{"metadata": {"labels": {"app.kubernetes.io/managed-by": "Helm"}}}'
+	$(KUBECTL_CMD) patch customresourcedefinition coherencejob.coherence.oracle.com \
+		--patch '{"metadata": {"annotations": {"meta.helm.sh/release-name": "operator"}}}'
+	$(KUBECTL_CMD) patch customresourcedefinition coherencejob.coherence.oracle.com \
+		--patch '{"metadata": {"annotations": {"meta.helm.sh/release-namespace": "operator-test"}}}'
+
 # ----------------------------------------------------------------------------------------------------------------------
 # Deploy controller in the configured Kubernetes cluster in ~/.kube/config
 # ----------------------------------------------------------------------------------------------------------------------
@@ -1902,19 +1920,21 @@ endef
 # Un-deploy controller from the configured Kubernetes cluster in ~/.kube/config
 # ----------------------------------------------------------------------------------------------------------------------
 .PHONY: undeploy
-undeploy: $(BUILD_PROPS) $(BUILD_TARGETS)/manifests $(TOOLS_BIN)/kustomize  ## Undeploy the Coherence Operator
+undeploy: $(BUILD_PROPS) $(BUILD_TARGETS)/manifests $(TOOLS_BIN)/kustomize uninstall-webhooks  ## Undeploy the Coherence Operator
 	@echo "Undeploy Coherence Operator..."
 	$(call prepare_deploy,$(OPERATOR_IMAGE),$(OPERATOR_NAMESPACE))
 	$(KUSTOMIZE) build $(BUILD_DEPLOY)/default | $(KUBECTL_CMD) delete -f - || true
-	$(KUBECTL_CMD) -n $(OPERATOR_NAMESPACE) delete secret coherence-webhook-server-cert || true
-	$(KUBECTL_CMD) delete mutatingwebhookconfiguration coherence-operator-mutating-webhook-configuration || true
-	$(KUBECTL_CMD) delete validatingwebhookconfiguration coherence-operator-validating-webhook-configuration || true
 	$(KUBECTL_CMD) -n $(OPERATOR_NAMESPACE) delete secret coherence-operator-pull-secret || true
 	@echo "Undeploy Coherence Operator completed"
 	@echo "Uninstalling CRDs - executing deletion"
 	$(KUSTOMIZE) build $(BUILD_DEPLOY)/crd | $(KUBECTL_CMD) delete --force -f - || true
 	@echo "Uninstall CRDs completed"
 
+.PHONY: uninstall-webhooks
+uninstall-webhooks:
+	$(KUBECTL_CMD) -n $(OPERATOR_NAMESPACE) delete secret coherence-webhook-server-cert || true
+	$(KUBECTL_CMD) delete mutatingwebhookconfiguration coherence-operator-mutating-webhook-configuration || true
+	$(KUBECTL_CMD) delete validatingwebhookconfiguration coherence-operator-validating-webhook-configuration || true
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Tail the deployed operator logs.
@@ -2087,7 +2107,7 @@ create-ssl-secrets: $(BUILD_OUTPUT)/certs
 ##@ KinD
 
 KIND_CLUSTER   ?= operator
-KIND_IMAGE     ?= "kindest/node:v1.32.0@sha256:c48c62eac5da28cdadcf560d1d8616cfa6783b58f0d94cf63ad1bf49600cb027"
+KIND_IMAGE     ?= "kindest/node:v1.32.2@sha256:f226345927d7e348497136874b6d207e0b32cc52154ad8323129352923a3142f"
 CALICO_TIMEOUT ?= 300s
 KIND_SCRIPTS   := $(SCRIPTS_DIR)/kind
 
@@ -2181,7 +2201,7 @@ K3D_REGISTRY_PORT     ?= 12345
 K3D_INTERNAL_REGISTRY := k3d-$(K3D_REGISTRY).localhost:$(K3D_REGISTRY_PORT)
 
 .PHONY: k3d
-k3d: $(TOOLS_BIN)/k3d k3d-create k3d-load-operator create-namespace  ## Run a default k3d cluster
+k3d: $(TOOLS_BIN)/k3d k3d-create k3d-load-operator k3d-load-coherence create-namespace  ## Run a default k3d cluster
 
 .PHONY: k3d-create
 k3d-create: $(TOOLS_BIN)/k3d ## Create the k3d cluster
@@ -2203,6 +2223,7 @@ k3d-load-operator: $(TOOLS_BIN)/k3d  ## Load the Operator images into the k3d cl
 
 .PHONY: k3d-load-coherence
 k3d-load-coherence: $(TOOLS_BIN)/k3d  ## Load the Coherence images into the k3d cluster
+	$(DOCKER_CMD) pull $(COHERENCE_IMAGE)
 	$(TOOLS_BIN)/k3d image import $(COHERENCE_IMAGE) -c $(K3D_CLUSTER)
 
 .PHONY: k3d-load-all

api/v1/coherence_types.go

@@ -13,6 +13,7 @@ import (
 	"fmt"
 	"github.com/go-logr/logr"
 	"github.com/go-test/deep"
+	"github.com/oracle/coherence-operator/pkg/operator"
 	"github.com/pkg/errors"
 	monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
 	appsv1 "k8s.io/api/apps/v1"
@@ -3066,8 +3067,8 @@ func (in Resources) SetController(object runtime.Object, scheme *runtime.Scheme)
 	return nil
 }
 
-// SetHashLabels sets the hash label on all the resources.
-func (in Resources) SetHashLabels(hash string) {
+// SetHashLabelAndAnnotations sets the hash label on all the resources.
+func (in Resources) SetHashLabelAndAnnotations(hash string) {
 	for _, r := range in.Items {
 		if r.Spec != nil {
 			labels := r.Spec.GetLabels()
@@ -3076,6 +3077,12 @@ func (in Resources) SetHashLabels(hash string) {
 			}
 			labels[LabelCoherenceHash] = hash
 			r.Spec.SetLabels(labels)
+			annotations := r.Spec.GetAnnotations()
+			if annotations == nil {
+				annotations = make(map[string]string)
+			}
+			annotations[AnnotationOperatorVersion] = operator.GetVersion()
+			r.Spec.SetAnnotations(annotations)
 		}
 	}
 }

api/v1/coherence_webhook.go

@@ -63,12 +63,6 @@ func (in *Coherence) Default(_ context.Context, obj runtime.Object) error {
 		spec.SetReplicas(spec.GetReplicas())
 	}
 	SetCommonDefaults(coh)
-
-	// apply a label with the hash of the spec - ths must be the last action here to make sure that
-	// any modifications to the spec field are included in the hash
-	if hash, applied := EnsureCoherenceHashLabel(coh); applied {
-		webhookLogger.Info(fmt.Sprintf("Applied %s label", LabelCoherenceHash), "hash", hash)
-	}
 	return nil
 }
 
@@ -130,9 +124,6 @@ func SetCommonDefaults(in CoherenceResource) {
 		// this is an update
 		logger.Info("Updating defaults for existing resource")
 	}
-
-	// apply the Operator version annotation
-	in.AddAnnotation(AnnotationOperatorVersion, operator.GetVersion())
 }
 
 // The path in this annotation MUST match the const below

api/v1/coherence_webhook_job.go

@@ -73,12 +73,6 @@ func (in *CoherenceJob) Default(_ context.Context, obj runtime.Object) error {
 	}
 
 	SetCommonDefaults(coh)
-
-	// apply a label with the hash of the spec - ths must be the last action here to make sure that
-	// any modifications to the spec field are included in the hash
-	if hash, applied := EnsureJobHashLabel(coh); applied {
-		webhookLogger.Info(fmt.Sprintf("Applied %s label", LabelCoherenceHash), "hash", hash)
-	}
 	return nil
 }
 

api/v1/coherence_webhook_job_test.go

@@ -29,19 +29,6 @@ func TestJobDefaultReplicasIsSet(t *testing.T) {
 	g.Expect(*c.Spec.Replicas).To(Equal(coh.DefaultJobReplicas))
 }
 
-func TestJobAddVersionAnnotation(t *testing.T) {
-	g := NewGomegaWithT(t)
-
-	c := coh.CoherenceJob{}
-	err := c.Default(context.Background(), &c)
-	g.Expect(err).To(BeNil())
-	g.Expect(c.Annotations).NotTo(BeNil())
-	g.Expect(c.Annotations[coh.AnnotationOperatorVersion]).To(Equal(operator.GetVersion()))
-	g.Expect(c.Spec).NotTo(BeNil())
-	replicas := c.Spec.CoherenceResourceSpec.Replicas
-	g.Expect(*replicas).To(Equal(coh.DefaultJobReplicas))
-}
-
 func TestJobShouldAddFinalizer(t *testing.T) {
 	g := NewGomegaWithT(t)
 	c := coh.CoherenceJob{}

api/v1/coherence_webhook_test.go

@@ -30,18 +30,6 @@ func TestDefaultReplicasIsSet(t *testing.T) {
 	g.Expect(*c.Spec.CoherenceResourceSpec.Replicas).To(Equal(coh.DefaultReplicas))
 }
 
-func TestAddVersionAnnotation(t *testing.T) {
-	g := NewGomegaWithT(t)
-
-	c := coh.Coherence{}
-	err := c.Default(context.Background(), &c)
-	g.Expect(err).NotTo(HaveOccurred())
-	an := c.GetAnnotations()
-	g.Expect(an).NotTo(BeNil())
-	g.Expect(an[coh.AnnotationOperatorVersion]).To(Equal(operator.GetVersion()))
-	g.Expect(*c.Spec.CoherenceResourceSpec.Replicas).To(Equal(coh.DefaultReplicas))
-}
-
 func TestShouldAddFinalizer(t *testing.T) {
 	g := NewGomegaWithT(t)
 	c := coh.Coherence{}