OSASINFRA-3960: Migrate OpenStack InfraCluster controller in-tree

e2e/go.mod

@@ -21,6 +21,7 @@ require (
 	sigs.k8s.io/cluster-api-provider-azure v1.20.2
 	sigs.k8s.io/cluster-api-provider-gcp v1.10.0
 	sigs.k8s.io/cluster-api-provider-ibmcloud v0.11.0
+	sigs.k8s.io/cluster-api-provider-openstack v0.12.4
 	sigs.k8s.io/cluster-api-provider-vsphere v1.13.0
 	sigs.k8s.io/controller-runtime v0.20.4
 	sigs.k8s.io/yaml v1.4.0
@@ -63,6 +64,7 @@ require (
 	github.com/google/gnostic-models v0.6.9 // indirect
 	github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 // indirect
 	github.com/google/uuid v1.6.0 // indirect
+	github.com/gophercloud/gophercloud/v2 v2.9.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/jmespath/go-jmespath v0.4.1-0.20220621161143-b0104c826a24 // indirect

e2e/go.sum

@@ -117,6 +117,7 @@ github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 h1:BHT72Gu3keYf3ZEu2J
 github.com/google/pprof v0.0.0-20250403155104-27863c87afa6/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/gophercloud/gophercloud/v2 v2.9.0 h1:Y9OMrwKF9EDERcHFSOTpf/6XGoAI0yOxmsLmQki4LPM=
 github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=
 github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
 github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k=
@@ -373,6 +374,8 @@ sigs.k8s.io/cluster-api-provider-gcp v1.10.0 h1:gngUxo9bz8l+otpdw9v3ULEXwAvijyqi
 sigs.k8s.io/cluster-api-provider-gcp v1.10.0/go.mod h1:VkmOqBgi3Jj+VR+YTZEHAlMMmyjqcKl4lXhpLsYnYok=
 sigs.k8s.io/cluster-api-provider-ibmcloud v0.11.0 h1:aunR3nnDzQ5x1Qj1hJbR3Xq4SCZth4XyTWAyUCN46kE=
 sigs.k8s.io/cluster-api-provider-ibmcloud v0.11.0/go.mod h1:9yPLATyiqLx4crMzbX11YQU+GuR5txjtiCt8z9sxDfM=
+sigs.k8s.io/cluster-api-provider-openstack v0.12.4 h1:zTg4UrFbK8GwUm+7983mm0Omz/w4BLB+VSmbELqGimc=
+sigs.k8s.io/cluster-api-provider-openstack v0.12.4/go.mod h1:tYFVtlu1NqU9H5edUaz2QkXDhucn6mAY9mHeK9pEKzU=
 sigs.k8s.io/cluster-api-provider-vsphere v1.13.0 h1:tvJX0p/LfBvOvF1EWNu4+9EJALBTAHU1US7Z1SX/24Q=
 sigs.k8s.io/cluster-api-provider-vsphere v1.13.0/go.mod h1:TgNq4vlGPmUhCmzT2hOptOZuNbyj0JfOXFLufr91tTY=
 sigs.k8s.io/controller-runtime v0.20.4 h1:X3c+Odnxz+iPTRobG4tp092+CvBU9UK0t/bRf+n0DGU=

e2e/openstack_test.go

@@ -0,0 +1,157 @@
+package e2e
+
+import (
+	"context"
+
+	"github.com/onsi/gomega/format"
+	configv1 "github.com/openshift/api/config/v1"
+	mapiv1alpha1 "github.com/openshift/api/machine/v1alpha1"
+	mapiv1beta1 "github.com/openshift/api/machine/v1beta1"
+	"github.com/openshift/cluster-capi-operator/e2e/framework"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/ptr"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	yaml "sigs.k8s.io/yaml"
+
+	openstackv1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+const (
+	openStackMachineTemplateName = "openstack-machine-template"
+)
+
+var _ = Describe("Cluster API OpenStack MachineSet", Ordered, func() {
+	var mapiMachineSpec *mapiv1alpha1.OpenstackProviderSpec
+
+	BeforeAll(func() {
+		if platform != configv1.OpenStackPlatformType {
+			Skip("Skipping OpenStack E2E tests")
+		}
+		mapiMachineSpec = getOpenStackMAPIProviderSpec(cl)
+	})
+
+	It("should be able to run a machine with implicit cluster default network", func() {
+		openStackMachineTemplate := createOpenStackMachineTemplate(ctx, cl, mapiMachineSpec)
+
+		machineSet := framework.CreateMachineSet(ctx, cl, framework.NewMachineSetParams(
+			"openstack-machineset",
+			clusterName,
+			"",
+			1,
+			corev1.ObjectReference{
+				Kind:       "OpenStackMachineTemplate",
+				APIVersion: infraAPIVersion,
+				Name:       openStackMachineTemplate.Name,
+			},
+			"worker-user-data",
+		))
+		DeferCleanup(func() {
+			By("Deleting machineset " + machineSet.Name)
+			Expect(cl.Delete(ctx, machineSet)).To(Succeed())
+			framework.WaitForMachineSetsDeleted(cl, machineSet)
+		})
+
+		framework.WaitForMachineSet(cl, machineSet.Name, machineSet.Namespace)
+	})
+})
+
+func getOpenStackMAPIProviderSpec(cl client.Client) *mapiv1alpha1.OpenstackProviderSpec {
+	machineSetList := &mapiv1beta1.MachineSetList{}
+	Expect(cl.List(ctx, machineSetList, client.InNamespace(framework.MAPINamespace))).To(Succeed())
+
+	Expect(machineSetList.Items).ToNot(HaveLen(0))
+	machineSet := machineSetList.Items[0]
+	Expect(machineSet.Spec.Template.Spec.ProviderSpec.Value).ToNot(BeNil())
+
+	providerSpec := &mapiv1alpha1.OpenstackProviderSpec{}
+	Expect(yaml.Unmarshal(machineSet.Spec.Template.Spec.ProviderSpec.Value.Raw, providerSpec)).To(Succeed())
+
+	return providerSpec
+}
+
+func createOpenStackMachineTemplate(ctx context.Context, cl client.Client, mapiProviderSpec *mapiv1alpha1.OpenstackProviderSpec) *openstackv1.OpenStackMachineTemplate {
+	By("Creating OpenStack machine template")
+
+	Expect(mapiProviderSpec).ToNot(BeNil())
+	Expect(mapiProviderSpec.Flavor).ToNot(BeEmpty())
+	// NOTE(stephenfin): Installer does not populate ps.Image when ps.RootVolume is set and will
+	// instead populate ps.RootVolume.SourceUUID. Moreover, according to the ClusterOSImage option
+	// definition this is always the name of the image and never the UUID. We should allow UUID
+	// at some point and this will need an update.
+	if mapiProviderSpec.RootVolume != nil {
+		Expect(mapiProviderSpec.RootVolume.SourceUUID).ToNot(BeEmpty())
+	} else {
+		Expect(mapiProviderSpec.Image).ToNot(BeEmpty())
+	}
+	Expect(len(mapiProviderSpec.Networks)).To(BeNumerically(">", 0))
+	Expect(len(mapiProviderSpec.Networks[0].Subnets)).To(BeNumerically(">", 0))
+	Expect(mapiProviderSpec.Tags).ToNot(BeNil())
+	Expect(len(mapiProviderSpec.Tags)).To(BeNumerically(">", 0))
+
+	var image openstackv1.ImageParam
+	var rootVolume *openstackv1.RootVolume
+
+	if mapiProviderSpec.RootVolume != nil {
+		rootVolume = &openstackv1.RootVolume{
+			SizeGiB: mapiProviderSpec.RootVolume.Size,
+			BlockDeviceVolume: openstackv1.BlockDeviceVolume{
+				Type: mapiProviderSpec.RootVolume.VolumeType,
+				AvailabilityZone: &openstackv1.VolumeAvailabilityZone{
+					From: openstackv1.VolumeAZFromName,
+					Name: ptr.To(openstackv1.VolumeAZName(mapiProviderSpec.RootVolume.Zone)),
+				},
+			},
+		}
+		image.ID = ptr.To(mapiProviderSpec.RootVolume.SourceUUID)
+	} else {
+		image.Filter = &openstackv1.ImageFilter{Name: &mapiProviderSpec.Image}
+	}
+
+	// NOTE(stephenfin): We intentionally ignore additional security for now.
+	var securityGroupParam openstackv1.SecurityGroupParam
+	securityGroup := mapiProviderSpec.SecurityGroups[0]
+	if securityGroup.UUID != "" {
+		securityGroupParam = openstackv1.SecurityGroupParam{ID: &securityGroup.UUID}
+	} else {
+		securityGroupParam = openstackv1.SecurityGroupParam{Filter: &openstackv1.SecurityGroupFilter{Name: securityGroup.Name}}
+	}
+	securityGroups := []openstackv1.SecurityGroupParam{
+		securityGroupParam,
+	}
+
+	// We intentionally omit ports so the machine will default its network
+	// from the OpenStackCluster created by the infracluster controller.
+	openStackMachineSpec := openstackv1.OpenStackMachineSpec{
+		Flavor: ptr.To(mapiProviderSpec.Flavor),
+		IdentityRef: &openstackv1.OpenStackIdentityReference{
+			CloudName: "openstack",
+			Name:      "openstack-cloud-credentials",
+		},
+		Image:          image,
+		RootVolume:     rootVolume,
+		SecurityGroups: securityGroups,
+	}
+
+	openStackMachineTemplate := &openstackv1.OpenStackMachineTemplate{
+		ObjectMeta: metav1.ObjectMeta{
+			GenerateName: openStackMachineTemplateName + "-",
+			Namespace:    framework.CAPINamespace,
+		},
+		Spec: openstackv1.OpenStackMachineTemplateSpec{
+			Template: openstackv1.OpenStackMachineTemplateResource{
+				Spec: openStackMachineSpec,
+			},
+		},
+	}
+
+	Expect(cl.Create(ctx, openStackMachineTemplate)).To(Succeed(), format.Object(openStackMachineTemplate, 1))
+	// DeferCleanup(func() error {
+	// 	return cl.Delete(ctx, openStackMachineTemplate)
+	// })
+
+	return openStackMachineTemplate
+}

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/golangci/golangci-lint v1.64.8
 	github.com/google/go-cmp v0.7.0
 	github.com/google/uuid v1.6.0
+	github.com/gophercloud/gophercloud/v2 v2.9.0
 	github.com/klauspost/compress v1.18.0
 	github.com/metal3-io/cluster-api-provider-metal3/api v1.10.1
 	github.com/onsi/ginkgo/v2 v2.23.4
@@ -134,6 +135,7 @@ require (
 	github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect
 	github.com/gobwas/glob v0.2.3 // indirect
 	github.com/gofrs/flock v0.12.1 // indirect
+	github.com/gofrs/uuid/v5 v5.3.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/mock v1.7.0-rc.1 // indirect
 	github.com/golangci/dupl v0.0.0-20250308024227-f665c8d69b32 // indirect
@@ -147,7 +149,7 @@ require (
 	github.com/google/cel-go v0.23.2 // indirect
 	github.com/google/gnostic-models v0.6.9 // indirect
 	github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 // indirect
-	github.com/gophercloud/gophercloud/v2 v2.7.0 // indirect
+	github.com/gophercloud/utils/v2 v2.0.0-20241209100706-e3a3b7c07d26 // indirect
 	github.com/gordonklaus/ineffassign v0.1.0 // indirect
 	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
 	github.com/gostaticanalysis/comment v1.5.0 // indirect
@@ -273,6 +275,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.36.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.6.0 // indirect
 	go.uber.org/automaxprocs v1.6.0 // indirect
+	go.uber.org/mock v0.5.2 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/crypto v0.39.0 // indirect

go.sum

@@ -225,6 +225,8 @@ github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
 github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
 github.com/gofrs/flock v0.12.1 h1:MTLVXXHf8ekldpJk3AKicLij9MdwOWkZ+a/jHHZby9E=
 github.com/gofrs/flock v0.12.1/go.mod h1:9zxTsyu5xtJ9DK+1tFZyibEV7y3uwDxPPfbxeeHCoD0=
+github.com/gofrs/uuid/v5 v5.3.0 h1:m0mUMr+oVYUdxpMLgSYCZiXe7PuVPnI94+OMeVBNedk=
+github.com/gofrs/uuid/v5 v5.3.0/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
 github.com/golang-jwt/jwt/v5 v5.2.2 h1:Rl4B7itRWVtYIHFrSNd7vhTiz9UpLdi6gZhZ3wEeDy8=
@@ -271,8 +273,10 @@ github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 h1:BHT72Gu3keYf3ZEu2J
 github.com/google/pprof v0.0.0-20250403155104-27863c87afa6/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/gophercloud/gophercloud/v2 v2.7.0 h1:o0m4kgVcPgHlcXiWAjoVxGd8QCmvM5VU+YM71pFbn0E=
-github.com/gophercloud/gophercloud/v2 v2.7.0/go.mod h1:Ki/ILhYZr/5EPebrPL9Ej+tUg4lqx71/YH2JWVeU+Qk=
+github.com/gophercloud/gophercloud/v2 v2.9.0 h1:Y9OMrwKF9EDERcHFSOTpf/6XGoAI0yOxmsLmQki4LPM=
+github.com/gophercloud/gophercloud/v2 v2.9.0/go.mod h1:Ki/ILhYZr/5EPebrPL9Ej+tUg4lqx71/YH2JWVeU+Qk=
+github.com/gophercloud/utils/v2 v2.0.0-20241209100706-e3a3b7c07d26 h1:N65GYmx5LrMeYdeXcxMESDU+2pDyAOXlFNlHl7siUwM=
+github.com/gophercloud/utils/v2 v2.0.0-20241209100706-e3a3b7c07d26/go.mod h1:7SHUbtoiSYINNKgAVxse+PMhIio05IK7shHy8DVRaN0=
 github.com/gordonklaus/ineffassign v0.1.0 h1:y2Gd/9I7MdY1oEIt+n+rowjBNDcLQq3RsH5hwJd0f9s=
 github.com/gordonklaus/ineffassign v0.1.0/go.mod h1:Qcp2HIAYhR7mNUVSIxZww3Guk4it82ghYcEXIAk+QT0=
 github.com/gostaticanalysis/analysisutil v0.7.1 h1:ZMCjoue3DtDWQ5WyU16YbjbQEQ3VuzwxALrpYd+HeKk=
@@ -620,6 +624,8 @@ go.uber.org/automaxprocs v1.6.0 h1:O3y2/QNTOdbF+e/dpXNNW7Rx2hZ4sTIPyybbxyNqTUs=
 go.uber.org/automaxprocs v1.6.0/go.mod h1:ifeIMSnPZuznNm6jmdzmU3/bfk01Fe2fotchwEFJ8r8=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
+go.uber.org/mock v0.5.2 h1:LbtPTcP8A5k9WPXj54PPPbjcI4Y6lhyOZXn+VS7wNko=
+go.uber.org/mock v0.5.2/go.mod h1:wLlUxC2vVTPTaE3UD51E0BGOAElKrILxhVSDYQLld5o=
 go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
 go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=

hack/e2e-openstack.sh

@@ -1,14 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-set -euo pipefail
+# TODO(stephenfin): This is legacy from when the OpenStack e2e tests lived
+# elsewhere. We should remove this script and update the CI jobs to call the
+# Makefile target like everyone else
 
-echo "Running e2e-openstack.sh"
-
-unset GOFLAGS
-tmp="$(mktemp -d)"
-
-echo "cloning github.com/openshift/cluster-api-provider-openstack at branch '$PULL_BASE_REF'"
-git clone --single-branch --branch="$PULL_BASE_REF" --depth=1 "https://github.com/openshift/cluster-api-provider-openstack.git" "$tmp"
-
-echo "running cluster-api-provider-openstack's: make e2e"
-exec make -C "$tmp/openshift" e2e
+exec make e2e

pkg/controllers/infracluster/infracluster_controller.go

@@ -34,8 +34,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 
-	openstackv1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
-
 	configv1 "github.com/openshift/api/config/v1"
 	mapiv1 "github.com/openshift/api/machine/v1"
 	mapiv1beta1 "github.com/openshift/api/machine/v1beta1"
@@ -210,7 +208,7 @@ func (r *InfraClusterController) ensureInfraCluster(ctx context.Context, log log
 
 		infraCluster, err = r.ensureIBMPowerVSCluster(ctx, log)
 		if err != nil {
-			return nil, fmt.Errorf("error ensuring IBMPowerVSCluster: %w", err)
+			return nil, fmt.Errorf("error getting InfraCluster object: %w", err)
 		}
 	case configv1.VSpherePlatformType:
 		var err error
@@ -227,12 +225,12 @@ func (r *InfraClusterController) ensureInfraCluster(ctx context.Context, log log
 			return nil, fmt.Errorf("error getting InfraCluster object: %w", err)
 		}
 	case configv1.OpenStackPlatformType:
-		openstackCluster := &openstackv1.OpenStackCluster{}
-		if err := r.Get(ctx, client.ObjectKey{Namespace: r.CAPINamespace, Name: r.Infra.Status.InfrastructureName}, openstackCluster); err != nil && !kerrors.IsNotFound(err) {
+		var err error
+
+		infraCluster, err = r.ensureOpenStackCluster(ctx, log)
+		if err != nil {
 			return nil, fmt.Errorf("error getting InfraCluster object: %w", err)
 		}
-
-		infraCluster = openstackCluster
 	default:
 		return nil, errPlatformNotSupported
 	}