api: Add ServerGroupFilter

Allow users to request Server Groups by either name or ID. This aligns
us with the pattern of filters used for other resources such as Security
Groups and Ports.

Additionally `ReferencedResources` field is added to `BastionStatus` and
`OpenStackMachineStatus` as a container to hold all the IDs of resources
computed by the controllers. `ServerGroupID` is the first field added
there.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

api/v1alpha5/conversion.go

@@ -213,7 +213,16 @@ func Convert_v1alpha8_PortOpts_To_v1alpha5_PortOpts(in *infrav1.PortOpts, out *P
 }
 
 func Convert_v1alpha5_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *OpenStackMachineSpec, out *infrav1.OpenStackMachineSpec, s conversion.Scope) error {
-	return autoConvert_v1alpha5_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in, out, s)
+	err := autoConvert_v1alpha5_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.ServerGroupID != "" {
+		out.ServerGroup = &infrav1.ServerGroupFilter{ID: in.ServerGroupID}
+	}
+
+	return nil
 }
 
 func Convert_v1alpha8_APIServerLoadBalancer_To_v1alpha5_APIServerLoadBalancer(in *infrav1.APIServerLoadBalancer, out *APIServerLoadBalancer, s conversion.Scope) error {
@@ -246,6 +255,7 @@ func Convert_v1alpha5_Instance_To_v1alpha8_BastionStatus(in *Instance, out *infr
 	out.State = infrav1.InstanceState(in.State)
 	out.IP = in.IP
 	out.FloatingIP = in.FloatingIP
+	out.ReferencedResources.ServerGroupID = in.ServerGroupID
 	return nil
 }
 
@@ -257,6 +267,7 @@ func Convert_v1alpha8_BastionStatus_To_v1alpha5_Instance(in *infrav1.BastionStat
 	out.State = InstanceState(in.State)
 	out.IP = in.IP
 	out.FloatingIP = in.FloatingIP
+	out.ServerGroupID = in.ReferencedResources.ServerGroupID
 	return nil
 }
 
@@ -435,5 +446,19 @@ func Convert_v1alpha5_OpenStackClusterStatus_To_v1alpha8_OpenStackClusterStatus(
 }
 
 func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in *infrav1.OpenStackMachineSpec, out *OpenStackMachineSpec, s conversion.Scope) error {
-	return autoConvert_v1alpha8_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in, out, s)
+	err := autoConvert_v1alpha8_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.ServerGroup != nil {
+		out.ServerGroupID = in.ServerGroup.ID
+	}
+
+	return nil
+}
+
+func Convert_v1alpha8_OpenStackMachineStatus_To_v1alpha5_OpenStackMachineStatus(in *infrav1.OpenStackMachineStatus, out *OpenStackMachineStatus, s conversion.Scope) error {
+	// ReferencedResources have no equivalent in v1alpha5
+	return autoConvert_v1alpha8_OpenStackMachineStatus_To_v1alpha5_OpenStackMachineStatus(in, out, s)
 }

api/v1alpha5/conversion_test.go

@@ -79,7 +79,7 @@ func TestConvertFrom(t *testing.T) {
 				Spec: OpenStackMachineSpec{},
 				ObjectMeta: metav1.ObjectMeta{
 					Annotations: map[string]string{
-						"cluster.x-k8s.io/conversion-data": "{\"spec\":{\"cloudName\":\"\",\"flavor\":\"\"},\"status\":{\"ready\":false}}",
+						"cluster.x-k8s.io/conversion-data": "{\"spec\":{\"cloudName\":\"\",\"flavor\":\"\"},\"status\":{\"ready\":false,\"referencedResources\":{}}}",
 					},
 				},
 			},

api/v1alpha5/zz_generated.conversion.go

@@ -362,6 +362,10 @@ func Convert_v1alpha6_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *
 		// Networks were previously created first, so need to come before ports
 		out.Ports = append(ports, out.Ports...)
 	}
+
+	if in.ServerGroupID != "" {
+		out.ServerGroup = &infrav1.ServerGroupFilter{ID: in.ServerGroupID}
+	}
 	return nil
 }
 
@@ -480,6 +484,7 @@ func Convert_v1alpha6_Instance_To_v1alpha8_BastionStatus(in *Instance, out *infr
 	out.State = infrav1.InstanceState(in.State)
 	out.IP = in.IP
 	out.FloatingIP = in.FloatingIP
+	out.ReferencedResources.ServerGroupID = in.ServerGroupID
 	return nil
 }
 
@@ -491,6 +496,7 @@ func Convert_v1alpha8_BastionStatus_To_v1alpha6_Instance(in *infrav1.BastionStat
 	out.State = InstanceState(in.State)
 	out.IP = in.IP
 	out.FloatingIP = in.FloatingIP
+	out.ServerGroupID = in.ReferencedResources.ServerGroupID
 	return nil
 }
 
