[ExternalNode] Implement SupportbundleCollection status on Controller #4249

wenyingd · 2022-09-27T11:21:59Z

Manage support bundle collection status on Controller side.

Aggregate the SupportBundleCollectionNodeStatus to updat to CRD status.
Report CollectionFailure condition when any Node/ExternalNode reports a failure

Signed-off-by: wenyingd [email protected]

codecov · 2022-09-27T11:42:37Z

Codecov Report

Merging #4249 (9e1da34) into main (6003cfa) will increase coverage by 0.57%.
The diff coverage is 90.51%.

@@            Coverage Diff             @@
##             main    #4249      +/-   ##
==========================================
+ Coverage   64.53%   65.10%   +0.57%     
==========================================
  Files         397      398       +1     
  Lines       56239    56484     +245     
==========================================
+ Hits        36292    36775     +483     
+ Misses      17287    17051     -236     
+ Partials     2660     2658       -2

Flag	Coverage Δ
e2e-tests	`38.76% <2.19%> (?)`
integration-tests	`34.60% <ø> (+0.04%)`	⬆️
kind-e2e-tests	`48.44% <2.56%> (+0.95%)`	⬆️
unit-tests	`48.97% <89.05%> (+0.24%)`	⬆️

Impacted Files	Coverage Δ
cmd/antrea-controller/controller.go	`0.00% <0.00%> (ø)`
...istry/controlplane/supportbundlecollection/rest.go	`79.48% <ø> (ø)`
...g/controller/supportbundlecollection/controller.go	`81.99% <90.15%> (+6.06%)`	⬆️
pkg/apiserver/apiserver.go	`91.09% <100.00%> (+0.09%)`	⬆️
...ntrolplane/supportbundlecollection/subresources.go	`100.00% <100.00%> (ø)`
pkg/agent/cniserver/ipam/ipam_service.go	`76.40% <0.00%> (-12.36%)`	⬇️
pkg/controller/networkpolicy/tier.go	`50.00% <0.00%> (-5.00%)`	⬇️
pkg/agent/interfacestore/interface_cache.go	`97.36% <0.00%> (-2.64%)`	⬇️
...gent/controller/networkpolicy/status_controller.go	`79.16% <0.00%> (-2.50%)`	⬇️
pkg/agent/openflow/multicluster.go	`44.85% <0.00%> (-1.87%)`	⬇️
... and 35 more

tnqn · 2022-11-02T04:49:46Z

pkg/apiserver/registry/controlplane/supportbundlecollection/subresources.go

+	"antrea.io/antrea/pkg/apis/controlplane"
+)
+
+// StatusREST implements the REST endpoint for getting NetworkPolicy's obj.


need update

tnqn · 2022-11-02T07:06:50Z

pkg/controller/supportbundlecollection/controller.go

@@ -169,6 +173,8 @@ func (c *Controller) Run(stopCh <-chan struct{}) {

 	go wait.Until(c.worker, time.Second, stopCh)

+	go c.StatusController.Run(stopCh)


This looks a bit strange. If we decouple supportBundleController and statusBundleStatusController, it doesn't make sense to inject the latter to the former and let the former to start both. As seen from the change, the only purpose of this injection is to start the status controller.

But here I feel there is no need to have a separate statusController, as the existing controller would also update status. If we just add some logic to the existing controller, many repeated code could be saved and no need to worry about race conditions between the two controllers.

tnqn · 2022-11-03T15:24:29Z

pkg/apiserver/registry/controlplane/supportbundlecollection/subresources.go

+	"antrea.io/antrea/pkg/apis/controlplane"
+)
+
+// StatusREST implements the REST endpoint for getting NetworkPolicy's obj.


tnqn · 2022-11-03T17:34:08Z

pkg/controller/supportbundlecollection/controller.go

+	// Update internal SupportBundleCollection status. This is triggered when Agent reports status.
+	// The event that SupportBundleCollection CR status update will not trigger this logic.


I think the comments are not accurate and maybe unnecessary.
It could be also triggered by the scheduling for expiry handling, and it seems now the expiry handling would never be executed as it's in createInternalSupportBundleCollection. I think the function name createInternalSupportBundleCollection is not accurate and some logic should be moved to updateStatus.

