use new version of common with required annotations

Signed-off-by: Michael Shitrit <[email protected]>

Author: mshitrit

controllers/nodehealthcheck_controller.go

@@ -57,7 +57,6 @@ import (
 	"github.com/medik8s/node-healthcheck-operator/controllers/mhc"
 	"github.com/medik8s/node-healthcheck-operator/controllers/resources"
 	"github.com/medik8s/node-healthcheck-operator/controllers/utils"
-	"github.com/medik8s/node-healthcheck-operator/controllers/utils/annotations"
 	"github.com/medik8s/node-healthcheck-operator/metrics"
 )
 
@@ -483,8 +482,8 @@ func (r *NodeHealthCheckReconciler) deleteOrphanedRemediationCRs(nhc *remediatio
 	log.Info("Going to delete orphaned remediation CRs", "count", len(orphanedRemediationCRs))
 	for _, cr := range orphanedRemediationCRs {
 		nodeName := cr.GetName()
-		if cr.GetAnnotations() != nil && len(cr.GetAnnotations()[annotations.NodeNameAnnotation]) > 0 {
-			nodeName = cr.GetAnnotations()[annotations.NodeNameAnnotation]
+		if cr.GetAnnotations() != nil && len(cr.GetAnnotations()[commonannotations.NodeNameAnnotation]) > 0 {
+			nodeName = cr.GetAnnotations()[commonannotations.NodeNameAnnotation]
 		}
 		// do some housekeeping first. When the CRs are deleted, we never get back here...
 		if err := rm.CleanUp(nodeName); err != nil {

controllers/nodehealthcheck_controller_test.go

@@ -960,7 +960,7 @@ var _ = Describe("Node Health Check CR", func() {
 					g.Expect(k8sClient.Get(context.Background(), client.ObjectKeyFromObject(newCr), newCr)).To(Succeed())
 					g.Expect(cr.GetAnnotations()).To(HaveKeyWithValue(Equal("remediation.medik8s.io/nhc-timed-out"), Not(BeNil())))
 					g.Expect(newCr.GetName()).To(Equal(unhealthyNodeName))
-					g.Expect(newCr.GetAnnotations()).ToNot(HaveKey(Equal(annotations.NodeNameAnnotation)))
+					g.Expect(newCr.GetAnnotations()).ToNot(HaveKey(Equal(commonannotations.NodeNameAnnotation)))
 
 				}, time.Second*10, time.Millisecond*300).Should(Succeed())
 
@@ -979,7 +979,7 @@ var _ = Describe("Node Health Check CR", func() {
 					thirdCR = getRemediationCRForMultiKindSupportTemplate(multiSupportTemplateRef.Name)
 					g.Expect(thirdCR).ToNot(BeNil())
 					g.Expect(thirdCR.GetName()).ToNot(Equal(unhealthyNodeName))
-					g.Expect(thirdCR.GetAnnotations()[annotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
+					g.Expect(thirdCR.GetAnnotations()[commonannotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
 					g.Expect(thirdCR.GetAnnotations()[annotations.TemplateNameAnnotation]).To(Equal(multiSupportTemplateRef.Name))
 					g.Expect(thirdCR.GetAnnotations()).ToNot(HaveKey(Equal("remediation.medik8s.io/nhc-timed-out")))
 				}, time.Second*10, time.Millisecond*300).Should(Succeed())
@@ -990,7 +990,7 @@ var _ = Describe("Node Health Check CR", func() {
 					thirdCR = getRemediationCRForMultiKindSupportTemplate(multiSupportTemplateRef.Name)
 					g.Expect(thirdCR).ToNot(BeNil())
 					g.Expect(thirdCR.GetName()).ToNot(Equal(unhealthyNodeName))
-					g.Expect(thirdCR.GetAnnotations()[annotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
+					g.Expect(thirdCR.GetAnnotations()[commonannotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
 					g.Expect(thirdCR.GetAnnotations()[annotations.TemplateNameAnnotation]).To(Equal(multiSupportTemplateRef.Name))
 					g.Expect(thirdCR.GetAnnotations()).To(HaveKeyWithValue(Equal("remediation.medik8s.io/nhc-timed-out"), Not(BeNil())))
 				}, time.Second*10, time.Millisecond*300).Should(Succeed())
@@ -1001,7 +1001,7 @@ var _ = Describe("Node Health Check CR", func() {
 					forthCR = getRemediationCRForMultiKindSupportTemplate(secondMultiSupportTemplateRef.Name)
 					g.Expect(forthCR).ToNot(BeNil())
 					g.Expect(forthCR.GetName()).ToNot(Equal(unhealthyNodeName))
-					g.Expect(forthCR.GetAnnotations()[annotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
+					g.Expect(forthCR.GetAnnotations()[commonannotations.NodeNameAnnotation]).To(Equal(unhealthyNodeName))
 					g.Expect(forthCR.GetAnnotations()[annotations.TemplateNameAnnotation]).To(Equal(secondMultiSupportTemplateRef.Name))
 					g.Expect(forthCR.GetAnnotations()).ToNot(HaveKey(Equal("remediation.medik8s.io/nhc-timed-out")))
 				}, time.Second*10, time.Millisecond*300).Should(Succeed())

controllers/resources/manager.go

@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/go-logr/logr"
+	commonannotations "github.com/medik8s/common/pkg/annotations"
 	commonevents "github.com/medik8s/common/pkg/events"
 	"github.com/pkg/errors"
 
@@ -127,7 +128,7 @@ func (m *manager) generateRemediationCR(name string, healthCheckOwnerRef *metav1
 
 	if annotations.HasMultipleTemplatesAnnotation(template) {
 		remediationCR.SetGenerateName(name)
-		remediationCR.SetAnnotations(map[string]string{annotations.NodeNameAnnotation: name, annotations.TemplateNameAnnotation: template.GetName()})
+		remediationCR.SetAnnotations(map[string]string{commonannotations.NodeNameAnnotation: name, annotations.TemplateNameAnnotation: template.GetName()})
 	} else {
 		remediationCR.SetName(name)
 	}
@@ -177,7 +178,7 @@ func (m *manager) GenerateRemediationCRBase(gvk schema.GroupVersionKind) *unstru
 // CreateRemediationCR creates the given remediation CR from remediationCR it'll return: a bool indicator of success, a *time.Duration an indicator on when requeue is needed in order to extend the lease, a *unstructured.Unstructured of the created/existing CR and an error
 func (m *manager) CreateRemediationCR(remediationCR *unstructured.Unstructured, owner client.Object, nodeName *string, currentRemediationDuration, previousRemediationsDuration time.Duration) (bool, *time.Duration, *unstructured.Unstructured, error) {
 	var err error
-	if remediationCR.GetAnnotations() == nil || len(remediationCR.GetAnnotations()[annotations.NodeNameAnnotation]) == 0 {
+	if remediationCR.GetAnnotations() == nil || len(remediationCR.GetAnnotations()[commonannotations.NodeNameAnnotation]) == 0 {
 		err = m.Get(m.ctx, client.ObjectKeyFromObject(remediationCR), remediationCR)
 	} else {
 		remediationCR, err = m.getCRWithNodeNameAnnotation(remediationCR)
@@ -358,7 +359,7 @@ func (m *manager) getOwningMachineWithNamespace(node *corev1.Node) (*metav1.Owne
 }
 
 func (m *manager) getCRWithNodeNameAnnotation(remediationCR *unstructured.Unstructured) (*unstructured.Unstructured, error) {
-	nodeName := remediationCR.GetAnnotations()[annotations.NodeNameAnnotation]
+	nodeName := remediationCR.GetAnnotations()[commonannotations.NodeNameAnnotation]
 	templateName := remediationCR.GetAnnotations()[annotations.TemplateNameAnnotation]
 
 	resourceList := &unstructured.UnstructuredList{Object: m.GenerateRemediationCRBase(remediationCR.GroupVersionKind()).Object}
@@ -386,7 +387,7 @@ func (m *manager) isMatchNodeTemplate(cr unstructured.Unstructured, nodeName str
 	if _, isMultiSupported := ann[annotations.TemplateNameAnnotation]; !isMultiSupported {
 		return cr.GetName() == nodeName
 	}
-	return ann[annotations.TemplateNameAnnotation] == templateName && ann[annotations.NodeNameAnnotation] == nodeName
+	return ann[annotations.TemplateNameAnnotation] == templateName && ann[commonannotations.NodeNameAnnotation] == nodeName
 }
 
 func (m *manager) extractNodeName(cr unstructured.Unstructured) string {
@@ -397,7 +398,7 @@ func (m *manager) extractNodeName(cr unstructured.Unstructured) string {
 	if _, isMultiSupported := ann[annotations.TemplateNameAnnotation]; !isMultiSupported {
 		return cr.GetName()
 	}
-	return ann[annotations.NodeNameAnnotation]
+	return ann[commonannotations.NodeNameAnnotation]
 }
 
 func createOwnerRef(obj client.Object) *metav1.OwnerReference {

controllers/suite_test.go

@@ -25,6 +25,7 @@ import (
 	"testing"
 	"time"
 
+	commonannotations "github.com/medik8s/common/pkg/annotations"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"go.uber.org/zap/zapcore"
@@ -54,9 +55,6 @@ import (
 	"github.com/medik8s/node-healthcheck-operator/controllers/cluster"
 	"github.com/medik8s/node-healthcheck-operator/controllers/featuregates"
 	"github.com/medik8s/node-healthcheck-operator/controllers/mhc"
-
-	// +kubebuilder:scaffold:imports
-	"github.com/medik8s/node-healthcheck-operator/controllers/utils/annotations"
 )
 
 // These tests use Ginkgo (BDD-style Go testing framework). Refer to
@@ -187,10 +185,10 @@ var _ = BeforeSuite(func() {
 	Expect(k8sClient.Create(context.Background(), newTestRemediationCRD(multiSupportTestKind))).To(Succeed())
 	time.Sleep(time.Second)
 	multiSupportTemplate := newTestRemediationTemplateCR(multiSupportTestKind, MachineNamespace, MultipleSupportTemplateName)
-	multiSupportTemplate.SetAnnotations(map[string]string{annotations.MultipleTemplatesSupportedAnnotation: "true"})
+	multiSupportTemplate.SetAnnotations(map[string]string{commonannotations.MultipleTemplatesSupportedAnnotation: "true"})
 	Expect(k8sClient.Create(context.Background(), multiSupportTemplate)).To(Succeed())
 	secondMultiSupportTemplate := newTestRemediationTemplateCR(multiSupportTestKind, MachineNamespace, SecondMultipleSupportTemplateName)
-	secondMultiSupportTemplate.SetAnnotations(map[string]string{annotations.MultipleTemplatesSupportedAnnotation: "true"})
+	secondMultiSupportTemplate.SetAnnotations(map[string]string{commonannotations.MultipleTemplatesSupportedAnnotation: "true"})
 	Expect(k8sClient.Create(context.Background(), secondMultiSupportTemplate)).To(Succeed())
 
 	upgradeChecker = &fakeClusterUpgradeChecker{

controllers/utils/annotations/annotations.go

@@ -1,24 +1,23 @@
 package annotations
 
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+import (
+	commonannotations "github.com/medik8s/common/pkg/annotations"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
 
 const (
 	// MHCPausedAnnotation is an annotation that can be applied to MachineHealthCheck objects to prevent the MHC
 	// controller from processing it.
 	MHCPausedAnnotation = "cluster.x-k8s.io/paused"
-	// MultipleTemplatesSupportedAnnotation is an annotation that indicates whether multiple templates of the same kind are supported by the template's remediator
-	MultipleTemplatesSupportedAnnotation = "remediation.medik8s.io/multiple-templates-support"
-	// NodeNameAnnotation is an annotation that will be placed on the CRs of remediatiors who support multiple templates of the same remediator.
-	// This is done because the CR will no longer be created with the node name.
-	NodeNameAnnotation = "remediation.medik8s.io/node-name"
 	// TemplateNameAnnotation is an annotation that will be placed on the CRs of remediatiors who support multiple templates of the same remediator.
 	// This is done because when checking for timeout CRs we need to know whether a CR was already created or not by that template.
 	TemplateNameAnnotation = "remediation.medik8s.io/template-name"
 )
 
 // HasMultipleTemplatesAnnotation returns true if the object has the medik8s `multiple-templates-support` annotation.
 func HasMultipleTemplatesAnnotation(o metav1.Object) bool {
-	return hasAnnotation(o, MultipleTemplatesSupportedAnnotation)
+	return hasAnnotation(o, commonannotations.MultipleTemplatesSupportedAnnotation)
 }
 
 func HasMHCPausedAnnotation(o metav1.Object) bool {

go.mod

@@ -4,7 +4,7 @@ go 1.21
 
 require (
 	github.com/go-logr/logr v1.4.1
-	github.com/medik8s/common v1.15.1
+	github.com/medik8s/common v1.17.0
 	github.com/onsi/ginkgo/v2 v2.15.0
 	github.com/onsi/gomega v1.31.1
 	github.com/openshift/api v0.0.0-20240124164020-e2ce40831f2e // release-4.16

go.sum

@@ -80,8 +80,8 @@ github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0
 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 h1:jWpvCLoY8Z/e3VKvlsiIGKtc+UG6U5vzxaoagmhXfyg=
 github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0/go.mod h1:QUyp042oQthUoa9bqDv0ER0wrtXnBruoNd7aNjkbP+k=
-github.com/medik8s/common v1.15.1 h1:qo2FBZGSegf5q35AZlWzrmgwW1GfUPNmmWaPhb/Uurc=
-github.com/medik8s/common v1.15.1/go.mod h1:A9jYldC6PZcAuBowNNm712FqWdASB2ey5Vjp8MYN/PY=
+github.com/medik8s/common v1.17.0 h1:AmJKx0tzqGZF27Ot0A4ak85q0F0zqUkVyCvYmm67rtY=
+github.com/medik8s/common v1.17.0/go.mod h1:A9jYldC6PZcAuBowNNm712FqWdASB2ey5Vjp8MYN/PY=
 github.com/moby/spdystream v0.2.0 h1:cjW1zVyyoiM0T7b6UoySUFqzXMoqRckQtXwGPiBhOM8=
 github.com/moby/spdystream v0.2.0/go.mod h1:f7i0iNDQJ059oMTcWxx8MA/zKFIuD/lY+0GqbN2Wy8c=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

vendor/github.com/medik8s/common/pkg/annotations/annotations.go

@@ -106,7 +106,7 @@ github.com/mailru/easyjson/jwriter
 # github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0
 ## explicit; go 1.19
 github.com/matttproud/golang_protobuf_extensions/v2/pbutil
-# github.com/medik8s/common v1.15.1
+# github.com/medik8s/common v1.17.0
 ## explicit; go 1.20
 github.com/medik8s/common/pkg/annotations
 github.com/medik8s/common/pkg/conditions