Move FloatingIP to Bastion spec

Re-adding commit which was previously erroneously added to v1alpha7 and reverted. (cherry picked from commit f19a6cc) Updated to target v1alpha8 instead of v1alpha7. Conversion code is reworked from previous commit to be minimal. Co-Authored-By: Matthew Booth <[email protected]>
kubernetes-sigs · Jan 13, 2024 · 126e10a · 126e10a
1 parent 86f78d6
commit 126e10a
Show file tree

Hide file tree

Showing 15 changed files with 117 additions and 55 deletions.
diff --git a/api/v1alpha5/conversion.go b/api/v1alpha5/conversion.go
@@ -504,3 +504,21 @@ func Convert_v1alpha8_OpenStackMachineStatus_To_v1alpha5_OpenStackMachineStatus(
 	// ReferencedResources have no equivalent in v1alpha5
 	return autoConvert_v1alpha8_OpenStackMachineStatus_To_v1alpha5_OpenStackMachineStatus(in, out, s)
 }
+
+func Convert_v1alpha8_Bastion_To_v1alpha5_Bastion(in *infrav1.Bastion, out *Bastion, s conversion.Scope) error {
+	err := autoConvert_v1alpha8_Bastion_To_v1alpha5_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+	in.FloatingIP = out.Instance.FloatingIP
+	return nil
+}
+
+func Convert_v1alpha5_Bastion_To_v1alpha8_Bastion(in *Bastion, out *infrav1.Bastion, s conversion.Scope) error {
+	err := autoConvert_v1alpha5_Bastion_To_v1alpha8_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+	in.Instance.FloatingIP = out.FloatingIP
+	return nil
+}
diff --git a/api/v1alpha5/zz_generated.conversion.go b/api/v1alpha5/zz_generated.conversion.go
diff --git a/api/v1alpha6/conversion.go b/api/v1alpha6/conversion.go
@@ -40,6 +40,10 @@ func restorev1alpha6MachineSpec(previous *OpenStackMachineSpec, dst *OpenStackMa
 	dst.Networks = previous.Networks
 	dst.Ports = previous.Ports
 	dst.SecurityGroups = previous.SecurityGroups
+
+	// FloatingIP is removed from v1alpha7 with no replacement, so can't be
+	// losslessly converted. Restore the previously stored value on down-conversion.
+	dst.FloatingIP = previous.FloatingIP
 }
 
 func restorev1alpha6ClusterStatus(previous *OpenStackClusterStatus, dst *OpenStackClusterStatus) {
@@ -759,6 +763,7 @@ func Convert_v1alpha6_Bastion_To_v1alpha8_Bastion(in *Bastion, out *infrav1.Bast
 		out.Instance.ServerGroup = nil
 	}
 
+	out.FloatingIP = in.Instance.FloatingIP
 	return nil
 }
 
@@ -772,5 +777,6 @@ func Convert_v1alpha8_Bastion_To_v1alpha6_Bastion(in *infrav1.Bastion, out *Bast
 		out.Instance.ServerGroupID = in.Instance.ServerGroup.ID
 	}
 
+	out.Instance.FloatingIP = in.FloatingIP
 	return nil
 }
diff --git a/api/v1alpha6/zz_generated.conversion.go b/api/v1alpha6/zz_generated.conversion.go
diff --git a/api/v1alpha7/conversion.go b/api/v1alpha7/conversion.go
@@ -65,6 +65,10 @@ var v1alpha8OpenStackClusterRestorer = conversion.RestorerFor[*infrav1.OpenStack
 	),
 }
 
