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

kubectl explain --output flag is missing -o short flag #1664

Open
brianpursley opened this issue Oct 4, 2024 · 4 comments · May be fixed by kubernetes/kubernetes#127869
Open

kubectl explain --output flag is missing -o short flag #1664

brianpursley opened this issue Oct 4, 2024 · 4 comments · May be fixed by kubernetes/kubernetes#127869
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@brianpursley
Copy link
Member

What happened:
kubectl explain has an --output flag, but unlike all other kubectl commands, there is no corresponding -o short flag:

What you expected to happen:
For consistency, kubectl explain should have a -o short flag like other commands that have an --output flag.

How to reproduce it (as minimally and precisely as possible):

~/go/src/k8s.io/kubernetes (master) $ kubectl explain pod -o plaintext-openapiv2
error: unknown shorthand flag: 'o' in -o
See 'kubectl explain --help' for usage.
~/go/src/k8s.io/kubernetes (master) $ kubectl explain pod --output plaintext-openapiv2
KIND:     Pod
VERSION:  v1

DESCRIPTION:
     Pod is a collection of containers that can run on a host. This resource is
     created by clients and scheduled onto hosts.

FIELDS:
   apiVersion	<string>
     APIVersion defines the versioned schema of this representation of an
     object. Servers should convert recognized schemas to the latest internal
     value, and may reject unrecognized values. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   kind	<string>
     Kind is a string value representing the REST resource this object
     represents. Servers may infer this from the endpoint the client submits
     requests to. Cannot be updated. In CamelCase. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata	<Object>
     Standard object's metadata. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   spec	<Object>
     Specification of the desired behavior of the pod. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

   status	<Object>
     Most recently observed status of the pod. This data may not be up to date.
     Populated by the system. Read-only. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Anything else we need to know?:

Environment:

  • Kubernetes client and server versions (use kubectl version):
Client Version: v1.32.0-alpha.0.1230+7478a30fdc6977
Kustomize Version: v5.4.2
Server Version: v1.27.3
WARNING: version difference between client (1.32) and server (1.27) exceeds the supported minor version skew of +/-1
  • Cloud provider or hardware configuration:
  • OS (e.g: cat /etc/os-release): Ubuntu 22.04.5 LTS
@brianpursley brianpursley added the kind/bug Categorizes issue or PR as related to a bug. label Oct 4, 2024
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Oct 4, 2024
@brianpursley
Copy link
Member Author

/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@brianpursley:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Oct 4, 2024
@ardaguclu
Copy link
Member

/triage accepted
/priority backlog

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 4, 2024
@ak20102763
Copy link

Hi @brianpursley / @ardaguclu , may I take this up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants