Merge pull request #1796 from shiftstack/issue_1795

✨ Change API for OpenStackMachine.Spec.Image

api/v1alpha5/conversion.go

@@ -247,6 +247,15 @@ func Convert_v1alpha5_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *
 		out.ServerGroup = &infrav1.ServerGroupFilter{}
 	}
 
+	imageFilter := infrav1.ImageFilter{}
+	if in.Image != "" {
+		imageFilter.Name = in.Image
+	}
+	if in.ImageUUID != "" {
+		imageFilter.ID = in.ImageUUID
+	}
+	out.Image = imageFilter
+
 	return nil
 }
 
@@ -480,6 +489,14 @@ func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in *
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
+	if in.Image.Name != "" {
+		out.Image = in.Image.Name
+	}
+
+	if in.Image.ID != "" {
+		out.ImageUUID = in.Image.ID
+	}
+
 	return nil
 }
 

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,\"referencedResources\":{}}}",
+						"cluster.x-k8s.io/conversion-data": "{\"spec\":{\"cloudName\":\"\",\"flavor\":\"\",\"image\":{}},\"status\":{\"ready\":false,\"referencedResources\":{}}}",
 					},
 				},
 			},
@@ -94,7 +94,7 @@ func TestConvertFrom(t *testing.T) {
 				Spec: OpenStackMachineTemplateSpec{},
 				ObjectMeta: metav1.ObjectMeta{
 					Annotations: map[string]string{
-						"cluster.x-k8s.io/conversion-data": "{\"spec\":{\"template\":{\"spec\":{\"cloudName\":\"\",\"flavor\":\"\"}}}}",
+						"cluster.x-k8s.io/conversion-data": "{\"spec\":{\"template\":{\"spec\":{\"cloudName\":\"\",\"flavor\":\"\",\"image\":{}}}}}",
 					},
 				},
 			},

api/v1alpha6/conversion.go

@@ -62,6 +62,7 @@ func restorev1alpha8MachineSpec(previous *infrav1.OpenStackMachineSpec, dst *inf
 	dst.Ports = previous.Ports
 	dst.AdditionalBlockDevices = previous.AdditionalBlockDevices
 	dst.ServerGroup = previous.ServerGroup
+	dst.Image = previous.Image
 }
 
 func restorev1alpha8Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {
@@ -393,6 +394,15 @@ func Convert_v1alpha6_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *
 		out.ServerGroup = nil
 	}
 
+	imageFilter := infrav1.ImageFilter{}
+	if in.Image != "" {
+		imageFilter.Name = in.Image
+	}
+	if in.ImageUUID != "" {
+		imageFilter.ID = in.ImageUUID
+	}
+	out.Image = imageFilter
+
 	return nil
 }
 
@@ -721,6 +731,14 @@ func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in *
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
+	if in.Image.Name != "" {
+		out.Image = in.Image.Name
+	}
+
+	if in.Image.ID != "" {
+		out.ImageUUID = in.Image.ID
+	}
+
 	return nil
 }
 

api/v1alpha7/conversion.go

@@ -67,6 +67,7 @@ var v1alpha8OpenStackClusterRestorer = conversion.RestorerFor[*infrav1.OpenStack
 
 func restorev1alpha8MachineSpec(previous *infrav1.OpenStackMachineSpec, dst *infrav1.OpenStackMachineSpec) {
 	dst.ServerGroup = previous.ServerGroup
+	dst.Image = previous.Image
 }
 
 func restorev1alpha8Bastion(previous **infrav1.Bastion, dst **infrav1.Bastion) {
@@ -273,6 +274,14 @@ func Convert_v1alpha8_OpenStackMachineSpec_To_v1alpha7_OpenStackMachineSpec(in *
 		out.ServerGroupID = in.ServerGroup.ID
 	}
 
+	if in.Image.Name != "" {
+		out.Image = in.Image.Name
+	}
+
+	if in.Image.ID != "" {
+		out.ImageUUID = in.Image.ID
+	}
+
 	return nil
 }
 
@@ -288,6 +297,15 @@ func Convert_v1alpha7_OpenStackMachineSpec_To_v1alpha8_OpenStackMachineSpec(in *
 		out.ServerGroup = nil
 	}
 
+	imageFilter := infrav1.ImageFilter{}
+	if in.Image != "" {
+		imageFilter.Name = in.Image
+	}
+	if in.ImageUUID != "" {
+		imageFilter.ID = in.ImageUUID
+	}
+	out.Image = imageFilter
+
 	return nil
 }
 

