-
Notifications
You must be signed in to change notification settings - Fork 39.8k
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
Add short name "netpol" for networkpolicies #42241
Add short name "netpol" for networkpolicies #42241
Conversation
Hi @xiangpengzhao. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
[APPROVALNOTIFIER] This PR is NOT APPROVED The following people have approved this PR: xiangpengzhao Needs approval from an approver in each of these OWNERS Files: We suggest the following people: |
@kubernetes/sig-cli-api-reviews |
/release-note |
@kubernetes/sig-network-api-reviews |
Thanks @Kargakis ! Should we also add short names for other resources e.g.
|
@xiangpengzhao I think that you can cover all of those issues here, I will try to close my issue if you can cover all of the short names, comments? Just some proposal for short names
|
StatefulSet alias is being discussed in #37099 |
@smarterclayton There was some concern about new shortcut names - what's the current thinking? |
Just that we be very judicious and actually think through how often they will be used, because they become part of the public CLI API (can't change them without breaking scripts). Any time we still a two letter alias, we are preventing ourselves from using it in the future. The bar for getting an alias is inversely proportional to how long it is and how often it is used (we shouldn't add short aliases for rarely used classes). Most cluster scoped resources aren't going to be accessed that often. We have tab completion, so I'd lean towards no shortcut for rarely accessed resources. |
I agree. NetworkPolicy is long and unwieldy and user-facing (namespaced).
"np" is pretty short. What about netpol ?
…On Tue, Feb 28, 2017 at 4:15 PM, Clayton Coleman ***@***.***> wrote:
Just that we be very judicious and actually think through how often they
will be used, because they become part of the public CLI API (can't change
them without breaking scripts). Any time we still a two letter alias, we
are preventing ourselves from using it in the future. The bar for getting
an alias is inversely proportional to how long it is and how often it is
used (we shouldn't add short aliases for rarely used classes).
Most cluster scoped resources aren't going to be accessed that often. We
have tab completion, so I'd lean towards no shortcut for rarely accessed
resources.
—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
<#42241 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFVgVH1S5iMK4LTq_oMkCsu5CqDK-sOdks5rhLibgaJpZM4MOQZA>
.
|
From a user's perspective, my first reaction is thinking the first letters of the full name of a resource as its shortcut name. If using |
How many users will ever type np often enough to need the shortcut? If we
measured the number of times various resources are used, I'd be willing to
bet that it's a long tail like:
pods
replication controllers
replica sets
deployments
services
persistent volume claims
secrets
configmap
namespace
.... a gap
nodes
.... a very large gap
everything else
…On Tue, Feb 28, 2017 at 10:27 PM, Peter Zhao ***@***.***> wrote:
From a user's perspective, my first reaction is thinking the first letters
of the full name of a resource as its shortcut name. If using netpol or
something else, users may have to try several times to find the right
shortcut:) On the other hand, using np will keep the same style with the
most existing shortcuts.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#42241 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABG_pzkncUFMpIII44UHP0raWbS8gcm1ks5rhOWGgaJpZM4MOQZA>
.
|
Reasonable. These resources are indeed not used so often. Then should we close this PR or just merge it and leave other resources without shortcuts as they are now? |
I would be OK with netpol, but np is too vague.
…On Tue, Feb 28, 2017 at 7:48 PM, Peter Zhao ***@***.***> wrote:
Reasonable. These resources are indeed not used so often. Then should we
close this PR or just merge it and leave other resources without shortcuts
as they are now?
—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
<#42241 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AFVgVJ_hAsKLZ5sLWgcxQiudDazLu97Xks5rhOqOgaJpZM4MOQZA>
.
|
91d8d46
to
5daa698
Compare
Addressed, but not sure if it's still necessary to merge this according to @smarterclayton 's reason :) |
@k8s-bot ok to test |
@k8s-bot gci gce e2e test this |
@xiangpengzhao: The following test(s) failed:
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Automatic merge from submit-queue (batch tested with PRs 44862, 42241, 42101, 43181, 44147) |
What this PR does / why we need it:
Add short name for
networkpolicies
in kubectl command for good user experience.Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close that issue when PR gets merged): fixes #None
Special notes for your reviewer:
None
Release note: