Use PortOpts instead of Network in createInstance()

This is a non-functional refactor, as PortOpts was the only field of
Network previously in use apart from ID (the network ID), which is
guaranteed to be set by the prior call to normalizePorts().

Author: mdbooth

pkg/cloud/services/compute/instance.go

@@ -171,42 +171,34 @@ func (s *Service) normalizePorts(ports []infrav1.PortOpts, openStackCluster *inf
 	return normalizedPorts, nil
 }
 
-// constructNetworks builds an array of networks from the network, subnet and ports items in the instance spec.
-// If no networks or ports are in the spec, returns a single network item for a network connection to the default cluster network.
-func (s *Service) constructNetworks(openStackCluster *infrav1.OpenStackCluster, instanceSpec *InstanceSpec) ([]infrav1.Network, error) {
+// constructPorts builds an array of ports from the instance spec.
+// If no ports are in the spec, returns a single port for a network connection to the default cluster network.
+func (s *Service) constructPorts(openStackCluster *infrav1.OpenStackCluster, instanceSpec *InstanceSpec) ([]infrav1.PortOpts, error) {
 	// Ensure user-specified ports have all required fields
 	ports, err := s.normalizePorts(instanceSpec.Ports, openStackCluster, instanceSpec)
 	if err != nil {
 		return nil, err
 	}
-	nets := make([]infrav1.Network, 0, len(ports))
-	for i := range ports {
-		port := &ports[i]
-		nets = append(nets, infrav1.Network{
-			ID:       port.Network.ID,
-			Subnet:   &infrav1.Subnet{},
-			PortOpts: port,
-		})
-	}
 
 	// no networks or ports found in the spec, so create a port on the cluster network
-	if len(nets) == 0 {
-		nets = []infrav1.Network{{
-			ID: openStackCluster.Status.Network.ID,
-			Subnet: &infrav1.Subnet{
-				ID: openStackCluster.Status.Network.Subnet.ID,
-			},
-			PortOpts: &infrav1.PortOpts{
-				Trunk: &instanceSpec.Trunk,
+	if len(ports) == 0 {
+		ports = []infrav1.PortOpts{{
+			Network: &infrav1.NetworkFilter{
+				ID: openStackCluster.Status.Network.ID,
 			},
+			FixedIPs: []infrav1.FixedIP{{
+				Subnet: &infrav1.SubnetFilter{
+					ID: openStackCluster.Status.Network.Subnet.ID,
+				},
+			}},
+			Trunk: &instanceSpec.Trunk,
 		}}
 	}
 
 	// trunk support is required if any port has trunk enabled
 	portUsesTrunk := func() bool {
-		for _, net := range nets {
-			port := net.PortOpts
-			if port != nil && port.Trunk != nil && *port.Trunk {
+		for _, port := range ports {
+			if port.Trunk != nil && *port.Trunk {
 				return true
 			}
 		}
@@ -222,7 +214,7 @@ func (s *Service) constructNetworks(openStackCluster *infrav1.OpenStackCluster,
 		}
 	}
 
-	return nets, nil
+	return ports, nil
 }
 
 func (s *Service) CreateInstance(eventObject runtime.Object, openStackCluster *infrav1.OpenStackCluster, instanceSpec *InstanceSpec, clusterName string, isBastion bool) (*InstanceStatus, error) {
@@ -266,7 +258,7 @@ func (s *Service) createInstanceImpl(eventObject runtime.Object, openStackCluste
 		}
 	}()
 
-	nets, err := s.constructNetworks(openStackCluster, instanceSpec)
+	ports, err := s.constructPorts(openStackCluster, instanceSpec)
 	if err != nil {
 		return nil, err
 	}
@@ -281,16 +273,14 @@ func (s *Service) createInstanceImpl(eventObject runtime.Object, openStackCluste
 		return nil, fmt.Errorf("error getting security groups: %v", err)
 	}
 
-	for i, network := range nets {
-		if network.ID == "" {
-			return nil, fmt.Errorf("no network was found or provided. Please check your machine configuration and try again")
-		}
+	for i := range ports {
+		portOpts := &ports[i]
 		iTags := []string{}
 		if len(instanceSpec.Tags) > 0 {
 			iTags = instanceSpec.Tags
 		}
-		portName := getPortName(instanceSpec.Name, network.PortOpts, i)
-		port, err := networkingService.GetOrCreatePort(eventObject, clusterName, portName, network, securityGroups, iTags)
+		portName := getPortName(instanceSpec.Name, portOpts, i)
+		port, err := networkingService.GetOrCreatePort(eventObject, clusterName, portName, portOpts, securityGroups, iTags)
 		if err != nil {
 			return nil, err
 		}

pkg/cloud/services/networking/port.go

@@ -53,10 +53,12 @@ func (s *Service) GetPortFromInstanceIP(instanceID string, ip string) ([]ports.P
 	return s.client.ListPort(portOpts)
 }
 
-func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string, portName string, net infrav1.Network, instanceSecurityGroups []string, instanceTags []string) (*ports.Port, error) {
+func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string, portName string, portOpts *infrav1.PortOpts, instanceSecurityGroups []string, instanceTags []string) (*ports.Port, error) {
+	networkID := portOpts.Network.ID
+
 	existingPorts, err := s.client.ListPort(ports.ListOpts{
 		Name:      portName,
-		NetworkID: net.ID,
+		NetworkID: networkID,
 	})
 	if err != nil {
 		return nil, fmt.Errorf("searching for existing port for server: %v", err)
@@ -70,12 +72,6 @@ func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string
 		return nil, fmt.Errorf("multiple ports found with name \"%s\"", portName)
 	}
 
-	// no port found, so create the port
-	portOpts := net.PortOpts
-	if portOpts == nil {
-		portOpts = &infrav1.PortOpts{}
-	}
-
 	description := portOpts.Description
 	if description == "" {
 		description = names.GetDescription(clusterName)
@@ -106,7 +102,7 @@ func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string
 	if len(portOpts.FixedIPs) > 0 {
 		fips := make([]ports.IP, 0, len(portOpts.FixedIPs)+1)
 		for _, fixedIP := range portOpts.FixedIPs {
-			subnetID, err := s.getSubnetIDForFixedIP(fixedIP.Subnet, net.ID)
+			subnetID, err := s.getSubnetIDForFixedIP(fixedIP.Subnet, networkID)
 			if err != nil {
 				return nil, err
 			}
@@ -115,9 +111,6 @@ func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string
 				IPAddress: fixedIP.IPAddress,
 			})
 		}
-		if net.Subnet.ID != "" {
-			fips = append(fips, ports.IP{SubnetID: net.Subnet.ID})
-		}
 		fixedIPs = fips
 	}
 
@@ -140,7 +133,7 @@ func (s *Service) GetOrCreatePort(eventObject runtime.Object, clusterName string
 
 	createOpts = ports.CreateOpts{
 		Name:                  portName,
-		NetworkID:             net.ID,
+		NetworkID:             networkID,
 		Description:           description,
 		AdminStateUp:          portOpts.AdminStateUp,
 		MACAddress:            portOpts.MACAddress,