Merge pull request #7618 from chiukapoor/inconsistent-constants-rename

⚠️ Use consistent naming for API constants

Author: k8s-ci-robot

api/v1beta1/common_types.go

@@ -22,9 +22,9 @@ import (
 )
 
 const (
-	// ClusterLabelName is the label set on machines linked to a cluster and
+	// ClusterNameLabel is the label set on machines linked to a cluster and
 	// external objects(bootstrap and infrastructure providers).
-	ClusterLabelName = "cluster.x-k8s.io/cluster-name"
+	ClusterNameLabel = "cluster.x-k8s.io/cluster-name"
 
 	// ClusterTopologyOwnedLabel is the label set on all the object which are managed as part of a ClusterTopology.
 	ClusterTopologyOwnedLabel = "topology.cluster.x-k8s.io/owned"
@@ -45,18 +45,18 @@ const (
 	// When removing also remove from staticcheck exclude-rules for SA1019 in golangci.yml.
 	ClusterTopologyManagedFieldsAnnotation = "topology.cluster.x-k8s.io/managed-field-paths"
 
-	// ClusterTopologyMachineDeploymentLabelName is the label set on the generated  MachineDeployment objects
+	// ClusterTopologyMachineDeploymentNameLabel is the label set on the generated  MachineDeployment objects
 	// to track the name of the MachineDeployment topology it represents.
-	ClusterTopologyMachineDeploymentLabelName = "topology.cluster.x-k8s.io/deployment-name"
+	ClusterTopologyMachineDeploymentNameLabel = "topology.cluster.x-k8s.io/deployment-name"
 
 	// ClusterTopologyUnsafeUpdateClassNameAnnotation can be used to disable the webhook check on
 	// update that disallows a pre-existing Cluster to be populated with Topology information and Class.
 	ClusterTopologyUnsafeUpdateClassNameAnnotation = "unsafe.topology.cluster.x-k8s.io/disable-update-class-name-check"
 
-	// ProviderLabelName is the label set on components in the provider manifest.
+	// ProviderNameLabel is the label set on components in the provider manifest.
 	// This label allows to easily identify all the components belonging to a provider; the clusterctl
 	// tool uses this label for implementing provider's lifecycle operations.
-	ProviderLabelName = "cluster.x-k8s.io/provider"
+	ProviderNameLabel = "cluster.x-k8s.io/provider"
 
 	// ClusterNameAnnotation is the annotation set on nodes identifying the name of the cluster the node belongs to.
 	ClusterNameAnnotation = "cluster.x-k8s.io/cluster-name"
@@ -80,10 +80,10 @@ const (
 	// on the reconciled object.
 	PausedAnnotation = "cluster.x-k8s.io/paused"
 
-	// DisableMachineCreate is an annotation that can be used to signal a MachineSet to stop creating new machines.
+	// DisableMachineCreateAnnotation is an annotation that can be used to signal a MachineSet to stop creating new machines.
 	// It is utilized in the OnDelete MachineDeploymentStrategy to allow the MachineDeployment controller to scale down
 	// older MachineSets when Machines are deleted and add the new replicas to the latest MachineSet.
-	DisableMachineCreate = "cluster.x-k8s.io/disable-machine-create"
+	DisableMachineCreateAnnotation = "cluster.x-k8s.io/disable-machine-create"
 
 	// WatchLabel is a label othat can be applied to any Cluster API object.
 	//

api/v1beta1/condition_consts.go

@@ -166,19 +166,19 @@ const (
 	// RemediationInProgressReason is the reason used when an unhealthy machine is being remediated by the remediation owner.
 	RemediationInProgressReason = "RemediationInProgress"
 
-	// ExternalRemediationTemplateAvailable is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
-	// ExternalRemediationTemplateAvailable is set to false if external remediation template is not found.
-	ExternalRemediationTemplateAvailable ConditionType = "ExternalRemediationTemplateAvailable"
+	// ExternalRemediationTemplateAvailableCondition is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
+	// ExternalRemediationTemplateAvailableCondition is set to false if external remediation template is not found.
+	ExternalRemediationTemplateAvailableCondition ConditionType = "ExternalRemediationTemplateAvailable"
 
-	// ExternalRemediationTemplateNotFound is the reason used when a machine health check fails to find external remediation template.
-	ExternalRemediationTemplateNotFound = "ExternalRemediationTemplateNotFound"
+	// ExternalRemediationTemplateNotFoundReason is the reason used when a machine health check fails to find external remediation template.
+	ExternalRemediationTemplateNotFoundReason = "ExternalRemediationTemplateNotFound"
 
-	// ExternalRemediationRequestAvailable is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
-	// ExternalRemediationRequestAvailable is set to false if creating external remediation request fails.
-	ExternalRemediationRequestAvailable ConditionType = "ExternalRemediationRequestAvailable"
+	// ExternalRemediationRequestAvailableCondition is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
+	// ExternalRemediationRequestAvailableCondition is set to false if creating external remediation request fails.
+	ExternalRemediationRequestAvailableCondition ConditionType = "ExternalRemediationRequestAvailable"
 
-	// ExternalRemediationRequestCreationFailed is the reason used when a machine health check fails to create external remediation request.
-	ExternalRemediationRequestCreationFailed = "ExternalRemediationRequestCreationFailed"
+	// ExternalRemediationRequestCreationFailedReason is the reason used when a machine health check fails to create external remediation request.
+	ExternalRemediationRequestCreationFailedReason = "ExternalRemediationRequestCreationFailed"
 )
 
 // Conditions and condition Reasons for the Machine's Node object.

api/v1beta1/machine_types.go

@@ -27,20 +27,20 @@ const (
 	// MachineFinalizer is set on PrepareForCreate callback.
 	MachineFinalizer = "machine.cluster.x-k8s.io"
 
-	// MachineControlPlaneLabelName is the label set on machines or related objects that are part of a control plane.
-	MachineControlPlaneLabelName = "cluster.x-k8s.io/control-plane"
+	// MachineControlPlaneLabel is the label set on machines or related objects that are part of a control plane.
+	MachineControlPlaneLabel = "cluster.x-k8s.io/control-plane"
 
 	// ExcludeNodeDrainingAnnotation annotation explicitly skips node draining if set.
 	ExcludeNodeDrainingAnnotation = "machine.cluster.x-k8s.io/exclude-node-draining"
 
 	// ExcludeWaitForNodeVolumeDetachAnnotation annotation explicitly skips the waiting for node volume detaching if set.
 	ExcludeWaitForNodeVolumeDetachAnnotation = "machine.cluster.x-k8s.io/exclude-wait-for-node-volume-detach"
 
-	// MachineSetLabelName is the label set on machines if they're controlled by MachineSet.
-	MachineSetLabelName = "cluster.x-k8s.io/set-name"
+	// MachineSetNameLabel is the label set on machines if they're controlled by MachineSet.
+	MachineSetNameLabel = "cluster.x-k8s.io/set-name"
 
-	// MachineDeploymentLabelName is the label set on machines if they're controlled by MachineDeployment.
-	MachineDeploymentLabelName = "cluster.x-k8s.io/deployment-name"
+	// MachineDeploymentNameLabel is the label set on machines if they're controlled by MachineDeployment.
+	MachineDeploymentNameLabel = "cluster.x-k8s.io/deployment-name"
 
 	// MachineControlPlaneNameLabel is the label set on machines if they're controlled by a ControlPlane.
 	MachineControlPlaneNameLabel = "cluster.x-k8s.io/control-plane-name"

api/v1beta1/machine_webhook.go

@@ -50,7 +50,7 @@ func (m *Machine) Default() {
 	if m.Labels == nil {
 		m.Labels = make(map[string]string)
 	}
-	m.Labels[ClusterLabelName] = m.Spec.ClusterName
+	m.Labels[ClusterNameLabel] = m.Spec.ClusterName
 
 	if m.Spec.Bootstrap.ConfigRef != nil && m.Spec.Bootstrap.ConfigRef.Namespace == "" {
 		m.Spec.Bootstrap.ConfigRef.Namespace = m.Namespace

api/v1beta1/machine_webhook_test.go

@@ -42,7 +42,7 @@ func TestMachineDefault(t *testing.T) {
 	t.Run("for Machine", utildefaulting.DefaultValidateTest(m))
 	m.Default()
 
-	g.Expect(m.Labels[ClusterLabelName]).To(Equal(m.Spec.ClusterName))
+	g.Expect(m.Labels[ClusterNameLabel]).To(Equal(m.Spec.ClusterName))
 	g.Expect(m.Spec.Bootstrap.ConfigRef.Namespace).To(Equal(m.Namespace))
 	g.Expect(m.Spec.InfrastructureRef.Namespace).To(Equal(m.Namespace))
 	g.Expect(*m.Spec.Version).To(Equal("v1.17.5"))

api/v1beta1/machinedeployment_webhook.go

@@ -149,7 +149,7 @@ func PopulateDefaultsMachineDeployment(d *MachineDeployment) {
 	if d.Labels == nil {
 		d.Labels = make(map[string]string)
 	}
-	d.Labels[ClusterLabelName] = d.Spec.ClusterName
+	d.Labels[ClusterNameLabel] = d.Spec.ClusterName
 
 	if d.Spec.MinReadySeconds == nil {
 		d.Spec.MinReadySeconds = pointer.Int32(0)
@@ -197,10 +197,10 @@ func PopulateDefaultsMachineDeployment(d *MachineDeployment) {
 	// If no selector has been provided, add label and selector for the
 	// MachineDeployment's name as a default way of providing uniqueness.
 	if len(d.Spec.Selector.MatchLabels) == 0 && len(d.Spec.Selector.MatchExpressions) == 0 {
-		d.Spec.Selector.MatchLabels[MachineDeploymentLabelName] = d.Name
-		d.Spec.Template.Labels[MachineDeploymentLabelName] = d.Name
+		d.Spec.Selector.MatchLabels[MachineDeploymentNameLabel] = d.Name
+		d.Spec.Template.Labels[MachineDeploymentNameLabel] = d.Name
 	}
 	// Make sure selector and template to be in the same cluster.
-	d.Spec.Selector.MatchLabels[ClusterLabelName] = d.Spec.ClusterName
-	d.Spec.Template.Labels[ClusterLabelName] = d.Spec.ClusterName
+	d.Spec.Selector.MatchLabels[ClusterNameLabel] = d.Spec.ClusterName
+	d.Spec.Template.Labels[ClusterNameLabel] = d.Spec.ClusterName
 }

api/v1beta1/machinedeployment_webhook_test.go

@@ -44,13 +44,13 @@ func TestMachineDeploymentDefault(t *testing.T) {
 	t.Run("for MachineDeployment", utildefaulting.DefaultValidateTest(md))
 	md.Default()
 
-	g.Expect(md.Labels[ClusterLabelName]).To(Equal(md.Spec.ClusterName))
+	g.Expect(md.Labels[ClusterNameLabel]).To(Equal(md.Spec.ClusterName))
 	g.Expect(md.Spec.MinReadySeconds).To(Equal(pointer.Int32(0)))
 	g.Expect(md.Spec.RevisionHistoryLimit).To(Equal(pointer.Int32(1)))
 	g.Expect(md.Spec.ProgressDeadlineSeconds).To(Equal(pointer.Int32(600)))
 	g.Expect(md.Spec.Strategy).ToNot(BeNil())
-	g.Expect(md.Spec.Selector.MatchLabels).To(HaveKeyWithValue(MachineDeploymentLabelName, "test-md"))
-	g.Expect(md.Spec.Template.Labels).To(HaveKeyWithValue(MachineDeploymentLabelName, "test-md"))
+	g.Expect(md.Spec.Selector.MatchLabels).To(HaveKeyWithValue(MachineDeploymentNameLabel, "test-md"))
+	g.Expect(md.Spec.Template.Labels).To(HaveKeyWithValue(MachineDeploymentNameLabel, "test-md"))
 	g.Expect(md.Spec.Strategy.Type).To(Equal(RollingUpdateMachineDeploymentStrategyType))
 	g.Expect(md.Spec.Strategy.RollingUpdate).ToNot(BeNil())
 	g.Expect(md.Spec.Strategy.RollingUpdate.MaxSurge.IntValue()).To(Equal(1))
@@ -259,8 +259,8 @@ func TestMachineDeploymentWithSpec(t *testing.T) {
 	}
 
 	md.Default()
-	g.Expect(md.Spec.Selector.MatchLabels).To(HaveKeyWithValue(ClusterLabelName, "test-cluster"))
-	g.Expect(md.Spec.Template.Labels).To(HaveKeyWithValue(ClusterLabelName, "test-cluster"))
+	g.Expect(md.Spec.Selector.MatchLabels).To(HaveKeyWithValue(ClusterNameLabel, "test-cluster"))
+	g.Expect(md.Spec.Template.Labels).To(HaveKeyWithValue(ClusterNameLabel, "test-cluster"))
 }
 
 func TestMachineDeploymentClusterNameImmutable(t *testing.T) {

api/v1beta1/machinehealthcheck_webhook.go

@@ -67,7 +67,7 @@ func (m *MachineHealthCheck) Default() {
 	if m.Labels == nil {
 		m.Labels = make(map[string]string)
 	}
-	m.Labels[ClusterLabelName] = m.Spec.ClusterName
+	m.Labels[ClusterNameLabel] = m.Spec.ClusterName
 
 	if m.Spec.MaxUnhealthy == nil {
 		defaultMaxUnhealthy := intstr.FromString("100%")
@@ -123,7 +123,7 @@ func (m *MachineHealthCheck) validate(old *MachineHealthCheck) error {
 		)
 	}
 
-	if clusterName, ok := m.Spec.Selector.MatchLabels[ClusterLabelName]; ok && clusterName != m.Spec.ClusterName {
+	if clusterName, ok := m.Spec.Selector.MatchLabels[ClusterNameLabel]; ok && clusterName != m.Spec.ClusterName {
 		allErrs = append(
 			allErrs,
 			field.Invalid(specPath.Child("selector"), m.Spec.Selector, "cannot specify a cluster selector other than the one specified by ClusterName"))

api/v1beta1/machinehealthcheck_webhook_test.go

@@ -50,7 +50,7 @@ func TestMachineHealthCheckDefault(t *testing.T) {
 	t.Run("for MachineHealthCheck", utildefaulting.DefaultValidateTest(mhc))
 	mhc.Default()
 
-	g.Expect(mhc.Labels[ClusterLabelName]).To(Equal(mhc.Spec.ClusterName))
+	g.Expect(mhc.Labels[ClusterNameLabel]).To(Equal(mhc.Spec.ClusterName))
 	g.Expect(mhc.Spec.MaxUnhealthy.String()).To(Equal("100%"))
 	g.Expect(mhc.Spec.NodeStartupTimeout).ToNot(BeNil())
 	g.Expect(*mhc.Spec.NodeStartupTimeout).To(Equal(metav1.Duration{Duration: 10 * time.Minute}))
@@ -378,7 +378,7 @@ func TestMachineHealthCheckClusterNameSelectorValidation(t *testing.T) {
 			ClusterName: "foo",
 			Selector: metav1.LabelSelector{
 				MatchLabels: map[string]string{
-					ClusterLabelName: "bar",
+					ClusterNameLabel: "bar",
 					"baz":            "qux",
 				},
 			},
@@ -394,9 +394,9 @@ func TestMachineHealthCheckClusterNameSelectorValidation(t *testing.T) {
 	g.Expect(err).To(HaveOccurred())
 	g.Expect(err.Error()).To(ContainSubstring("cannot specify a cluster selector other than the one specified by ClusterName"))
 
-	mhc.Spec.Selector.MatchLabels[ClusterLabelName] = "foo"
+	mhc.Spec.Selector.MatchLabels[ClusterNameLabel] = "foo"
 	g.Expect(mhc.validate(nil)).To(Succeed())
-	delete(mhc.Spec.Selector.MatchLabels, ClusterLabelName)
+	delete(mhc.Spec.Selector.MatchLabels, ClusterNameLabel)
 	g.Expect(mhc.validate(nil)).To(Succeed())
 }
 

api/v1beta1/machineset_webhook.go

@@ -48,7 +48,7 @@ func (m *MachineSet) Default() {
 	if m.Labels == nil {
 		m.Labels = make(map[string]string)
 	}
-	m.Labels[ClusterLabelName] = m.Spec.ClusterName
+	m.Labels[ClusterNameLabel] = m.Spec.ClusterName
 
 	if m.Spec.DeletePolicy == "" {
 		randomPolicy := string(RandomMachineSetDeletePolicy)
@@ -64,8 +64,8 @@ func (m *MachineSet) Default() {
 	}
 
 	if len(m.Spec.Selector.MatchLabels) == 0 && len(m.Spec.Selector.MatchExpressions) == 0 {
-		m.Spec.Selector.MatchLabels[MachineSetLabelName] = m.Name
-		m.Spec.Template.Labels[MachineSetLabelName] = m.Name
+		m.Spec.Selector.MatchLabels[MachineSetNameLabel] = m.Name
+		m.Spec.Template.Labels[MachineSetNameLabel] = m.Name
 	}
 
 	if m.Spec.Template.Spec.Version != nil && !strings.HasPrefix(*m.Spec.Template.Spec.Version, "v") {