Add trunk subports support for OpenStackMachine ports

This adds the ability to specify subports when creating trunk ports.
Users can now define VLAN subports that will be attached to the trunk
when the port is created.

Example usage:
  ports:
  - network:
      filter:
        name: foo_vlan_300
    trunk: true
    subports:
    - network:
        filter:
          name: bar_vlan_301
      segmentationID: 301
      segmentationType: "vlan"

- Added SubportOpts and ResolvedSubportSpec types to API
- Since sub-ports and ports are essentially the same entities
  CommonPortOpts and CommonResolvedPortSpec types were introduced as a
  basis for regular ports and trunk subports
- Added SubPortStatus to keep track of ports which are associated with
  trunk
- Introduced separate method for adding supports to trunk
- Added AddSubports method to NetworkClient interface
- Added validation to ensure subports require trunk enabled
- Updated port normalization to resolve subports

Author: pbasov

api/v1alpha1/zz_generated.deepcopy.go

@@ -96,6 +96,12 @@ func TestFuzzyConversion(t *testing.T) {
 				// None of the following identityRef fields have ever been set in v1alpha7
 				identityRef.Region = ""
 			},
+			func(portOpts *infrav1.PortOpts, c fuzz.Continue) {
+				c.FuzzNoCustom(portOpts)
+
+				// None of the following PortOpts fields have ever been set in v1alpha7
+				portOpts.Subports = nil
+			},
 		}
 
 		return slices.Concat(v1alpha7FuzzerFuncs, testhelpers.InfraV1FuzzerFuncs())

api/v1alpha7/conversion_test.go

@@ -18,10 +18,12 @@ package v1alpha7
 
 import (
 	"errors"
+	unsafe "unsafe"
 
 	apiconversion "k8s.io/apimachinery/pkg/conversion"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
+	v1beta1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/conversioncommon"
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/optional"
 )
@@ -426,6 +428,35 @@ func Convert_v1alpha7_PortOpts_To_v1beta1_PortOpts(in *PortOpts, out *infrav1.Po
 		}
 	}
 
+	if in.Network != nil {
+		in, out := &in.Network, &out.Network
+		*out = new(v1beta1.NetworkParam)
+		if err := Convert_v1alpha7_NetworkFilter_To_v1beta1_NetworkParam(*in, *out, s); err != nil {
+			return err
+		}
+	} else {
+		out.Network = nil
+	}
+	if err := optional.Convert_string_To_optional_String(&in.NameSuffix, &out.NameSuffix, s); err != nil {
+		return err
+	}
+	if err := optional.Convert_string_To_optional_String(&in.Description, &out.Description, s); err != nil {
+		return err
+	}
+
+	if in.FixedIPs != nil {
+		in, out := &in.FixedIPs, &out.FixedIPs
+		*out = make([]v1beta1.FixedIP, len(*in))
+		for i := range *in {
+			if err := Convert_v1alpha7_FixedIP_To_v1beta1_FixedIP(&(*in)[i], &(*out)[i], s); err != nil {
+				return err
+			}
+		}
+	} else {
+		out.FixedIPs = nil
+	}
+	out.Tags = *(*[]string)(unsafe.Pointer(&in.Tags))
+
 	return nil
 }
 
@@ -482,6 +513,34 @@ func Convert_v1beta1_PortOpts_To_v1alpha7_PortOpts(in *infrav1.PortOpts, out *Po
 		}
 	}
 
+	if in.Network != nil {
+		in, out := &in.Network, &out.Network
+		*out = new(NetworkFilter)
+		if err := Convert_v1beta1_NetworkParam_To_v1alpha7_NetworkFilter(*in, *out, s); err != nil {
+			return err
+		}
+	} else {
+		out.Network = nil
+	}
+	if err := optional.Convert_optional_String_To_string(&in.Description, &out.Description, s); err != nil {
+		return err
+	}
+	if err := optional.Convert_optional_String_To_string(&in.NameSuffix, &out.NameSuffix, s); err != nil {
+		return err
+	}
+	if in.FixedIPs != nil {
+		in, out := &in.FixedIPs, &out.FixedIPs
+		*out = make([]FixedIP, len(*in))
+		for i := range *in {
+			if err := Convert_v1beta1_FixedIP_To_v1alpha7_FixedIP(&(*in)[i], &(*out)[i], s); err != nil {
+				return err
+			}
+		}
+	} else {
+		out.FixedIPs = nil
+	}
+	out.Tags = *(*[]string)(unsafe.Pointer(&in.Tags))
+
 	return nil
 }
 

