fix comments

apis/v1alpha3/topology_conversion.go

@@ -22,12 +22,5 @@ import (
 )
 
 func Convert_v1beta1_Topology_To_v1alpha3_Topology(in *v1beta1.Topology, out *Topology, s conversion.Scope) error {
-	if len(in.NetworkConfigurations) > 0 {
-		networks := make([]string, len(in.NetworkConfigurations))
-		for i := range in.NetworkConfigurations {
-			networks[i] = in.NetworkConfigurations[i].NetworkName
-		}
-		out.Networks = networks
-	}
-	return nil
+	return autoConvert_v1beta1_Topology_To_v1alpha3_Topology(in, out, s)
 }

apis/v1alpha4/topology_conversion.go

@@ -22,12 +22,5 @@ import (
 )
 
 func Convert_v1beta1_Topology_To_v1alpha4_Topology(in *v1beta1.Topology, out *Topology, s conversion.Scope) error {
-	if len(in.NetworkConfigurations) > 0 {
-		networks := make([]string, len(in.NetworkConfigurations))
-		for i := range in.NetworkConfigurations {
-			networks[i] = in.NetworkConfigurations[i].NetworkName
-		}
-		out.Networks = networks
-	}
-	return nil
+	return autoConvert_v1beta1_Topology_To_v1alpha4_Topology(in, out, s)
 }

apis/v1beta1/vspherefailuredomain_types.go

@@ -82,7 +82,7 @@ type Topology struct {
 	// +optional
 	Networks []string `json:"networks,omitempty"`
 
-	// NetworkConfigurations is a list with new network configurations within this failure domain
+	// NetworkConfigurations is a list of network configurations within this failure domain.
 	// +optional
 	NetworkConfigurations []NetworkConfiguration `json:"networkConfigs,omitempty"`
 
@@ -98,11 +98,11 @@ type NetworkConfiguration struct {
 	// NetworkName is the network name for this machine's VM.
 	NetworkName string `json:"name,omitempty"`
 
-	// DHCP4 is a flag that indicates whether or not to use DHCP for IPv4
+	// DHCP4 is a flag that indicates whether or not to use DHCP for IPv4.
 	// +optional
 	DHCP4 *bool `json:"dhcp4,omitempty"`
 
-	// DHCP6 is a flag that indicates whether or not to use DHCP for IPv6
+	// DHCP6 is a flag that indicates whether or not to use DHCP for IPv6.
 	// +optional
 	DHCP6 *bool `json:"dhcp6,omitempty"`
 

config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherefailuredomains.yaml

@@ -366,8 +366,8 @@ spec:
                     - vmGroupName
                     type: object
                   networkConfigs:
-                    description: NetworkConfigurations is a list with new network
-                      configurations within this failure domain
+                    description: NetworkConfigurations is a list of network configurations
+                      within this failure domain.
                     items:
                       description: |-
                         NetworkConfiguration defines a network configuration that should be used when consuming
@@ -403,7 +403,7 @@ spec:
                           type: array
                         dhcp4:
                           description: DHCP4 is a flag that indicates whether or not
-                            to use DHCP for IPv4
+                            to use DHCP for IPv4.
                           type: boolean
                         dhcp4Overrides:
                           description: |-
@@ -464,7 +464,7 @@ spec:
                           type: object
                         dhcp6:
                           description: DHCP6 is a flag that indicates whether or not
-                            to use DHCP for IPv6
+                            to use DHCP for IPv6.
                           type: boolean
                         dhcp6Overrides:
                           description: |-

controllers/vspheredeploymentzone_controller_domain.go

@@ -95,7 +95,7 @@ func (r vsphereDeploymentZoneReconciler) reconcileTopology(ctx context.Context,
 
 	for _, network := range topology.Networks {
 		if _, err := deploymentZoneCtx.AuthSession.Finder.Network(ctx, network); err != nil {
-			conditions.MarkFalse(deploymentZoneCtx.VSphereDeploymentZone, infrav1.VSphereFailureDomainValidatedCondition, infrav1.NetworkNotFoundReason, clusterv1.ConditionSeverityError, "network %s is misconfigured", network)
+			conditions.MarkFalse(deploymentZoneCtx.VSphereDeploymentZone, infrav1.VSphereFailureDomainValidatedCondition, infrav1.NetworkNotFoundReason, clusterv1.ConditionSeverityError, "network %s is not found", network)
 			return errors.Wrapf(err, "unable to find network %s", network)
 		}
 	}
@@ -105,7 +105,7 @@ func (r vsphereDeploymentZoneReconciler) reconcileTopology(ctx context.Context,
 			continue
 		}
 		if _, err := deploymentZoneCtx.AuthSession.Finder.Network(ctx, networkConfig.NetworkName); err != nil {
-			conditions.MarkFalse(deploymentZoneCtx.VSphereDeploymentZone, infrav1.VSphereFailureDomainValidatedCondition, infrav1.NetworkNotFoundReason, clusterv1.ConditionSeverityError, "network %s is misconfigured", networkConfig.NetworkName)
+			conditions.MarkFalse(deploymentZoneCtx.VSphereDeploymentZone, infrav1.VSphereFailureDomainValidatedCondition, infrav1.NetworkNotFoundReason, clusterv1.ConditionSeverityError, "network %s is not found", networkConfig.NetworkName)
 			return errors.Wrapf(err, "unable to find network %s", networkConfig.NetworkName)
 		}
 	}

pkg/services/vimmachine.go

@@ -440,7 +440,7 @@ func (v *VimMachineService) generateOverrideFunc(ctx context.Context, vimMachine
 			vm.Spec.Network.Devices = overrideNetworkDeviceSpecs(vm.Spec.Network.Devices, vsphereFailureDomain.Spec.Topology.Networks, mergeFailureDomainNetworkName)
 		}
 		if len(vsphereFailureDomain.Spec.Topology.NetworkConfigurations) > 0 {
-			vm.Spec.Network.Devices = overrideNetworkDeviceSpecs(vm.Spec.Network.Devices, vsphereFailureDomain.Spec.Topology.NetworkConfigurations, mergeFailureDomainNetSpecToNetworkDeviceSpec)
+			vm.Spec.Network.Devices = overrideNetworkDeviceSpecs(vm.Spec.Network.Devices, vsphereFailureDomain.Spec.Topology.NetworkConfigurations, mergeNetworkConfigurationInNetworkDeviceSpec)
 		}
 	}
 	return overrideWithFailureDomainFunc, true
@@ -477,39 +477,39 @@ func mergeFailureDomainNetworkName(device *infrav1.NetworkDeviceSpec, network st
 	device.NetworkName = network
 }
 
-func mergeFailureDomainNetSpecToNetworkDeviceSpec(device *infrav1.NetworkDeviceSpec, fd infrav1.NetworkConfiguration) {
+func mergeNetworkConfigurationInNetworkDeviceSpec(device *infrav1.NetworkDeviceSpec, nc infrav1.NetworkConfiguration) {
 	if device == nil {
 		return
 	}
-	if fd.NetworkName != "" {
-		device.NetworkName = fd.NetworkName
+	if nc.NetworkName != "" {
+		device.NetworkName = nc.NetworkName
 	}
-	if fd.DHCP4 != nil {
-		device.DHCP4 = *fd.DHCP4
+	if nc.DHCP4 != nil {
+		device.DHCP4 = *nc.DHCP4
 	}
-	if fd.DHCP6 != nil {
-		device.DHCP6 = *fd.DHCP6
+	if nc.DHCP6 != nil {
+		device.DHCP6 = *nc.DHCP6
 	}
-	if len(fd.Nameservers) > 0 {
-		device.Nameservers = make([]string, len(fd.Nameservers))
-		copy(device.Nameservers, fd.Nameservers)
+	if len(nc.Nameservers) > 0 {
+		device.Nameservers = make([]string, len(nc.Nameservers))
+		copy(device.Nameservers, nc.Nameservers)
 	}
 
-	if len(fd.SearchDomains) > 0 {
-		device.SearchDomains = make([]string, len(fd.SearchDomains))
-		copy(device.SearchDomains, fd.SearchDomains)
+	if len(nc.SearchDomains) > 0 {
+		device.SearchDomains = make([]string, len(nc.SearchDomains))
+		copy(device.SearchDomains, nc.SearchDomains)
 	}
 
-	if fd.DHCP4Overrides != nil {
-		device.DHCP4Overrides = fd.DHCP4Overrides.DeepCopy()
+	if nc.DHCP4Overrides != nil {
+		device.DHCP4Overrides = nc.DHCP4Overrides.DeepCopy()
 	}
 
-	if fd.DHCP6Overrides != nil {
-		device.DHCP6Overrides = fd.DHCP6Overrides.DeepCopy()
+	if nc.DHCP6Overrides != nil {
+		device.DHCP6Overrides = nc.DHCP6Overrides.DeepCopy()
 	}
 
-	if len(fd.AddressesFromPools) > 0 {
-		device.AddressesFromPools = make([]corev1.TypedLocalObjectReference, len(fd.AddressesFromPools))
-		copy(device.AddressesFromPools, fd.AddressesFromPools)
+	if len(nc.AddressesFromPools) > 0 {
+		device.AddressesFromPools = make([]corev1.TypedLocalObjectReference, len(nc.AddressesFromPools))
+		copy(device.AddressesFromPools, nc.AddressesFromPools)
 	}
 }

pkg/services/vimmachine_test.go

@@ -315,12 +315,12 @@ func Test_VimMachineService_GenerateOverrideFunc(t *testing.T) {
 	})
 }
 
-func Test_mergeFailureDomainNetSpecToNetworkDeviceSpec(t *testing.T) {
+func Test_mergeNetworkConfigurationToNetworkDeviceSpec(t *testing.T) {
 	t.Run("device is nil", func(t *testing.T) {
 		g := NewWithT(t)
 
 		var device *infrav1.NetworkDeviceSpec
-		mergeFailureDomainNetSpecToNetworkDeviceSpec(device, infrav1.NetworkConfiguration{
+		mergeNetworkConfigurationInNetworkDeviceSpec(device, infrav1.NetworkConfiguration{
 			NetworkName: "ignored",
 		})
 
@@ -332,7 +332,7 @@ func Test_mergeFailureDomainNetSpecToNetworkDeviceSpec(t *testing.T) {
 
 		device := infrav1.NetworkDeviceSpec{}
 
-		mergeFailureDomainNetSpecToNetworkDeviceSpec(&device, infrav1.NetworkConfiguration{
+		mergeNetworkConfigurationInNetworkDeviceSpec(&device, infrav1.NetworkConfiguration{
 			NetworkName:   "nw-name",
 			DHCP4:         ptr.To(true),
 			DHCP6:         ptr.To(false),