Repository files navigation

A simple tool to show the current status of a pod and its associatedcontainers andinitContainers.

This was developed out of frustration withkubectl get pod not showing much andkubectl describe pod showing way too much in a cryptic way. Debugging failed pods with a lot ofinitContainers andsideCars usually was done withkubectl get pod -o yaml |less with a lot of going up and down over a pager to figure out what's going on and a bunch of swearing 🔞. All those techniques for introspection and debugging are still useful andKSS is not planning to fully replace them but now thanks to it you can see quickly what happen and what fails and get your sanity back 😅.

You can specify a pod or multiple ones as argument toKSS, if you don't it will launch the lovelyfzf and let you choose the pod interactively, if there is only one pod available it will select it automatically. If you would like to choose multiple pods you can use the key [TAB] and select them,KSS will then show them all.

KSS shows a preview when running with fzf, it will try to do the preview with itself if it cannot find itself in thePATH it will fallback to a good ol' and boringkubectl describe 👴🏼👵🏻.

If you add the-l option it will show you the log output of the container, you can adjust how many lines of the log you want to see if you add the flag--maxlines=INT.

You can use the-r option if you would like to restrict it to only some containers, it accepts a regexp as an argument, so you can do some fancy matching in there. You would typically use this flag combined when you are outputting the container's log (-l).

With the-L flag you will display the labels and with the-A flag you will do the same but for annotations.

You can installKSS latest with homebrew, you just have to fire up thosecommands in your shell andKSS and its zsh completions will be installed :

brew tap chmouel/kss https://github.com/chmouel/kssbrew install kss

This has been tested as working onlinuxbrew too.

It's available on Arch AURhere.

Install it with your favourite aur installer (i.e:yay)

You just make sure you have >=Python3.6,fzf and kubectl. You then can download thescript and put it directly into yourPATH or checkout this GIT repo and link the binary into your path so you can have do some git pull to get the updates.

With zsh you can install the_kss completionfile to yourfpath.

I may do akrew plugin if this getrequested enough. Watch this space as cool people would say 😎🏄🤙.

• The code is getting quite tortured, like some sort of spaghetti plate 🍝 with greasy meatballs 🥩 on the top, the kind of stuff you start to write quickly and dirty out of frustration to fix a problem and it grows it grows until it really become an unreadable beast. I probably going to rewrite it up properly with tests and all (in a compiled language perhaps?) soonish enough.

And I actually did start rewritting the whole thing proper, with a bunch of testcases, nice code and all with all the best practices and all. Starting to write my testcases I realise there is so many crazy edge cases and different status in Kubernetes that would have been getting longer than I tought, so let's say for now that KSS has a i in between and we will keep it "KISS"But hey who cares, since it kinda works! (until I broke it :D) 😅