Move FloatingIP to Bastion spec

EmilienM · EmilienM · commit a1ae5ddfa79b · 2023-11-09T14:52:46.000-05:00
diff --git a/api/v1alpha5/conversion.go b/api/v1alpha5/conversion.go
@@ -238,6 +238,16 @@ func Convert_v1alpha5_PortOpts_To_v1alpha7_PortOpts(in *PortOpts, out *infrav1.P
 	return nil
 }
 
+func Convert_v1alpha5_OpenStackMachineSpec_To_v1alpha7_Bastion(in *OpenStackMachineSpec, out *infrav1.Bastion, _ conversion.Scope) error {
+	out.FloatingIP = in.FloatingIP
+	return nil
+}
+
+func Convert_v1alpha7_Bastion_To_v1alpha5_OpenStackMachineSpec(in *infrav1.Bastion, out *OpenStackMachineSpec, _ conversion.Scope) error {
+	out.FloatingIP = in.FloatingIP
+	return nil
+}
+
 func Convert_v1alpha5_Instance_To_v1alpha7_BastionStatus(in *Instance, out *infrav1.BastionStatus, _ conversion.Scope) error {
 	// BastionStatus is the same as Instance with unused fields removed
 	out.ID = in.ID
@@ -437,3 +447,12 @@ func Convert_v1alpha5_OpenStackClusterStatus_To_v1alpha7_OpenStackClusterStatus(
 func Convert_v1alpha7_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in *infrav1.OpenStackMachineSpec, out *OpenStackMachineSpec, s conversion.Scope) error {
 	return autoConvert_v1alpha7_OpenStackMachineSpec_To_v1alpha5_OpenStackMachineSpec(in, out, s)
 }
+
+func Convert_v1alpha7_Bastion_To_v1alpha5_Bastion(in *infrav1.Bastion, out *Bastion, s conversion.Scope) error {
+	err := autoConvert_v1alpha7_Bastion_To_v1alpha5_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+	in.FloatingIP = out.Instance.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) {
@@ -472,6 +476,16 @@ func Convert_v1alpha7_PortOpts_To_v1alpha6_PortOpts(in *infrav1.PortOpts, out *P
 	return nil
 }
 
+func Convert_v1alpha6_OpenStackMachineSpec_To_v1alpha7_Bastion(in *OpenStackMachineSpec, out *infrav1.Bastion, _ apiconversion.Scope) error {
+	out.FloatingIP = in.FloatingIP
+	return nil
+}
+
+func Convert_v1alpha7_Bastion_To_v1alpha6_OpenStackMachineSpec(in *infrav1.Bastion, out *OpenStackMachineSpec, _ apiconversion.Scope) error {
+	//out.FloatingIP = in.FloatingIP
+	return nil
+}
+
 func Convert_v1alpha6_Instance_To_v1alpha7_BastionStatus(in *Instance, out *infrav1.BastionStatus, _ apiconversion.Scope) error {
 	// BastionStatus is the same as Instance with unused fields removed
 	out.ID = in.ID
@@ -659,3 +673,12 @@ func Convert_v1alpha6_OpenStackClusterStatus_To_v1alpha7_OpenStackClusterStatus(
 func Convert_v1alpha7_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in *infrav1.OpenStackMachineSpec, out *OpenStackMachineSpec, s apiconversion.Scope) error {
 	return autoConvert_v1alpha7_OpenStackMachineSpec_To_v1alpha6_OpenStackMachineSpec(in, out, s)
 }
+
+func Convert_v1alpha7_Bastion_To_v1alpha6_Bastion(in *infrav1.Bastion, out *Bastion, s apiconversion.Scope) error {
+	err := autoConvert_v1alpha7_Bastion_To_v1alpha6_Bastion(in, out, s)
+	if err != nil {
+		return err
+	}
+	in.FloatingIP = out.Instance.FloatingIP
+	return nil
+}
diff --git a/api/v1alpha6/zz_generated.conversion.go b/api/v1alpha6/zz_generated.conversion.go
diff --git a/api/v1alpha7/openstackmachine_types.go b/api/v1alpha7/openstackmachine_types.go
@@ -60,10 +60,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/v1alpha7/types.go b/api/v1alpha7/types.go
@@ -344,6 +344,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
@@ -3767,6 +3767,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:
@@ -3842,11 +3847,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
@@ -1607,6 +1607,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:
@@ -1688,11 +1693,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
@@ -1226,11 +1226,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
@@ -1030,11 +1030,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
@@ -359,7 +359,7 @@ func reconcileBastion(scope scope.Scope, cluster *clusterv1.Cluster, openStackCl
 		return err
 	}
 	clusterName := fmt.Sprintf("%s-%s", cluster.Namespace, cluster.Name)
-	fp, err := networkingService.GetOrCreateFloatingIP(openStackCluster, openStackCluster, clusterName, openStackCluster.Spec.Bastion.Instance.FloatingIP)
+	fp, err := networkingService.GetOrCreateFloatingIP(openStackCluster, openStackCluster, clusterName, openStackCluster.Spec.Bastion.FloatingIP)
 	if err != nil {
 		handleUpdateOSCError(openStackCluster, fmt.Errorf("failed to get or create floating IP for bastion: %w", err))
 		return fmt.Errorf("failed to get or create floating IP for bastion: %w", err)
diff --git a/docs/book/src/clusteropenstack/configuration.md b/docs/book/src/clusteropenstack/configuration.md
@@ -609,7 +609,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.
diff --git a/docs/book/src/topics/crd-changes/v1alpha6-to-v1alpha7.md b/docs/book/src/topics/crd-changes/v1alpha6-to-v1alpha7.md
@@ -8,6 +8,7 @@
     - [`OpenStackMachine`](#openstackmachine)
       - [⚠️ Removal of networks](#-removal-of-networks)
       - [Removal of subnet](#removal-of-subnet)
+      - [Change to floatingIP](#change-to-floatingip)
       - [Change to securityGroups](#change-to-securitygroups)
       - [Changes to ports](#changes-to-ports)
         - [Change to securityGroupFilters](#change-to-securitygroupfilters)
@@ -121,6 +122,38 @@ to set the `accessIPv4` field on Nova servers. This feature was not widely
 used, difficult to use, and could not be extended to support IPv6. It is
 removed without replacement.
 
+#### Change to floatingIP
+
+The `OpenStackMachineSpec.FloatingIP` field has moved to `OpenStackClusterSpec.Bastion.FloatingIP`.
+For example, if you had the following `OpenStackMachineTemplate`:
+
+```yaml
+apiVersion: infrastructure.cluster.x-k8s.io/v1alpha6
+kind: OpenStackMachineTemplate
+metadata:
+  name: ${CLUSTER_NAME}-md-0
+spec:
+  template:
+    spec:
+      ..
+      floatingIP: "1.2.3.4"
+```
+
+This will safely converted to use `Bastion.FloatingIP` when upgrading to version 0.8.
+
+To use the new `Bastion.FloatingIP` field, here is an example:
+
+```yaml
+apiVersion: infrastructure.cluster.x-k8s.io/v1alpha7
+kind: OpenStackCluster
+metadata:
+  name: ${CLUSTER_NAME}
+spec:
+  ..
+  bastion:
+    floatingIP: "1.2.3.4"
+```
+
 #### Change to securityGroups
 
 `securityGroups` has been simplified by the removal of a separate filter parameter. It was previously:
