✨ Fix `klusterlet-info` command and update `hub-info` output. #453

RokibulHasan7 · 2024-10-24T18:23:35Z

Summary

Related issue(s)

Fixes #

Signed-off-by: Rokibul Hasan <[email protected]>

zhujian7 · 2024-10-25T06:45:09Z

pkg/cmd/get/hubinfo/exec.go

@@ -59,6 +59,7 @@ const (

 	componentNameRegistrationController = "cluster-manager-registration-controller"
 	componentNameRegistrationWebhook    = "cluster-manager-registration-webhook"
+	componentNameWorkController         = "cluster-manager-work-controller"


we do not have a work controller component on the hub side.

If I enable the ManifestWorkReplicaSet feature, then the work controller gets deployed.

so I think we should print the work-controller only when the ManifestWorkReplicaSet feature is enabled.
BTW, the cluster-manager-addon-manager-controller is in the same situation. if the AddonManagement feature is enabled, we should print the addon-manager info.

Updated code to print each controller only when its feature is enabled

could you add some tests or paste some test result because when I try to use the command to get info, I got:

╰─# oc get pod -n open-cluster-management 2 ↵ NAME READY STATUS RESTARTS AGE managedcluster-import-controller-99968fd7-s6dk2 1/1 Running 0 17h ╰─# oc get pod -n open-cluster-management-hub NAME READY STATUS RESTARTS AGE cluster-manager-addon-manager-controller-664d75f6bf-kgb8b 1/1 Running 0 17h cluster-manager-registration-controller-84c6489fd9-rxnld 1/1 Running 0 17h cluster-manager-registration-webhook-69d78f8744-wt4hf 1/1 Running 0 17h cluster-manager-work-webhook-69f55b7fb5-shsld 1/1 Running 0 17h ╰─# oc get clustermanager cluster-manager -oyaml apiVersion: operator.open-cluster-management.io/v1 kind: ClusterManager metadata: annotations: kubectl.kubernetes.io/last-applied-configuration: | {"apiVersion":"operator.open-cluster-management.io/v1","kind":"ClusterManager","metadata":{"annotations":{},"name":"cluster-manager"},"spec":{"addOnManagerImagePullSpec":"quay.io/stolostron/addon-manager:main","deployOption":{"mode":"Default"},"placementImagePullSpec":"quay.io/stolostron/placement:main","registrationConfiguration":{"featureGates":[{"feature":"DefaultClusterSet","mode":"Enable"}]},"registrationImagePullSpec":"quay.io/stolostron/registration:main","workImagePullSpec":"quay.io/stolostron/work:main"}} creationTimestamp: "2024-10-25T09:10:46Z" finalizers: - operator.open-cluster-management.io/cluster-manager-cleanup generation: 1 name: cluster-manager resourceVersion: "852" uid: 963a4a8a-c94f-4cce-beb9-8d0afb415a82 spec: addOnManagerImagePullSpec: quay.io/stolostron/addon-manager:main deployOption: mode: Default placementImagePullSpec: quay.io/stolostron/placement:main registrationConfiguration: featureGates: - feature: DefaultClusterSet mode: Enable registrationImagePullSpec: quay.io/stolostron/registration:main workConfiguration: workDriver: kube workImagePullSpec: quay.io/stolostron/work:main ╰─# clusteradm get hub-info Registration Operator: Controller: (0/0) quay.io/open-cluster-management/registration-operator:latest CustomResourceDefinition: (installed) clustermanagers.operator.open-cluster-management.io [*v1] Components: panic: runtime error: invalid memory address or nil pointer dereference [signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x2dd9af3] goroutine 1 [running]: open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo.(*Options).printComponents(0xc000887000) /home/go/src/open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo/exec.go:121 +0xb3 open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo.(*Options).run(0xc000887000) /home/go/src/open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo/exec.go:76 +0x27 open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo.NewCmd.func2(0xc000906200?, {0x57a9ec0, 0x0, 0x0}) /home/go/src/open-cluster-management.io/clusteradm/pkg/cmd/get/hubinfo/cmd.go:39 +0x6f github.com/spf13/cobra.(*Command).execute(0xc0008dcc08, {0x57a9ec0, 0x0, 0x0}) /home/go/src/open-cluster-management.io/clusteradm/vendor/github.com/spf13/cobra/command.go:985 +0xaca github.com/spf13/cobra.(*Command).ExecuteC(0xc0008c4008) /home/go/src/open-cluster-management.io/clusteradm/vendor/github.com/spf13/cobra/command.go:1117 +0x3ff github.com/spf13/cobra.(*Command).Execute(...) /home/go/src/open-cluster-management.io/clusteradm/vendor/github.com/spf13/cobra/command.go:1041 main.main() /home/go/src/open-cluster-management.io/clusteradm/cmd/clusteradm/clusteradm.go:131 +0xc3c

I found even there is no addOnManagerConfiguration configured in the clustermanager.spec, the addon-manager is enabled by default.

so maybe we need to refactor the IsFeatureEnabled func.
references:

https://github.com/open-cluster-management-io/ocm/blob/865ae069b3e5eab72faf3c1bcd2eb52bb7c1b8c6/pkg/registration/spoke/spokeagent.go#L419

https://github.com/open-cluster-management-io/api/blob/f6c65820279078afbe536d5a6012e0b3badde3c5/feature/feature.go#L90

zhujian7 · 2024-10-25T06:49:43Z

pkg/cmd/get/klusterletinfo/exec.go

@@ -57,8 +57,7 @@ const (
 	registrationOperatorNamespace = "open-cluster-management"
 	klusterletCRD                 = "klusterlets.operator.open-cluster-management.io"

-	componentNameRegistrationAgent = "klusterlet-registration-agent"
-	componentNameWorkAgent         = "klusterlet-work-agent"
+	componentNameKlusterletAgent = "klusterlet-agent"


we have 2 deploy modes for the klusterlet:

Default mode: there will be two components on the managed cluster, registration-agent and work-agent

Singleton mode: there will be only one component klusterlet-agent

Here maybe we need to print the agent components based on the klusterlet deploy mode.

Signed-off-by: Rokibul Hasan <[email protected]>

zhujian7 · 2024-10-28T01:32:58Z

pkg/helpers/check/check.go

+func IsFeatureEnabled(featureGates []operatorv1.FeatureGate, feature string) bool {
+	for _, fg := range featureGates {
+		if fg.Feature == feature && fg.Mode == operatorv1.FeatureGateModeTypeEnable {
+			return true


This still does not fit the add-on manager case, because it is enabled by default.
so there are two cases:

enabled by default(eg. addon-manager): as long as the feature gate flag is not explicitly set to false(including the feature gate config is not set), we should output the info

disabled by default(eg. work-controller): only output the info when the feature gate flag is explicitly set to true

example: https://github.com/open-cluster-management-io/ocm/blob/865ae069b3e5eab72faf3c1bcd2eb52bb7c1b8c6/pkg/registration/spoke/spokeagent.go#L419
feature gate default values: https://github.com/open-cluster-management-io/api/blob/f6c65820279078afbe536d5a6012e0b3badde3c5/feature/feature.go#L90

zhujian7 · 2024-10-28T01:34:45Z

/cc @qiujian16

Signed-off-by: Rokibul Hasan <[email protected]>

zhujian7 · 2024-10-29T02:18:19Z

@RokibulHasan7 Thanks!!! :)
/lgtm

qiujian16 · 2024-10-29T03:02:59Z

/approve

thanks, this is great. Something in my mind as the future enhancement: we should also link all the related events in this command.

openshift-ci · 2024-10-29T03:03:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiujian16, RokibulHasan7

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiujian16]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Fix klusterlet-info command and update hub-info output.

c776493

Signed-off-by: Rokibul Hasan <[email protected]>

openshift-ci bot requested review from ycyaoxdu and yue9944882 October 24, 2024 18:23

RokibulHasan7 changed the title ~~Fix klusterlet-info command and update hub-info output.~~ ✨ Fix klusterlet-info command and update hub-info output. Oct 24, 2024

zhujian7 suggested changes Oct 25, 2024

View reviewed changes

openshift-ci bot assigned zhujian7 Oct 25, 2024

RokibulHasan7 added 2 commits October 25, 2024 14:13

Handle Default mode of klusterlet

d3cd9ba

Signed-off-by: Rokibul Hasan <[email protected]>

Print addon-manager info

750e384

Signed-off-by: Rokibul Hasan <[email protected]>

RokibulHasan7 force-pushed the update-info branch from 0aa627f to d5073ed Compare October 26, 2024 02:58

Fix panic issue

ad43749

Signed-off-by: Rokibul Hasan <[email protected]>

RokibulHasan7 force-pushed the update-info branch from d5073ed to ad43749 Compare October 26, 2024 03:16

zhujian7 reviewed Oct 28, 2024

View reviewed changes

openshift-ci bot requested a review from qiujian16 October 28, 2024 01:34

Handle addon-manager case

5511482

Signed-off-by: Rokibul Hasan <[email protected]>

RokibulHasan7 force-pushed the update-info branch from 93e4866 to 5511482 Compare October 28, 2024 02:31

openshift-ci bot added the lgtm label Oct 29, 2024

openshift-ci bot added the approved label Oct 29, 2024

openshift-merge-bot bot merged commit e5a4b77 into open-cluster-management-io:main Oct 29, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Fix `klusterlet-info` command and update `hub-info` output. #453

✨ Fix `klusterlet-info` command and update `hub-info` output. #453

RokibulHasan7 commented Oct 24, 2024

zhujian7 Oct 25, 2024

RokibulHasan7 Oct 25, 2024

zhujian7 Oct 25, 2024

RokibulHasan7 Oct 25, 2024

zhujian7 Oct 26, 2024 •

edited

Loading

zhujian7 Oct 26, 2024

zhujian7 Oct 26, 2024

zhujian7 Oct 25, 2024

zhujian7 Oct 25, 2024

RokibulHasan7 Oct 25, 2024

zhujian7 Oct 28, 2024 •

edited

Loading

zhujian7 commented Oct 28, 2024

zhujian7 commented Oct 29, 2024

qiujian16 commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

✨ Fix klusterlet-info command and update hub-info output. #453

✨ Fix klusterlet-info command and update hub-info output. #453

Conversation

RokibulHasan7 commented Oct 24, 2024

Summary

Related issue(s)

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

zhujian7 Oct 26, 2024 • edited Loading

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

zhujian7 Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

zhujian7 commented Oct 28, 2024

zhujian7 commented Oct 29, 2024

qiujian16 commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

✨ Fix `klusterlet-info` command and update `hub-info` output. #453

✨ Fix `klusterlet-info` command and update `hub-info` output. #453

zhujian7 Oct 26, 2024 •

edited

Loading

zhujian7 Oct 28, 2024 •

edited

Loading