Make the output of kubectl describe service more informative
#125117
Conversation
k8s-ci-robot
added
release-note
k8s-ci-robot
added
area/kubectl
sig/cli
|
/sig network |
k8s-ci-robot
added
the
sig/network
|
From sig-cli POV, this looks good to me. But I'd prefer sig-network reviews first. |
|
@ardaguclu thanks for the review. @danwinship @aojea could you please take a look? |
| @@ -3030,7 +3030,7 @@ func describeService(service *corev1.Service, endpointSlices []discoveryv1.Endpo | |||
| w.Write(LEVEL_0, "External IPs:\t%v\n", strings.Join(service.Spec.ExternalIPs, ",")) | |||
| } | |||
| if service.Spec.LoadBalancerIP != "" { | |||
| w.Write(LEVEL_0, "IP:\t%s\n", service.Spec.LoadBalancerIP) | |||
| w.Write(LEVEL_0, "LoadBalancer IP:\t%s\n", service.Spec.LoadBalancerIP) | |||
There was a problem hiding this comment.
should be something like "Requested LoadBalancer IP" to distinguish it from the "LoadBalancer Ingress" (which is the assigned IP/hostname). Though that would be the new longest field name and it seems like we probably don't want the field names to be too long (since it pushes the field values further away, making it harder to read) so if we could abbreviate that somehow...
Alternatively, this field is deprecated anyway and we discourage people from using it, so maybe we should just remove it from "kubectl describe"? (Is describe supposed to show everything or just the most useful stuff?)
There was a problem hiding this comment.
Thanks for the suggestion. How about "Desired LoadBalancer IP"? It has the same length as "External Traffic Policy", so it won't push the values further away.
There was a problem hiding this comment.
I prefer Requested over Desired honestly, better an english native to judge here, at least in spanish desire has some connotations that will not ideal for this context :)
There was a problem hiding this comment.
I see desired is already used in some objects' describers :)
Please let me know if I should still update it to Requested. It will push values two spaces further when the field is not empty, but it's not the longest field, "LoadBalancer Source Ranges" is the one, but none of the tests set it.
There was a problem hiding this comment.
@danwinship @aojea as "desired" is already used in several describers, do you think it could be used in Service describer, or you prefer using "Requested" (which would push the values two spaces unless "LoadBalancer Source Ranges" is also set).
|
lgtm |
|
/approve |
|
/triage accepted |
k8s-ci-robot
added
triage/accepted
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ardaguclu, tnqn 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 |
k8s-ci-robot
added
the
approved
For a LoadBalancer Service, there were two "IP" fields in the output of `kubectl describe service` if its loadBalancerIP is not empty, which looks ambiguous.
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
InternalTrafficPolicy has been GA and LoadBalancerIPMode has been beta and enabled by default. Adding them to the output of
kubectl describe serviceto make it more informative.In addition, for a LoadBalancer Service, there were two "IP" fields in the output of
kubectl describe serviceif its loadBalancerIP is not empty, which looks confusing. The second "IP" is the loadBalancer IP in spec.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: