Kubectl plugin for listing objects

[alculquicondor]

What would you like to be added:

A kubectl plugin that allows to list Jobs and ClusterQueues with comprehensive information.

And a kubectl describe equivalent for Jobs that includes Workload information.

Other useful helpers:

• Manually admit a workload.

Why is this needed:

The basic view of kubectl get can't include details such as whether a workload is admitted or why it's pending, because the information is present in compound objects. Similarly, it can't tell the status of a ClusterQueue if it's misconfigured.

Furthermore, when listing Jobs, you wouldn't see the details of the accompanying Workload.

Completion requirements:

This enhancement requires the following artifacts:

• Design doc
• API change: the command line interface is an API.
• Docs update

The artifacts should be linked in subsequent comments.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[tenzen-y]

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[tenzen-y]

/remove-lifecycle stale

[alculquicondor]

@vsoch this is the issue I was referring to.

[vsoch]

Here is a design document for what I am thinking: https://gist.github.com/vsoch/954d8c95bdb71bcca92b438bbc879eca. Let me know if you'd like that as a Google document instead. Some notes:

• It will be more advantageous to have this scoped to be a command line tool for kueue, and one that folds into being a plugin if desired. I actually think the first use case (where someone could essentially interact with kueue via the command line and not with kubectl) would be hugely great for the converged computing use case - folks are used to command line tools to interact with / manage jobs, and we could provide similar interactions to it.
• I've proposed a set of subcommands to start, and additional ones I think would be useful.

And it's assumed that the implementation would be in Go.

[alculquicondor]

oh, we actually have a place for this in the repo itself :)
https://github.com/kubernetes-sigs/kueue/tree/main/keps

Either a PR or a google doc works better as we can comment on specific sections of the design.

I like the idea of a tool that works both standalone and as a plugin. To be fair, a plugin is not much more than a CLI that happens to start with kubectl- :)

[vsoch]

All set! #977

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[vsoch]

Hey is there a status update here? I made my first plugin last weekend and it was fairly simple so I could jump in to help if the current assignee is low on bandwidth.

[tenzen-y]

Hey is there a status update here? I made my first plugin last weekend and it was fairly simple so I could jump in to help if the current assignee is low on bandwidth.

@vsoch Thank you for offering help. @yaroslava-serdiuk is working on the KEP.

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[vsoch]

Checking in again - this is still a WIP?

[yaroslava-serdiuk]

I'm currently not working on it, but AFAIK this should be picked up soon.
@mwielgus do you have any update on it?

[vsoch]

I originally couldn't do it because we didn't have a proper CLA, but we do now, in case help is still wanted. Let me know!

[alculquicondor]

/close

I see that @mwielgus created an updated issue.

[k8s-ci-robot]

@alculquicondor: Closing this issue.

In response to this:

/close

I see that @mwielgus created an updated 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/test-infra repository.