move annotations to separate package

kobzonega · kobzonega · commit 35a3c4ff15bc · 2024-07-01T19:31:21.000+03:00
diff --git a/api/v1alpha1/const.go b/api/v1alpha1/const.go
@@ -51,7 +51,7 @@ const (
 	AnnotationNodeHost               = "ydb.tech/node-host"
 	AnnotationNodeDomain             = "ydb.tech/node-domain"
 
-	AnnotationValueTrue = "true"
+	FinalizerRemote = "ydb.tech/remote-finalizer"
 
 	legacyTenantNameFormat = "/%s/%s"
 )
diff --git a/internal/annotations/annotations.go b/internal/annotations/annotations.go
@@ -1,14 +1,85 @@
 package annotations
 
+import (
+	"github.com/ydb-platform/ydb-kubernetes-operator/api/v1alpha1"
+	corev1 "k8s.io/api/core/v1"
+)
+
 const (
-	PrimaryResourceStorageAnnotation  = "ydb.tech/primary-resource-storage"
-	PrimaryResourceDatabaseAnnotation = "ydb.tech/primary-resource-database"
-	RemoteResourceVersionAnnotation   = "ydb.tech/remote-resource-version"
-	ConfigurationChecksum             = "ydb.tech/configuration-checksum"
-	RemoteFinalizerKey                = "ydb.tech/remote-finalizer"
-	LastAppliedAnnotation             = "ydb.tech/last-applied"
+	PrimaryResourceStorage  = "ydb.tech/primary-resource-storage"
+	PrimaryResourceDatabase = "ydb.tech/primary-resource-database"
+	RemoteResourceVersion   = "ydb.tech/remote-resource-version"
+	ConfigurationChecksum   = "ydb.tech/configuration-checksum"
+	LastApplied             = "ydb.tech/last-applied"
+)
+
+var (
+	AcceptedDNSPolicy = []string{
+		string(corev1.DNSClusterFirstWithHostNet),
+		string(corev1.DNSClusterFirst),
+		string(corev1.DNSDefault),
+		string(corev1.DNSNone),
+	}
+	UserAnnotations = map[string]struct{}{
+		v1alpha1.AnnotationSkipInitialization:     struct{}{},
+		v1alpha1.AnnotationUpdateStrategyOnDelete: struct{}{},
+		v1alpha1.AnnotationUpdateDNSPolicy:        struct{}{},
+		v1alpha1.AnnotationDisableLivenessProbe:   struct{}{},
+		v1alpha1.AnnotationDataCenter:             struct{}{},
+		v1alpha1.AnnotationGRPCPublicHost:         struct{}{},
+		v1alpha1.AnnotationNodeHost:               struct{}{},
+		v1alpha1.AnnotationNodeDomain:             struct{}{},
+	}
 )
 
