deprecate ProviderID (#469)

linode · Aug 20, 2024 · 98b4e79 · 98b4e79
1 parent 9e2fb06
commit 98b4e79
Show file tree

Hide file tree

Showing 11 changed files with 176 additions and 79 deletions.
diff --git a/api/v1alpha1/linodemachine_conversion_test.go b/api/v1alpha1/linodemachine_conversion_test.go
@@ -40,7 +40,6 @@ func TestLinodeMachineConvertTo(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{Name: "test-machine"},
 		Spec: LinodeMachineSpec{
 			ProviderID:      ptr.To("linode://1234"),
-			InstanceID:      ptr.To(1234),
 			Region:          "us-mia",
 			Type:            "g6-standard-2",
 			Group:           "",
@@ -82,7 +81,6 @@ func TestLinodeMachineConvertTo(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{Name: "test-machine"},
 		Spec: infrav1alpha2.LinodeMachineSpec{
 			ProviderID:      ptr.To("linode://1234"),
-			InstanceID:      ptr.To(1234),
 			Region:          "us-mia",
 			Type:            "g6-standard-2",
 			Group:           "",
@@ -168,7 +166,6 @@ func TestLinodeMachineConvertFrom(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{Name: "test-machine"},
 		Spec: infrav1alpha2.LinodeMachineSpec{
 			ProviderID:      ptr.To("linode://1234"),
-			InstanceID:      ptr.To(1234),
 			Region:          "us-mia",
 			Type:            "g6-standard-2",
 			Group:           "",
@@ -215,7 +212,6 @@ func TestLinodeMachineConvertFrom(t *testing.T) {
 		ObjectMeta: metav1.ObjectMeta{Name: "test-machine"},
 		Spec: LinodeMachineSpec{
 			ProviderID:      ptr.To("linode://1234"),
-			InstanceID:      ptr.To(1234),
 			Region:          "us-mia",
 			Type:            "g6-standard-2",
 			Group:           "",

diff --git a/api/v1alpha1/linodemachinetemplate_conversion_test.go b/api/v1alpha1/linodemachinetemplate_conversion_test.go
@@ -42,7 +42,6 @@ func TestLinodeMachineTemplateConvertTo(t *testing.T) {
 			Template: LinodeMachineTemplateResource{
 				Spec: LinodeMachineSpec{
 					ProviderID:      ptr.To("linode://1234"),
-					InstanceID:      ptr.To(1234),
 					Region:          "us-mia",
 					Type:            "g6-standard-2",
 					Group:           "",
@@ -87,7 +86,6 @@ func TestLinodeMachineTemplateConvertTo(t *testing.T) {
 			Template: infrav1alpha2.LinodeMachineTemplateResource{
 				Spec: infrav1alpha2.LinodeMachineSpec{
 					ProviderID:      ptr.To("linode://1234"),
-					InstanceID:      ptr.To(1234),
 					Region:          "us-mia",
 					Type:            "g6-standard-2",
 					Group:           "",
@@ -176,7 +174,6 @@ func TestLinodeMachineTemplateConvertFrom(t *testing.T) {
 			Template: infrav1alpha2.LinodeMachineTemplateResource{
 				Spec: infrav1alpha2.LinodeMachineSpec{
 					ProviderID:      ptr.To("linode://1234"),
-					InstanceID:      ptr.To(1234),
 					Region:          "us-mia",
 					Type:            "g6-standard-2",
 					Group:           "",
@@ -221,7 +218,6 @@ func TestLinodeMachineTemplateConvertFrom(t *testing.T) {
 			Template: LinodeMachineTemplateResource{
 				Spec: LinodeMachineSpec{
 					ProviderID:      ptr.To("linode://1234"),
-					InstanceID:      ptr.To(1234),
 					Region:          "us-mia",
 					Type:            "g6-standard-2",
 					Group:           "",

diff --git a/api/v1alpha2/linodemachine_types.go b/api/v1alpha2/linodemachine_types.go
@@ -38,6 +38,7 @@ type LinodeMachineSpec struct {
 	ProviderID *string `json:"providerID,omitempty"`
 	// InstanceID is the Linode instance ID for this machine.
 	// +optional
+	// +kubebuilder:deprecatedversion:warning="ProviderID deprecates InstanceID"
 	InstanceID *int `json:"instanceID,omitempty"`
 
 	// +kubebuilder:validation:Required
@@ -215,7 +216,7 @@ type LinodeMachineStatus struct {
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this LinodeMachine belongs"
 // +kubebuilder:printcolumn:name="State",type="string",JSONPath=".status.instanceState",description="Linode instance state"
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Machine ready status"
-// +kubebuilder:printcolumn:name="InstanceID",type="string",JSONPath=".spec.providerID",description="Linode instance ID"
+// +kubebuilder:printcolumn:name="ProviderID",type="string",JSONPath=".spec.providerID",description="Provider ID"
 // +kubebuilder:printcolumn:name="Machine",type="string",JSONPath=".metadata.ownerReferences[?(@.kind==\"Machine\")].name",description="Machine object which owns with this LinodeMachine"
 
 // LinodeMachine is the Schema for the linodemachines API

diff --git a/cloud/services/domains_test.go b/cloud/services/domains_test.go
@@ -66,7 +66,7 @@ func TestAddIPToEdgeDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -129,7 +129,7 @@ func TestAddIPToEdgeDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -228,7 +228,7 @@ func TestRemoveIPFromEdgeDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -298,7 +298,7 @@ func TestRemoveIPFromEdgeDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -398,7 +398,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -472,7 +472,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -545,7 +545,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -613,7 +613,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -687,7 +687,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -754,7 +754,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: nil,
@@ -811,7 +811,7 @@ func TestAddIPToDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -916,7 +916,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -991,7 +991,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -1066,7 +1066,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -1113,7 +1113,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -1174,7 +1174,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{
@@ -1240,7 +1240,7 @@ func TestDeleteIPFromDNS(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 					Status: infrav1alpha2.LinodeMachineStatus{
 						Addresses: []clusterv1.MachineAddress{

diff --git a/cloud/services/loadbalancers.go b/cloud/services/loadbalancers.go
@@ -122,8 +122,13 @@ func AddNodeToNB(
 		return nil
 	}
 
+	instanceID, err := util.GetInstanceID(machineScope.LinodeMachine.Spec.ProviderID)
+	if err != nil {
+		logger.Error(err, "Failed to parse instance ID from provider ID")
+		return err
+	}
 	// Get the private IP that was assigned
-	addresses, err := machineScope.LinodeClient.GetInstanceIPAddresses(ctx, *machineScope.LinodeMachine.Spec.InstanceID)
+	addresses, err := machineScope.LinodeClient.GetInstanceIPAddresses(ctx, instanceID)
 	if err != nil {
 		logger.Error(err, "Failed get instance IP addresses")
 
@@ -200,11 +205,16 @@ func DeleteNodeFromNB(
 		return nil
 	}
 
-	err := machineScope.LinodeClient.DeleteNodeBalancerNode(
+	instanceID, err := util.GetInstanceID(machineScope.LinodeMachine.Spec.ProviderID)
+	if err != nil {
+		logger.Error(err, "Failed to parse instance ID from provider ID")
+		return err
+	}
+	err = machineScope.LinodeClient.DeleteNodeBalancerNode(
 		ctx,
 		*machineScope.LinodeCluster.Spec.Network.NodeBalancerID,
 		*machineScope.LinodeCluster.Spec.Network.ApiserverNodeBalancerConfigID,
-		*machineScope.LinodeMachine.Spec.InstanceID,
+		instanceID,
 	)
 	if util.IgnoreLinodeAPIError(err, http.StatusNotFound) != nil {
 		logger.Error(err, "Failed to update Node Balancer")
@@ -217,7 +227,7 @@ func DeleteNodeFromNB(
 			ctx,
 			*machineScope.LinodeCluster.Spec.Network.NodeBalancerID,
 			*portConfig.NodeBalancerConfigID,
-			*machineScope.LinodeMachine.Spec.InstanceID,
+			instanceID,
 		)
 		if util.IgnoreLinodeAPIError(err, http.StatusNotFound) != nil {
 			logger.Error(err, "Failed to update Node Balancer")

diff --git a/cloud/services/loadbalancers_test.go b/cloud/services/loadbalancers_test.go
@@ -450,7 +450,7 @@ func TestAddNodeToNBConditions(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -488,7 +488,7 @@ func TestAddNodeToNBConditions(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -522,7 +522,7 @@ func TestAddNodeToNBConditions(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -631,7 +631,7 @@ func TestAddNodeToNBFullWorkflow(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -687,7 +687,7 @@ func TestAddNodeToNBFullWorkflow(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 			},
@@ -782,7 +782,7 @@ func TestDeleteNodeFromNB(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 				LinodeCluster: &infrav1alpha2.LinodeCluster{
@@ -818,7 +818,7 @@ func TestDeleteNodeFromNB(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 				LinodeCluster: &infrav1alpha2.LinodeCluster{
@@ -867,7 +867,7 @@ func TestDeleteNodeFromNB(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 				LinodeCluster: &infrav1alpha2.LinodeCluster{
@@ -910,7 +910,7 @@ func TestDeleteNodeFromNB(t *testing.T) {
 						UID:  "test-uid",
 					},
 					Spec: infrav1alpha2.LinodeMachineSpec{
-						InstanceID: ptr.To(123),
+						ProviderID: ptr.To("linode://123"),
 					},
 				},
 				LinodeCluster: &infrav1alpha2.LinodeCluster{

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_linodemachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_linodemachines.yaml
@@ -399,9 +399,9 @@ spec:
       jsonPath: .status.ready
       name: Ready
       type: string
-    - description: Linode instance ID
+    - description: Provider ID
       jsonPath: .spec.providerID
-      name: InstanceID
+      name: ProviderID
       type: string
     - description: Machine object which owns with this LinodeMachine
       jsonPath: .metadata.ownerReferences[?(@.kind=="Machine")].name