Fix issues where v3.1.0 is not backwards compatible with 3.0.2

Author: thegridman

.github/workflows/build.yaml

@@ -65,7 +65,7 @@ jobs:
 #     Start a KinD K8s cluster with single worker node
       shell: bash
       run: |
-        sh ./hack/kind.sh --image kindest/node:v1.16.9@sha256:7175872357bc85847ec4b1aba46ed1d12fa054c83ac7a8a11f5c268957fd5765
+        sh ./hack/kind.sh --image kindest/node:v1.18.8@sha256:f4bcc97a0ad6e7abaf3f643d890add7efe6ee4ab90baeb374b4f41a4c95567eb
         kubectl version
         kubectl get nodes
         docker pull gcr.io/distroless/java
@@ -113,10 +113,6 @@ jobs:
       run: |
         make e2e-helm-test
 
-#    - name: Compatibility Tests
-#      shell: bash
-#      run: make compatibility-test
-
     - uses: actions/upload-artifact@v1
       if: failure()
       with:

.github/workflows/compatibility-tests.yaml

@@ -0,0 +1,105 @@
+# Copyright 2019 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.
+
+# ---------------------------------------------------------------------------
+# Coherence Operator GitHub Actions Backwards Compatibility Tests.
+# ---------------------------------------------------------------------------
+name: Backwards Compatibility Tests
+
+on:
+  push:
+    branches-ignore:
+    - gh-pages
+    - 1.0.0
+    - 2.x
+  pull_request:
+    types:
+      - opened
+      - committed
+    branches-ignore:
+    - gh-pages
+    - 1.0.0
+    - 2.x
+
+env:
+  RELEASE_IMAGE_PREFIX: "localhost:5000/"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        compatibilityVersion:
+        - 3.0.2
+      include:
+      - compatibilityVersion: 3.0.2
+        compatibilitySelector: component=coherence-operator
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Set up JDK
+      uses: actions/setup-java@v1
+      with:
+        java-version: '1.8'
+
+    - name: Cache Go Modules
+      uses: actions/cache@v1
+      with:
+        path: ~/go/pkg/mod
+        key: ${{ runner.os }}-go-mods-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-mods-
+
+    - name: Cache Maven packages
+      uses: actions/cache@v1
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+        restore-keys: ${{ runner.os }}-m2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2-beta
+      with:
+        go-version: 1.14.x
+
+    - name: Start KinD Cluster
+#     Start a KinD K8s cluster with single worker node
+      shell: bash
+      run: |
+        sh ./hack/kind.sh --image kindest/node:v1.18.8@sha256:f4bcc97a0ad6e7abaf3f643d890add7efe6ee4ab90baeb374b4f41a4c95567eb
+        kubectl version
+        kubectl get nodes
+        docker pull gcr.io/distroless/java
+
+    - name: Code Review
+      shell: bash
+      run: |
+        make code-review
+
+    - name: Build
+      shell: bash
+      run: make all
+
+    - name: Push Images
+#     Push the images just built to the local Docker registry localhost:5000 started with the KinD cluster
+      shell: bash
+      run: |
+        make push-all-images
+        make kind-load
+
+    - name: Compatibility Tests
+      shell: bash
+      run: |
+        make compatibility-test COMPATIBLE_VERSION=${{ matrix.compatibilityVersion }} COMPATIBLE_SELECTOR=${{ matrix.compatibilitySelector }}
+
+    - uses: actions/upload-artifact@v1
+      if: failure()
+      with:
+        name: test-output
+        path: build/_output/test-logs

.github/workflows/k8s-matrix.yaml

@@ -35,10 +35,10 @@ jobs:
       matrix:
         k8s:
           - kindest/node:v1.19.1@sha256:98cf5288864662e37115e362b23e4369c8c4a408f99cbc06e58ac30ddc721600