api/v1alpha8/filter_convert.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha8
 
 import (
+	"github.com/gophercloud/gophercloud/openstack/imageservice/v2/images"
 	"github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/layer3/routers"
 	securitygroups "github.com/gophercloud/gophercloud/openstack/networking/v2/extensions/security/groups"
 	"github.com/gophercloud/gophercloud/openstack/networking/v2/networks"
@@ -79,3 +80,11 @@ func (routerFilter RouterFilter) ToListOpt() routers.ListOpts {
 		NotTagsAny:  routerFilter.NotTagsAny,
 	}
 }
+
+func (imageFilter ImageFilter) ToListOpt() images.ListOpts {
+	return images.ListOpts{
+		ID:   imageFilter.ID,
+		Name: imageFilter.Name,
+		Tags: imageFilter.Tags,
+	}
+}

api/v1alpha8/openstackcluster_webhook_test.go

@@ -119,7 +119,7 @@ func TestOpenStackCluster_ValidateUpdate(t *testing.T) {
 					Bastion: &Bastion{
 						Instance: OpenStackMachineSpec{
 							CloudName: "foobar",
-							Image:     "foobar",
+							Image:     ImageFilter{Name: "foobar"},
 							Flavor:    "minimal",
 						},
 						Enabled: true,
@@ -137,7 +137,7 @@ func TestOpenStackCluster_ValidateUpdate(t *testing.T) {
 					Bastion: &Bastion{
 						Instance: OpenStackMachineSpec{
 							CloudName: "foobarbaz",
-							Image:     "foobarbaz",
+							Image:     ImageFilter{Name: "foobarbaz"},
 							Flavor:    "medium",
 						},
 						Enabled: true,

api/v1alpha8/openstackmachine_types.go

@@ -45,13 +45,9 @@ type OpenStackMachineSpec struct {
 	// The flavor reference for the flavor for your server instance.
 	Flavor string `json:"flavor"`
 
-	// The name of the image to use for your server instance.
-	// If the RootVolume is specified, this will be ignored and use rootVolume directly.
-	Image string `json:"image,omitempty"`
-
-	// The uuid of the image to use for your server instance.
-	// if it's empty, Image name will be used
-	ImageUUID string `json:"imageUUID,omitempty"`
+	// The image to use for your server instance.
+	// If the rootVolume is specified, this will be used when creating the root volume.
+	Image ImageFilter `json:"image,omitempty"`
 
 	// The ssh key to inject in the instance
 	SSHKeyName string `json:"sshKeyName,omitempty"`

api/v1alpha8/openstackmachinetemplate_webhook_test.go

@@ -45,7 +45,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "bar",
+							Image:  ImageFilter{Name: "bar"},
 						},
 					},
 				},
@@ -55,7 +55,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "NewImage",
+							Image:  ImageFilter{Name: "NewImage"},
 						},
 					},
 				},
@@ -70,7 +70,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "bar",
+							Image:  ImageFilter{Name: "bar"},
 						},
 					},
 				},
@@ -83,7 +83,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "bar",
+							Image:  ImageFilter{Name: "bar"},
 						},
 					},
 				},
@@ -100,7 +100,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "bar",
+							Image:  ImageFilter{Name: "bar"},
 						},
 					},
 				},
@@ -110,7 +110,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "NewImage",
+							Image:  ImageFilter{Name: "NewImage"},
 						},
 					},
 				},
@@ -125,7 +125,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "bar",
+							Image:  ImageFilter{Name: "bar"},
 						},
 					},
 				},
@@ -140,7 +140,7 @@ func TestOpenStackMachineTemplate_ValidateUpdate(t *testing.T) {
 					Template: OpenStackMachineTemplateResource{
 						Spec: OpenStackMachineSpec{
 							Flavor: "foo",
-							Image:  "NewImage",
+							Image:  ImageFilter{Name: "NewImage"},
 						},
 					},
 				},

api/v1alpha8/types.go

@@ -22,6 +22,15 @@ type OpenStackMachineTemplateResource struct {
 	Spec OpenStackMachineSpec `json:"spec"`
 }
 
+type ImageFilter struct {
+	// The ID of the desired image. If this is provided, the other filters will be ignored.
+	ID string `json:"id,omitempty"`
+	// 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.
+	Name 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.
+	Tags []string `json:"tags,omitempty"`
+}
+
 type ExternalRouterIPParam struct {
 	// The FixedIP in the corresponding subnet
 	FixedIP string `json:"fixedIP,omitempty"`
@@ -371,6 +380,10 @@ type ReferencedMachineResources struct {
 	// ServerGroupID is the ID of the server group the machine should be added to and is calculated based on ServerGroupFilter.
 	// +optional
 	ServerGroupID string `json:"serverGroupID,omitempty"`
+
+	// ImageID is the ID of the image to use for the machine and is calculated based on ImageFilter.
+	// +optional
+	ImageID string `json:"imageID,omitempty"`
 }
 
 // ValueSpec represents a single value_spec key-value pair.