[fix] check machine readiness before adding to DNS (#979)

* fix: check machine readiness before adding to DNS

* Update cloud/services/domains.go

Co-authored-by: Ashley Dumaine <[email protected]>

---------

Co-authored-by: Ashley Dumaine <[email protected]>

Author: tchinmai7

cloud/services/domains.go

@@ -11,7 +11,9 @@ import (
 	"sync"
 
 	"github.com/akamai/AkamaiOPEN-edgegrid-golang/v8/pkg/dns"
+	"github.com/go-logr/logr"
 	"github.com/linode/linodego"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/cluster-api/api/core/v1beta2"
 	kutil "sigs.k8s.io/cluster-api/util"
 
@@ -300,7 +302,16 @@ func removeElement(stringList []string, elemToRemove string) []string {
 	return stringList
 }
 
-func processLinodeMachine(ctx context.Context, cscope *scope.ClusterScope, machine v1alpha2.LinodeMachine, dnsTTLSec int, subdomain string) ([]DNSOptions, error) {
+func isCapiMachineReady(capiMachine *v1beta2.Machine) bool {
+	for _, condition := range capiMachine.Status.Conditions {
+		if condition.Type == v1beta2.ReadyCondition {
+			return condition.Status == metav1.ConditionTrue
+		}
+	}
+	return false
+}
+
+func processLinodeMachine(ctx context.Context, cscope *scope.ClusterScope, machine v1alpha2.LinodeMachine, dnsTTLSec int, subdomain string, firstMachine bool) ([]DNSOptions, error) {
 	// Look up the corresponding CAPI machine, see if it is marked for deletion
 	capiMachine, err := kutil.GetOwnerMachine(ctx, cscope.Client, machine.ObjectMeta)
 	if err != nil {
@@ -312,6 +323,14 @@ func processLinodeMachine(ctx context.Context, cscope *scope.ClusterScope, machi
 		return nil, nil
 	}
 
+	if !firstMachine && !isCapiMachineReady(capiMachine) {
+		// always process the first linodeMachine, and add its IP to the DNS entries.
+		// For other linodeMachine, only process them if the CAPI machine is ready
+		logger := logr.FromContextOrDiscard(ctx)
+		logger.Info("skipping DNS entry creation for LinodeMachine as the CAPI machine is not ready", "LinodeMachine", machine.Name)
+		return nil, nil
+	}
+
 	options := []DNSOptions{}
 	for _, IPs := range machine.Status.Addresses {
 		recordType := linodego.RecordTypeA
@@ -340,8 +359,10 @@ func (d *DNSEntries) getDNSEntriesToEnsure(ctx context.Context, cscope *scope.Cl
 	}
 
 	subDomain := getSubDomain(cscope)
+	firstMachine := true
 	for _, eachMachine := range cscope.LinodeMachines.Items {
-		options, err := processLinodeMachine(ctx, cscope, eachMachine, dnsTTLSec, subDomain)
+		options, err := processLinodeMachine(ctx, cscope, eachMachine, dnsTTLSec, subDomain, firstMachine)
+		firstMachine = false
 		if err != nil {
 			return nil, fmt.Errorf("failed to process LinodeMachine %s: %w", eachMachine.Name, err)
 		}

cloud/services/domains_test.go

@@ -458,6 +458,33 @@ func TestAddIPToDNS(t *testing.T) {
 								},
 							},
 						},
+						{
+							// This machine's CAPI owner is NOT ready, and should NOT have DNS entries
+							ObjectMeta: metav1.ObjectMeta{
+								Name: "test-not-ready-machine",
+								UID:  "test-uid-2",
+								OwnerReferences: []metav1.OwnerReference{
+									{
+										APIVersion: "cluster.x-k8s.io/v1beta1",
+										Kind:       "Machine",
+										Name:       "test-not-ready-machine",
+										UID:        "test-uid-3",
+									},
+								},
+							},
+							Spec: infrav1alpha2.LinodeMachineSpec{
+								ProviderID: ptr.To("linode://4567"),
+								InstanceID: ptr.To(456),
+							},
+							Status: infrav1alpha2.LinodeMachineStatus{
+								Addresses: []clusterv1.MachineAddress{
+									{
+										Type:    "ExternalIP",
+										Address: "10.20.20.22",
+									},
+								},
+							},
+						},
 					},
 				},
 			},
@@ -529,6 +556,18 @@ func TestAddIPToDNS(t *testing.T) {
 								machine.Namespace = "default"
 								machine.UID = "test-uid-2"
 								machine.DeletionTimestamp = nil
+								machine.Status.Conditions = []metav1.Condition{
+									{
+										Type:   clusterv1.ReadyCondition,
+										Status: metav1.ConditionTrue,
+									},
+								}
+							case "test-not-ready-machine":
+								// Set up as a not-ready machine (skipping conditions)
+								machine.Name = "test-not-ready-machine"
+								machine.Namespace = "default"
+								machine.UID = "test-uid-3"
+								machine.DeletionTimestamp = nil
 							}
 						}
 						return nil