Skip to content

⚠️ Remove deprecated index ByClusterClassName, ClusterByClusterClassClassName and ClusterClassNameField #12269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged

⚠️ Remove deprecated index ByClusterClassName, ClusterByClusterClassClassName and ClusterClassNameField #12269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions api/core/v1beta2/index/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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
}
2 changes: 2 additions & 0 deletions docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading