Improving kubectl get output #123440

Ritikaa96 · 2024-02-22T09:33:18Z

Signed-off-by: Ritikaa96 <ritika@india.nec.com

What this PR does / why we need it:

Adding namespace flag & examples
kubectl get --help states the following even though we can use --namespace to get details for other namespace resources.

Display one or many resources.

 Prints a table of the most important information about the specified resources.
You can filter the list using a label selector and the --selector flag. If the
desired resource type is namespaced you will only see results in your current
namespace unless you pass --all-namespaces.
...

The description should mention --namespace as this can show objects/resources from different namespace as well

Which issue(s) this PR fixes:

Fixes #kubernetes/kubectl#1555

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

NONE

Ritikaa96 · 2024-02-22T09:41:05Z

/sig cli
/kind bug

ardaguclu · 2024-02-22T09:45:55Z

staging/src/k8s.io/kubectl/pkg/cmd/get/get.go

@@ -92,7 +92,7 @@ var (
 		Prints a table of the most important information about the specified resources.
 		You can filter the list using a label selector and the --selector flag. If the
 		desired resource type is namespaced you will only see results in your current
-		namespace unless you pass --all-namespaces.
+		namespace unless you pass --all-namespaces or --namespace(for specific namespace)


What about?

Suggested change

namespace unless you pass --all-namespaces or --namespace(for specific namespace)

namespace by passing --namespace(for specific namespace) unless you pass --all-namespaces.

The whole sentence doesnt make sense then.
how about

If the desired resource type is namespaced you will only see results in your current namespace unless you pass --namespace or --all-namespaces.

or better..

If the desired resource type is namespaced you will only see results in other namespaces by passing --namespace(for specific namespace) or --all-namespaces.

ardaguclu · 2024-02-22T09:46:23Z

staging/src/k8s.io/kubectl/pkg/cmd/get/get.go

+		kubectl get deployments.apps --namespace backend
+
+		# List all pods existing in all namespaces
+		kubectl get pods --all-namspaces`))


Suggested change

kubectl get pods --all-namspaces`))

kubectl get pods --all-namespaces`))

oh!! how did i miss that.

ardaguclu · 2024-02-22T09:46:45Z

staging/src/k8s.io/kubectl/pkg/cmd/get/get.go

-		kubectl get pod web-pod-13je7 --subresource status`))
+		kubectl get pod web-pod-13je7 --subresource status
+
+		# List all deployments in namespace - backend


Suggested change

# List all deployments in namespace - backend

# List all deployments in namespace 'backend'

ardaguclu · 2024-02-22T09:47:28Z

/kind cleanup
/release-note-none

Ritikaa96 · 2024-02-26T05:37:08Z

Made some changes PTAL @ardaguclu

ardaguclu · 2024-02-26T05:59:01Z

staging/src/k8s.io/kubectl/pkg/cmd/get/get.go

