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.

Co-Authored-By: Emilien Macchi <[email protected]>
Co-Authored-By: Michał Dulko <[email protected]>
Co-Authored-By: Stephen Finucane <[email protected]>

Author: 3 people

api/v1alpha5/conversion.go

@@ -213,7 +213,18 @@ 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}
+	} else {
+		out.ServerGroup = &infrav1.ServerGroupFilter{}
+	}
+
+	return nil
 }
 
 func Convert_v1alpha8_APIServerLoadBalancer_To_v1alpha5_APIServerLoadBalancer(in *infrav1.APIServerLoadBalancer, out *APIServerLoadBalancer, s conversion.Scope) error {
@@ -246,6 +257,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 +269,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 +448,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

@@ -61,6 +61,11 @@ func restorev1alpha8MachineSpec(previous *infrav1.OpenStackMachineSpec, dst *inf
 	// We restore the whole Ports since they are anyway immutable.
 	dst.Ports = previous.Ports
 	dst.AdditionalBlockDevices = previous.AdditionalBlockDevices
+	dst.ServerGroup = previous.ServerGroup
+}
+
+func restorev1alpha8MachineStatus(previous *infrav1.OpenStackMachineStatus, dst *infrav1.OpenStackMachineStatus) {
+	dst.ReferencedResources = previous.ReferencedResources
 }
 
 func restorev1alpha8Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {
@@ -257,6 +262,12 @@ var v1alpha8OpenStackMachineRestorer = conversion.RestorerFor[*infrav1.OpenStack
 		},
 		restorev1alpha8MachineSpec,
 	),
+	"status": conversion.HashedFieldRestorer(
+		func(c *infrav1.OpenStackMachine) *infrav1.OpenStackMachineStatus {
+			return &c.Status
+		},
+		restorev1alpha8MachineStatus,
+	),
 }
 
 func (r *OpenStackMachine) ConvertTo(dstRaw ctrlconversion.Hub) error {
@@ -354,6 +365,13 @@ 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}
+	} else {
+		out.ServerGroup = nil
+	}
+
 	return nil
 }
 
@@ -472,6 +490,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
 }
 
@@ -483,6 +502,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
 }
 
@@ -649,5 +669,47 @@ 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 v1alpha6
+	return autoConvert_v1alpha8_OpenStackMachineStatus_To_v1alpha6_OpenStackMachineStatus(in, out, s)
+}
+
+func Convert_v1alpha6_Bastion_To_v1alpha8_Bastion(in *Bastion, out *infrav1.Bastion, s apiconversion.Scope) error {
+	err := autoConvert_v1alpha6_Bastion_To_v1alpha8_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.Instance.ServerGroupID != "" {
+		out.Instance.ServerGroup = &infrav1.ServerGroupFilter{ID: in.Instance.ServerGroupID}
+	} else {
+		out.Instance.ServerGroup = nil
+	}
+
+	return nil
+}
+
+func Convert_v1alpha8_Bastion_To_v1alpha6_Bastion(in *infrav1.Bastion, out *Bastion, s apiconversion.Scope) error {
+	err := autoConvert_v1alpha8_Bastion_To_v1alpha6_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+
+	if in.Instance.ServerGroup != nil && in.Instance.ServerGroup.ID != "" {
+		out.Instance.ServerGroupID = in.Instance.ServerGroup.ID
+	}
+
+	return nil
 }