Enhance the capabilities of the karmadactl get command #5254

hulizhe · 2024-07-26T02:36:00Z

What type of PR is this?
/kind feature

What this PR does / why we need it:

Fix the issue of incomplete output when the resource does not found

before:

$ karmadactl get secret 
No resources found in  namespace.

after:

$ karmadactl get secret 
No resources found in default namespace.

Enhance karmadactl to provide a complete resource view of the Karmada control plane and member clusters.

Given that the Karmada control plane has a deployment named nginx, which is propagated to member1 and member2.

// display deployment in Karmada control plane
$ _output/bin/linux/amd64/karmadactl get deployment             
NAME    CLUSTER   READY   UP-TO-DATE   AVAILABLE   AGE   ADOPTION
nginx   Karmada   0/2     4            0           17s   -

// display deployment in Karmada control plane and all member clusters
$ _output/bin/linux/amd64/karmadactl get deployment --operation-scope all
NAME    CLUSTER   READY   UP-TO-DATE   AVAILABLE   AGE   ADOPTION
nginx   Karmada   0/2     4            0           26s   -
nginx   member1   0/2     2            0           26s   Y
nginx   member2   0/2     2            0           26s   Y

// display deployment in Karmada control plane and member1
$ _output/bin/linux/amd64/karmadactl get deployment --operation-scope all -Cmember1     
NAME    CLUSTER   READY   UP-TO-DATE   AVAILABLE   AGE   ADOPTION
nginx   Karmada   0/2     4            0           37s   -
nginx   member1   0/2     2            0           37s   Y

// only display deployment in member clustes
$ _output/bin/linux/amd64/karmadactl get deployment --operation-scope members
NAME    CLUSTER   READY   UP-TO-DATE   AVAILABLE   AGE   ADOPTION
nginx   member1   2/2     2            2           65s   Y
nginx   member2   0/2     2            0           65s   Y

// only display deployment in member1
$ _output/bin/linux/amd64/karmadactl get deployment --operation-scope members -Cmember1
NAME    CLUSTER   READY   UP-TO-DATE   AVAILABLE   AGE   ADOPTION
nginx   member1   2/2     2            2           65s   Y

Which issue(s) this PR fixes:
Parts of #5249

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

`karmadactl`: The `get` command can show Karmada resources now.

codecov-commenter · 2024-07-26T02:50:08Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 0% with 101 lines in your changes missing coverage. Please review.

Project coverage is 29.35%. Comparing base (bcefb22) to head (37a6dc9).
Report is 2 commits behind head on master.

Files	Patch %	Lines
pkg/karmadactl/get/get.go	0.00%	72 Missing ⚠️
pkg/karmadactl/options/global.go	0.00%	29 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5254      +/-   ##
==========================================
- Coverage   29.41%   29.35%   -0.06%     
==========================================
  Files         632      632              
  Lines       43835    43901      +66     
==========================================
- Hits        12892    12889       -3     
- Misses      30003    30071      +68     
- Partials      940      941       +1

Flag	Coverage Δ
unittests	`29.35% <0.00%> (-0.06%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pkg/karmadactl/get/get.go

zhzhuang-zju · 2024-08-05T08:39:05Z

cc @XiShanYongYe-Chang @chaunceyjiang

zhzhuang-zju · 2024-08-15T10:32:37Z

/retest

zhzhuang-zju · 2024-08-15T11:22:47Z

[FAIL] [resource-status collection] resource status collection testing PodDisruptionBudget collection testing [It] pdb status collection testing

The probability of this e2e tests failing has been quite high recently.

/retest

RainbowMango

/assign

zhzhuang-zju · 2024-08-15T12:33:16Z

The probability of this e2e tests failing has been quite high recently.

tracked by #5382

/retest

pkg/karmadactl/options/global.go

pkg/karmadactl/get/get.go

pkg/karmadactl/options/global.go

pkg/karmadactl/get/get.go

RainbowMango · 2024-08-18T11:10:18Z

pkg/karmadactl/get/get.go

 	flags.StringVarP(options.DefaultConfigFlags.Namespace, "namespace", "n", *options.DefaultConfigFlags.Namespace, "If present, the namespace scope for this CLI request")
 	flags.StringVarP(&o.LabelSelector, "labels", "l", "", "-l=label or -l label")
-	flags.StringSliceVarP(&o.Clusters, "clusters", "C", []string{}, "-C=member1,member2")
+	flags.StringSliceVarP(&o.Clusters, "clusters", "C", []string{}, "Used to specify target member clusters and only takes effect when the command's operation scope includes member clusters, for example: --operation-scope=all -C=member1,member2")


How about this one?

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

RainbowMango

/lgtm
/approve

karmada-bot · 2024-08-19T03:01:43Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

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:

~~pkg/karmadactl/OWNERS~~ [RainbowMango]
~~test/OWNERS~~ [RainbowMango]

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

zhzhuang-zju · 2024-08-19T03:15:50Z

/retest

karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Jul 26, 2024

karmada-bot requested review from carlory and yanfeng1992 July 26, 2024 02:36

karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 26, 2024

zhzhuang-zju mentioned this pull request Jul 26, 2024

Enhance karmadactl operation and maintenance experience #5249

Closed

15 tasks

zhzhuang-zju reviewed Jul 29, 2024

View reviewed changes

pkg/karmadactl/get/get.go Outdated Show resolved Hide resolved

hulizhe force-pushed the karmadactlget branch 2 times, most recently from 2c2fae2 to fedd361 Compare August 2, 2024 09:03

hulizhe force-pushed the karmadactlget branch from fedd361 to 7482c76 Compare August 15, 2024 07:34

hulizhe requested a review from zhzhuang-zju August 15, 2024 07:37

hulizhe force-pushed the karmadactlget branch from 7482c76 to 298deb7 Compare August 15, 2024 08:17

RainbowMango reviewed Aug 15, 2024

View reviewed changes

karmada-bot assigned RainbowMango Aug 15, 2024

hulizhe force-pushed the karmadactlget branch from 298deb7 to 7a7d054 Compare August 16, 2024 02:31

zhzhuang-zju reviewed Aug 16, 2024

View reviewed changes

pkg/karmadactl/options/global.go Outdated Show resolved Hide resolved

hulizhe force-pushed the karmadactlget branch from 7a7d054 to 9095cc5 Compare August 16, 2024 02:45

RainbowMango reviewed Aug 16, 2024

View reviewed changes

hulizhe force-pushed the karmadactlget branch 2 times, most recently from 2f7dfb5 to 054c22b Compare August 17, 2024 02:57

RainbowMango reviewed Aug 18, 2024

View reviewed changes

hulizhe force-pushed the karmadactlget branch from 054c22b to f8d054a Compare August 19, 2024 01:38

hulizhe added 2 commits August 19, 2024 10:16

enhance karmadactl get command

99ef7a3

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

karmadactl get e2e test

37a6dc9

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

hulizhe force-pushed the karmadactlget branch from f8d054a to 37a6dc9 Compare August 19, 2024 02:17

RainbowMango approved these changes Aug 19, 2024

View reviewed changes

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2024

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 19, 2024

karmada-bot merged commit f3ae66b into karmada-io:master Aug 19, 2024
12 checks passed

RainbowMango mentioned this pull request Aug 19, 2024

enhance karmadactl describe command #5392

Merged

RainbowMango added this to the v1.11 milestone Aug 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance the capabilities of the karmadactl get command #5254

Enhance the capabilities of the karmadactl get command #5254

hulizhe commented Jul 26, 2024 •

edited by RainbowMango

Loading

codecov-commenter commented Jul 26, 2024 •

edited

Loading

zhzhuang-zju commented Aug 5, 2024

zhzhuang-zju commented Aug 15, 2024

zhzhuang-zju commented Aug 15, 2024

RainbowMango left a comment

zhzhuang-zju commented Aug 15, 2024

RainbowMango Aug 18, 2024

RainbowMango left a comment

karmada-bot commented Aug 19, 2024

zhzhuang-zju commented Aug 19, 2024

Enhance the capabilities of the karmadactl get command #5254

Enhance the capabilities of the karmadactl get command #5254

Conversation

hulizhe commented Jul 26, 2024 • edited by RainbowMango Loading

codecov-commenter commented Jul 26, 2024 • edited Loading

Codecov Report

zhzhuang-zju commented Aug 5, 2024

zhzhuang-zju commented Aug 15, 2024

zhzhuang-zju commented Aug 15, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

zhzhuang-zju commented Aug 15, 2024

RainbowMango Aug 18, 2024

Choose a reason for hiding this comment

RainbowMango left a comment

Choose a reason for hiding this comment

karmada-bot commented Aug 19, 2024

zhzhuang-zju commented Aug 19, 2024

hulizhe commented Jul 26, 2024 •

edited by RainbowMango

Loading

codecov-commenter commented Jul 26, 2024 •

edited

Loading