Add new plugin, kubectl resources

[howardjohn]

Fixes howardjohn/kubectl-resources#24

[k8s-ci-robot]

Welcome @howardjohn!

It looks like this is your first PR to kubernetes-sigs/krew-index 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/krew-index has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: howardjohn
To complete the pull request process, please assign ahmetb
You can assign the PR to them by writing /assign @ahmetb in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

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

[ahmetb]

Thanks for submitting. Do you mind explaining how is it different than the several resource/allocation plugins we have?

[ahmetb]

I guess it is similar to view-allocations, just curious if it’s entirely overlapping or not.

[howardjohn]

As far as I know this is the only one aggregating resource requests/limits with usage. I realize it isn't groundbreakingly innovative, I made it since I find it useful and someone opened an issue recommending me to add it to krew

[ahmetb]

For reference, I'm attaching screenshots:

• kubectl view-allocations:
  

• kubectl resources (with "pods" section of the "view-allocations" in the same screen)
  

• kubectl view-allocations is also very similar to this, but it shows Node statuses.

The kubectl view-allocations has a funny separation of "cpu" "memory" and "pods", whereas kubectl resources is a cleaner representation of Pod resources.

Per our guidelines, this plugin likely would require renaming to accurately represent what it does (like pod-resources), or pod-usage. I'll have @corneliusweig also review and provide input.

[howardjohn]

You can also aggregate by namespace or node for what its worth, with --by namespace or --by node, so pod-resources doesn't seem quite accurate

[ahmetb]

Yeah, in that case --by=node part is overlapping with resource-capacity plugin (also overlapping in name). I believe @corneliusweig opened the issue so we are not leaving any plugin authors uninformed about Krew, but let's see if it fits. Right now there's considerable overlap with existing plugins.

[corneliusweig]

Hey @howardjohn, thanks for submitting this to krew!

Of the three alternatives, I like this plugin the most, because it produces a clean and noise-free report. However, the overlap with other plugins is substantial. Most of all, this is creates a naming problem. Just resources is too generic and many other names are already taken. Here you need to be a bit more creative (maybe resource-overview?).

Overall, I'm not 100% sure what to do here. So far we have pushed back plugins which are too similar to other ones. If you have something that clearly sets this plugin apart from the other ones, that would help a lot 😃.

Alternatively, if you plan to add something that makes your plugin unique, then let's wait for that before merging.

[howardjohn]

I don't have any current plans to add any more features to the plugin (maybe a --watch flag, but not a high priority), but I am open to suggestions.

I am fine with changing the name, resource-overview sounds right. Let me know if that is sufficient or if I would need additional distinguishing

[ahmetb]

I'm good with both resource-overview and resource-usage (consider renaming your repo, and --help messages).

This would help it distinguish from resource-capacity which is geared towards showing cluster-wide total and percentages, despite both plugins are largely overlapping.

[corneliusweig]

Then let's add this plugin to the index too. Please let us know if you plan to rename your repo as suggested.

[corneliusweig]

Can you wrap this at ~80 chars for easier reading on small terminals?

[howardjohn]

Sounds good. I'll rename everything in my repo then send out an updated PR later. Thanks!

[saiharshitachava]

@howardjohn is this availble with krew yet?