@@ -91,8 +91,8 @@ var (

 		Prints a table of the most important information about the specified resources.
 		You can filter the list using a label selector and the --selector flag. If the
-		desired resource type is namespaced you will only see results in your current
-		namespace unless you pass --all-namespaces.
+		desired resource type is namespaced you will only see results in other namespaces


or current namespace if user doesn't specify none of them?

Ritikaa96 · 2024-03-14T09:48:53Z

/easycla

Ritikaa96 · 2024-05-27T10:48:55Z

Hi , is there anything to add in this PR as the PR is awaiting reviews from long.

ardaguclu · 2024-05-27T10:52:59Z

Hi , is there anything to add in this PR as the PR is awaiting reviews from long.

This https://github.com/kubernetes/kubernetes/pull/123440/files#r1502075458 comment hasn't been resolved yet.

Adding namespace flag & examples Signed-off-by: Ritikaa96 <ritika@india.nec.com>

Signed-off-by: Ritikaa96 <ritika@india.nec.com>

Ritikaa96 · 2024-05-30T06:25:29Z

Hi , is there anything to add in this PR as the PR is awaiting reviews from long.

This https://github.com/kubernetes/kubernetes/pull/123440/files#r1502075458 comment hasn't been resolved yet.

Hi @ardaguclu I have made some changes. PTAL. Does it look good or i should make another change?

ardaguclu · 2024-05-30T06:32:27Z

Thank you
/lgtm
/approve
/triage accepted
/priority backlog

k8s-ci-robot · 2024-05-30T06:32:32Z

LGTM label has been added.

Git tree hash: 207a2efea30bed8048287727d7814ce7c1a3300c

k8s-ci-robot · 2024-05-30T06:32:56Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ardaguclu, Ritikaa96

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:

~~staging/src/k8s.io/kubectl/OWNERS~~ [ardaguclu]

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

ardaguclu · 2024-05-30T07:20:54Z

this is only doc change;
/retest

ardaguclu · 2024-05-30T08:00:56Z

/retest

k8s-triage-robot · 2024-05-30T10:47:38Z

The Kubernetes project has merge-blocking tests that are currently too flaky to consistently pass.

This bot retests PRs for certain kubernetes repos according to the following rules:

The PR does have any do-not-merge/* labels
The PR does not have the needs-ok-to-test label
The PR is mergeable (does not have a needs-rebase label)
The PR is approved (has cncf-cla: yes, lgtm, approved labels)
The PR is failing tests required for merge

You can:

Review the full test history for this PR
Prevent this bot from retesting with /lgtm cancel or /hold
Help make our tests less flaky by following our Flaky Tests Guide

/retest

Ritikaa96 · 2024-05-30T13:46:22Z

Seems like all the test have passed . Waiting for @dims review .
Thanks a lot @ardaguclu !!

k8s-ci-robot requested review from ardaguclu and dims February 22, 2024 09:34

Ritikaa96 force-pushed the kubectl-improve-get branch from 8162535 to 6802f8a Compare February 22, 2024 09:36

k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. and removed do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Feb 22, 2024

ardaguclu reviewed Feb 22, 2024

View reviewed changes

Ritikaa96 force-pushed the kubectl-improve-get branch from 6802f8a to e307621 Compare February 26, 2024 05:36

Ritikaa96 mentioned this pull request Feb 26, 2024

Improvement required in kubectl get kubernetes/kubectl#1555

Closed

ardaguclu reviewed Feb 26, 2024

View reviewed changes

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 1, 2024

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 14, 2024

Ritikaa96 added 3 commits May 27, 2024 17:07

Improving kubectl get output

22186fa

Adding namespace flag & examples Signed-off-by: Ritikaa96 <ritika@india.nec.com>

adding suggested changes

6f4e60a

Signed-off-by: Ritikaa96 <ritika@india.nec.com>

correcting description as per review

b9ec8b3

Signed-off-by: Ritikaa96 <ritika@india.nec.com>

Ritikaa96 force-pushed the kubectl-improve-get branch from e307621 to b9ec8b3 Compare May 30, 2024 06:23

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 May 30, 2024

k8s-ci-robot assigned ardaguclu May 30, 2024

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels May 30, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 30, 2024

k8s-ci-robot merged commit 36f1d73 into kubernetes:master May 30, 2024
14 checks passed

k8s-ci-robot added this to the v1.31 milestone May 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improving kubectl get output #123440

Improving kubectl get output #123440

Ritikaa96 commented Feb 22, 2024 •

edited

Ritikaa96 commented Feb 22, 2024

ardaguclu Feb 22, 2024

Ritikaa96 Feb 26, 2024 •

edited

Ritikaa96 Feb 26, 2024

ardaguclu Feb 22, 2024

Ritikaa96 Feb 26, 2024

ardaguclu Feb 22, 2024

ardaguclu commented Feb 22, 2024

Ritikaa96 commented Feb 26, 2024

ardaguclu Feb 26, 2024

Ritikaa96 commented Mar 14, 2024

Ritikaa96 commented May 27, 2024

ardaguclu commented May 27, 2024

Ritikaa96 commented May 30, 2024

ardaguclu commented May 30, 2024

k8s-ci-robot commented May 30, 2024

k8s-ci-robot commented May 30, 2024

ardaguclu commented May 30, 2024

ardaguclu commented May 30, 2024

k8s-triage-robot commented May 30, 2024

Ritikaa96 commented May 30, 2024

	namespace unless you pass --all-namespaces or --namespace(for specific namespace)
	namespace by passing --namespace(for specific namespace) unless you pass --all-namespaces.

	kubectl get pods --all-namspaces`))
	kubectl get pods --all-namespaces`))

	# List all deployments in namespace - backend
	# List all deployments in namespace 'backend'

Improving kubectl get output #123440

Improving kubectl get output #123440

Conversation

Ritikaa96 commented Feb 22, 2024 • edited

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Ritikaa96 commented Feb 22, 2024

ardaguclu Feb 22, 2024

Choose a reason for hiding this comment

Ritikaa96 Feb 26, 2024 • edited

Choose a reason for hiding this comment

Ritikaa96 Feb 26, 2024

Choose a reason for hiding this comment

ardaguclu Feb 22, 2024

Choose a reason for hiding this comment

Ritikaa96 Feb 26, 2024

Choose a reason for hiding this comment

ardaguclu Feb 22, 2024

Choose a reason for hiding this comment

ardaguclu commented Feb 22, 2024

Ritikaa96 commented Feb 26, 2024

ardaguclu Feb 26, 2024

Choose a reason for hiding this comment

Ritikaa96 commented Mar 14, 2024

Ritikaa96 commented May 27, 2024

ardaguclu commented May 27, 2024

Ritikaa96 commented May 30, 2024

ardaguclu commented May 30, 2024

k8s-ci-robot commented May 30, 2024

k8s-ci-robot commented May 30, 2024

ardaguclu commented May 30, 2024

ardaguclu commented May 30, 2024

k8s-triage-robot commented May 30, 2024

Ritikaa96 commented May 30, 2024

Ritikaa96 commented Feb 22, 2024 •

edited

Ritikaa96 Feb 26, 2024 •

edited