@@ -657,5 +663,19 @@ func Convert_v1alpha6_OpenStackClusterStatus_To_v1alpha8_OpenStackClusterStatus(
 }
 
 func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in *infrav1.OpenStackMachineSpec, out *OpenStackMachineSpec, s apiconversion.Scope) error {
-	return autoConvert_v1alpha8_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in, out, s)
+	err := autoConvert_v1alpha8_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.ServerGroup != nil {
+		out.ServerGroupID = in.ServerGroup.ID
+	}
+
+	return nil
+}
+
+func Convert_v1alpha8_OpenStackMachineStatus_To_v1alpha6_OpenStackMachineStatus(in *infrav1.OpenStackMachineStatus, out *OpenStackMachineStatus, s apiconversion.Scope) error {
+	// ReferencedResources have no equivalent in v1alpha7
+	return autoConvert_v1alpha8_OpenStackMachineStatus_To_v1alpha6_OpenStackMachineStatus(in, out, s)
 }

api/v1alpha6/conversion.go

@@ -88,6 +88,13 @@ func TestFuzzyConversion(t *testing.T) {
 					status.ExternalNetwork.APIServerLoadBalancer = nil
 				}
 			},
+
+			func(v1alpha8Bastion *infrav1.Bastion, c fuzz.Continue) {
+				c.FuzzNoCustom(v1alpha8Bastion)
+
+				// None of the following fields have ever been set in v1alpha6
+				v1alpha8Bastion.Instance.ServerGroup.Name = ""
+			},
 		}
 	}
 

api/v1alpha6/conversion_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha7
 
 import (
+	apiconversion "k8s.io/apimachinery/pkg/conversion"
 	ctrlconversion "sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha8"
@@ -232,3 +233,39 @@ func (r *OpenStackMachineTemplateList) ConvertFrom(srcRaw ctrlconversion.Hub) er
 	src := srcRaw.(*infrav1.OpenStackMachineTemplateList)
 	return Convert_v1alpha8_OpenStackMachineTemplateList_To_v1alpha7_OpenStackMachineTemplateList(src, r, nil)
 }
+
+func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha7_OpenStackMachineSpec(in *infrav1.OpenStackMachineSpec, out *OpenStackMachineSpec, s apiconversion.Scope) error {
+	err := autoConvert_v1alpha8_OpenStackMachineSpec_To_v1alpha7_OpenStackMachineSpec(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.ServerGroup != nil {
+		out.ServerGroupID = in.ServerGroup.ID
+	}
+
+	return nil
+}
+
+func Convert_v1alpha7_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *OpenStackMachineSpec, out *infrav1.OpenStackMachineSpec, s apiconversion.Scope) error {
+	err := autoConvert_v1alpha7_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.ServerGroupID != "" {
+		out.ServerGroup = &infrav1.ServerGroupFilter{ID: in.ServerGroupID}
+	}
+
+	return nil
+}
+
+func Convert_v1alpha8_OpenStackMachineStatus_To_v1alpha7_OpenStackMachineStatus(in *infrav1.OpenStackMachineStatus, out *OpenStackMachineStatus, s apiconversion.Scope) error {
+	// ReferencedResources have no equivalent in v1alpha7
+	return autoConvert_v1alpha8_OpenStackMachineStatus_To_v1alpha7_OpenStackMachineStatus(in, out, s)
+}
+
+func Convert_v1alpha8_BastionStatus_To_v1alpha7_BastionStatus(in *infrav1.BastionStatus, out *BastionStatus, s apiconversion.Scope) error {
+	// ReferencedResources have no equivalent in v1alpha7
+	return autoConvert_v1alpha8_BastionStatus_To_v1alpha7_BastionStatus(in, out, s)
+}

api/v1alpha6/zz_generated.conversion.go

@@ -60,6 +60,13 @@ func TestFuzzyConversion(t *testing.T) {
 			func(status *OpenStackClusterStatus, c fuzz.Continue) {
 				c.FuzzNoCustom(status)
 			},
+
+			func(v1alpha8Bastion *infrav1.Bastion, c fuzz.Continue) {
+				c.FuzzNoCustom(v1alpha8Bastion)
+
+				// None of the following fields have ever been set in v1alpha7
+				v1alpha8Bastion.Instance.ServerGroup.Name = ""
+			},
 		}
 	}
 

api/v1alpha7/conversion.go

@@ -90,7 +90,7 @@ type OpenStackMachineSpec struct {
 	// +optional
 	AdditionalBlockDevices []AdditionalBlockDevice `json:"additionalBlockDevices,omitempty"`
 
-	// The server group to assign the machine to
+	// The server group to assign the machine to.
 	ServerGroupID string `json:"serverGroupID,omitempty"`
 
 	// IdentityRef is a reference to a identity to be used when reconciling this cluster

api/v1alpha7/conversion_test.go

@@ -215,6 +215,11 @@ type AdditionalBlockDevice struct {
 	Storage BlockDeviceStorage `json:"storage"`
 }
 
+type ServerGroupFilter struct {
+	ID   string `json:"id,omitempty"`
+	Name string `json:"name,omitempty"`
+}
+
 // BlockDeviceType defines the type of block device to create.
 type BlockDeviceType string