Here lies my swiss army knife of kubernetes tools I use on a daily-basis.
I'm assuming this repo is cloned to /opt/autokube, but you can clone it somewhere.
git clone https://github.com/caruccio/autokube
sudo mv autokube /opt/Mnemonic kubectl commands
Sorry, bash-only for now.
# Install
echo 'source ~/autokube/autokubectl.sh' >> ~/.bashrc
source ~/.bashrc
# Execute:
kgwponv default 3
# And it will run:
kubectl get -w pod -n="default" -v="3"Tired of typing kubectl get event -w -n=default -v=3 -o=json?
Try this instead: kgevwnvoj default 3
ALERT: This is not a shell alias
Inspired by ahmetb's kubectl-aliases, this tool will resolve an alias-like command to kubectl.
Take, for instance, both commands below.
kgevwnvoj default 3
kwojgevvn 3 defaultEach one will expand for the following commands respectively.
kubectl get event -w -n=default -v=3 -o=json
kubectl -w -o=json get event -v=3 -n=defaultHere, each mnemonic becomes a kubectl parameter.
k --> kubectl (required)
g --> get
ev --> event
w --> -w
n --> namespace=$1
v --> -v=$2
oj --> -o=json
The order doesn't matter (much).
It works by searching for the longest mnemonic sequence on a lookup-table (just some associative arrays), translating characters (or a sequence of characters) into kubectl verbs, resources and options.
You can see all available mnemonics by executing kH (H stands for help).
The lookup-tables can be expanded or modified with your custom mappings.
source /etc/profile.d/autokubectl.sh # only if not properly installed in /etc/profile.d/
autokube_command_not_found_handle_map_verb[K]='krew'
autokube_command_not_found_handle_map_verb[Ki]='krew install "%s"' ## each "%s" is replaced with positional parameters afther the command, like in $1 $2 $N...
autokube_command_not_found_handle_map_verb[Kl]='krew list'
autokube_command_not_found_handle_map_verb[D]='deprecations'Now you can use your own mnemonics.
$ kKi deprecations --> kubectl krew install deprecations
$ kD --> kubectl deprecations
$ kDv debug --> kubectl deprecations -v=debugIf var AUTOKUBECTL_DRYRUN=true no command is executed, and the resulting expansion is shown in stdout:
$ AUTOKUBECTL_DRYRUN=true
$ kgevwnvoj default 3
kubectl get event -w -n="default" -v="3" -o=jsonDisclaimer
This method may conflicts with other tools that install a "command not found" handler function.
For example, Fedora-like distros often comes with package PackageKit-command-not-found installed.
This packages provides the file /etc/profile.d/PackageKit.sh with a single function command_not_found_handle, which is called by bash when a command you typed is not found.
That is how it can suggest speelling corretions or even packages for that uninstalled command in your system.
You can see this sections of bash's manual for details.
The problem is that files from /etc/profile.d are sourceed on boot, with no garantees that our file will overwrite PackageKit-command-not-found's function.
That said, you can only have one "command not found" function handler (for now). Thus, either you uninstall PackageKit-command-not-found or source autokubectl.sh from your .bashrc:
Either source it from your .bashrc:
echo "source /opt/autokubectl.sh" >> ~/.bashrcOr install it system-wide (see explaning above):
sudo cp /opt/autokube/autokubectl.sh /etc/profile.d/Restart your shell/terminal and that's it.
There are problems with this method? Of course there are!! Who do you think I'm?! Dennis Ritchie?!
Sometimes you will face ambiguity, but I can live with that... Fell free to fix and send me a PR.
For example kgno: is this kubectl get node or kubect get -n=$1 -o=$2?
Turns out the longest mnemonic matches first, thus no (2 chars) will match as node, not n (1 char) + o (1 char).
$ kH
Please refer to https://github.com/caruccio/autokube for instructions.
Available mnemonics:
--- Verbs --------------
gnok get node -L=kubernetes.io/arch,eks.amazonaws.com/capacityType,karpenter.sh/capacity-type,karpenter.k8s.aws/instance-cpu,karpenter.k8s.aws/instance-memory
gnoz get node -L=kubernetes.io/arch,beta.kubernetes.io/instance-type
lo logs
lof logs -f
H HELP
h HELP
g get
d describe
c create
a apply
dbg debug -it %s
rm delete
dbgno debug -it --image=alpine node/%s -- chroot /host
--- Resources ----------
crb clusterrolebinding
no node
is imagestream
dc deploymentconfig
dep deployment
sa serviceaccount
r role
po pod
svc service
cr clusterrole
cm configmap
ing ingress
rb rolebinding
ro route
ev event
sec secret
--- Options ------------
now --now
ojs -o=json
ojp -o=jsonpath
all --all
nh --no-headers
ojsonpath -o=jsonpath="%s"
oyaml -o=yaml
force --force
otpl -o=template="%s"
A --all-namespaces
sb --sort-by="%s"
w -w
sl --show-labels
v -v="%s"
o -o="%s"
n -n="%s"
l -l "$s"
f -f "%s"
oyml -o=yaml
owide -o=wide
otemplate -o=template="%s"
ow -o=wide
oy -o=yaml
oj -o=json
sys -n=kube-system
ojson -o=json
--- Watch -------------
W watch -n %i --Change current kubeconfig as you change directories.
$ cd /some/dir
Using kubeconfig: /some/dir/.kubeconfig
$ echo $KUBECONFIG
/some/dir/.kubeconfigYou can also use kubecfg directly to update $KUBECONFIG env var:
$ kubecfg ./kubeconfig-dev
Using kubeconfig: /some/dir/.kubeconfig-devRunning kubecfg alone prints the current $KUBECONFIG:
$ kubecfg
/some/dir/.kubeconfig-devThe flag -u unsets $KUBECONFIG:
$ kubecfg -u
Unsetting KUBECONFIG=/some/dir/.kubeconfig-devEither source it from your .bashrc:
```sh
echo "source /opt/autokubeconfig.sh" >> ~/.bashrcOr install globally (see explaning above):
sudo cp /opt/autokube/autokubeconfig.sh /etc/profile.d/Restart your shell/terminal and that's it.
Print full kubectl command before execute it
It's just an small function which replaces kubectl and print the whole command to stderr.
echo "source /opt/showkubectl.sh" >> ~/.bashrc
source ~/.bashrcNow every kubectl command, including aliases and functions, will be printed to stderr before it's executed.
$ kgno
+ kubectl get nodes
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent