The magical kubectl companion with fzf, fx, aliases, new output formats, and more!
Kuba is an evolution of kubectl that makes it more efficient for power users, especially platform operators and SREs managing multiple clusters, investigating cross-cutting issues, and supporting multiple teams/orgs. It adds a number of key features to kubectl, including:
- โ๏ธ Fuzzy arguments for get, describe, logs, exec
- ๐ New output formats like fx, lineage, events, pod's node, node's pods, and pod's containers
โ๏ธ Cross namespaces and clusters in one command, no more for-loops- ๐ง Guess pod containers automagically, no more
-c <container-name> - โก Cut down on keystrokes with an extensible alias language, e.g.
kpftokuba get pods -o json | fx - ๐งช Simulate scheduling without the scheduler, try it with
kuba sched - ๐ And lots more!
Quick-install:
pip install kubaKuba makes use of the following tools you'll likely want to install as well: fzf, fx, kubecolor, and krew for stern and lineage. On macOS, you can install these tools with Homebrew:
brew install fzf fx kubecolor krew && kubectl krew install stern lineageTo use the aliases, add this to one of your dotfiles:
source <(kuba shellenv --kubectl kubecolor) # omit --kubectl kubecolor if you haven't installed kubecolorStart by using kuba get and kuba describe as ~drop-in replacements for kubectl get and kubectl describe. Then try a few examples from the overview video, or check out the commands below.
$ kuba --help
Usage: kuba [OPTIONS] COMMAND [ARGS]...
The magical kubectl companion.
Options:
-h, --help Show this message and exit.
Commands:
api Enhances kubectl api-resources.
cluster Combines kubectx + kubens for all-in-one switching between clusters.
ctx Enhances kubectx.
describe Enhances kubectl describe.
exec Enhances kubectl exec.
get Enhances kubectl get.
hostname Convert between node names and hostnames.
logs Enhances kubectl logs.
ns Enhances kubens.
sched Predict which nodes a pod can be scheduled on.
shellenv Generate k-aliases and completions for easy kubectl resource access.
ssh SSH into a node.
$ kuba shellenv --help
Usage: kuba shellenv [OPTIONS]
Generate k-aliases and completions for easy kubectl resource access.
E.g. kp for kubectl get pod.
Generated aliases all forward to kuba, which eventually forwards to kubectl, including any kubectl-specific
parameters. Passing kubectl arguments and shell completion both have some rough edges.
GENERAL
- kns => kuba ns (suffixes: l=list)
- kctx => kuba ctx (suffixes: l=list, n=ns)
- kclus => kuba cluster
- kssh => kuba ssh (suffixes: a=any, p=pods)
- kapi => kuba api (suffixes: n=name, z=select)
- ksys => kuba ns kube-system
RESOURCE-LEVEL
Default native resource mappings:
- c=configmap
- d=deployment
- j=job
- m=daemonset
- n=node
- o=cronjob
- p=pod
- r=secret
- s=service
- x=lease
Alias modifiers, optional and in this order:
- Search in (a)ll namespaces or (k)ube-system namespace
- Search across (m)ultiple sibling clusters
- Restrict to objects e(x)clusively holding a lease
- Force selection using f(z)f or force (p)icking all
- Choose an alternative output type:
- (d)escribe
- (n)ame
- (w)ide
- (y)aml
- (j)son
- (f)x
- (e)vents
- lo(g)s
- follow (l)ogs
- lineage downward i.e. (c)hildren
- lineage (u)pward
- p(o)ds (only for nodes, shows pods on the node)
- n(o)de (only for pods, shows node the pod is on)
- containe(r)s (only for pods, shows containers in the pod)
Example alias usage:
- kp -> kuba get pod
- kpw -> kuba get pod -o wide
- kpz -> kuba get pod (fzf multi-select over all pods)
- kpzf myapp -> kuba get pod --select -o json | fx (fzf multi-select over all pods fuzzy matching 'myapp')
- kxd -> kuba describe lease
- kny -> kuba get node -o yaml
- kdj -> kuba get deployment -o json
- ksz -> kuba get service (fzf multi-select over all services)
- kjf -> kuba get job -o json | fx
- kcaj -l app=myapp -> kuba get configmap --all-namespaces -o json -l app=myapp
CONTAINER-LEVEL
Default kuba aliases:
- l=logs
- e=exec
Alias modifiers, optional and in this order:
- Search in (a)ll namespaces or (k)ube-system namespace
- Search across (m)ultiple sibling clusters
- Restrict to objects e(x)clusively holding a lease (via convenience heuristic)
- Choose (c)ontainers, or automatically pick a(l)l containers
- Command-specific
- logs: (f)ollow logs
Example alias usage:
- kl -> kuba logs --guess
- ke -> kuba exec --guess
- klx -> kuba logs --leader --guess
- kexc -> kuba exec --leader
- klamlf -> kuba logs --all-namespaces --multi-cluster --all --follow
Usage: source <(kuba shellenv [OPTIONS])
Options:
--resources TEXT Add or override resource mappings, formatted as e.g. p=pod,n=node. Can also set via
KUBA_SHELLENV_RESOURCES env var.
--clusters TEXT List of clusters to consider, formatted as e.g. stag*=k8s-staging-*,prod=k8s-production (use
single '*' to match multiple clusters). Can also set via KUBA_CLUSTERS env var.
--shell [|zsh] Override shell detection.
--kubectl TEXT Name or path of the kubectl binary to use. Can also set via KUBA_KUBECTL env var.
--no-native Don't include the default native resource mappings.
--no-resources Don't include aliases and completions for resource-level commands.
--no-containers Don't include aliases and completions for container-level commands.
--ssh-bastion TEXT SSH bastion option to use with kuba ssh. Can also set via KUBA_SSH_BASTION env var.
--ssh-use-name Use name option to use with kuba ssh.
--list Just list all resource aliases.
--listq TEXT Same as --list, but filter for the query.
--debug Print debug info to stderr.
-h, --help Show this message and exit.
- Kubectl + fzf
- Kubectl aliases