Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added 's' shorthand to operation-scope flags #5483

Merged

Conversation

ahorine
Copy link
Contributor

@ahorine ahorine commented Sep 4, 2024

What type of PR is this?

/kind feature

What this PR does / why we need it:
The operation-scope flag gets used a lot when examining resources on member clusters. The 's' shorthand was added to improve user QoL.

Does this PR introduce a user-facing change?:

`karmadactl`: Added shorthand letter `s` to 'operation-scope' flags across commands.

@karmada-bot karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 4, 2024
@karmada-bot
Copy link
Collaborator

Welcome @ahorine! It looks like this is your first PR to karmada-io/karmada 🎉

@karmada-bot karmada-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 4, 2024
The operation-scope flag gets used a lot when examining resources on
member clusters. The 's' shorthand was added to improve user QoL.

Signed-off-by: ahorine <[email protected]>
@ahorine ahorine force-pushed the feature/operation-scope-shorthand branch from 80e0990 to 5d2cf3e Compare September 4, 2024 20:53
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

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

Project coverage is 31.70%. Comparing base (f2bed78) to head (5d2cf3e).

Files with missing lines Patch % Lines
pkg/karmadactl/apiresources/apiresources.go 0.00% 1 Missing ⚠️
pkg/karmadactl/apiresources/apiversions.go 0.00% 1 Missing ⚠️
pkg/karmadactl/attach/attach.go 0.00% 1 Missing ⚠️
pkg/karmadactl/describe/describe.go 0.00% 1 Missing ⚠️
pkg/karmadactl/exec/exec.go 0.00% 1 Missing ⚠️
pkg/karmadactl/explain/explain.go 0.00% 1 Missing ⚠️
pkg/karmadactl/get/get.go 0.00% 1 Missing ⚠️

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5483      +/-   ##
==========================================
- Coverage   31.71%   31.70%   -0.01%     
==========================================
  Files         643      643              
  Lines       44444    44444              
==========================================
- Hits        14094    14091       -3     
- Misses      29321    29323       +2     
- Partials     1029     1030       +1     
Flag Coverage Δ
unittests 31.70% <0.00%> (-0.01%) ⬇️

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.

@zhzhuang-zju
Copy link
Contributor

@ahorine Is karmadactl being used by you or your organization as the operations command tool? Falg operation-scope was introduced in karmadactl in release 1.11, and there have been many other capability enhancements besides this. We look forward to feedback from users on their experience.

@ahorine
Copy link
Contributor Author

ahorine commented Sep 5, 2024

@zhzhuang-zju Currently the kubectl plugin form (kubectl-karmada) is my go-to for administration and such. I moved one of the multicluster development environments I'm supported from 1.10.1. to 1.11.0 as a trial earlier today, and so far I'm liking the enhancements. A lot of the features added to the CLI tool were ones that I had previously been wanting, and being able to see both the member and controlplane resources within the same tool with the operation-scope flag makes it feel more streamlined.

That said, since operation-scope defaults to karmada and I'm often wanting to look at stuff on members, just today alone I found myself typing it very frequently, and ended up really wanting a shorthand flag alternative. I think the operation-scope flag was a great enhancement, and the shorthand would be very nice to have as a user.

@zhzhuang-zju
Copy link
Contributor

A lot of the features added to the CLI tool were ones that I had previously been wanting, and being able to see both the member and controlplane resources within the same tool with the operation-scope flag makes it feel more streamlined.

Glad to hear that. The capability enhancements are ongoing, and you can track the new features of karmadactl in release-1.12 through #5477. Your participation is also highly welcome~
If you have any suggestions or new requirements while using karmadactl, please feel free to share them through comments, issues or PRs. We look forward to more feedback from you.

I'm often wanting to look at stuff on members, just today alone I found myself typing it very frequently, and ended up really wanting a shorthand flag alternative

Get it. Frequently using the full name of operation-scope is burdensome; it would be better to have an easier way to achieve this.

@RainbowMango
Copy link
Member

@ahorine Thank you for doing this and giving feedback, it means a lot to us.

Usually, we would be cautious about introducing shorthand parameters as those might bring confusion and ambiguity. But as you mentioned, this parameter will be used frequently, so I think giving a shorthand parameter is reasonable.

Given that this PR is unlikely to be backported, this change might be included in v1.12 instead of v1.11.x. Is that OK with you?

By the way, are you using Karmada now? Just want you to know that we'd always love to establish connections with users to listen to voices, provide support, and so on.

@ahorine
Copy link
Contributor Author

ahorine commented Sep 5, 2024

@RainbowMango

Given that this PR is unlikely to be backported, this change might be included in v1.12 instead of v1.11.x. Is that OK with you?

A v1.12 target is absolutely fine considering this is largely QoL more than anything else.

By the way, are you using Karmada now? Just want you to know that we'd always love to establish connections with users to listen to voices, provide support, and so on.

Yes, I am the lead for devops/cloudops/infra for the dev and test teams for the products we’re working on, and one of the current projects is supporting geo redundancy. I have 6+ environments between dev and test running Karmada currently, with some more planned.

I’m already in the Slack channels, and I’m sure I’ll be getting involved a bit more going forward as the efforts I’m supporting start ramping up.

@zhzhuang-zju
Copy link
Contributor

/lgtm
The shorthand s can represent operation-scope's scope, and currently, no other parameters use the shorthand s. Therefore, I think using s as the shorthand for the operation-scope parameter is feasible.
cc @RainbowMango for another look

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Sep 5, 2024
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

I updated the release notes a little bit, by the way.

@karmada-bot
Copy link
Collaborator

[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:

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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 5, 2024
@karmada-bot karmada-bot merged commit 136e268 into karmada-io:master Sep 5, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants