fix(k8s): set annotation kuma.io/display-name for Secrets and Configs (backport of #11923)

pkg/plugins/config/k8s/store.go

@@ -2,6 +2,7 @@ package k8s
 
 import (
 	"context"
+	"maps"
 	"time"
 
 	"github.com/pkg/errors"
@@ -12,11 +13,13 @@ import (
 	kube_client "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
+	"github.com/kumahq/kuma/api/mesh/v1alpha1"
 	system_proto "github.com/kumahq/kuma/api/system/v1alpha1"
 	config_model "github.com/kumahq/kuma/pkg/core/resources/apis/system"
 	core_model "github.com/kumahq/kuma/pkg/core/resources/model"
 	core_store "github.com/kumahq/kuma/pkg/core/resources/store"
 	common_k8s "github.com/kumahq/kuma/pkg/plugins/common/k8s"
+	"github.com/kumahq/kuma/pkg/plugins/resources/k8s"
 )
 
 var _ core_store.ResourceStore = &KubernetesStore{}
@@ -62,6 +65,11 @@ func (s *KubernetesStore) Create(ctx context.Context, r core_model.Resource, fs
 			configMapKey: configRes.Spec.Config,
 		},
 	}
+
+	labels, annotations := k8s.SplitLabelsAndAnnotations(opts.Labels, cm.GetAnnotations())
+	cm.GetObjectMeta().SetLabels(labels)
+	cm.GetObjectMeta().SetAnnotations(annotations)
+
 	if opts.Owner != nil {
 		k8sOwner, err := s.converter.ToKubernetesObject(opts.Owner)
 		if err != nil {
@@ -83,6 +91,7 @@ func (s *KubernetesStore) Update(ctx context.Context, r core_model.Resource, fs
 	if !ok {
 		return newInvalidTypeError()
 	}
+	opts := core_store.NewUpdateOptions(fs...)
 	cm := &kube_core.ConfigMap{
 		TypeMeta: kube_meta.TypeMeta{
 			Kind:       "ConfigMap",
@@ -94,6 +103,16 @@ func (s *KubernetesStore) Update(ctx context.Context, r core_model.Resource, fs
 			configMapKey: configRes.Spec.Config,
 		},
 	}
+
+	updateLabels := cm.GetLabels()
+	if opts.ModifyLabels {
+		updateLabels = opts.Labels
+	}
+
+	labels, annotations := k8s.SplitLabelsAndAnnotations(updateLabels, cm.GetAnnotations())
+	cm.GetObjectMeta().SetLabels(labels)
+	cm.GetObjectMeta().SetAnnotations(annotations)
+
 	if err := s.client.Update(ctx, cm); err != nil {
 		if kube_apierrs.IsConflict(err) {
 			return core_store.ErrorResourceConflict(r.Descriptor().Name, r.GetMeta().GetName(), r.GetMeta().GetMesh())
@@ -192,6 +211,19 @@ func (m *KubernetesMetaAdapter) GetModificationTime() time.Time {
 	return m.GetObjectMeta().GetCreationTimestamp().Time
 }
 
+func (m *KubernetesMetaAdapter) GetLabels() map[string]string {
+	labels := maps.Clone(m.GetObjectMeta().GetLabels())
+	if labels == nil {
+		labels = map[string]string{}
+	}
+	if displayName, ok := m.GetObjectMeta().GetAnnotations()[v1alpha1.DisplayName]; ok {
+		labels[v1alpha1.DisplayName] = displayName
+	} else {
+		labels[v1alpha1.DisplayName] = m.GetObjectMeta().GetName()
+	}
+	return labels
+}
+
 func newInvalidTypeError() error {
 	return errors.New("resource has a wrong type")
 }

pkg/plugins/config/k8s/store_test.go

@@ -12,6 +12,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/serializer"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	mesh_proto "github.com/kumahq/kuma/api/mesh/v1alpha1"
 	system_proto "github.com/kumahq/kuma/api/system/v1alpha1"
 	"github.com/kumahq/kuma/pkg/core"
 	system_model "github.com/kumahq/kuma/pkg/core/resources/apis/system"
@@ -91,13 +92,15 @@ var _ = Describe("KubernetesStore", func() {
             kind: ConfigMap
             metadata:
               name: "kuma-internal-config"
-              namespace : "kuma-system"
+              namespace: "kuma-system"
             data:
               config: "test" 
 `).(*kube_core.ConfigMap)
 
 			// when
-			err := s.Create(context.Background(), config, core_store.CreateByKey("kuma-internal-config", ""))
+			err := s.Create(context.Background(), config, core_store.CreateByKey("kuma-internal-config", ""), core_store.CreateWithLabels(map[string]string{
+				mesh_proto.DisplayName: "kuma-internal-config",
+			}))
 
 			// then
 			Expect(err).ToNot(HaveOccurred())
@@ -108,6 +111,8 @@ var _ = Describe("KubernetesStore", func() {
 
 			// then
 			Expect(actual.Data).To(Equal(expected.Data))
+			Expect(actual.GetLabels()).NotTo(HaveKey(mesh_proto.DisplayName))
+			Expect(actual.GetAnnotations()).To(HaveKeyWithValue(mesh_proto.DisplayName, "kuma-internal-config"))
 		})
 	})
 
@@ -120,6 +125,8 @@ var _ = Describe("KubernetesStore", func() {
             metadata:
               name: "kuma-internal-config"
               namespace : %s
+              annotations:
+                kuma.io/display-name: "kuma-internal-config"
             data:
               config: "test" 
     `, ns))
@@ -130,7 +137,9 @@ var _ = Describe("KubernetesStore", func() {
             kind: ConfigMap
             metadata:
               name: "kuma-internal-config"
-              namespace : %s
+              namespace: %s
+              annotations:
+                kuma.io/display-name: "kuma-internal-config"
             data:
               config: "next test" 
     `, ns)).(*kube_core.ConfigMap)
@@ -156,6 +165,8 @@ var _ = Describe("KubernetesStore", func() {
 
 			// then
 			Expect(actual.Data).To(Equal(expected.Data))
+			Expect(actual.GetLabels()).NotTo(HaveKey(mesh_proto.DisplayName))
+			Expect(actual.GetAnnotations()).To(HaveKeyWithValue(mesh_proto.DisplayName, "kuma-internal-config"))
 		})
 
 		It("should return error in case of resource conflict", func() {

pkg/plugins/resources/k8s/store.go

@@ -58,7 +58,7 @@ func (s *KubernetesStore) Create(ctx context.Context, r core_model.Resource, fs
 		return err
 	}
 
-	labels, annotations := splitLabelsAndAnnotations(opts.Labels, obj.GetAnnotations())
+	labels, annotations := SplitLabelsAndAnnotations(opts.Labels, obj.GetAnnotations())
 	obj.GetObjectMeta().SetLabels(labels)
 	obj.GetObjectMeta().SetAnnotations(annotations)
 	obj.SetMesh(opts.Mesh)
@@ -103,7 +103,8 @@ func (s *KubernetesStore) Update(ctx context.Context, r core_model.Resource, fs
 	if opts.ModifyLabels {
 		updateLabels = opts.Labels
 	}
-	labels, annotations := splitLabelsAndAnnotations(updateLabels, obj.GetAnnotations())
+	labels, annotations := SplitLabelsAndAnnotations(updateLabels, obj.GetAnnotations())
+
 	obj.GetObjectMeta().SetLabels(labels)
 	obj.GetObjectMeta().SetAnnotations(annotations)
 	obj.SetMesh(r.GetMeta().GetMesh())
@@ -241,7 +242,7 @@ func k8sNameNamespace(coreName string, scope k8s_model.Scope) (string, string, e
 
 // Kuma resource labels are generally stored on Kubernetes as labels, except "kuma.io/display-name".
 // We store it as an annotation because the resource name on k8s is limited by 253 and the label value is limited by 63.
-func splitLabelsAndAnnotations(coreLabels map[string]string, currentAnnotations map[string]string) (map[string]string, map[string]string) {
+func SplitLabelsAndAnnotations(coreLabels map[string]string, currentAnnotations map[string]string) (map[string]string, map[string]string) {
 	labels := maps.Clone(coreLabels)
 	annotations := maps.Clone(currentAnnotations)
 	if annotations == nil {

pkg/plugins/secrets/k8s/store.go

@@ -3,6 +3,7 @@ package k8s
 import (
 	"context"
 	"fmt"
+	"maps"
 	"time"
 
 	"github.com/pkg/errors"
@@ -13,6 +14,7 @@ import (
 	kube_client "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
+	"github.com/kumahq/kuma/api/mesh/v1alpha1"
 	system_proto "github.com/kumahq/kuma/api/system/v1alpha1"
 	secret_model "github.com/kumahq/kuma/pkg/core/resources/apis/system"
 	core_model "github.com/kumahq/kuma/pkg/core/resources/model"
@@ -56,9 +58,8 @@ func (s *KubernetesStore) Create(ctx context.Context, r core_model.Resource, fs
 	}
 	secret.Namespace = s.namespace
 	secret.Name = opts.Name
-	if r.Descriptor().Scope == core_model.ScopeMesh {
-		setMesh(secret, opts.Mesh, opts.Labels)
-	}
+
+	setLabelsAnnotationsAndMesh(secret, opts.Mesh, opts.Labels)
 
 	if opts.Owner != nil {
 		k8sOwner, err := s.resourcesConverter.ToKubernetesObject(opts.Owner)
@@ -91,9 +92,13 @@ func (s *KubernetesStore) Update(ctx context.Context, r core_model.Resource, fs
 		return errors.Wrap(err, "failed to convert core Secret into k8s counterpart")
 	}
 	secret.Namespace = s.namespace
-	if r.Descriptor().Scope == core_model.ScopeMesh {
-		setMesh(secret, r.GetMeta().GetMesh(), opts.Labels)
+
+	updateLabels := r.GetMeta().GetLabels()
+	if opts.ModifyLabels {
+		updateLabels = opts.Labels
 	}
+	setLabelsAnnotationsAndMesh(secret, r.GetMeta().GetMesh(), updateLabels)
+
 	if err := s.writer.Update(ctx, secret); err != nil {
 		if kube_apierrs.IsConflict(err) {
 			return core_store.ErrorResourceConflict(r.Descriptor().Name, secret.Name, r.GetMeta().GetMesh())
@@ -107,12 +112,17 @@ func (s *KubernetesStore) Update(ctx context.Context, r core_model.Resource, fs
 	return nil
 }
 
-func setMesh(s *kube_core.Secret, mesh string, labels map[string]string) {
+func setLabelsAnnotationsAndMesh(s *kube_core.Secret, mesh string, labels map[string]string) {
 	if labels == nil {
 		labels = map[string]string{}
 	}
-	labels[metadata.KumaMeshLabel] = mesh
-	s.SetLabels(labels)
+	if mesh != "" {
+		labels[metadata.KumaMeshLabel] = mesh
+	}
+
+	labels, annotations := k8s.SplitLabelsAndAnnotations(labels, s.GetAnnotations())
+	s.GetObjectMeta().SetLabels(labels)
+	s.GetObjectMeta().SetAnnotations(annotations)
 }
 
 func (s *KubernetesStore) Delete(ctx context.Context, r core_model.Resource, fs ...core_store.DeleteOptionsFunc) error {
@@ -236,6 +246,19 @@ func (m *KubernetesMetaAdapter) GetModificationTime() time.Time {
 	return m.GetObjectMeta().GetCreationTimestamp().Time
 }
 
+func (m *KubernetesMetaAdapter) GetLabels() map[string]string {
+	labels := maps.Clone(m.GetObjectMeta().GetLabels())
+	if labels == nil {
+		labels = map[string]string{}
+	}
+	if displayName, ok := m.GetObjectMeta().GetAnnotations()[v1alpha1.DisplayName]; ok {
+		labels[v1alpha1.DisplayName] = displayName
+	} else {
+		labels[v1alpha1.DisplayName] = m.GetObjectMeta().GetName()
+	}
+	return labels
+}
+
 type Converter interface {
 	ToKubernetesObject(resource core_model.Resource) (*kube_core.Secret, error)
 	ToCoreResource(secret *kube_core.Secret, out core_model.Resource) error

pkg/plugins/secrets/k8s/store_test.go

@@ -13,6 +13,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/serializer"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	mesh_proto "github.com/kumahq/kuma/api/mesh/v1alpha1"
 	system_proto "github.com/kumahq/kuma/api/system/v1alpha1"
 	"github.com/kumahq/kuma/pkg/core"
 	core_system "github.com/kumahq/kuma/pkg/core/resources/apis/system"
@@ -106,7 +107,9 @@ var _ = Describe("KubernetesStore", func() {
 `).(*kube_core.Secret)
 
 			// when
-			err := rs.Create(context.Background(), secret, store.CreateByKey(name, "demo"))
+			err := rs.Create(context.Background(), secret, store.CreateByKey(name, "demo"), store.CreateWithLabels(map[string]string{
+				mesh_proto.DisplayName: name,
+			}))
 
 			// then
 			Expect(err).ToNot(HaveOccurred())
@@ -122,6 +125,9 @@ var _ = Describe("KubernetesStore", func() {
 			// then
 			Expect(actual.Data).To(Equal(expected.Data))
 			Expect(actual.Type).To(Equal(expected.Type))
+			Expect(actual.GetObjectMeta().GetLabels()).NotTo(HaveKey(mesh_proto.DisplayName))
+			Expect(actual.GetObjectMeta().GetAnnotations()).To(HaveKeyWithValue(mesh_proto.DisplayName, name))
+
 			// and
 			Expect(actual.ObjectMeta.ResourceVersion).To(Equal(secret.Meta.GetVersion()))
 		})
@@ -192,9 +198,11 @@ var _ = Describe("KubernetesStore", func() {
               name: %s
               labels:
                 kuma.io/mesh: demo
+              annotations:
+                kuma.io/display-name: %s
             data:
               value: ZXhhbXBsZQ== # base64(example)
-`, ns, name))
+`, ns, name, name))
 			backend.Create(initial)
 			// and
 			expected := backend.ParseYAML(`
@@ -231,6 +239,8 @@ var _ = Describe("KubernetesStore", func() {
 			// then
 			Expect(actual.Data).To(Equal(expected.Data))
 			Expect(actual.Type).To(Equal(expected.Type))
+			Expect(actual.GetObjectMeta().GetLabels()).NotTo(HaveKey(mesh_proto.DisplayName))
+			Expect(actual.GetObjectMeta().GetAnnotations()).To(HaveKeyWithValue(mesh_proto.DisplayName, name))
 			// and
 			Expect(actual.ObjectMeta.ResourceVersion).To(Equal(secret.Meta.GetVersion()))
 		})