Support Flavor IDs

If I have a system that uses flavor IDs, beacuse it's unambiguous, I
then need to translate it into a flavor name before passing it to CAPO
that will then translate it back into an ID using a list API call.
Adds a "FlavorID" field to the CRD, and handles resolution in the same
manner as images are handled.

Author: spjmurray

api/v1alpha1/openstackserver_types.go

@@ -32,6 +32,7 @@ const (
 )
 
 // OpenStackServerSpec defines the desired state of OpenStackServer.
+// +kubebuilder:validation:XValidation:message="at least one of flavor or flavorID must be set",rule=(has(self.flavor) || has(self.flavorID))
 type OpenStackServerSpec struct {
 	// AdditionalBlockDevices is a list of specifications for additional block devices to attach to the server instance.
 	// +listType=map
@@ -48,8 +49,15 @@ type OpenStackServerSpec struct {
 	ConfigDrive optional.Bool `json:"configDrive,omitempty"`
 
 	// The flavor reference for the flavor for the server instance.
-	// +required
-	Flavor string `json:"flavor"`
+	// +optional
+	// +kubebuilder:validation:MinLength=1
+	Flavor *string `json:"flavor,omitempty"`
+
+	// FlavorID allows flavors to be specified by ID.  This field takes precedence
+	// over Flavor.
+	// +optional
+	// +kubebuilder:validation:MinLength=1
+	FlavorID *string `json:"flavorID,omitempty"`
 
 	// FloatingIPPoolRef is a reference to a FloatingIPPool to allocate a floating IP from.
 	// +optional

api/v1alpha1/types.go

@@ -30,6 +30,10 @@ type ResolvedServerSpec struct {
 	// +optional
 	ImageID string `json:"imageID,omitempty"`
 
+	// FlavorID is the ID of the flavor to use.
+	// +optional
+	FlavorID string `json:"flavorID,omitempty"`
+
 	// Ports is the fully resolved list of ports to create for the server.
 	// +optional
 	Ports []infrav1.ResolvedPortSpec `json:"ports,omitempty"`

api/v1alpha1/zz_generated.deepcopy.go

@@ -582,10 +582,10 @@ func TestMachineConversionControllerSpecFields(t *testing.T) {
 		{
 			name: "Non-ignored change",
 			modifyUp: func(up *infrav1.OpenStackMachine) {
-				up.Spec.Flavor = "new-flavor"
+				up.Spec.Flavor = ptr.To("new-flavor")
 			},
 			testAfter: func(g gomega.Gomega, after *OpenStackMachine) {
-				g.Expect(after.Spec.Flavor).To(gomega.Equal("new-flavor"))
+				g.Expect(after.Spec.Flavor).To(gomega.Equal(ptr.To("new-flavor")))
 			},
 			expectNetworkDiff: true,
 		},
@@ -613,11 +613,11 @@ func TestMachineConversionControllerSpecFields(t *testing.T) {
 			name: "Set ProviderID and non-ignored change",
 			modifyUp: func(up *infrav1.OpenStackMachine) {
 				up.Spec.ProviderID = ptr.To("new-provider-id")
-				up.Spec.Flavor = "new-flavor"
+				up.Spec.Flavor = ptr.To("new-flavor")
 			},
 			testAfter: func(g gomega.Gomega, after *OpenStackMachine) {
 				g.Expect(after.Spec.ProviderID).To(gomega.Equal(ptr.To("new-provider-id")))
-				g.Expect(after.Spec.Flavor).To(gomega.Equal("new-flavor"))
+				g.Expect(after.Spec.Flavor).To(gomega.Equal(ptr.To("new-flavor")))
 			},
 			expectNetworkDiff: true,
 		},

api/v1alpha6/conversion_test.go

@@ -43,7 +43,13 @@ type OpenStackMachineSpec struct {
 	CloudName string `json:"cloudName"`
 
 	// The flavor reference for the flavor for your server instance.
-	Flavor string `json:"flavor"`
+	// +kubebuilder:validation:MinLength=1
+	Flavor *string `json:"flavor,omitempty"`
+
+	// FlavorID allows flavors to be specified by ID.  This field takes precedence
+	// over Flavor.
+	// +kubebuilder:validation:MinLength=1
+	FlavorID *string `json:"flavorID,omitempty"`
 
 	// The name of the image to use for your server instance.
 	// If the RootVolume is specified, this will be ignored and use rootVolume directly.

api/v1alpha6/openstackmachine_types.go

@@ -191,10 +191,10 @@ func TestMachineConversionControllerSpecFields(t *testing.T) {
 		{
 			name: "Non-ignored change",
 			modifyUp: func(up *infrav1.OpenStackMachine) {
-				up.Spec.Flavor = "new-flavor"
+				up.Spec.Flavor = ptr.To("new-flavor")
 			},
 			testAfter: func(g gomega.Gomega, after *OpenStackMachine) {
-				g.Expect(after.Spec.Flavor).To(gomega.Equal("new-flavor"))
+				g.Expect(after.Spec.Flavor).To(gomega.Equal(ptr.To("new-flavor")))
 			},
 			expectIdentityRefDiff: true,
 		},
@@ -222,11 +222,11 @@ func TestMachineConversionControllerSpecFields(t *testing.T) {
 			name: "Set ProviderID and non-ignored change",
 			modifyUp: func(up *infrav1.OpenStackMachine) {
 				up.Spec.ProviderID = ptr.To("new-provider-id")
-				up.Spec.Flavor = "new-flavor"
+				up.Spec.Flavor = ptr.To("new-flavor")
 			},
 			testAfter: func(g gomega.Gomega, after *OpenStackMachine) {
 				g.Expect(after.Spec.ProviderID).To(gomega.Equal(ptr.To("new-provider-id")))
-				g.Expect(after.Spec.Flavor).To(gomega.Equal("new-flavor"))
+				g.Expect(after.Spec.Flavor).To(gomega.Equal(ptr.To("new-flavor")))
 			},
 			expectIdentityRefDiff: true,
 		},

api/v1alpha6/zz_generated.conversion.go

@@ -43,7 +43,13 @@ type OpenStackMachineSpec struct {
 	CloudName string `json:"cloudName"`
 
 	// The flavor reference for the flavor for your server instance.
-	Flavor string `json:"flavor"`
+	// +kubebuilder:validation:MinLength=1
+	Flavor *string `json:"flavor,omitempty"`
+
+	// FlavorID allows flavors to be specified by ID.  This field takes precedence
+	// over Flavor.
+	// +kubebuilder:validation:MinLength=1
+	FlavorID *string `json:"flavorID,omitempty"`
 
 	// The name of the image to use for your server instance.
 	// If the RootVolume is specified, this will be ignored and use rootVolume directly.