Split ImageFilter into ImageParam

This makes validation of the filter much simpler, because either ID or
Filter must be specified.

Author: mdbooth

api/v1alpha5/conversion.go

@@ -360,13 +360,13 @@ func Convert_v1alpha5_OpenStackMachineSpec_To_v1beta1_OpenStackMachineSpec(in *O
 		out.ServerGroup = &infrav1.ServerGroupFilter{}
 	}
 
-	imageFilter := infrav1.ImageFilter{}
+	imageParam := infrav1.ImageParam{}
 	if in.ImageUUID != "" {
-		imageFilter.ID = &in.ImageUUID
+		imageParam.ID = &in.ImageUUID
 	} else if in.Image != "" { // Only add name when ID is not set, in v1beta1 it's not possible to set both.
-		imageFilter.Name = &in.Image
+		imageParam.Filter = &infrav1.ImageFilter{Name: &in.Image}
 	}
-	out.Image = imageFilter
+	out.Image = imageParam
 
 	if in.IdentityRef != nil {
 		out.IdentityRef = &infrav1.OpenStackIdentityReference{Name: in.IdentityRef.Name}
@@ -645,12 +645,10 @@ func Convert_v1beta1_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in *i
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
-	if in.Image.Name != nil && *in.Image.Name != "" {
-		out.Image = *in.Image.Name
-	}
-
-	if in.Image.ID != nil && *in.Image.ID != "" {
+	if in.Image.ID != nil {
 		out.ImageUUID = *in.Image.ID
+	} else if in.Image.Filter != nil && in.Image.Filter.Name != nil {
+		out.Image = *in.Image.Filter.Name
 	}
 
 	if in.IdentityRef != nil {

api/v1alpha5/zz_generated.conversion.go

@@ -266,13 +266,13 @@ func Convert_v1alpha6_OpenStackMachineSpec_To_v1beta1_OpenStackMachineSpec(in *O
 		out.ServerGroup = nil
 	}
 
-	imageFilter := infrav1.ImageFilter{}
+	imageParam := infrav1.ImageParam{}
 	if in.ImageUUID != "" {
-		imageFilter.ID = &in.ImageUUID
+		imageParam.ID = &in.ImageUUID
 	} else if in.Image != "" { // Only add name when ID is not set, in v1beta1 it's not possible to set both.
-		imageFilter.Name = &in.Image
+		imageParam.Filter = &infrav1.ImageFilter{Name: &in.Image}
 	}
-	out.Image = imageFilter
+	out.Image = imageParam
 
 	if len(in.ServerMetadata) > 0 {
 		serverMetadata := make([]infrav1.ServerMetadata, 0, len(in.ServerMetadata))
@@ -314,12 +314,10 @@ func Convert_v1beta1_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in *i
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
-	if in.Image.Name != nil && *in.Image.Name != "" {
-		out.Image = *in.Image.Name
-	}
-
-	if in.Image.ID != nil && *in.Image.ID != "" {
+	if in.Image.ID != nil {
 		out.ImageUUID = *in.Image.ID
+	} else if in.Image.Filter != nil && in.Image.Filter.Name != nil {
+		out.Image = *in.Image.Filter.Name
 	}
 
 	if len(in.ServerMetadata) > 0 {

api/v1alpha6/openstackmachine_conversion.go

@@ -160,13 +160,13 @@ func Convert_v1alpha7_OpenStackMachineSpec_To_v1beta1_OpenStackMachineSpec(in *O
 		out.ServerGroup = nil
 	}
 
-	imageFilter := infrav1.ImageFilter{}
+	imageParam := infrav1.ImageParam{}
 	if in.ImageUUID != "" {
-		imageFilter.ID = &in.ImageUUID
+		imageParam.ID = &in.ImageUUID
 	} else if in.Image != "" { // Only add name when ID is not set, in v1beta1 it's not possible to set both.
-		imageFilter.Name = &in.Image
+		imageParam.Filter = &infrav1.ImageFilter{Name: &in.Image}
 	}
-	out.Image = imageFilter
+	out.Image = imageParam
 
 	if len(in.ServerMetadata) > 0 {
 		serverMetadata := make([]infrav1.ServerMetadata, 0, len(in.ServerMetadata))
@@ -205,12 +205,10 @@ func Convert_v1beta1_OpenStackMachineSpec_To_v1alpha7_OpenStackMachineSpec(in *i
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
-	if in.Image.Name != nil && *in.Image.Name != "" {
-		out.Image = *in.Image.Name
-	}
-
-	if in.Image.ID != nil && *in.Image.ID != "" {
+	if in.Image.ID != nil {
 		out.ImageUUID = *in.Image.ID
+	} else if in.Image.Filter != nil && in.Image.Filter.Name != nil {
+		out.Image = *in.Image.Filter.Name
 	}
 
 	if len(in.ServerMetadata) > 0 {

api/v1alpha6/zz_generated.conversion.go

@@ -45,7 +45,7 @@ type OpenStackMachineSpec struct {
 	// The image to use for your server instance.
 	// If the rootVolume is specified, this will be used when creating the root volume.
 	// +required
-	Image ImageFilter `json:"image"`
+	Image ImageParam `json:"image"`
 
 	// The ssh key to inject in the instance
 	SSHKeyName string `json:"sshKeyName,omitempty"`

api/v1alpha7/openstackmachine_conversion.go

@@ -28,16 +28,29 @@ type OpenStackMachineTemplateResource struct {
 	Spec OpenStackMachineSpec `json:"spec"`
 }
 
-// ImageFilter describes the data needed to identify which image to use. If ID is provided it is required that all other fields are unset.
-// +kubebuilder:validation:XValidation:rule="(has(self.id) && !has(self.name) && !has(self.tags)) || !has(self.id)",message="when ID is set you cannot set other options"
-type ImageFilter struct {
-	// The ID of the desired image. If ID is provided, the other filters cannot be provided. Must be in UUID format.
+// ImageParam describes a glance image. It can be specified by ID or filter.
+// +kubebuilder:validation:MaxProperties:=1
+// +kubebuilder:validation:MinProperties:=1
+type ImageParam struct {
+	// ID is the uuid of the image. ID will not be validated before use.
 	// +kubebuilder:validation:Format:=uuid
 	// +optional
 	ID optional.String `json:"id,omitempty"`
+
+	// Filter describes a query for an image. If specified, the combination
+	// of name and tags must return a single matching image or an error will
+	// be raised.
+	// +optional
+	Filter *ImageFilter `json:"filter,omitempty"`
+}
+
+// ImageFilter describes a query for an image.
+// +kubebuilder:validation:MinProperties:=1
+type ImageFilter struct {
 	// The name of the desired image. If specified, the combination of name and tags must return a single matching image or an error will be raised.
 	// +optional
 	Name optional.String `json:"name,omitempty"`
+
 	// The tags associated with the desired image. If specified, the combination of name and tags must return a single matching image or an error will be raised.
 	// +listType=set
 	// +optional