Stop serving v1alpha7

The API was marked as deprecated in v0.11.x, we propose to stop
serving it in v0.12.x and we'll remove it in v0.13.x.

That would give ~1 year to our users to update their manifests, since
the v1beta1 release.

Author: EmilienM

api/v1alpha7/openstackcluster_types.go

@@ -234,6 +234,7 @@ type OpenStackClusterStatus struct {
 // +kubebuilder:object:root=true
 // +kubebuilder:resource:path=openstackclusters,scope=Namespaced,categories=cluster-api,shortName=osc
 // +kubebuilder:subresource:status
+// +kubebuilder:unservedversion
 // +kubebuilder:deprecatedversion:warning="The v1alpha7 version of OpenStackCluster has been deprecated and will be removed in a future release."
 // +kubebuilder:printcolumn:name="Cluster",type="string",JSONPath=".metadata.labels.cluster\\.x-k8s\\.io/cluster-name",description="Cluster to which this OpenStackCluster belongs"
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.ready",description="Cluster infrastructure is ready for OpenStack instances"

api/v1alpha7/openstackclustertemplate_types.go

@@ -32,6 +32,7 @@ type OpenStackClusterTemplateSpec struct {
 
 // +genclient
 // +kubebuilder:object:root=true
+// +kubebuilder:unservedversion
 // +kubebuilder:deprecatedversion:warning="The v1alpha7 version of OpenStackClusterTemplate has been deprecated and will be removed in a future release."
 // +kubebuilder:resource:path=openstackclustertemplates,scope=Namespaced,categories=cluster-api,shortName=osct
 

api/v1alpha7/openstackmachine_types.go

@@ -145,6 +145,7 @@ type OpenStackMachineStatus struct {
 
 // +genclient
 // +kubebuilder:object:root=true
+// +kubebuilder:unservedversion
 // +kubebuilder:deprecatedversion:warning="The v1alpha7 version of OpenStackMachine has been deprecated and will be removed in a future release."
 // +kubebuilder:resource:path=openstackmachines,scope=Namespaced,categories=cluster-api,shortName=osm
 // +kubebuilder:subresource:status

api/v1alpha7/openstackmachinetemplate_types.go

@@ -27,6 +27,7 @@ type OpenStackMachineTemplateSpec struct {
 
 // +genclient
 // +kubebuilder:object:root=true
+// +kubebuilder:unservedversion
 // +kubebuilder:deprecatedversion:warning="The v1alpha7 version of OpenStackMachineTemplate has been deprecated and will be removed in a future release."
 // +kubebuilder:resource:path=openstackmachinetemplates,scope=Namespaced,categories=cluster-api,shortName=osmt
 

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml

@@ -21,17 +21,14 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"github.com/onsi/gomega/format"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	infrav1alpha7 "sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha7"
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
 )
 
@@ -239,79 +236,4 @@ var _ = Describe("OpenStackCluster API validations", func() {
 			Expect(createObj(u)).To(Succeed(), "OpenStackCluster creation should succeed")
 		})
 	})
-
-	Context("v1alpha7", func() {
-		var cluster *infrav1alpha7.OpenStackCluster //nolint: staticcheck
-
-		BeforeEach(func() {
-			// Initialise a basic cluster object in the correct namespace
-			cluster = &infrav1alpha7.OpenStackCluster{} //nolint: staticcheck
-			cluster.Namespace = namespace.Name
-			cluster.GenerateName = clusterNamePrefix
-		})
-
-		It("should restore cluster spec idempotently after controller writes to controlPlaneEndpoint", func() {
-			// Set identityRef.Kind, as it will be lost if the restorer does not execute
-			cluster.Spec.IdentityRef = &infrav1alpha7.OpenStackIdentityReference{
-				Kind: "FakeKind",
-				Name: "identity-ref",
-			}
-			Expect(createObj(cluster)).To(Succeed(), "OpenStackCluster creation should succeed")
-
-			// Fetch the infrav1 version of the cluster
-			infrav1Cluster := &infrav1.OpenStackCluster{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: cluster.Name, Namespace: cluster.Namespace}, infrav1Cluster)).To(Succeed(), "OpenStackCluster fetch should succeed")
-
-			// Update the infrav1 cluster to set the control plane endpoint
-			infrav1Cluster.Spec.ControlPlaneEndpoint = &clusterv1.APIEndpoint{
-				Host: "foo",
-				Port: 1234,
-			}
-			Expect(k8sClient.Update(ctx, infrav1Cluster)).To(Succeed(), "Setting control plane endpoint should succeed")
-
-			// Fetch the v1alpha7 version of the cluster and ensure that both the new control plane endpoint and the identityRef.Kind are present
-			cluster = &infrav1alpha7.OpenStackCluster{} //nolint:staticcheck
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: infrav1Cluster.Name, Namespace: infrav1Cluster.Namespace}, cluster)).To(Succeed(), "OpenStackCluster fetch should succeed")
-			Expect(cluster.Spec.ControlPlaneEndpoint).To(Equal(*infrav1Cluster.Spec.ControlPlaneEndpoint), "Control plane endpoint should be restored")
-			Expect(cluster.Spec.IdentityRef.Kind).To(Equal("FakeKind"), "IdentityRef.Kind should be restored")
-		})
-
-		It("should not enable an explicitly disabled bastion when converting to v1beta1", func() {
-			cluster.Spec.Bastion = &infrav1alpha7.Bastion{Enabled: false}
-			Expect(createObj(cluster)).To(Succeed(), "OpenStackCluster creation should succeed")
-
-			// Fetch the infrav1 version of the cluster
-			infrav1Cluster := &infrav1.OpenStackCluster{}
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: cluster.Name, Namespace: cluster.Namespace}, infrav1Cluster)).To(Succeed(), "OpenStackCluster fetch should succeed")
-
-			infrav1Bastion := infrav1Cluster.Spec.Bastion
-
-			// NOTE(mdbooth): It may be reasonable to remove the
-			// bastion if it is disabled with no other properties.
-			// It would be reasonable to update the assertions
-			// accordingly if we did that.
-			Expect(infrav1Bastion).ToNot(BeNil(), "Bastion should not have been removed")
-			Expect(infrav1Bastion.Enabled).To(Equal(ptr.To(false)), "Bastion should remain disabled")
-		})
-
-		It("should downgrade cleanly from infrav1", func() {
-			infrav1Cluster := &infrav1.OpenStackCluster{}
-			infrav1Cluster.Namespace = namespace.Name
-			infrav1Cluster.GenerateName = clusterNamePrefix
-			infrav1Cluster.Spec.IdentityRef.CloudName = "test-cloud"
-			infrav1Cluster.Spec.IdentityRef.Name = "test-credentials"
-			Expect(createObj(infrav1Cluster)).To(Succeed(), "infrav1 OpenStackCluster creation should succeed")
-
-			// Just fetching the object as v1alpha7 doesn't trigger
-			// validation failure, so we first fetch it and then
-			// patch the object with identical contents. The patch
-			// triggers a validation failure.
-			cluster := &infrav1alpha7.OpenStackCluster{} //nolint: staticcheck
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: infrav1Cluster.Name, Namespace: infrav1Cluster.Namespace}, cluster)).To(Succeed(), "OpenStackCluster fetch should succeed")
-
-			setObjectGVK(cluster)
-			cluster.ManagedFields = nil
-			Expect(k8sClient.Patch(ctx, cluster, client.Apply, client.FieldOwner("test"), client.ForceOwnership)).To(Succeed(), format.Object(cluster, 4))
-		})
-	})
 })

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml

