Merge pull request #2387 from shiftstack/prep-v0.12.x

k8s-ci-robot · web-flow · commit ac29f1af4068 · 2025-01-23T07:30:58.000-08:00
🌱 Prepare 0.12.x release
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -50,6 +50,57 @@ updates:
     - "area/dependency"
     - "ok-to-test"
 ## main branch config ends here
+## release-0.12 branch config starts here
+# github-actions
+- directory: "/"
+  package-ecosystem: "github-actions"
+  schedule:
+    interval: "weekly"
+    day: "monday"
+  target-branch: release-0.12
+  groups:
+    all-github-actions:
+      patterns: [ "*" ]
+  commit-message:
+    prefix: ":seedling:"
+    include: scope
+  labels:
+  - "area/dependency"
+  - "ok-to-test"
+# Go directories
+- directories:
+  - "/"
+  - "/hack/tools"
+  package-ecosystem: "gomod"
+  schedule:
+    interval: "weekly"
+    day: "monday"
+  target-branch: release-0.12
+  groups:
+    all-go-mod-patch-and-minor:
+      patterns: [ "*" ]
+      update-types: [ "patch", "minor" ]
+  commit-message:
+    prefix: ":seedling:"
+    include: scope
+  ignore:
+  # Ignore CAPI major and minor bumps
+  - dependency-name: "sigs.k8s.io/cluster-api*"
+    update-types: ["version-update:semver-major", "version-update:semver-minor"]
+  # Ignore controller-runtime major and minor bumps as its upgraded manually.
+  - dependency-name: "sigs.k8s.io/controller-runtime"
+    update-types: ["version-update:semver-major", "version-update:semver-minor"]
+  # Ignore k8s major and minor bumps and its transitives modules
+  - dependency-name: "k8s.io/*"
+    update-types: ["version-update:semver-major", "version-update:semver-minor"]
+  - dependency-name: "sigs.k8s.io/controller-tools"
+    update-types: ["version-update:semver-major", "version-update:semver-minor"]
+  # We will need k8s v0.31.3 to bump structured-merge-diff to v4.4.2 (check git history for details).
+  - dependency-name: "sigs.k8s.io/structured-merge-diff/*"
+  labels:
+    - "area/dependency"
+    - "ok-to-test"
+## release-0.12 branch config ends here
 ## release-0.11 branch config starts here
 # github-actions
 - directory: "/"
@@ -98,10 +149,6 @@ updates:
     update-types: ["version-update:semver-major", "version-update:semver-minor"]
   # We will need k8s v0.31.3 to bump structured-merge-diff to v4.4.2 (check git history for details).
   - dependency-name: "sigs.k8s.io/structured-merge-diff/*"
-  # Newest code-generator requires k8s api minor version (to v0.31.x) which we don't want at this point
-  # https://github.com/kubernetes/code-generator/commit/3dab3dd1438bd944bd9ae050ec5e6fe6750ad994
-  - dependency-name: "k8s.io/code-generator"
-    update-types: ["version-update:semver-major", "version-update:semver-minor"]
   labels:
     - "area/dependency"
     - "ok-to-test"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -41,12 +41,13 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
 - For the current stable API version (v1beta1) we support the two most recent minor releases; older minor releases are immediately unsupported when a new major/minor release is available.
 - For older API versions we only support the most recent minor release until the API version reaches EOL.
 - We will maintain test coverage for all supported minor releases and for one additional release for the current stable API version in case we have to do an emergency patch release.
-  For example, if v0.10 and v0.11 are currently supported, we will also maintain test coverage for v0.9 for one additional release cycle. When v0.12 is released, tests for v0.9 will be removed.
+  For example, if v0.11 and v0.12 are currently supported, we will also maintain test coverage for v0.10 for one additional release cycle. When v0.13 is released, tests for v0.10 will be removed.
 
 | Minor Release | API Version  | Supported Until                                |
 |---------------|--------------|------------------------------------------------|
+| v0.12.x       | **v1beta1**  | when v0.14.0 will be released                  |
 | v0.11.x       | **v1beta1**  | when v0.13.0 will be released                  |
