MTV-2025 | NICs mapping is unordered

Issue:
When migrating VMs with multiple NICs the mapping  order must match source VM order

Fix:
Since rhel 6 swapping/renaming devices isn't supported anymore due to kernel issues.
Since we can't prevent that we will add a validation to the NICs mapping to make sure the order is correct,
if not we'll issue a warning during migration plan's creation so the user will be aware and could
work this around by creating the network map in the same order as source VM.

Ref: https://issues.redhat.com/browse/MTV-2025

Author: Hazanel

pkg/controller/plan/adapter/base/doc.go

@@ -142,6 +142,8 @@ type Validator interface {
 	DirectStorage(vmRef ref.Ref) (bool, error)
 	// Validate that a VM's networks have been mapped.
 	NetworksMapped(vmRef ref.Ref) (bool, error)
+	// Validate the network mapping order.
+	NetworkMappingOrder(vmRef ref.Ref) (bool, []string, error)
 	// Validate that a VM's Host isn't in maintenance mode.
 	MaintenanceMode(vmRef ref.Ref) (bool, error)
 	// Validate whether warm migration is supported from this provider type.

pkg/controller/plan/adapter/ocp/validator.go

@@ -203,3 +203,8 @@ func (r *Validator) StaticIPs(vmRef ref.Ref) (bool, error) {
 func (r *Validator) ChangeTrackingEnabled(vmRef ref.Ref) (bool, error) {
 	return true, nil
 }
+
+// NO-OP
+func (r *Validator) NetworkMappingOrder(vmRef ref.Ref) (bool, []string, error) {
+	return true, nil, nil
+}

pkg/controller/plan/adapter/openstack/validator.go

@@ -127,3 +127,8 @@ func (r *Validator) StaticIPs(vmRef ref.Ref) (bool, error) {
 func (r *Validator) ChangeTrackingEnabled(vmRef ref.Ref) (bool, error) {
 	return true, nil
 }
+
+// NO-OP
+func (r *Validator) NetworkMappingOrder(vmRef ref.Ref) (bool, []string, error) {
+	return true, nil, nil
+}

pkg/controller/plan/adapter/ova/validator.go

@@ -118,3 +118,8 @@ func (r *Validator) ChangeTrackingEnabled(vmRef ref.Ref) (bool, error) {
 	// Validate that the vm has the change tracking enabled
 	return true, nil
 }
+
+// NO-OP
+func (r *Validator) NetworkMappingOrder(vmRef ref.Ref) (bool, []string, error) {
+	return true, nil, nil
+}

pkg/controller/plan/adapter/ovirt/validator.go

@@ -184,3 +184,8 @@ func (r *Validator) ChangeTrackingEnabled(vmRef ref.Ref) (bool, error) {
 	// Validate that the vm has the change tracking enabled
 	return true, nil
 }
+
+// NO-OP
+func (r *Validator) NetworkMappingOrder(vmRef ref.Ref) (bool, []string, error) {
+	return true, nil, nil
+}

pkg/controller/plan/adapter/vsphere/validator.go

@@ -34,6 +34,51 @@ func (r *Validator) WarmMigration() (ok bool) {
 	return
 }
 
+// Validate the VM's network mapping order.
+func (r *Validator) NetworkMappingOrder(vmRef ref.Ref) (ok bool, correctOrder []string, err error) {
+	if r.plan.Referenced.Map.Network == nil {
+		return false, nil, nil
+	}
+
+	vm := &model.VM{}
+	err = r.inventory.Find(vm, vmRef)
+	if err != nil {
+		return false, nil, liberr.Wrap(err, "vm", vmRef.String())
+	}
+
+	mapping := r.plan.Referenced.Map.Network.Spec.Map
+
+	// Ensure both lists are of equal length
+	if len(vm.NICs) != len(mapping) {
+		return false, nil, nil
+	}
+
+	// Create a slice to store the correct order of network IDs
+	correctOrder = make([]string, len(vm.NICs))
+	for i, nic := range vm.NICs {
+		correctOrder[i] = nic.Network.ID
+	}
+
+	// Iterate by index to ensure one-to-one mapping
+	for i := range mapping {
+		mapped := &mapping[i]
+		network := &model.Network{}
+		// Fetch the network at the corresponding index
+		fErr := r.inventory.Find(network, mapped.Source)
+		if fErr != nil {
+			return false, nil, fErr
+		}
+
+		// Ensure NIC and network IDs match exactly at the same index
+		if vm.NICs[i].Network.ID != network.ID {
+			return false, correctOrder, nil // Mismatch found, return the failing NIC
+		}
+	}
+
+	ok = true
+	return ok, nil, nil
+}
+
 // Validate that a VM's networks have been mapped.
 func (r *Validator) NetworksMapped(vmRef ref.Ref) (ok bool, err error) {
 	if r.plan.Referenced.Map.Network == nil {

pkg/controller/plan/validation.go

@@ -10,6 +10,7 @@ import (
 	"net"
 	"path"
 	"strconv"
+	"strings"
 	"text/template"
 
 	k8snet "github.com/k8snetworkplumbingwg/network-attachment-definition-client/pkg/apis/k8s.cni.cncf.io/v1"
@@ -78,6 +79,7 @@ const (
 	ValidatingVDDK                = "ValidatingVDDK"
 	VDDKInitImageNotReady         = "VDDKInitImageNotReady"
 	VDDKInitImageUnavailable      = "VDDKInitImageUnavailable"
+	NetMapOrder                   = "NetworkMapUnordered"
 )
 
 // Categories
@@ -573,6 +575,13 @@ func (r *Reconciler) validateVM(plan *api.Plan) error {
 		Status:   True,
 		Category: Warn,
 		Message:  "VMs with shared disk can not be migrated.", // This should be set by the provider validator
+	}
+	unorderedNics := libcnd.Condition{
+		Type:     NetMapOrder,
+		Status:   True,
+		Reason:   NotValid,
+		Category: Warn,
+		Message:  "VM network mapping is unordered.",
 		Items:    []string{},
 	}
 
@@ -660,6 +669,14 @@ func (r *Reconciler) validateVM(plan *api.Plan) error {
 			if !ok {
 				multiplePodNetworkMappings.Items = append(multiplePodNetworkMappings.Items, ref.String())
 			}
+			ok, correctOrder, err := validator.NetworkMappingOrder(*ref)
+			if err != nil {
+				return err
+			}
+			if !ok {
+				unorderedNics.Message += fmt.Sprintf("\n Expected order: %s", strings.Join(correctOrder, ", "))
+				unorderedNics.Items = append(unorderedNics.Items, ref.String())
+			}
 		}
 		if plan.Referenced.Map.Storage != nil {
 			ok, err := validator.StorageMapped(*ref)
@@ -829,6 +846,8 @@ func (r *Reconciler) validateVM(plan *api.Plan) error {
 	}
 	if len(targetNameNotUnique.Items) > 0 {
 		plan.Status.SetCondition(targetNameNotUnique)
+	if len(unorderedNics.Items) > 0 {
+		plan.Status.SetCondition(unorderedNics)
 	}
 
 	return nil

pkg/controller/provider/container/vsphere/model.go

@@ -717,6 +717,7 @@ func (v *VmAdapter) Apply(u types.ObjectUpdate) {
 				if devArray, cast := p.Val.(types.ArrayOfVirtualDevice); cast {
 					devList := []model.Device{}
 					nicList := []model.NIC{}
+					nicsIndex := 0
 					for _, dev := range devArray.VirtualDevice {
 						var nic *types.VirtualEthernetCard
 						switch device := dev.(type) {
@@ -763,12 +764,14 @@ func (v *VmAdapter) Apply(u types.ObjectUpdate) {
 							nicList = append(
 								nicList,
 								model.NIC{
-									MAC: nic.MacAddress,
+									MAC:   nic.MacAddress,
+									Order: strconv.Itoa(nicsIndex),
 									Network: model.Ref{
 										Kind: model.NetKind,
 										ID:   network,
 									},
 								})
+							nicsIndex++
 						}
 					}
 					v.model.Devices = devList

pkg/controller/provider/model/vsphere/model.go

@@ -305,6 +305,7 @@ type Device struct {
 type NIC struct {
 	Network Ref    `json:"network"`
 	MAC     string `json:"mac"`
+	Order   string `json:"order"`
 }
 
 // Guest network.