Remove the comments, and move the call of updateStatus out of createInternalSupportBundleCollection, and call updateStatus only in syncSupportBundleCollection

pkg/controller/supportbundlecollection/controller.go

tnqn · 2022-11-03T17:59:02Z

pkg/controller/supportbundlecollection/controller.go

+}
+
+func conditionSliceEqualsIgnoreLastTransitionTime(as, bs []v1alpha1.SupportBundleCollectionCondition) bool {
+	sort.Slice(as, func(i, j int) bool {


A way to simplify this is to always set full condition list whenever updating status, instead of only setting Completed to True but never False, and always using the same order to store status in slice.

It is difficult to provide a full condition list any time when updating the status, for example, if the Started is false, it is meaningless to set a condition that CollectionFailure is false, and completed is false. Besides, we expect to leverage CollectionFailure=False as part of the identifier for all Nodes have uploaded the files to server. So I think the condition status is set as false when all Nodes are succeeded to upload. But if it is set in advance ( because no failure was found at that time, but maybe happens in future), it is easier to introduce misunderstanding.

I change the logic to sort the conditions before executing update operation to reduce the complexity, and set condition status of CollectionComplete and bundleCollected whenever updating the status, but for CollectionFailure, the status is set when a failure is reported from any Node or no failure is reported from all Nodes.

I think the condition is there regardless of the stage of the realization, it seems you want to use "unset" to represent another state in addition to True and False. The condition value doesn't have to mean the final state, it could change based on the actual state. For example, when Started is false, it doesn't seem wrong that CollectionFailure is False and Completed is False as it just means there is no collection failure yet and the collection is not completed yet, they are obvious and redundant but not wrong and not ambiguous.

Got it, updated.

pkg/apiserver/registry/controlplane/supportbundlecollection/subresources.go

tnqn · 2022-11-10T12:55:01Z

pkg/controller/supportbundlecollection/controller.go

 	_, oldInternalBundleExists, _ := c.supportBundleCollectionStore.Get(bundle.Name)
 	if oldInternalBundleExists {
 		klog.InfoS("Internal SupportBundleCollection already exists", "name", bundle.Name)
-		return nil
+		return nil, nil


this can never happen since you have checked the object doesn't exist before calling create method.

Yes, thanks for catching it, removed.

tnqn · 2022-11-10T13:13:54Z

pkg/controller/supportbundlecollection/controller.go

+}
+
+func conditionSliceEqualsIgnoreLastTransitionTime(as, bs []v1alpha1.SupportBundleCollectionCondition) bool {
+	sort.Slice(as, func(i, j int) bool {


I think the condition is there regardless of the stage of the realization, it seems you want to use "unset" to represent another state in addition to True and False. The condition value doesn't have to mean the final state, it could change based on the actual state. For example, when Started is false, it doesn't seem wrong that CollectionFailure is False and Completed is False as it just means there is no collection failure yet and the collection is not completed yet, they are obvious and redundant but not wrong and not ambiguous.

pkg/controller/supportbundlecollection/controller.go

tnqn · 2022-11-14T12:19:47Z

pkg/controller/supportbundlecollection/controller.go

+			return nil
+		}
+		toUpdate.Status = *updatedStatus
+		klog.V(2).InfoS("Updating SupportBundleCollection", "supportBundleCollection", name, "status", klog.KObj(toUpdate))


klog.KObj will just print the object name, just like the existing name, instead of the status part of the object.

tnqn

LGTM

tnqn · 2022-11-15T05:12:50Z

pkg/controller/supportbundlecollection/controller.go

+	updateStatusFunc := func(currentNodes, desiredNodes int, updatedConditions []v1alpha1.SupportBundleCollectionCondition) error {
+		status := &v1alpha1.SupportBundleCollectionStatus{
+			SucceededNodes: int32(currentNodes),
+			DesiredNodes:   int32(desiredNodes),
+			Conditions:     updatedConditions,
+		}
+		klog.V(2).InfoS("Updating SupportBundleCollection status", "supportBundleCollection", internalBundleCollection.Name, "status", status)
+		return c.updateSupportBundleCollectionStatus(internalBundleCollection.Name, status)
+	}


nit: it seems no benefit gained from having this as a function now.

Yes, removed.

wenyingd · 2022-11-15T06:11:18Z

/test-all

tnqn

LGTM

tnqn · 2022-11-15T14:22:54Z

@jianjuns @mengdie-song please let me know if you will take another look or if this looks good to you.

mengdie-song

I want to confirm a RBAC question. For now, it seems that controller only has update privilege for supportbundlecollections/status. Then if agent side calls UpdateStatus function, it should use create privilege?

wenyingd · 2022-11-16T03:46:46Z

I want to confirm a RBAC question. For now, it seems that controller only has update privilege for supportbundlecollections/status. Then if agent side calls UpdateStatus function, it should use create privilege?

Controller needs update privilege to update CR SupportBundleCollection status, and Agent needs create privilege on the internal resource supportbundlecollections/status

Signed-off-by: wenyingd <[email protected]>

wenyingd · 2022-11-16T08:19:45Z

I want to confirm a RBAC question. For now, it seems that controller only has update privilege for supportbundlecollections/status. Then if agent side calls UpdateStatus function, it should use create privilege?

Thanks for proposing it, the failure catches one issue in Controller apiserver in my code. Resolved in my latest change.

mengdie-song

LGTM

tnqn

@wenyingd I see controller.go is updated, any change in it I need to recheck?

wenyingd · 2022-11-17T01:57:57Z

@wenyingd I see controller.go is updated, any change in it I need to recheck?

No logic change happens in controller.go. The change is about the Field name ( SucceededNodes -> CollectedNodes ) in SupportBundleCollectionStatus, which was not matching the name defined in the CRD.

tnqn

LGTM

tnqn · 2022-11-17T03:51:55Z

/test-all

tnqn · 2022-11-17T10:49:20Z

/skip-conformance which failed on an irrelevant case (and was env issue)

…er (antrea-io#4249) Signed-off-by: wenyingd <[email protected]>

wenyingd changed the title ~~Implement SupportbundleCollection status on Controller~~ [ExternalNode] Implement SupportbundleCollection status on Controller Sep 28, 2022

wenyingd mentioned this pull request Sep 30, 2022

[ExternalNode] Implement SupportBundleCollection on Controller #4184

Merged

wenyingd force-pushed the supportbundle_status branch from 19313fc to f5ff083 Compare September 30, 2022 07:37

tnqn added this to the Antrea v1.9 release milestone Oct 11, 2022

wenyingd modified the milestones: Antrea v1.9 release, Antrea v1.10 release Oct 13, 2022

wenyingd force-pushed the supportbundle_status branch from f5ff083 to c9ed12e Compare October 18, 2022 11:21

wenyingd requested a review from tnqn October 24, 2022 09:31

wenyingd force-pushed the supportbundle_status branch from c9ed12e to 96f6bd8 Compare October 27, 2022 12:29

wenyingd requested review from jianjuns and mengdie-song November 2, 2022 02:54

tnqn reviewed Nov 2, 2022

View reviewed changes

wenyingd force-pushed the supportbundle_status branch 2 times, most recently from e0a7989 to 5ef40c9 Compare November 3, 2022 04:01

tnqn reviewed Nov 3, 2022

View reviewed changes

wenyingd force-pushed the supportbundle_status branch from 5ef40c9 to 7f1a078 Compare November 9, 2022 15:18

wenyingd requested a review from tnqn November 9, 2022 15:18

tnqn reviewed Nov 10, 2022

View reviewed changes

pkg/controller/supportbundlecollection/controller.go Outdated Show resolved Hide resolved

wenyingd force-pushed the supportbundle_status branch from 7f1a078 to c66ed1d Compare November 14, 2022 05:40

tnqn reviewed Nov 14, 2022

View reviewed changes

wenyingd force-pushed the supportbundle_status branch from c66ed1d to bae291c Compare November 15, 2022 03:23

tnqn previously approved these changes Nov 15, 2022

View reviewed changes

wenyingd dismissed tnqn’s stale review via 3bb4e40 November 15, 2022 06:10

wenyingd force-pushed the supportbundle_status branch from bae291c to 3bb4e40 Compare November 15, 2022 06:10

tnqn previously approved these changes Nov 15, 2022

View reviewed changes

mengdie-song reviewed Nov 16, 2022

View reviewed changes

[ExternalNode] Implement support bundle collection status on Controller

9e1da34

Signed-off-by: wenyingd <[email protected]>

wenyingd dismissed tnqn’s stale review via 9e1da34 November 16, 2022 08:11

wenyingd force-pushed the supportbundle_status branch from 3bb4e40 to 9e1da34 Compare November 16, 2022 08:11

mengdie-song approved these changes Nov 16, 2022

View reviewed changes

tnqn reviewed Nov 16, 2022

View reviewed changes

tnqn approved these changes Nov 17, 2022

View reviewed changes

tnqn merged commit 073dbf9 into antrea-io:main Nov 17, 2022

GraysonWu pushed a commit to GraysonWu/antrea that referenced this pull request Jan 27, 2023

[ExternalNode] Implement support bundle collection status on Controll…

82051bc

…er (antrea-io#4249) Signed-off-by: wenyingd <[email protected]>

heanlan pushed a commit to heanlan/antrea that referenced this pull request Mar 29, 2023

[ExternalNode] Implement support bundle collection status on Controll…

151d5d7

…er (antrea-io#4249) Signed-off-by: wenyingd <[email protected]>

wenyingd deleted the supportbundle_status branch May 30, 2023 07:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ExternalNode] Implement SupportbundleCollection status on Controller #4249

[ExternalNode] Implement SupportbundleCollection status on Controller #4249

wenyingd commented Sep 27, 2022

codecov bot commented Sep 27, 2022 •

edited

Loading

tnqn Nov 2, 2022

tnqn Nov 3, 2022

wenyingd Nov 9, 2022

tnqn Nov 2, 2022

tnqn Nov 3, 2022

tnqn Nov 3, 2022

wenyingd Nov 9, 2022

tnqn Nov 3, 2022

wenyingd Nov 9, 2022

tnqn Nov 10, 2022

wenyingd Nov 14, 2022

tnqn Nov 10, 2022

wenyingd Nov 14, 2022

tnqn Nov 10, 2022

tnqn Nov 14, 2022

wenyingd Nov 15, 2022

tnqn left a comment

tnqn Nov 15, 2022

wenyingd Nov 15, 2022

wenyingd commented Nov 15, 2022

tnqn left a comment

tnqn commented Nov 15, 2022

mengdie-song left a comment

wenyingd commented Nov 16, 2022

wenyingd commented Nov 16, 2022

mengdie-song left a comment

tnqn left a comment

wenyingd commented Nov 17, 2022

tnqn left a comment

tnqn commented Nov 17, 2022

tnqn commented Nov 17, 2022

		@@ -169,6 +173,8 @@ func (c *Controller) Run(stopCh <-chan struct{}) {

		go wait.Until(c.worker, time.Second, stopCh)

		go c.StatusController.Run(stopCh)

		// Update internal SupportBundleCollection status. This is triggered when Agent reports status.
		// The event that SupportBundleCollection CR status update will not trigger this logic.

[ExternalNode] Implement SupportbundleCollection status on Controller #4249

[ExternalNode] Implement SupportbundleCollection status on Controller #4249

Conversation

wenyingd commented Sep 27, 2022

codecov bot commented Sep 27, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tnqn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenyingd commented Nov 15, 2022

tnqn left a comment

Choose a reason for hiding this comment

tnqn commented Nov 15, 2022

mengdie-song left a comment

Choose a reason for hiding this comment

wenyingd commented Nov 16, 2022

wenyingd commented Nov 16, 2022

mengdie-song left a comment

Choose a reason for hiding this comment

tnqn left a comment

Choose a reason for hiding this comment

wenyingd commented Nov 17, 2022

tnqn left a comment

Choose a reason for hiding this comment

tnqn commented Nov 17, 2022

tnqn commented Nov 17, 2022

codecov bot commented Sep 27, 2022 •

edited

Loading