@@ -21,13 +21,9 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"github.com/onsi/gomega/format"
 	corev1 "k8s.io/api/core/v1"
-	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
-	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	infrav1alpha7 "sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha7"
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
 )
 
@@ -548,30 +544,4 @@ var _ = Describe("OpenStackMachine API validations", func() {
 			Expect(k8sClient.Create(ctx, machineSN)).NotTo(Succeed(), "Creating a machine with string type but number value scheduler hint property should fail.")
 		})
 	})
-
-	Context("v1alpha7", func() {
-		It("should downgrade cleanly from infrav1", func() {
-			infrav1Machine := &infrav1.OpenStackMachine{}
-			infrav1Machine.Namespace = namespace.Name
-			infrav1Machine.GenerateName = clusterNamePrefix
-			infrav1Machine.Spec.IdentityRef = &infrav1.OpenStackIdentityReference{
-				CloudName: "test-cloud",
-				Name:      "test-credentials",
-			}
-			infrav1Machine.Spec.Image.ID = ptr.To("de9872ee-0c2c-44ed-9414-90163c8b0e0d")
-			infrav1Machine.Spec.Flavor = ptr.To("flavor-name")
-			Expect(createObj(infrav1Machine)).To(Succeed(), "infrav1 OpenStackMachine creation should succeed")
-
-			// Just fetching the object as v1alpha7 doesn't trigger
-			// validation failure, so we first fetch it and then
-			// patch the object with identical contents. The patch
-			// triggers a validation failure.
-			machine := &infrav1alpha7.OpenStackMachine{} //nolint: staticcheck
-			Expect(k8sClient.Get(ctx, types.NamespacedName{Name: infrav1Machine.Name, Namespace: infrav1Machine.Namespace}, machine)).To(Succeed(), "OpenStackMachine fetch should succeed")
-
-			setObjectGVK(machine)
-			machine.ManagedFields = nil
-			Expect(k8sClient.Patch(ctx, machine, client.Apply, client.FieldOwner("test"), client.ForceOwnership)).To(Succeed(), format.Object(machine, 4))
-		})
-	})
 })