🥸 Custom Resource Aliases

Quick overview

Config file

$XDG_DATA_HOME/k9s/aliases.yaml

Format

aliases top-level object with key-value pairs

Aliases

In k9s, you can define your very own command aliases (short-names) to access your resources. In your $XDG_CONFIG_HOME/k9s define a file called aliases.yaml. A k9s alias defines pairs of alias:gvr or alias:command. A gvr (Group/Version/Resource) represents a fully qualified Kubernetes resource identifier. The command can be any commands that you would normally use while in command prompt mode.

Aliases can be defined a two levels: global and context specific. At the global level you would create a file in $XDG_CONFIG_HOME/k9s/aliases.yaml. For context specific aliases, you can define $XDG_DATA_HOME/k9s/clusters/clusterX/contextY/aliases.yaml.

Example

The key is always the shortcut, the value the resource. So for example pr: prometheusrule defines pr as shortcut for the custom resource definition prometheusrule.

# $XDG_CONFIG_HOME/k9s/aliases.yaml
aliases:
  # Use `pp` as an alias for Pod
  pp: v1/pods

  # Use `dep` as an alias for Deployments
  dep: apps/v1/deployments

  # Use `fred` as an alias for CRD Frederick
  fred: acme.io/v1alpha1/fredericks

  # Defines a `pos` alias for a command listing all pod in kube-system matching labels app=fred and blee=duh
  pos: pod kube-system app=fred,blee=duh