From abac997b5fb9f87284c1125b6cb83dd8bf6d1c20 Mon Sep 17 00:00:00 2001 From: Stefan Bueringer Date: Thu, 22 May 2025 15:00:19 +0200 Subject: [PATCH] Remove deprecated index ByClusterClassName, ClusterByClusterClassClassName and ClusterClassNameField MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stefan Büringer buringerst@vmware.com --- api/core/v1beta2/index/cluster.go | 33 ------------------- .../providers/migrations/v1.10-to-v1.11.md | 2 ++ 2 files changed, 2 insertions(+), 33 deletions(-) diff --git a/api/core/v1beta2/index/cluster.go b/api/core/v1beta2/index/cluster.go index 5787622f635b..aa5ba4ab9b69 100644 --- a/api/core/v1beta2/index/cluster.go +++ b/api/core/v1beta2/index/cluster.go @@ -28,11 +28,6 @@ import ( ) const ( - // ClusterClassNameField is used by the Cluster controller to index Clusters by ClusterClass name. - // - // Deprecated: This constant will be removed in an upcoming release, please use ClusterClassRefPath instead. - ClusterClassNameField = "spec.topology.class" - // ClusterClassRefPath is used by the Cluster controller to index Clusters by ClusterClass name and namespace. ClusterClassRefPath = "spec.topology.classRef" @@ -69,31 +64,3 @@ func ClusterByClusterClassRef(o client.Object) []string { func ClusterClassRef(cc *clusterv1.ClusterClass) string { return fmt.Sprintf(clusterClassRefFmt, cc.GetNamespace(), cc.GetName()) } - -// ByClusterClassName adds the cluster class name index to the -// managers cache. -// -// Deprecated: This func will be removed in an upcoming release, please use ByClusterClassRef instead. -func ByClusterClassName(ctx context.Context, mgr ctrl.Manager) error { - if err := mgr.GetCache().IndexField(ctx, &clusterv1.Cluster{}, - ClusterClassNameField, - ClusterByClusterClassClassName, - ); err != nil { - return errors.Wrap(err, "error setting index field") - } - return nil -} - -// ClusterByClusterClassClassName contains the logic to index Clusters by ClusterClass name. -// -// Deprecated: This func will be removed in an upcoming release, please use ClusterByClusterClassRef instead. -func ClusterByClusterClassClassName(o client.Object) []string { - cluster, ok := o.(*clusterv1.Cluster) - if !ok { - panic(fmt.Sprintf("Expected Cluster but got a %T", o)) - } - if cluster.Spec.Topology != nil { - return []string{cluster.GetClassKey().Name} - } - return nil -} diff --git a/docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md b/docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md index 8492f2ecd1f8..d3eb20ed1621 100644 --- a/docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md +++ b/docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md @@ -109,6 +109,8 @@ proposal because most of the changes described below are a consequence of the wo - `status.failureReason` and `status.failureMessage` will continue to exist temporarily under `status.deprecated.v1beta1`. - The const values for `Failed` phase has been deprecated in the enum type for `status.phase` (controllers are not setting this value anymore) - The `GetIPFamily` method (deprecated since CAPI v1.8) has been removed +- The `index.ByClusterClassName`, `index.ClusterByClusterClassClassName` and `index.ClusterClassNameField` types have been removed + in favor of `index.ByClusterClassRef`, `index.ClusterByClusterClassRef` and `index.ClusterClassRefPath` ### MachineDeployment