+func restorev1alpha7MachineSpec(previous *OpenStackMachineSpec, dst *OpenStackMachineSpec) {
+	dst.FloatingIP = previous.FloatingIP
+}
+
 func restorev1alpha8MachineSpec(previous *infrav1.OpenStackMachineSpec, dst *infrav1.OpenStackMachineSpec) {
 	dst.ServerGroup = previous.ServerGroup
 	dst.Image = previous.Image
@@ -169,7 +173,14 @@ func (r *OpenStackClusterTemplate) ConvertFrom(srcRaw ctrlconversion.Hub) error
 
 var _ ctrlconversion.Convertible = &OpenStackMachine{}
 
-var v1alpha7OpenStackMachineRestorer = conversion.RestorerFor[*OpenStackMachine]{}
+var v1alpha7OpenStackMachineRestorer = conversion.RestorerFor[*OpenStackMachine]{
+	"spec": conversion.HashedFieldRestorer(
+		func(c *OpenStackMachine) *OpenStackMachineSpec {
+			return &c.Spec
+		},
+		restorev1alpha7MachineSpec,
+	),
+}
 
 var v1alpha8OpenStackMachineRestorer = conversion.RestorerFor[*infrav1.OpenStackMachine]{
 	"spec": conversion.HashedFieldRestorer(
@@ -221,7 +232,18 @@ func (r *OpenStackMachineList) ConvertFrom(srcRaw ctrlconversion.Hub) error {
 
 var _ ctrlconversion.Convertible = &OpenStackMachineTemplate{}
 
-var v1alpha7OpenStackMachineTemplateRestorer = conversion.RestorerFor[*OpenStackMachineTemplate]{}
+func restorev1alpha7MachineTemplateSpec(previous *OpenStackMachineTemplateSpec, dst *OpenStackMachineTemplateSpec) {
+	restorev1alpha7MachineSpec(&previous.Template.Spec, &dst.Template.Spec)
+}
+
+var v1alpha7OpenStackMachineTemplateRestorer = conversion.RestorerFor[*OpenStackMachineTemplate]{
+	"spec": conversion.HashedFieldRestorer(
+		func(c *OpenStackMachineTemplate) *OpenStackMachineTemplateSpec {
+			return &c.Spec
+		},
+		restorev1alpha7MachineTemplateSpec,
+	),
+}
 
 var v1alpha8OpenStackMachineTemplateRestorer = conversion.RestorerFor[*infrav1.OpenStackMachineTemplate]{
 	"spec": conversion.HashedFieldRestorer(
@@ -331,6 +353,7 @@ func Convert_v1alpha7_Bastion_To_v1alpha8_Bastion(in *Bastion, out *infrav1.Bast
 		out.Instance.ServerGroup = nil
 	}
 
+	out.FloatingIP = in.Instance.FloatingIP
 	return nil
 }
 
@@ -344,6 +367,7 @@ func Convert_v1alpha8_Bastion_To_v1alpha7_Bastion(in *infrav1.Bastion, out *Bast
 		out.Instance.ServerGroupID = in.Instance.ServerGroup.ID
 	}
 
+	out.Instance.FloatingIP = in.FloatingIP
 	return nil
 }
 

diff --git a/api/v1alpha7/zz_generated.conversion.go b/api/v1alpha7/zz_generated.conversion.go
diff --git a/api/v1alpha8/openstackmachine_types.go b/api/v1alpha8/openstackmachine_types.go
@@ -56,10 +56,6 @@ type OpenStackMachineSpec struct {
 	// If not specified a default port will be added for the default cluster network.
 	Ports []PortOpts `json:"ports,omitempty"`
 
-	// The floatingIP which will be associated to the machine, only used for master.
-	// The floatingIP should have been created and haven't been associated.
-	FloatingIP string `json:"floatingIP,omitempty"`
-
 	// The names of the security groups to assign to the instance
 	SecurityGroups []SecurityGroupFilter `json:"securityGroups,omitempty"`
 

diff --git a/api/v1alpha8/types.go b/api/v1alpha8/types.go
@@ -362,6 +362,11 @@ type Bastion struct {
 
 	//+optional
 	AvailabilityZone string `json:"availabilityZone,omitempty"`
+
+	// FloatingIP which will be associated to the bastion machine.
+	// The floating IP should already exist and should not be associated with a port.
+	//+optional
+	FloatingIP string `json:"floatingIP,omitempty"`
 }
 
 type APIServerLoadBalancer struct {

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml
@@ -4811,6 +4811,11 @@ spec:
                     type: string
                   enabled:
                     type: boolean
+                  floatingIP:
+                    description: FloatingIP which will be associated to the bastion
+                      machine. The floating IP should already exist and should not
+                      be associated with a port.
+                    type: string
                   instance:
                     description: Instance for the bastion itself
                     properties:
@@ -4886,11 +4891,6 @@ spec:
                         description: The flavor reference for the flavor for your
                           server instance.
                         type: string
-                      floatingIP:
-                        description: The floatingIP which will be associated to the
-                          machine, only used for master. The floatingIP should have
-                          been created and haven't been associated.
-                        type: string
                       identityRef:
                         description: IdentityRef is a reference to a identity to be
                           used when reconciling this cluster

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml
@@ -2338,6 +2338,11 @@ spec:
                             type: string
                           enabled:
                             type: boolean
+                          floatingIP:
+                            description: FloatingIP which will be associated to the
+                              bastion machine. The floating IP should already exist
+                              and should not be associated with a port.
+                            type: string
                           instance:
                             description: Instance for the bastion itself
                             properties:
@@ -2419,11 +2424,6 @@ spec:
                                 description: The flavor reference for the flavor for
                                   your server instance.
                                 type: string
-                              floatingIP:
-                                description: The floatingIP which will be associated
-                                  to the machine, only used for master. The floatingIP
-                                  should have been created and haven't been associated.
-                                type: string
                               identityRef:
                                 description: IdentityRef is a reference to a identity
                                   to be used when reconciling this cluster

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachines.yaml
@@ -1725,11 +1725,6 @@ spec:
               flavor:
                 description: The flavor reference for the flavor for your server instance.
                 type: string
-              floatingIP:
-                description: The floatingIP which will be associated to the machine,
-                  only used for master. The floatingIP should have been created and
-                  haven't been associated.
-                type: string
               identityRef:
                 description: IdentityRef is a reference to a identity to be used when
                   reconciling this cluster

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachinetemplates.yaml
@@ -1438,11 +1438,6 @@ spec:
                         description: The flavor reference for the flavor for your
                           server instance.
                         type: string
-                      floatingIP:
-                        description: The floatingIP which will be associated to the
-                          machine, only used for master. The floatingIP should have
-                          been created and haven't been associated.
-                        type: string
                       identityRef:
                         description: IdentityRef is a reference to a identity to be
                           used when reconciling this cluster

diff --git a/controllers/openstackcluster_controller.go b/controllers/openstackcluster_controller.go
@@ -412,7 +412,7 @@ func reconcileBastion(scope scope.Scope, cluster *clusterv1.Cluster, openStackCl
 	}
 
 	clusterName := fmt.Sprintf("%s-%s", cluster.Namespace, cluster.Name)
-	floatingIP := openStackCluster.Spec.Bastion.Instance.FloatingIP
+	floatingIP := openStackCluster.Spec.Bastion.FloatingIP
 	if openStackCluster.Status.Bastion.FloatingIP != "" {
 		// Some floating IP has already been created for this bastion, make sure we re-use it
 		floatingIP = openStackCluster.Status.Bastion.FloatingIP

diff --git a/docs/book/src/clusteropenstack/configuration.md b/docs/book/src/clusteropenstack/configuration.md
@@ -649,7 +649,7 @@ spec:
   ...
   bastion:
     ...
-        floatingIP: <Floating IP address>
+    floatingIP: <Floating IP address>
 ```
 
 If `managedSecurityGroups: true`, security group rule opening 22/tcp is added to security groups for bastion, controller, and worker nodes respectively. Otherwise, you have to add `securityGroups` to the `bastion` in `OpenStackCluster` spec and `OpenStackMachineTemplate` spec template respectively.