api/v1alpha7/types_conversion.go

@@ -290,7 +290,7 @@ type AllocationPool struct {
 	End string `json:"end"`
 }
 
-type PortOpts struct {
+type CommonPortOpts struct {
 	// Network is a query for an openstack network that the port will be created or discovered on.
 	// This will fail if the query returns more than one network.
 	// +optional
@@ -320,13 +320,41 @@ type PortOpts struct {
 	// +optional
 	Tags []string `json:"tags,omitempty"`
 
+	ResolvedPortSpecFields `json:",inline"`
+}
+
+// PortOpts defines port parameters.
+type PortOpts struct {
 	// Trunk specifies whether trunking is enabled at the port level. If not
 	// provided the value is inherited from the machine, or false for a
 	// bastion host.
 	// +optional
 	Trunk *bool `json:"trunk,omitempty"`
 
-	ResolvedPortSpecFields `json:",inline"`
+	// Subports is a list of port specifications that will be created as
+	// subports of the trunk.
+	// +optional
+	// +listType=atomic
+	Subports []SubportOpts `json:"subports,omitempty"`
+
+	CommonPortOpts `json:",inline"`
+}
+
+// SubportOpts defines a trunk subport.
+type SubportOpts struct {
+	// SegmentationID is the segmentation ID of the subport. E.g. VLAN ID.
+	// +required
+	// +kubebuilder:validation:Minimum:=1
+	// +kubebuilder:validation:Maximum:=4094
+	SegmentationID int `json:"segmentationID"`
+
+	// SegmentationType is the segmentation type of the subport. E.g. "vlan".
+	// +required
+	// +kubebuilder:validation:Enum=vlan;flat
+	SegmentationType string `json:"segmentationType"`
+
+	// Port contains parameters of the port associated with this subport
+	CommonPortOpts `json:",inline"`
 }
 
 // ResolvePortSpecFields is a convenience struct containing all fields of a
@@ -393,7 +421,7 @@ type ResolvedPortSpecFields struct {
 }
 
 // ResolvedPortSpec is a PortOpts with all contained references fully resolved.
-type ResolvedPortSpec struct {
+type CommonResolvedPortSpec struct {
 	// Name is the name of the port.
 	Name string `json:"name"`
 
@@ -408,10 +436,6 @@ type ResolvedPortSpec struct {
 	// +optional
 	Tags []string `json:"tags,omitempty"`
 
-	// Trunk specifies whether trunking is enabled at the port level.
-	// +optional
-	Trunk optional.Bool `json:"trunk,omitempty"`
-
 	// FixedIPs is a list of pairs of subnet and/or IP address to assign to the port. If specified, these must be subnets of the port's network.
 	// +optional
 	// +listType=atomic
@@ -425,10 +449,47 @@ type ResolvedPortSpec struct {
 	ResolvedPortSpecFields `json:",inline"`
 }
 
+type ResolvedPortSpec struct {
+	// Trunk specifies whether trunking is enabled at the port level.
+	// +optional
+	Trunk optional.Bool `json:"trunk,omitempty"`
+
+	// Subports is a list of resolved port specifications that will be created as
+	// subports of the trunk.
+	// +optional
+	// +listType=atomic
+	Subports []ResolvedSubportSpec `json:"subports,omitempty"`
+
+	CommonResolvedPortSpec `json:",inline"`
+}
+
+// ResolvedSubportSpec is a SubportOpts with all contained references fully resolved.
+type ResolvedSubportSpec struct {
+	// SegmentationID is the segmentation ID of the subport. E.g. VLAN ID.
+	SegmentationID int `json:"segmentationID"`
+
+	// SegmentationType is the segmentation type of the subport. E.g. "vlan".
+	SegmentationType string `json:"segmentationType"`
+
+	// Port is a PortOpts with all contained references fully resolved. This is
+	// essentially port which is used as subport in trunk
+	CommonResolvedPortSpec `json:",inline"`
+}
+
 type PortStatus struct {
 	// ID is the unique identifier of the port.
 	// +required
 	ID string `json:"id"`
+
+	// Subports is the list of port IDs which intended to be trunk sub-ports
+	// +optional
+	Subports []SubPortStatus `json:"subports,omitempty"`
+}
+
+type SubPortStatus struct {
+	// ID is the unique identifier of the trunk sub-port.
+	// +required
+	ID string `json:"id"`
 }
 
 type BindingProfile struct {