-          - kindest/node:v1.18.2@sha256:7b27a6d0f2517ff88ba444025beae41491b016bc6af573ba467b70c5e8e0d85f
-          - kindest/node:v1.17.5@sha256:ab3f9e6ec5ad8840eeb1f76c89bb7948c77bbf76bcebe1a8b59790b8ae9a283a
-          - kindest/node:v1.16.9@sha256:7175872357bc85847ec4b1aba46ed1d12fa054c83ac7a8a11f5c268957fd5765
-          - kindest/node:v1.15.11@sha256:6cc31f3533deb138792db2c7d1ffc36f7456a06f1db5556ad3b6927641016f50
+          - kindest/node:v1.18.8@sha256:f4bcc97a0ad6e7abaf3f643d890add7efe6ee4ab90baeb374b4f41a4c95567eb
+          - kindest/node:v1.17.11@sha256:5240a7a2c34bf241afb54ac05669f8a46661912eab05705d660971eeb12f6555
+          - kindest/node:v1.16.15@sha256:a89c771f7de234e6547d43695c7ab047809ffc71a0c3b65aa54eda051c45ed20
+          - kindest/node:v1.15.12@sha256:d9b939055c1e852fe3d86955ee24976cab46cba518abcb8b13ba70917e6547a6
           - kindest/node:v1.14.10@sha256:6cd43ff41ae9f02bb46c8f455d5323819aec858b99534a290517ebc181b443c6
           - kindest/node:v1.13.12@sha256:214476f1514e47fe3f6f54d0f9e24cfb1e4cda449529791286c7161b7f9c08e7
 

Makefile

@@ -13,8 +13,10 @@ VERSION ?= 3.1.1
 # The operator version to use to run certification tests against
 CERTIFICATION_VERSION ?= $(VERSION)
 
-# A SPACE delimited list of previous Operator versions that are used to run the compatibility tests.
-COMPATIBLE_VERSIONS = 3.0.0
+# The previous Operator version used to run the compatibility tests.
+COMPATIBLE_VERSION  = 3.0.2
+# The selector to use to find Operator Pods of the COMPATIBLE_VERSION (do not put in double quotes!!)
+COMPATIBLE_SELECTOR = component=coherence-operator
 
 # Capture the Git commit to add to the build information
 GITCOMMIT       ?= $(shell git rev-list -1 HEAD)
@@ -466,14 +468,17 @@ compatibility-test: export TEST_SSL_SECRET := $(TEST_SSL_SECRET)
 compatibility-test: export TEST_IMAGE_PULL_POLICY := $(IMAGE_PULL_POLICY)
 compatibility-test: export TEST_STORAGE_CLASS := $(TEST_STORAGE_CLASS)
 compatibility-test: export VERSION := $(VERSION)
-compatibility-test: export COMPATIBLE_VERSIONS := $(COMPATIBLE_VERSIONS)
+compatibility-test: export COMPATIBLE_VERSION := $(COMPATIBLE_VERSION)
+compatibility-test: export COMPATIBLE_SELECTOR := $(COMPATIBLE_SELECTOR)
 compatibility-test: export OPERATOR_IMAGE := $(OPERATOR_IMAGE)
 compatibility-test: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
 compatibility-test: export UTILS_IMAGE := $(UTILS_IMAGE)
 compatibility-test: export GO_TEST_FLAGS_E2E := $(strip $(GO_TEST_FLAGS_E2E))
-compatibility-test: $(BUILD_TARGETS)/build-operator clean-namespace reset-namespace create-ssl-secrets gotestsum
+compatibility-test: $(BUILD_TARGETS)/build-operator undeploy clean-namespace reset-namespace gotestsum
+	helm repo add coherence https://oracle.github.io/coherence-operator/charts
+	helm repo update
 	$(GOTESTSUM) --format standard-verbose --junitfile $(TEST_LOGS_DIR)/operator-e2e-compatibility-test.xml \
-	  -- $(GO_TEST_FLAGS_E2E) ./test/compatibility/...
+	  -- $(GO_TEST_FLAGS_E2E) ./test/e2e/compatibility/...
 
 
 # ----------------------------------------------------------------------------------------------------------------------
@@ -623,8 +628,11 @@ endef
 .PHONY: undeploy
 undeploy: $(BUILD_PROPS) $(BUILD_TARGETS)/manifests $(GOBIN)/kustomize
 	$(call prepare_deploy,$(OPERATOR_IMAGE),$(OPERATOR_NAMESPACE))