+type Annotations map[string]string
+
+func Common(objAnnotations Annotations) Annotations {
+	an := Annotations{}
+
+	an.Merge(getUserAnnotations(objAnnotations))
+
+	return an
+}
+
+func (an Annotations) Merge(other map[string]string) map[string]string {
+	if other == nil {
+		return an
+	}
+
+	for k, v := range other {
+		an[k] = v
+	}
+
+	return an
+}
+
+func (an Annotations) AsMap() map[string]string {
+	return an
+}
+
+func (an Annotations) Copy() Annotations {
+	res := Annotations{}
+
+	for k, v := range an {
+		res[k] = v
+	}
+
+	return res
+}
+
+func getUserAnnotations(annotations map[string]string) map[string]string {
+	common := make(map[string]string)
+
+	for key, value := range annotations {
+		if _, exists := UserAnnotations[key]; exists {
+			common[key] = value
+		}
+	}
+
+	return common
+}
+
 func CompareLastAppliedAnnotation(map1, map2 map[string]string) bool {
 	value1 := getLastAppliedAnnotation(map1)
 	value2 := getLastAppliedAnnotation(map2)
@@ -17,7 +88,7 @@ func CompareLastAppliedAnnotation(map1, map2 map[string]string) bool {
 
 func getLastAppliedAnnotation(annotations map[string]string) string {
 	for key, value := range annotations {
-		if key == LastAppliedAnnotation {
+		if key == LastApplied {
 			return value
 		}
 	}
diff --git a/internal/annotations/annotations_test.go b/internal/annotations/annotations_test.go
@@ -0,0 +1,48 @@
+package annotations_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
+)
+
+func TestLabels(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Label suite")
+}
+
+var _ = Describe("Testing annotations", func() {
+	It("merges two sets of annotations", func() {
+		fstLabels := annotations.Annotations{
+			"a": "a",
+			"b": "b",
+		}
+
+		sndLabels := annotations.Annotations{
+			"c": "c",
+			"d": "d",
+		}
+
+		Expect(fstLabels.Merge(sndLabels)).To(BeEquivalentTo(map[string]string{
+			"a": "a",
+			"b": "b",
+			"c": "c",
+			"d": "d",
+		}))
+	})
+
+	It("sets correct defaults", func() {
+		Expect(annotations.Common(map[string]string{
+			"ydb.tech/skip-initialization": "true",
+			"ydb.tech/node-host":           "ydb-testing.k8s-c.yandex.net",
+			"ydb.tech/last-applied":        "some-body",
+			"sample-annotation":            "test",
+		})).To(BeEquivalentTo(map[string]string{
+			"ydb.tech/skip-initialization": "true",
+			"ydb.tech/node-host":           "ydb-testing.k8s-c.yandex.net",
+		}))
+	})
+})
diff --git a/internal/controllers/database/init.go b/internal/controllers/database/init.go
@@ -3,6 +3,7 @@ package database
 import (
 	"context"
 	"fmt"
+	"strconv"
 
 	"github.com/ydb-platform/ydb-go-sdk/v3"
 	corev1 "k8s.io/api/core/v1"
@@ -34,15 +35,17 @@ func (r *Reconciler) setInitPipelineStatus(
 	}
 
 	// This block is special internal logic that skips all Database initialization.
-	if value, ok := database.Annotations[v1alpha1.AnnotationSkipInitialization]; ok && value == v1alpha1.AnnotationValueTrue {
-		r.Log.Info("Database initialization disabled (with annotation), proceed with caution")
-		r.Recorder.Event(
-			database,
-			corev1.EventTypeWarning,
-			"SkippingInit",
-			"Skipping initialization due to skip annotation present, be careful!",
-		)
-		return r.setInitDatabaseCompleted(ctx, database, "Database initialization not performed because initialization is skipped")
+	if value, ok := database.Annotations[v1alpha1.AnnotationSkipInitialization]; ok {
+		if isTrue, _ := strconv.ParseBool(value); isTrue {
+			r.Log.Info("Database initialization disabled (with annotation), proceed with caution")
+			r.Recorder.Event(
+				database,
+				corev1.EventTypeWarning,
+				"SkippingInit",
+				"Skipping initialization due to skip annotation present, be careful!",
+			)
+			return r.setInitDatabaseCompleted(ctx, database, "Database initialization not performed because initialization is skipped")
+		}
 	}
 
 	if meta.IsStatusConditionTrue(database.Status.Conditions, OldDatabaseInitializedCondition) {
diff --git a/internal/controllers/remotedatabasenodeset/controller.go b/internal/controllers/remotedatabasenodeset/controller.go
@@ -6,7 +6,7 @@ import (
 	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
-	"k8s.io/apimachinery/pkg/labels"
+	apilabels "k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/selection"
 	"k8s.io/apimachinery/pkg/types"
@@ -23,9 +23,9 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	"github.com/ydb-platform/ydb-kubernetes-operator/api/v1alpha1"
-	ydbannotations "github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
+	"github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
 	. "github.com/ydb-platform/ydb-kubernetes-operator/internal/controllers/constants" //nolint:revive,stylecheck
-	ydblabels "github.com/ydb-platform/ydb-kubernetes-operator/internal/labels"
+	"github.com/ydb-platform/ydb-kubernetes-operator/internal/labels"
 	"github.com/ydb-platform/ydb-kubernetes-operator/internal/resources"
 )
 
@@ -72,15 +72,15 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 		// The object is not being deleted, so if it does not have our finalizer,
 		// then lets add the finalizer and update the object. This is equivalent
 		// to registering our finalizer.
-		if !controllerutil.ContainsFinalizer(remoteDatabaseNodeSet, ydbannotations.RemoteFinalizerKey) {
-			controllerutil.AddFinalizer(remoteDatabaseNodeSet, ydbannotations.RemoteFinalizerKey)
+		if !controllerutil.ContainsFinalizer(remoteDatabaseNodeSet, v1alpha1.FinalizerRemote) {
+			controllerutil.AddFinalizer(remoteDatabaseNodeSet, v1alpha1.FinalizerRemote)
 			if err := r.RemoteClient.Update(ctx, remoteDatabaseNodeSet); err != nil {
 				return ctrl.Result{RequeueAfter: DefaultRequeueDelay}, err
 			}
 		}
 	} else {
 		// The object is being deleted
-		if controllerutil.ContainsFinalizer(remoteDatabaseNodeSet, ydbannotations.RemoteFinalizerKey) {
+		if controllerutil.ContainsFinalizer(remoteDatabaseNodeSet, v1alpha1.FinalizerRemote) {
 			// our finalizer is present, so lets handle any external dependency
 			if err := r.deleteExternalResources(ctx, remoteDatabaseNodeSet); err != nil {
 				// if fail to delete the external dependency here, return with error
@@ -89,7 +89,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 			}
 
 			// remove our finalizer from the list and update it.
-			controllerutil.RemoveFinalizer(remoteDatabaseNodeSet, ydbannotations.RemoteFinalizerKey)
+			controllerutil.RemoveFinalizer(remoteDatabaseNodeSet, v1alpha1.FinalizerRemote)
 			if err := r.RemoteClient.Update(ctx, remoteDatabaseNodeSet); err != nil {
 				return ctrl.Result{RequeueAfter: DefaultRequeueDelay}, err
 			}
@@ -118,8 +118,8 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, remoteCluster *cluster.C
 	annotationFilter := func(mapObj client.Object) []reconcile.Request {
 		requests := make([]reconcile.Request, 0)
 
-		annotations := mapObj.GetAnnotations()
-		primaryResourceName, exist := annotations[ydbannotations.PrimaryResourceDatabaseAnnotation]
+		an := mapObj.GetAnnotations()
+		primaryResourceName, exist := an[annotations.PrimaryResourceDatabase]
 		if exist {
 			databaseNodeSets := &v1alpha1.DatabaseNodeSetList{}
 			if err := r.Client.List(
@@ -192,32 +192,32 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, remoteCluster *cluster.C
 		Complete(r)
 }
 
-func buildLocalSelector() (labels.Selector, error) {
-	labelRequirements := []labels.Requirement{}
-	localClusterRequirement, err := labels.NewRequirement(
-		ydblabels.RemoteClusterKey,
+func buildLocalSelector() (apilabels.Selector, error) {
+	labelRequirements := []apilabels.Requirement{}
+	localClusterRequirement, err := apilabels.NewRequirement(
+		labels.RemoteClusterKey,
 		selection.Exists,
 		[]string{},
 	)
 	if err != nil {
 		return nil, err
 	}
 	labelRequirements = append(labelRequirements, *localClusterRequirement)
-	return labels.NewSelector().Add(labelRequirements...), nil
+	return apilabels.NewSelector().Add(labelRequirements...), nil
 }
 
-func BuildRemoteSelector(remoteCluster string) (labels.Selector, error) {
-	labelRequirements := []labels.Requirement{}
-	remoteClusterRequirement, err := labels.NewRequirement(
-		ydblabels.RemoteClusterKey,
+func BuildRemoteSelector(remoteCluster string) (apilabels.Selector, error) {
+	labelRequirements := []apilabels.Requirement{}
+	remoteClusterRequirement, err := apilabels.NewRequirement(
+		labels.RemoteClusterKey,
 		selection.Equals,
 		[]string{remoteCluster},
 	)
 	if err != nil {
 		return nil, err
 	}
 	labelRequirements = append(labelRequirements, *remoteClusterRequirement)
-	return labels.NewSelector().Add(labelRequirements...), nil
+	return apilabels.NewSelector().Add(labelRequirements...), nil
 }
 
 func (r *Reconciler) deleteExternalResources(
diff --git a/internal/controllers/remotedatabasenodeset/remote_objects.go b/internal/controllers/remotedatabasenodeset/remote_objects.go
@@ -278,7 +278,7 @@ func (r *Reconciler) removeUnusedRemoteObjects(
 		// Remove annotation if no one another DatabaseNodeSet
 		if !existInDatabase {
 			// Try to update existing object in local cluster by rawPatch
-			patch := []byte(fmt.Sprintf(`{"metadata": {"annotations": {"%s": null}}}`, ydbannotations.PrimaryResourceStorageAnnotation))
+			patch := []byte(fmt.Sprintf(`{"metadata": {"annotations": {"%s": null}}}`, ydbannotations.PrimaryResourceStorage))
 			updateErr := r.Client.Patch(ctx, localObj, client.RawPatch(types.StrategicMergePatchType, patch))
 			if updateErr != nil {
 				r.Recorder.Event(
@@ -298,7 +298,7 @@ func (r *Reconciler) removeUnusedRemoteObjects(
 		}
 
 		// Delete resource if annotation `ydb.tech/primary-resource-storage` does not exist
-		_, existInStorage := localObj.GetAnnotations()[ydbannotations.PrimaryResourceStorageAnnotation]
+		_, existInStorage := localObj.GetAnnotations()[ydbannotations.PrimaryResourceStorage]
 		if !existInStorage {
 			// Try to delete unused resource from local cluster
 			deleteErr := r.Client.Delete(ctx, localObj)
diff --git a/internal/controllers/remotestoragenodeset/controller.go b/internal/controllers/remotestoragenodeset/controller.go
@@ -23,7 +23,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	"github.com/ydb-platform/ydb-kubernetes-operator/api/v1alpha1"
-	ydbannotations "github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
+	"github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
 	. "github.com/ydb-platform/ydb-kubernetes-operator/internal/controllers/constants" //nolint:revive,stylecheck
 	ydblabels "github.com/ydb-platform/ydb-kubernetes-operator/internal/labels"
 	"github.com/ydb-platform/ydb-kubernetes-operator/internal/resources"
@@ -72,15 +72,15 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 		// The object is not being deleted, so if it does not have our finalizer,
 		// then lets add the finalizer and update the object. This is equivalent
 		// to registering our finalizer.
-		if !controllerutil.ContainsFinalizer(remoteStorageNodeSet, ydbannotations.RemoteFinalizerKey) {
-			controllerutil.AddFinalizer(remoteStorageNodeSet, ydbannotations.RemoteFinalizerKey)
+		if !controllerutil.ContainsFinalizer(remoteStorageNodeSet, v1alpha1.FinalizerRemote) {
+			controllerutil.AddFinalizer(remoteStorageNodeSet, v1alpha1.FinalizerRemote)
 			if err := r.RemoteClient.Update(ctx, remoteStorageNodeSet); err != nil {
 				return ctrl.Result{RequeueAfter: DefaultRequeueDelay}, err
 			}
 		}
 	} else {
 		// The object is being deleted
-		if controllerutil.ContainsFinalizer(remoteStorageNodeSet, ydbannotations.RemoteFinalizerKey) {
+		if controllerutil.ContainsFinalizer(remoteStorageNodeSet, v1alpha1.FinalizerRemote) {
 			// our finalizer is present, so lets handle any external dependency
 			if err := r.deleteExternalResources(ctx, remoteStorageNodeSet); err != nil {
 				// if fail to delete the external dependency here, return with error
@@ -89,7 +89,7 @@ func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 			}
 
 			// remove our finalizer from the list and update it.
-			controllerutil.RemoveFinalizer(remoteStorageNodeSet, ydbannotations.RemoteFinalizerKey)
+			controllerutil.RemoveFinalizer(remoteStorageNodeSet, v1alpha1.FinalizerRemote)
 			if err := r.RemoteClient.Update(ctx, remoteStorageNodeSet); err != nil {
 				return ctrl.Result{RequeueAfter: DefaultRequeueDelay}, err
 			}
@@ -118,8 +118,8 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, remoteCluster *cluster.C
 	annotationFilter := func(mapObj client.Object) []reconcile.Request {
 		requests := make([]reconcile.Request, 0)
 
-		annotations := mapObj.GetAnnotations()
-		primaryResourceName, exist := annotations[ydbannotations.PrimaryResourceStorageAnnotation]
+		an := mapObj.GetAnnotations()
+		primaryResourceName, exist := an[annotations.PrimaryResourceStorage]
 		if exist {
 			storageNodeSets := &v1alpha1.StorageNodeSetList{}
 			if err := r.Client.List(
diff --git a/internal/controllers/remotestoragenodeset/remote_objects.go b/internal/controllers/remotestoragenodeset/remote_objects.go
@@ -16,7 +16,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/ydb-platform/ydb-kubernetes-operator/api/v1alpha1"
-	ydbannotations "github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
+	"github.com/ydb-platform/ydb-kubernetes-operator/internal/annotations"
 	. "github.com/ydb-platform/ydb-kubernetes-operator/internal/controllers/constants" //nolint:revive,stylecheck
 	ydblabels "github.com/ydb-platform/ydb-kubernetes-operator/internal/labels"
 	"github.com/ydb-platform/ydb-kubernetes-operator/internal/resources"
@@ -277,7 +277,7 @@ func (r *Reconciler) removeUnusedRemoteObjects(
 
 		// Remove annotation if no one another StorageNodeSet
 		if !existInStorage {
-			patch := []byte(fmt.Sprintf(`{"metadata": {"annotations": {"%s": null}}}`, ydbannotations.PrimaryResourceStorageAnnotation))
+			patch := []byte(fmt.Sprintf(`{"metadata": {"annotations": {"%s": null}}}`, annotations.PrimaryResourceStorage))
 			updateErr := r.Client.Patch(ctx, localObj, client.RawPatch(types.StrategicMergePatchType, patch))
 			if updateErr != nil {
 				r.Recorder.Event(
@@ -297,7 +297,7 @@ func (r *Reconciler) removeUnusedRemoteObjects(
 		}
 
 		// Delete resource if annotation `ydb.tech/primary-resource-database` does not exist
-		_, existInDatabase := localObj.GetAnnotations()[ydbannotations.PrimaryResourceDatabaseAnnotation]
+		_, existInDatabase := localObj.GetAnnotations()[annotations.PrimaryResourceDatabase]
 		if !existInDatabase {
 			// Try to delete unused resource from local cluster
 			deleteErr := r.Client.Delete(ctx, localObj)
diff --git a/internal/controllers/storage/init.go b/internal/controllers/storage/init.go

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ const (`
`51`	`51`	`AnnotationNodeHost = "ydb.tech/node-host"`
`52`	`52`	`AnnotationNodeDomain = "ydb.tech/node-domain"`
`53`	`53`
`54`		`- AnnotationValueTrue = "true"`
	`54`	`+ FinalizerRemote = "ydb.tech/remote-finalizer"`
`55`	`55`
`56`	`56`	`legacyTenantNameFormat = "/%s/%s"`
`57`	`57`	`)`