Skip to content

Commit c6d70ab

Browse files
authored
Merge pull request #11744 from sbueringer/prdeprecate-index
🌱 Deprecate old ClusterClass index
2 parents 29905d5 + 9efb8dd commit c6d70ab

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

api/v1beta1/index/cluster.go

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ import (
2929

3030
const (
3131
// ClusterClassNameField is used by the Cluster controller to index Clusters by ClusterClass name.
32+
//
33+
// Deprecated: This constant will be removed in an upcoming release, please use ClusterClassRefPath instead.
3234
ClusterClassNameField = "spec.topology.class"
3335

3436
// ClusterClassRefPath is used by the Cluster controller to index Clusters by ClusterClass name and namespace.
@@ -70,6 +72,8 @@ func ClusterClassRef(cc *clusterv1.ClusterClass) string {
7072

7173
// ByClusterClassName adds the cluster class name index to the
7274
// managers cache.
75+
//
76+
// Deprecated: This func will be removed in an upcoming release, please use ByClusterClassRef instead.
7377
func ByClusterClassName(ctx context.Context, mgr ctrl.Manager) error {
7478
if err := mgr.GetCache().IndexField(ctx, &clusterv1.Cluster{},
7579
ClusterClassNameField,
@@ -81,6 +85,8 @@ func ByClusterClassName(ctx context.Context, mgr ctrl.Manager) error {
8185
}
8286

8387
// ClusterByClusterClassClassName contains the logic to index Clusters by ClusterClass name.
88+
//
89+
// Deprecated: This func will be removed in an upcoming release, please use ClusterByClusterClassRef instead.
8490
func ClusterByClusterClassClassName(o client.Object) []string {
8591
cluster, ok := o.(*clusterv1.Cluster)
8692
if !ok {

0 commit comments

Comments
 (0)