K8SPS-334: add prefix to finalizers (#655)

* K8SPS-334: add prefix to finalizers

https://perconadev.atlassian.net/browse/K8SPS-334

* fix rename

* `delete-backup` => `percona.com/delete-backup`

---------

Co-authored-by: Viacheslav Sarzhan <[email protected]>

Author: pooknull

api/v1alpha1/perconaservermysql_types.go

@@ -25,19 +25,19 @@ import (
 	"strings"
 
 	cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
-
-	"github.com/percona/percona-server-mysql-operator/pkg/platform"
-	"github.com/percona/percona-server-mysql-operator/pkg/version"
+	"github.com/pkg/errors"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
-
-	"github.com/pkg/errors"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	logf "sigs.k8s.io/controller-runtime/pkg/log"
+
+	"github.com/percona/percona-server-mysql-operator/pkg/naming"
+	"github.com/percona/percona-server-mysql-operator/pkg/platform"
+	"github.com/percona/percona-server-mysql-operator/pkg/version"
 )
 
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
@@ -876,32 +876,13 @@ func (p *PodSpec) GetTopologySpreadConstraints(ls map[string]string) []corev1.To
 	return tscs
 }
 
-type AnnotationKey string
-
-const (
-	AnnotationSpecHash   AnnotationKey = "percona.com/last-applied-spec"
-	AnnotationSecretHash AnnotationKey = "percona.com/last-applied-secret"
-	AnnotationConfigHash AnnotationKey = "percona.com/configuration-hash"
-	AnnotationTLSHash    AnnotationKey = "percona.com/last-applied-tls"
-)
-
-const (
-	NameLabel         = "app.kubernetes.io/name"
-	InstanceLabel     = "app.kubernetes.io/instance"
-	ManagedByLabel    = "app.kubernetes.io/managed-by"
-	PartOfLabel       = "app.kubernetes.io/part-of"
-	ComponentLabel    = "app.kubernetes.io/component"
-	MySQLPrimaryLabel = "mysql.percona.com/primary"
-	ExposedLabel      = "percona.com/exposed"
-)
-
 // Labels returns a standardized set of labels for the PerconaServerMySQL custom resource.
 func (cr *PerconaServerMySQL) Labels() map[string]string {
 	return map[string]string{
-		NameLabel:      "percona-server",
-		InstanceLabel:  cr.Name,
-		ManagedByLabel: "percona-server-operator",
-		PartOfLabel:    "percona-server",
+		naming.LabelName:      "percona-server",
+		naming.LabelInstance:  cr.Name,
+		naming.LabelManagedBy: "percona-server-operator",
+		naming.LabelPartOf:    "percona-server",
 	}
 }
 
@@ -914,9 +895,9 @@ func (cr *PerconaServerMySQL) ClusterHint() string {
 // GetClusterNameFromObject retrieves the cluster's name from the given client object's labels.
 func GetClusterNameFromObject(obj client.Object) (string, error) {
 	labels := obj.GetLabels()
-	instance, ok := labels[InstanceLabel]
+	instance, ok := labels[naming.LabelInstance]
 	if !ok {
-		return "", errors.Errorf("label %s doesn't exist", InstanceLabel)
+		return "", errors.Errorf("label %s doesn't exist", naming.LabelInstance)
 	}
 	return instance, nil
 }

cmd/orc-handler/main.go

@@ -22,14 +22,13 @@ import (
 	perconaClientCmd "github.com/percona/percona-server-mysql-operator/pkg/clientcmd"
 	"github.com/percona/percona-server-mysql-operator/pkg/k8s"
 	"github.com/percona/percona-server-mysql-operator/pkg/mysql"
+	"github.com/percona/percona-server-mysql-operator/pkg/naming"
 	"github.com/percona/percona-server-mysql-operator/pkg/platform"
 )
 
 var log = logf.Log.WithName("orc-handler")
 
-var (
-	primary = flag.String("primary", "", "Primary hostname")
-)
+var primary = flag.String("primary", "", "Primary hostname")
 
 func main() {
 	ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGTERM, os.Interrupt)
@@ -124,8 +123,8 @@ func setPrimaryLabel(ctx context.Context, primary string) error {
 			continue
 		}
 		pod := pods[i].DeepCopy()
-		if pod.GetLabels()[apiv1alpha1.MySQLPrimaryLabel] == "true" {
-			k8s.RemoveLabel(pod, apiv1alpha1.MySQLPrimaryLabel)
+		if pod.GetLabels()[naming.LabelMySQLPrimary] == "true" {
+			k8s.RemoveLabel(pod, naming.LabelMySQLPrimary)
 			if err := cl.Patch(ctx, pod, client.StrategicMergeFrom(&pods[i])); err != nil {
 				return errors.Wrapf(err, "remove label from old primary pod: %v/%v", pod.GetNamespace(), pod.GetName())
 			}
@@ -138,13 +137,13 @@ func setPrimaryLabel(ctx context.Context, primary string) error {
 		return errors.Wrapf(err, "primary pod %s not found %s", primaryName, primary)
 	}
 
-	if primaryPod.GetLabels()[apiv1alpha1.MySQLPrimaryLabel] == "true" {
+	if primaryPod.GetLabels()[naming.LabelMySQLPrimary] == "true" {
 		log.Info("Primary pod is not changed, skipping", "pod", primaryName)
 		return nil
 	}
 
 	pod := primaryPod.DeepCopy()
-	k8s.AddLabel(pod, apiv1alpha1.MySQLPrimaryLabel, "true")
+	k8s.AddLabel(pod, naming.LabelMySQLPrimary, "true")
 	if err := cl.Patch(ctx, pod, client.StrategicMergeFrom(primaryPod)); err != nil {
 		return errors.Wrapf(err, "add label to new primary pod %v/%v", pod.GetNamespace(), pod.GetName())
 	}

deploy/backup.yaml

@@ -3,7 +3,7 @@ kind: PerconaServerMySQLBackup
 metadata:
   name: backup1
   finalizers:
-    - delete-backup
+    - percona.com/delete-backup
 spec:
   clusterName: cluster1
   storageName: minio

deploy/cr.yaml

@@ -3,8 +3,8 @@ kind: PerconaServerMySQL
 metadata:
   name: cluster1
   finalizers:
-    - delete-mysql-pods-in-order
-    # - delete-ssl
+    - percona.com/delete-mysql-pods-in-order
+    # - percona.com/delete-ssl
 spec:
   allowUnsafeConfigurations: false
 #  pause: false

e2e-tests/tests/async-ignore-annotations/01-assert.yaml

@@ -43,7 +43,7 @@ kind: PerconaServerMySQL
 metadata:
   name: async-ignore-annotations
   finalizers:
-    - delete-mysql-pods-in-order
+    - percona.com/delete-mysql-pods-in-order
 status:
   haproxy:
     ready: 3

e2e-tests/tests/demand-backup/02-assert.yaml

@@ -43,7 +43,7 @@ kind: PerconaServerMySQL
 metadata:
   name: demand-backup
   finalizers:
-    - delete-mysql-pods-in-order
+    - percona.com/delete-mysql-pods-in-order
 status:
   haproxy:
     ready: 3

e2e-tests/tests/demand-backup/05-assert.yaml

@@ -7,6 +7,6 @@ apiVersion: ps.percona.com/v1alpha1
 metadata:
   name: demand-backup-minio
   finalizers:
-    - delete-backup
+    - percona.com/delete-backup
 status:
   state: Succeeded

e2e-tests/tests/demand-backup/05-create-backup-minio.yaml

@@ -3,7 +3,7 @@ kind: PerconaServerMySQLBackup
 metadata:
   name: demand-backup-minio
   finalizers:
-    - delete-backup
+    - percona.com/delete-backup
 spec:
   clusterName: demand-backup
   storageName: minio

e2e-tests/tests/demand-backup/08-assert.yaml

@@ -7,7 +7,7 @@ kind: PerconaServerMySQL
 metadata:
   name: demand-backup
   finalizers:
-    - delete-mysql-pods-in-order
+    - percona.com/delete-mysql-pods-in-order
 status:
   haproxy:
     ready: 3

e2e-tests/tests/demand-backup/12-assert.yaml

@@ -7,7 +7,7 @@ kind: PerconaServerMySQL
 metadata:
   name: demand-backup
   finalizers:
-    - delete-mysql-pods-in-order
+    - percona.com/delete-mysql-pods-in-order
 status:
   haproxy:
     ready: 3