-| v0.10.x       | **v1beta1**  | when v0.12.0 will be released                  |
+| v0.10.x       | **v1beta1**  | EOL to be defined (v0.12.0 release date)       |
 | v0.9.x        | **v1alpha7** | EOL since 2024-10-24 - v0.11.0 release date    |
 | v0.8.x        | **v1alpha7** | EOL since 2024-04-17 - v0.10.0 release date    |
 
@@ -56,6 +57,7 @@ Cluster API Provider OpenStack maintains the most recent release/releases for al
 
 | Minor Release | v1beta1       | v1alpha7   | v1alpha6   | v1alpha5   |
 |---------------|---------------|------------|------------|------------|
+| v0.12.x       | **supported** | not served |            |            |
 | v0.11.x       | **supported** | deprecated | not served |            |
 | v0.10.x       | **supported** | supported  | deprecated | not served |
 | v0.9.x        |               | supported  | supported  | deprecated |
diff --git a/api/v1alpha7/openstackcluster_types.go b/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"
diff --git a/api/v1alpha7/openstackclustertemplate_types.go b/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
 
diff --git a/api/v1alpha7/openstackmachine_types.go b/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
diff --git a/api/v1alpha7/openstackmachinetemplate_types.go b/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
 
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachines.yaml
diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_openstackmachinetemplates.yaml
diff --git a/metadata.yaml b/metadata.yaml
@@ -22,3 +22,6 @@ releaseSeries:
 - major: 0
   minor: 11
   contract: v1beta1
+- major: 0
+  minor: 12
+  contract: v1beta1
diff --git a/test/e2e/data/e2e_conf.yaml b/test/e2e/data/e2e_conf.yaml
@@ -117,7 +117,7 @@ providers:
       new: "--v=4"
     - old: "--leader-elect"
       new: "--leader-elect=false\n        - --sync-period=1m"
-  - name: v0.11.99
+  - name: v0.12.99
     value: ../../../config/default
     # This is the upcoming version.
     # Specify no contract so that upgrade tests that start from a specific contract won't pick it up.
diff --git a/test/e2e/data/shared/v1beta1_provider/metadata.yaml b/test/e2e/data/shared/v1beta1_provider/metadata.yaml
@@ -22,3 +22,6 @@ releaseSeries:
 - major: 0
   minor: 11
   contract: v1beta1
+- major: 0
+  minor: 12
+  contract: v1beta1
diff --git a/test/e2e/suites/apivalidations/openstackcluster_test.go b/test/e2e/suites/apivalidations/openstackcluster_test.go
@@ -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))
-		})
-	})
 })
diff --git a/test/e2e/suites/apivalidations/openstackmachine_test.go b/test/e2e/suites/apivalidations/openstackmachine_test.go
@@ -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))
-		})
-	})
 })
diff --git a/test/e2e/suites/apivalidations/suite_test.go b/test/e2e/suites/apivalidations/suite_test.go
@@ -40,7 +40,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
 	infrav1alpha1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha1"
-	infrav1alpha7 "sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha7"
 	infrav1 "sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1"
 	"sigs.k8s.io/cluster-api-provider-openstack/pkg/webhooks"
 )
@@ -69,7 +68,6 @@ var _ = BeforeSuite(func() {
 	testScheme = scheme.Scheme
 	for _, f := range []func(*runtime.Scheme) error{
 		infrav1alpha1.AddToScheme,
-		infrav1alpha7.AddToScheme,
 		infrav1.AddToScheme,
 	} {
 		Expect(f(testScheme)).To(Succeed())
@@ -171,11 +169,3 @@ func createObj(obj client.Object) error {
 	}
 	return err
 }
-
-func setObjectGVK(obj runtime.Object) {
-	gvk, unversioned, err := testScheme.ObjectKinds(obj)
-	Expect(unversioned).To(BeFalse(), "Object is considered unversioned")
-	Expect(err).ToNot(HaveOccurred(), "Error fetching gvk for Object")
-	Expect(gvk).To(HaveLen(1), "Object should have only one gvk")
-	obj.GetObjectKind().SetGroupVersionKind(gvk[0])
-}
