Move controller revision to annotations

operators/config/crds/apm_v1alpha1_apmserver.yaml

@@ -195,10 +195,6 @@ spec:
           type: object
         status:
           properties:
-            controllerVersion:
-              description: ControllerVersion is the version of the controller that
-                last updated the ApmServer instance
-              type: string
             health:
               type: string
             secretTokenSecret:

operators/config/crds/elasticsearch_v1alpha1_elasticsearch.yaml

@@ -244,10 +244,6 @@ spec:
           properties:
             clusterUUID:
               type: string
-            controllerVersion:
-              description: ControllerVersion is the version of the controller that
-                last updated the Elasticsearch cluster
-              type: string
             health:
               type: string
             masterNode:

operators/config/crds/kibana_v1alpha1_kibana.yaml

@@ -189,10 +189,6 @@ spec:
           properties:
             associationStatus:
               type: string
-            controllerVersion:
-              description: ControllerVersion is the version of the controller that
-                last updated the Kibana instance
-              type: string
             health:
               type: string
           type: object

operators/pkg/apis/apm/v1alpha1/apmserver_types.go

@@ -98,8 +98,6 @@ type ApmServerStatus struct {
 	SecretTokenSecretName string `json:"secretTokenSecret,omitempty"`
 	// Association is the status of any auto-linking to Elasticsearch clusters.
 	Association commonv1alpha1.AssociationStatus
-	// ControllerVersion is the version of the controller that last updated the ApmServer instance
-	ControllerVersion string `json:"controllerVersion,omitempty"`
 }
 
 // IsDegraded returns true if the current status is worse than the previous.

operators/pkg/apis/elasticsearch/v1alpha1/elasticsearch_types.go

