Merge pull request #1318 from stackhpc/feature/control-plane-omit-az

✨ Allow for omitting AZ from control plane nodes

Author: k8s-ci-robot

api/v1alpha3/conversion_test.go

@@ -235,6 +235,7 @@ func TestFuzzyConversion(t *testing.T) {
 					v1alpha6Cluster.Spec.Bastion.Instance.ImageUUID = ""
 					v1alpha6Cluster.Spec.Bastion.Instance.Ports = nil
 				}
+				v1alpha6Cluster.Spec.ControlPlaneOmitAvailabilityZone = false
 
 				v1alpha6Cluster.Status.FailureMessage = nil
 				v1alpha6Cluster.Status.FailureReason = nil

api/v1alpha3/zz_generated.conversion.go

@@ -331,6 +331,8 @@ func TestFuzzyConversion(t *testing.T) {
 
 				v1alpha6Cluster.Spec.APIServerLoadBalancer.AllowedCIDRs = nil
 
+				v1alpha6Cluster.Spec.ControlPlaneOmitAvailabilityZone = false
+
 				if v1alpha6Cluster.Spec.Bastion != nil {
 					v1alpha6Cluster.Spec.Bastion.Instance.Image = ""
 				}
@@ -405,6 +407,8 @@ func TestFuzzyConversion(t *testing.T) {
 
 				v1alpha6ClusterTemplate.Spec.Template.Spec.APIServerLoadBalancer.AllowedCIDRs = nil
 
+				v1alpha6ClusterTemplate.Spec.Template.Spec.ControlPlaneOmitAvailabilityZone = false
+
 				if v1alpha6ClusterTemplate.Spec.Template.Spec.Bastion != nil {
 					v1alpha6ClusterTemplate.Spec.Template.Spec.Bastion.Instance.Image = ""
 				}

api/v1alpha4/conversion_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha5
 
 import (
+	conversion "k8s.io/apimachinery/pkg/conversion"
 	utilconversion "sigs.k8s.io/cluster-api/util/conversion"
 	ctrlconversion "sigs.k8s.io/controller-runtime/pkg/conversion"
 
@@ -196,3 +197,8 @@ func (r *OpenStackMachineTemplateList) ConvertFrom(srcRaw ctrlconversion.Hub) er
 
 	return Convert_v1alpha6_OpenStackMachineTemplateList_To_v1alpha5_OpenStackMachineTemplateList(src, r, nil)
 }
+
+func Convert_v1alpha6_OpenStackClusterSpec_To_v1alpha5_OpenStackClusterSpec(in *infrav1.OpenStackClusterSpec, out *OpenStackClusterSpec, s conversion.Scope) error {
+	// Our new flag has no equivalent in v1alpha5
+	return autoConvert_v1alpha6_OpenStackClusterSpec_To_v1alpha5_OpenStackClusterSpec(in, out, s)
+}

api/v1alpha4/zz_generated.conversion.go

@@ -129,6 +129,10 @@ type OpenStackClusterSpec struct {
 	// +listType=set
 	ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
 
+	// Indicates whether to omit the az for control plane nodes, allowing the Nova scheduler
+	// to make a decision on which az to use based on other scheduling constraints
+	ControlPlaneOmitAvailabilityZone bool `json:"controlPlaneOmitAvailabilityZone,omitempty"`
+
 	// Bastion is the OpenStack instance to login the nodes
 	//
 	// As a rolling update is not ideal during a bastion host session, we

api/v1alpha5/conversion.go

@@ -4728,6 +4728,11 @@ spec:
                 - host
                 - port
                 type: object
+              controlPlaneOmitAvailabilityZone:
+                description: Indicates whether to omit the az for control plane nodes,
+                  allowing the Nova scheduler to make a decision on which az to use
+                  based on other scheduling constraints
+                type: boolean
               disableAPIServerFloatingIP:
                 description: DisableAPIServerFloatingIP determines whether or not
                   to attempt to attach a floating IP to the API server. This allows

api/v1alpha5/zz_generated.conversion.go

@@ -1966,6 +1966,11 @@ spec:
                         - host
                         - port
                         type: object
+                      controlPlaneOmitAvailabilityZone:
+                        description: Indicates whether to omit the az for control
+                          plane nodes, allowing the Nova scheduler to make a decision
+                          on which az to use based on other scheduling constraints
+                        type: boolean
                       disableAPIServerFloatingIP:
                         description: DisableAPIServerFloatingIP determines whether
                           or not to attempt to attach a floating IP to the API server.

api/v1alpha6/openstackcluster_types.go

@@ -280,21 +280,16 @@ func reconcileNormal(ctx context.Context, scope *scope.Scope, patchHelper *patch
 		return ctrl.Result{}, err
 	}
 
-	// Create a new list to remove any Availability
-	// Zones that have been removed from OpenStack
+	// Create a new list in case any AZs have been removed from OpenStack
 	openStackCluster.Status.FailureDomains = make(clusterv1.FailureDomains)
 	for _, az := range availabilityZones {
-		found := true
-		// If Az given, then check whether it's in the allow list
-		// If no Az given, then by default put into allow list
+		// By default, the AZ is used or not used for control plane nodes depending on the flag
+		found := !openStackCluster.Spec.ControlPlaneOmitAvailabilityZone
+		// If explicit AZs for control plane nodes are given, they override the value
 		if len(openStackCluster.Spec.ControlPlaneAvailabilityZones) > 0 {
-			if contains(openStackCluster.Spec.ControlPlaneAvailabilityZones, az.ZoneName) {
-				found = true
-			} else {
-				found = false
-			}
+			found = contains(openStackCluster.Spec.ControlPlaneAvailabilityZones, az.ZoneName)
 		}
-
+		// Add the AZ object to the failure domains for the cluster
 		openStackCluster.Status.FailureDomains[az.ZoneName] = clusterv1.FailureDomainSpec{
 			ControlPlane: found,
 		}