k9s icon indicating copy to clipboard operation
k9s copied to clipboard

Missing xr command for :xray

Open Nitrodist opened this issue 2 years ago • 4 comments

Describe the bug I don't know how to use the :xray command. I've installed k9s and I use it on mac. I don't know what the backing command for 'xr' is and googling 'k9s xr' or 'k9s xray' etc. did not yield much.

I'd like the documentation updated to clarify what I should install specifically? I.e. using homebrew to install a package.

To Reproduce Steps to reproduce the behaviour:

  1. Run :xray
  2. See cow
  3. Google for 'xr xray k9s' and never come across anything explaining this error etc.

Expected behaviour

I'd like the documentation updated to clarify what I should install specifically? I.e. using homebrew to install a package.

In the end, I'd like to get the feature working as demonstrated on the k9scli.io docs site.

Screenshots Screen Shot 2022-04-20 at 1 48 43 PM

Versions (please complete the following information):

  • OS: macOS Big Sur 11.6.4
  • K9s: v0.24.14
  • K8s: xxx

Additional context

I would like to see a doc page for this somewhere.

Nitrodist avatar Apr 21 '22 15:04 Nitrodist

Hey @Nitrodist! the x-ray command allows you to view resources in a tree style view

The usage is :xray [Resource] for example if you use :xray deployment you would see all of your deployments in a tree style list with their linked services, secrets, config maps, etc. These items also act as shortcuts to go directly to that item. This can be very convenient for getting a "whole picture" view of your resource. I do agree that there isn't a lot of documentation around this feature other than a one line blurb on the readme. I did find a video that may give you a little more info: https://youtu.be/jovHiTobzKQ?t=11m57s

Hope this helps!

JefeDavis avatar Apr 23 '22 06:04 JefeDavis

I mean, what is the backing command?

Nitrodist avatar May 05 '22 04:05 Nitrodist

As far as I know, there isn't one, this feature is unique to k9s. Its just another way to view your kubernetes resources

JefeDavis avatar May 05 '22 05:05 JefeDavis

Running :xray by itself won't work, you need to add the resource type you want to view aka :xray deployment or :xray dp for short

JefeDavis avatar May 05 '22 05:05 JefeDavis