@@ -219,8 +219,6 @@ type ElasticsearchStatus struct {
 	MasterNode      string                          `json:"masterNode,omitempty"`
 	ExternalService string                          `json:"service,omitempty"`
 	ZenDiscovery    ZenDiscoveryStatus              `json:"zenDiscovery,omitempty"`
-	// ControllerVersion is the version of the controller that last updated the Elasticsearch cluster
-	ControllerVersion string `json:"controllerVersion,omitempty"`
 }
 
 type ZenDiscoveryStatus struct {

operators/pkg/apis/kibana/v1alpha1/kibana_types.go

@@ -87,8 +87,6 @@ type KibanaStatus struct {
 	commonv1alpha1.ReconcilerStatus
 	Health            KibanaHealth                     `json:"health,omitempty"`
 	AssociationStatus commonv1alpha1.AssociationStatus `json:"associationStatus,omitempty"`
-	// ControllerVersion is the version of the controller that last updated the Kibana instance
-	ControllerVersion string `json:"controllerVersion,omitempty"`
 }
 
 // IsDegraded returns true if the current status is worse than the previous.

operators/pkg/controller/apmserver/apmserver_controller.go

@@ -18,6 +18,7 @@ import (
 	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/apmserver/labels"
 	apmname "github.com/elastic/cloud-on-k8s/operators/pkg/controller/apmserver/name"
 	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/common"
+	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/common/annotation"
 	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/common/certificates"
 	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/common/certificates/http"
 	"github.com/elastic/cloud-on-k8s/operators/pkg/controller/common/defaults"
@@ -195,9 +196,12 @@ func (r *ReconcileApmServer) Reconcile(request reconcile.Request) (reconcile.Res
 		return reconcile.Result{}, nil
 	}
 
-	state := NewState(request, as)
-	state.UpdateApmServerControllerVersion(r.OperatorInfo.BuildInfo.Version)
+	err = annotation.UpdateControllerVersion(r.Client, as, r.OperatorInfo.BuildInfo.Version)
+	if err != nil {
+		return reconcile.Result{}, err
+	}
 
+	state := NewState(request, as)
 	svc, err := common.ReconcileService(r.Client, r.scheme, NewService(*as), as)
 	if err != nil {
 		return reconcile.Result{}, err

operators/pkg/controller/apmserver/state.go

@@ -43,11 +43,3 @@ func (s State) UpdateApmServerState(deployment v1.Deployment, apmServerSecret co
 func (s State) UpdateApmServerExternalService(svc corev1.Service) {
 	s.ApmServer.Status.ExternalService = svc.Name
 }
-
-func (s *State) UpdateApmServerControllerVersion(version string) {
-	s.ApmServer.Status.ControllerVersion = version
-}
-
-func (s *State) GetApmServerControllerVersion() string {
-	return s.ApmServer.Status.ControllerVersion
-}

operators/pkg/controller/common/annotation/controller_version.go

@@ -0,0 +1,52 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+package annotation
+
+import (
+	"github.com/elastic/cloud-on-k8s/operators/pkg/utils/k8s"
+	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+// ControllerVersionAnnotation is the annotation name that indicates the last controller version to update a resource
+const ControllerVersionAnnotation = "common.k8s.elastic.co/controller-version"
+
+// UpdateControllerVersion updates the controller version annotation to the current version if necessary
+func UpdateControllerVersion(client k8s.Client, obj runtime.Object, version string) error {
+	accessor := meta.NewAccessor()
+	namespace, err := accessor.Namespace(obj)
+	if err != nil {
+		log.Error(err, "error getting namespace", "kind", obj.GetObjectKind().GroupVersionKind().Kind)
+		return err
+	}
+	name, err := accessor.Name(obj)
+	if err != nil {
+		log.Error(err, "error getting name", "namespace", namespace, "kind", obj.GetObjectKind().GroupVersionKind().Kind)
+		return err
+	}
+	annotations, err := accessor.Annotations(obj)
+	if err != nil {
+		log.Error(err, "error getting annotations", "namespace", namespace, "name", name, "kind", obj.GetObjectKind().GroupVersionKind().Kind)
+		return err
+	}
+	if annotations == nil {
+		annotations = make(map[string]string)
+	}
+
+	// do not send unnecessary update if the value would not change
+	if annotations[ControllerVersionAnnotation] == version {
+		log.V(1).Info("Skipping controller version annotation update, version already matches", "namespace", namespace, "name", name, "kind", obj.GetObjectKind())
+		return nil
+	}
+
+	annotations[ControllerVersionAnnotation] = version
+	err = accessor.SetAnnotations(obj, annotations)
+	if err != nil {
+		log.Error(err, "error updating controller version annotation", "namespace", namespace, "name", name, "kind", obj.GetObjectKind())
+		return err
+	}
+	log.V(1).Info("updating controller version annotation", "namespace", namespace, "name", name, "kind", obj.GetObjectKind())
+	return client.Update(obj)
+}

operators/pkg/controller/common/annotation/controller_version_test.go

@@ -0,0 +1,86 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+package annotation
+
+import (
+	"testing"
+
+	kibanav1alpha1 "github.com/elastic/cloud-on-k8s/operators/pkg/apis/kibana/v1alpha1"
+	"github.com/elastic/cloud-on-k8s/operators/pkg/utils/k8s"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+
+	apmtype "github.com/elastic/cloud-on-k8s/operators/pkg/apis/apm/v1alpha1"
+	assoctype "github.com/elastic/cloud-on-k8s/operators/pkg/apis/associations/v1alpha1"
+	estype "github.com/elastic/cloud-on-k8s/operators/pkg/apis/elasticsearch/v1alpha1"
+	"k8s.io/client-go/kubernetes/scheme"
+)
+
+// Test UpdateControllerVersion updates annotation if there is an older version
+func TestAnnotationUpdated(t *testing.T) {
+	kibana := kibanav1alpha1.Kibana{
+		ObjectMeta: metav1.ObjectMeta{
+			Namespace: "ns",
+			Name:      "kibana",
+			Annotations: map[string]string{
+				ControllerVersionAnnotation: "oldversion",
+			},
+		},
+	}
+	obj := kibana.DeepCopy()
+	sc := setupScheme(t)
+	client := k8s.WrapClient(fake.NewFakeClientWithScheme(sc, obj))
+	err := UpdateControllerVersion(client, obj, "newversion")
+	require.NoError(t, err)
+	require.Equal(t, obj.GetAnnotations()[ControllerVersionAnnotation], "newversion")
+}
+
+// Test UpdateControllerVersion creates an annotation even if there are no current annotations
+func TestAnnotationCreated(t *testing.T) {
+	kibana := kibanav1alpha1.Kibana{
+		ObjectMeta: metav1.ObjectMeta{
+			Namespace: "ns",
+			Name:      "kibana",
+		},
+	}
+
+	obj := kibana.DeepCopy()
+	sc := setupScheme(t)
+	client := k8s.WrapClient(fake.NewFakeClientWithScheme(sc, obj))
+	err := UpdateControllerVersion(client, obj, "newversion")
+	require.NoError(t, err)
+	actualKibana := &kibanav1alpha1.Kibana{}
+	err = client.Get(types.NamespacedName{
+		Namespace: obj.Namespace,
+		Name:      obj.Name,
+	}, actualKibana)
+	require.NoError(t, err)
+	require.NotNil(t, actualKibana.GetAnnotations())
+	assert.Equal(t, actualKibana.GetAnnotations()[ControllerVersionAnnotation], "newversion")
+}
+
+// setupScheme creates a scheme to use for our fake clients so they know about our custom resources
+// TODO move this into one of the upper level common packages and make public, refactor out this code that's in a lot of our tests
+func setupScheme(t *testing.T) *runtime.Scheme {
+	sc := scheme.Scheme
+	if err := assoctype.SchemeBuilder.AddToScheme(sc); err != nil {
+		assert.Fail(t, "failed to add Association types")
+	}
+	if err := apmtype.SchemeBuilder.AddToScheme(sc); err != nil {
+		assert.Fail(t, "failed to add APM types")
+	}
+	if err := estype.SchemeBuilder.AddToScheme(sc); err != nil {
+		assert.Fail(t, "failed to add ES types")
+	}
+	if err := kibanav1alpha1.SchemeBuilder.AddToScheme(sc); err != nil {
+		assert.Fail(t, "failed to add Kibana types")
+	}
+	return sc
+}