Merge pull request #12369 from fabriziopandini/switch-clusterctl-describe-to-v1beta2

⚠️ Clusterctl describe defaults to v1beta2

Author: k8s-ci-robot

cmd/clusterctl/client/describe.go

@@ -58,8 +58,10 @@ type DescribeClusterOptions struct {
 	// have the same Status, Severity and Reason.
 	Grouping bool
 
-	// V1Beta2 instructs tree to use V1Beta2 conditions.
-	V1Beta2 bool
+	// V1Beta1 instructs tree to use V1Beta1 conditions.
+	//
+	// Deprecated: This field will be removed when v1beta1 will be dropped.
+	V1Beta1 bool
 }
 
 // DescribeCluster returns the object tree representing the status of a Cluster API cluster.
@@ -99,6 +101,6 @@ func (c *clusterctlClient) DescribeCluster(ctx context.Context, options Describe
 		AddTemplateVirtualNode:  options.AddTemplateVirtualNode,
 		Echo:                    options.Echo,
 		Grouping:                options.Grouping,
-		V1Beta2:                 options.V1Beta2,
+		V1Beta1:                 options.V1Beta1,
 	})
 }

cmd/clusterctl/client/tree/discovery.go

@@ -57,8 +57,10 @@ type DiscoverOptions struct {
 	// have the same Status, Severity and Reason.
 	Grouping bool
 
-	// V1Beta2 instructs tree to use V1Beta2 conditions.
-	V1Beta2 bool
+	// V1Beta1 instructs tree to use V1Beta1 conditions.
+	//
+	// Deprecated: This field will be removed when v1beta1 will be dropped.
+	V1Beta1 bool
 }
 
 func (d DiscoverOptions) toObjectTreeOptions() ObjectTreeOptions {

cmd/clusterctl/client/tree/tree.go

@@ -57,8 +57,10 @@ type ObjectTreeOptions struct {
 	// have the same Status, Severity and Reason
 	Grouping bool
 
-	// V1Beta2 instructs tree to use V1Beta2 conditions.
-	V1Beta2 bool
+	// V1Beta1 instructs tree to use V1Beta1 conditions.
+	//
+	// Deprecated: This field will be removed when v1beta1 will be dropped.
+	V1Beta1 bool
 }
 
 // ObjectTree defines an object tree representing the status of a Cluster API cluster.
@@ -99,15 +101,15 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 	// its parent.
 	var objReadyV1Beta1, parentReadyV1Beta1 *clusterv1.Condition
 	var objAvailable, objReady, objUpToDate, parentReady *metav1.Condition
-	switch od.options.V1Beta2 {
+	switch od.options.V1Beta1 {
 	case true:
+		objReadyV1Beta1 = GetV1Beta1ReadyCondition(obj)
+		parentReadyV1Beta1 = GetV1Beta1ReadyCondition(parent)
+	default:
 		objAvailable = GetAvailableCondition(obj)
 		objReady = GetReadyCondition(obj)
 		objUpToDate = GetMachineUpToDateCondition(obj)
 		parentReady = GetReadyCondition(parent)
-	default:
-		objReadyV1Beta1 = GetV1Beta1ReadyCondition(obj)
-		parentReadyV1Beta1 = GetV1Beta1ReadyCondition(parent)
 	}
 
 	// If it is requested to show all the conditions for the object, add
@@ -119,13 +121,13 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 	// If echo should be dropped from the ObjectTree, return if the object's ready condition is true, and it is the same it has of parent's object ready condition (it is an echo).
 	// Note: the Echo option applies only for infrastructure machine or bootstrap config objects, and for those objects only Ready condition makes sense.
 	if addOpts.NoEcho && !od.options.Echo {
-		switch od.options.V1Beta2 {
+		switch od.options.V1Beta1 {
 		case true:
-			if (objReady != nil && objReady.Status == metav1.ConditionTrue) || hasSameAvailableReadyUptoDateStatusAndReason(nil, nil, parentReady, objReady, nil, nil) {
+			if (objReadyV1Beta1 != nil && objReadyV1Beta1.Status == corev1.ConditionTrue) || hasSameReadyStatusSeverityAndReason(parentReadyV1Beta1, objReadyV1Beta1) {
 				return false, false
 			}
 		default:
-			if (objReadyV1Beta1 != nil && objReadyV1Beta1.Status == corev1.ConditionTrue) || hasSameReadyStatusSeverityAndReason(parentReadyV1Beta1, objReadyV1Beta1) {
+			if (objReady != nil && objReady.Status == metav1.ConditionTrue) || hasSameAvailableReadyUptoDateStatusAndReason(nil, nil, parentReady, objReady, nil, nil) {
 				return false, false
 			}
 		}
@@ -156,8 +158,16 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 
 			var sReadyV1Beta1 *clusterv1.Condition
 			var sAvailable, sReady, sUpToDate *metav1.Condition
-			switch od.options.V1Beta2 {
+			switch od.options.V1Beta1 {
 			case true:
+				sReadyV1Beta1 = GetV1Beta1ReadyCondition(s)
+
+				// If the object's ready condition has a different Status, Severity and Reason than the sibling object,
+				// move on (they should not be grouped).
+				if !hasSameReadyStatusSeverityAndReason(objReadyV1Beta1, sReadyV1Beta1) {
+					continue
+				}
+			default:
 				// If the object's ready condition has a different Available/ReadyUpToDate condition than the sibling object,
 				// move on (they should not be grouped).
 				sAvailable = GetAvailableCondition(s)
@@ -166,26 +176,18 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 				if !hasSameAvailableReadyUptoDateStatusAndReason(objAvailable, sAvailable, objReady, sReady, objUpToDate, sUpToDate) {
 					continue
 				}
-			default:
-				sReadyV1Beta1 = GetV1Beta1ReadyCondition(s)
-
-				// If the object's ready condition has a different Status, Severity and Reason than the sibling object,
-				// move on (they should not be grouped).
-				if !hasSameReadyStatusSeverityAndReason(objReadyV1Beta1, sReadyV1Beta1) {
-					continue
-				}
 			}
 
 			// If the sibling node is already a group object
 			if IsGroupObject(s) {
 				// Check to see if the group object kind matches the object, i.e. group is MachineGroup and object is Machine.
 				// If so, upgrade it with the current object.
 				if s.GetObjectKind().GroupVersionKind().Kind == obj.GetObjectKind().GroupVersionKind().Kind+"Group" {
-					switch od.options.V1Beta2 {
+					switch od.options.V1Beta1 {
 					case true:
-						updateGroupNode(s, sReady, obj, objAvailable, objReady, objUpToDate)
-					default:
 						updateV1Beta1GroupNode(s, sReadyV1Beta1, obj, objReadyV1Beta1)
+					default:
+						updateGroupNode(s, sReady, obj, objAvailable, objReady, objUpToDate)
 					}
 
 					return true, false
@@ -199,11 +201,11 @@ func (od ObjectTree) Add(parent, obj client.Object, opts ...AddObjectOption) (ad
 
 			// Create virtual object for the group and add it to the object tree.
 			var groupNode *NodeObject
-			switch od.options.V1Beta2 {
+			switch od.options.V1Beta1 {
 			case true:
-				groupNode = createGroupNode(s, sReady, obj, objAvailable, objReady, objUpToDate)
-			default:
 				groupNode = createV1Beta1GroupNode(s, sReadyV1Beta1, obj, objReadyV1Beta1)
+			default:
+				groupNode = createGroupNode(s, sReady, obj, objAvailable, objReady, objUpToDate)
 			}
 
 			// By default, grouping objects should be sorted last.

cmd/clusterctl/client/tree/tree_test.go

@@ -860,10 +860,10 @@ func Test_Add_setsShowObjectConditionsAnnotation(t *testing.T) {
 		},
 	}
 	for _, tt := range tests {
-		for _, v1beta2 := range []bool{true, false} {
-			tt.args.treeOptions.V1Beta2 = v1beta2
+		for _, v1beta1 := range []bool{true, false} {
+			tt.args.treeOptions.V1Beta1 = v1beta1
 
-			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta2), func(t *testing.T) {
+			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta1), func(t *testing.T) {
 				root := parent.DeepCopy()
 				tree := NewObjectTree(root, tt.args.treeOptions)
 
@@ -925,10 +925,10 @@ func Test_Add_setsGroupingObjectAnnotation(t *testing.T) {
 		},
 	}
 	for _, tt := range tests {
-		for _, v1beta2 := range []bool{true, false} {
-			tt.args.treeOptions.V1Beta2 = v1beta2
+		for _, v1beta1 := range []bool{true, false} {
+			tt.args.treeOptions.V1Beta1 = v1beta1
 
-			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta2), func(t *testing.T) {
+			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta1), func(t *testing.T) {
 				root := parent.DeepCopy()
 				tree := NewObjectTree(root, tt.args.treeOptions)
 
@@ -979,10 +979,10 @@ func Test_Add_setsObjectMetaNameAnnotation(t *testing.T) {
 		},
 	}
 	for _, tt := range tests {
-		for _, v1beta2 := range []bool{true, false} {
-			treeOptions := ObjectTreeOptions{V1Beta2: v1beta2}
+		for _, v1beta1 := range []bool{true, false} {
+			treeOptions := ObjectTreeOptions{V1Beta1: v1beta1}
 
-			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta2), func(t *testing.T) {
+			t.Run(tt.name+" v1beta2: "+fmt.Sprintf("%t", v1beta1), func(t *testing.T) {
 				root := parent.DeepCopy()
 				tree := NewObjectTree(root, treeOptions)
 
@@ -1067,7 +1067,6 @@ func Test_Add_NoEcho(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			tt.args.treeOptions.V1Beta2 = true
 			root := parent.DeepCopy()
 			tree := NewObjectTree(root, tt.args.treeOptions)
 
@@ -1149,6 +1148,8 @@ func Test_Add_NoEcho_V1Beta1(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			tt.args.treeOptions.V1Beta1 = true
+
 			root := parent.DeepCopy()
 			tree := NewObjectTree(root, tt.args.treeOptions)
 
@@ -1249,7 +1250,7 @@ func Test_Add_Grouping(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			root := parent.DeepCopy()
-			tree := NewObjectTree(root, ObjectTreeOptions{V1Beta2: true})
+			tree := NewObjectTree(root, ObjectTreeOptions{})
 
 			for i := range tt.args.siblings {
 				tree.Add(parent, tt.args.siblings[i], tt.args.addOptions...)
@@ -1361,7 +1362,7 @@ func Test_Add_Grouping_V1Beta1(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			root := parent.DeepCopy()
-			tree := NewObjectTree(root, ObjectTreeOptions{})
+			tree := NewObjectTree(root, ObjectTreeOptions{V1Beta1: true})
 
 			for i := range tt.args.siblings {
 				tree.Add(parent, tt.args.siblings[i], tt.args.addOptions...)

cmd/clusterctl/cmd/describe_cluster.go

@@ -109,8 +109,10 @@ func init() {
 		"Disable grouping machines when ready condition has the same Status, Severity and Reason.")
 	_ = describeClusterClusterCmd.Flags().MarkDeprecated("disable-grouping",
 		"use --grouping instead.")
-	describeClusterClusterCmd.Flags().BoolVar(&dc.v1beta2, "v1beta2", false,
+	describeClusterClusterCmd.Flags().BoolVar(&dc.v1beta2, "v1beta2", true,
 		"Use V1Beta2 conditions..")
+	_ = describeClusterClusterCmd.Flags().MarkDeprecated("v1beta2",
+		"this field will be removed when v1beta1 will be dropped.")
 	describeClusterClusterCmd.Flags().BoolVarP(&dc.color, "color", "c", false, "Enable or disable color output; if not set color is enabled by default only if using tty. The flag is overridden by the NO_COLOR env variable if set.")
 
 	// completions
@@ -144,7 +146,7 @@ func runDescribeCluster(cmd *cobra.Command, name string) error {
 		AddTemplateVirtualNode:  true,
 		Echo:                    dc.echo,
 		Grouping:                dc.grouping && !dc.disableGrouping,
-		V1Beta2:                 dc.v1beta2,
+		V1Beta1:                 !dc.v1beta2,
 	})
 	if err != nil {
 		return err

docs/book/src/developer/providers/migrations/v1.10-to-v1.11.md

@@ -474,12 +474,13 @@ TODO
 
 ### clusterctl
 
-- **Stricter validation for provider metadata**: clusterctl now enforces validation rules when reading provider metadata files to ensure they are properly formatted and contain required information. The following validation rules are now enforced:
+- **Stricter validation for provider metadata**: clusterctl now enforces validation rules when reading provider metadata files to ensure they are properly formatted and contain required information.
+  These changes help surface mis-shaped metadata early and make failures easier to troubleshoot. Providers with invalid metadata.yaml files will need to update them to comply with these validation rules.
+  The following validation rules are now enforced:
   - `apiVersion` must be set to `clusterctl.cluster.x-k8s.io/v1alpha3`
   - `kind` must be set to `Metadata`
   - `releaseSeries` must contain at least one entry
-
-These changes help surface mis-shaped metadata early and make failures easier to troubleshoot. Providers with invalid metadata.yaml files will need to update them to comply with these validation rules.
+- The `--v1beta2` flag in clusterctl describe now defaults to `true`; the flag will be removed as soon as v1beta1 API is removed.
 
 ## Deprecations
 

internal/util/tree/tree_test.go

@@ -314,9 +314,7 @@ func Test_TreePrefix(t *testing.T) {
 						Message: "first line must not be validated in the test\nsecond line",
 					}),
 				)
-				objectTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{
-					V1Beta2: true,
-				})
+				objectTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{})
 
 				o1 := fakeObject("child1",
 					withCondition(falseCondition("Available", "first line must not be validated in the test\nsecond line")),
@@ -348,9 +346,7 @@ func Test_TreePrefix(t *testing.T) {
 						Reason: "Available",
 					}),
 				)
-				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{
-					V1Beta2: true,
-				})
+				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{})
 
 				o1 := fakeObject("child1",
 					withCondition(trueCondition()),
@@ -383,9 +379,7 @@ func Test_TreePrefix(t *testing.T) {
 						Reason: "Available",
 					}),
 				)
-				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{
-					V1Beta2: true,
-				})
+				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{})
 
 				o1 := fakeObject("child1",
 					withCondition(trueCondition()),
@@ -432,9 +426,7 @@ func Test_TreePrefix(t *testing.T) {
 						Reason: "Available",
 					}),
 				)
-				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{
-					V1Beta2: true,
-				})
+				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{})
 
 				o1 := fakeObject("child1",
 					withCondition(trueCondition()),
@@ -475,9 +467,7 @@ func Test_TreePrefix(t *testing.T) {
 						Reason: "Available",
 					}),
 				)
-				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{
-					V1Beta2: true,
-				})
+				obectjTree := tree.NewObjectTree(root, tree.ObjectTreeOptions{})
 
 				o1 := fakeObject("child1",
 					withCondition(trueCondition()),

test/framework/cluster_helpers.go

@@ -368,7 +368,6 @@ func DescribeCluster(ctx context.Context, input DescribeClusterInput) {
 		AddTemplateVirtualNode:  true,
 		Echo:                    true,
 		Grouping:                false,
-		V1Beta2:                 true,
 	})
 	Expect(err).ToNot(HaveOccurred(), "Failed to run clusterctl describe")