-	$(GOBIN)/kustomize build $(BUILD_DEPLOY)/default | kubectl delete -f -
+	$(GOBIN)/kustomize build $(BUILD_DEPLOY)/default | kubectl delete -f - || true
 	kubectl -n $(OPERATOR_NAMESPACE) delete secret coherence-webhook-server-cert || true
+	kubectl delete mutatingwebhookconfiguration coherence-operator-mutating-webhook-configuration || true
+	kubectl delete validatingwebhookconfiguration coherence-operator-validating-webhook-configuration || true
+
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Tail the deployed operator logs.
@@ -648,15 +656,15 @@ $(BUILD_MANIFESTS_PKG):
 	cp -R config/rbac/ $(BUILD_MANIFESTS)/rbac
 	tar -C $(BUILD_OUTPUT) -czf $(BUILD_MANIFESTS_PKG) manifests/
 
-$(BUILD_TARGETS)/manifests: $(BUILD_PROPS) config/crd/bases/coherence.oracle.com_coherences.yaml config/crd-v1beta1/bases/coherence.oracle.com_coherences.yaml docs/about/04_coherence_spec.adoc
+$(BUILD_TARGETS)/manifests: $(BUILD_PROPS) config/crd/bases/coherence.oracle.com_coherence.yaml config/crd-v1beta1/bases/coherence.oracle.com_coherence.yaml docs/about/04_coherence_spec.adoc
 	touch $(BUILD_TARGETS)/manifests
 
-config/crd/bases/coherence.oracle.com_coherences.yaml: $(API_GO_FILES) $(GOBIN)/controller-gen
+config/crd/bases/coherence.oracle.com_coherence.yaml: $(API_GO_FILES) $(GOBIN)/controller-gen
 	$(GOBIN)/controller-gen "crd:trivialVersions=true,crdVersions={v1}" \
 	  rbac:roleName=manager-role paths="{./api/...,./controllers/...}" \
 	  output:crd:artifacts:config=config/crd/bases
 
-config/crd-v1beta1/bases/coherence.oracle.com_coherences.yaml: $(API_GO_FILES) $(GOBIN)/controller-gen
+config/crd-v1beta1/bases/coherence.oracle.com_coherence.yaml: $(API_GO_FILES) $(GOBIN)/controller-gen
 	@echo "Generating CRD v1beta1"
 	$(GOBIN)/controller-gen "crd:trivialVersions=true,crdVersions={v1beta1}" \
 	  rbac:roleName=manager-role paths="{./api/...,./controllers/...}" \
@@ -1028,7 +1036,9 @@ run-clean: reset-namespace run
 run-debug: export COHERENCE_IMAGE := $(COHERENCE_IMAGE)
 run-debug: export UTILS_IMAGE := $(UTILS_IMAGE)
 run-debug:
-	dlv debug --headless --listen=:2345 --api-version=2 --accept-multiclient
+	dlv debug --headless --listen=:2345 --api-version=2 --accept-multiclient \
+		-- --skip-service-suspend=true --coherence-dev-mode=true \
+		--cert-type=self-signed --webhook-service=host.docker.internal
 
 # ----------------------------------------------------------------------------------------------------------------------
 # Run the Operator locally in debug mode after deleting and recreating

api/v1/coherence_webhook.go

@@ -28,7 +28,7 @@ func (in *Coherence) SetupWebhookWithManager(mgr ctrl.Manager) error {
 }
 
 // The path in this annotation MUST match the const below
-// +kubebuilder:webhook:path=/mutate-coherence-oracle-com-v1-coherence,mutating=true,failurePolicy=fail,groups=coherence.oracle.com,resources=coherences,verbs=create;update,versions=v1,name=mcoherence.kb.io
+// +kubebuilder:webhook:path=/mutate-coherence-oracle-com-v1-coherence,mutating=true,failurePolicy=fail,groups=coherence.oracle.com,resources=coherence,verbs=create;update,versions=v1,name=mcoherence.kb.io
 
 // This const MUST match the path in the kubebuilder annotation above
 const MutatingWebHookPath = "/mutate-coherence-oracle-com-v1-coherence"
@@ -39,20 +39,29 @@ var _ webhook.Defaulter = &Coherence{}
 
 // Default implements webhook.Defaulter so a webhook will be registered for the type
 func (in *Coherence) Default() {
-	webhookLogger.Info("default", "name", in.Name)
+	logger := webhookLogger.WithValues("namespace", in.Namespace, "name", in.Name)
+	if in.Status.Phase == "" {
+		logger.Info("setting defaults for resource")
 
-	if in.Spec.Replicas == nil {
-		in.Spec.SetReplicas(3)
-	}
+		if in.Spec.Replicas == nil {
+			in.Spec.SetReplicas(3)
+		}
 
-	coherenceImage := operator.GetDefaultCoherenceImage()
-	in.Spec.EnsureCoherenceImage(&coherenceImage)
-	utilsImage := operator.GetDefaultUtilsImage()
-	in.Spec.EnsureCoherenceUtilsImage(&utilsImage)
+		// only set defaults for image names new Coherence instances
+		coherenceImage := operator.GetDefaultCoherenceImage()
+		in.Spec.EnsureCoherenceImage(&coherenceImage)
+		utilsImage := operator.GetDefaultUtilsImage()
+		in.Spec.EnsureCoherenceUtilsImage(&utilsImage)
+
+		// Set the features supported by this version
+		in.Annotations[ANNOTATION_FEATURE_SUSPEND] = "true"
+	} else {
+		logger.Info("skipping defaulting for existing resource")
+	}
 }
 
 // The path in this annotation MUST match the const below
-// +kubebuilder:webhook:verbs=create;update,path=/validate-coherence-oracle-com-v1-coherence,mutating=false,failurePolicy=fail,groups=coherence.oracle.com,resources=coherences,versions=v1,name=vcoherence.kb.io
+// +kubebuilder:webhook:verbs=create;update,path=/validate-coherence-oracle-com-v1-coherence,mutating=false,failurePolicy=fail,groups=coherence.oracle.com,resources=coherence,versions=v1,name=vcoherence.kb.io
 
 // This const MUST match the path in the kubebuilder annotation above
 const ValidatingWebHookPath = "/validate-coherence-oracle-com-v1-coherence"

api/v1/coherenceresource_types.go

@@ -261,7 +261,7 @@ const (
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector
-// +kubebuilder:resource:path=coherences,scope=Namespaced,shortName=coh,categories=coherence
+// +kubebuilder:resource:path=coherence,scope=Namespaced,shortName=coh,categories=coherence
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".status.coherenceCluster",description="The name of the Coherence cluster that this deployment belongs to"
 // +kubebuilder:printcolumn:name="Role",type="string",JSONPath=".status.role",description="The role of this deployment in a Coherence cluster"
 // +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=".status.replicas",description="The number of Coherence deployments for this deployment"
@@ -418,13 +418,13 @@ func ensureV1CRDs(logger logr.Logger, crdClient v1client.CustomResourceDefinitio
 func ensureV1CRD(logger logr.Logger, crdClient v1client.CustomResourceDefinitionInterface, fileName string) error {
 	f, err := data.Assets.Open(fileName)
 	if err != nil {
-		return errors.Wrap(err, "opening embedded CRD asset " + fileName)
+		return errors.Wrap(err, "opening embedded CRD asset "+fileName)
 	}
 	defer f.Close()
 
 	yml, err := ioutil.ReadAll(f)
 	if err != nil {
-		return errors.Wrap(err, "reading embedded CRD asset " + fileName)
+		return errors.Wrap(err, "reading embedded CRD asset "+fileName)
 	}
 
 	u := unstructured.Unstructured{}
@@ -488,13 +488,13 @@ func ensureV1Beta1CRDs(logger logr.Logger, crdClient v1beta1client.CustomResourc
 func ensureV1Beta1CRD(logger logr.Logger, crdClient v1beta1client.CustomResourceDefinitionInterface, fileName string) error {
 	f, err := data.Assets.Open(fileName)
 	if err != nil {
-		return errors.Wrap(err, "opening embedded CRD asset " + fileName)
+		return errors.Wrap(err, "opening embedded CRD asset "+fileName)
 	}
 	defer f.Close()
 
 	yml, err := ioutil.ReadAll(f)
 	if err != nil {
-		return errors.Wrap(err, "reading embedded CRD asset " + fileName)
+		return errors.Wrap(err, "reading embedded CRD asset "+fileName)
 	}
 
 	u := unstructured.Unstructured{}

api/v1/coherenceresourcespec_types.go

@@ -755,7 +755,7 @@ func (in *CoherenceResourceSpec) CreateCommonEnv(deployment *Coherence) []corev1
 
 // Create the default environment variables for the Coherence container.
 func (in *CoherenceResourceSpec) CreateDefaultEnv(deployment *Coherence) []corev1.EnvVar {
-	return append(in.CreateCommonEnv(deployment),
+	env := append(in.CreateCommonEnv(deployment),
 		corev1.EnvVar{Name: EnvVarCohWka, Value: deployment.Spec.Coherence.GetWKA(deployment)},
 		corev1.EnvVar{
 			Name: EnvVarOperatorHost, ValueFrom: &corev1.EnvVarSource{
@@ -771,8 +771,13 @@ func (in *CoherenceResourceSpec) CreateDefaultEnv(deployment *Coherence) []corev
 		corev1.EnvVar{Name: EnvVarCohUtilDir, Value: VolumeMountPathUtils},
 		corev1.EnvVar{Name: EnvVarOperatorTimeout, Value: Int32PtrToStringWithDefault(in.OperatorRequestTimeout, 120)},
 		corev1.EnvVar{Name: EnvVarCohHealthPort, Value: Int32ToString(in.GetHealthPort())},
-		corev1.EnvVar{Name: EnvVarCohIdentity, Value: deployment.Name + "@" + deployment.Namespace},
 	)
+
+	if deployment.Annotations[ANNOTATION_FEATURE_SUSPEND] == "true" {
+		env = append(env, corev1.EnvVar{Name: EnvVarCohIdentity, Value: deployment.Name + "@" + deployment.Namespace})
+	}
+
+	return env
 }
 
 // Create the default Container resources.

api/v1/constants.go

@@ -38,6 +38,9 @@ const (
 
 	StatusSelectorTemplate = LabelCoherenceCluster + "=%s," + LabelCoherenceDeployment + "=%s"
 
+	// Feature annotations
+	ANNOTATION_FEATURE_SUSPEND = "com.oracle.coherence.operator/feature.suspend"
+
 	// The default k8s service account name.
 	DefaultServiceAccount = "default"
 

config/crd-v1beta1/bases/coherence.oracle.com_coherences.yaml renamed to config/crd-v1beta1/bases/coherence.oracle.com_coherence.yaml

@@ -6,7 +6,7 @@ metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.3.0
   creationTimestamp: null
-  name: coherences.coherence.oracle.com
+  name: coherence.coherence.oracle.com
 spec:
   additionalPrinterColumns:
   - JSONPath: .status.coherenceCluster
@@ -35,7 +35,7 @@ spec:
     - coherence
     kind: Coherence
     listKind: CoherenceList
-    plural: coherences
+    plural: coherence
     shortNames:
     - coh
     singular: coherence

config/crd-v1beta1/kustomization.yaml

@@ -2,17 +2,17 @@
 # since it depends on service name and namespace that are out of this kustomize package.
 # It should be run by config/default
 resources:
-- bases/coherence.oracle.com_coherences.yaml
+- bases/coherence.oracle.com_coherence.yaml
 # +kubebuilder:scaffold:crdkustomizeresource
 
 patchesStrategicMerge:
 # patches here are for enabling the conversion webhook for each CRD
-#- patches/webhook_in_coherences.yaml
+#- patches/webhook_in_coherence.yaml
 # +kubebuilder:scaffold:crdkustomizewebhookpatch
 
 # [CERTMANAGER] To enable webhook, uncomment all the sections with [CERTMANAGER] prefix.
 # patches here are for enabling the CA injection for each CRD
-#- patches/cainjection_in_coherences.yaml
+#- patches/cainjection_in_coherence.yaml
 # +kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # the following config is for teaching kustomize how to do kustomization for CRDs.