1
0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-22 15:36:24 +08:00
ohmyzsh/plugins/kubectx/README.md
Marc Cornellà 22bda7799b
fix(kubectx): fix display of k8s contexts without double quotes (#12534)
BREAKING CHANGE: the `kubectx` plugin now properly displays contexts from the
kubectx_mapping array, without using double quotes. Please refer to the plugin
README to see how to use it properly.

Closes #12534

Co-authored-by: Ken Kelly <ken@kenhkelly.us>
2024-08-01 10:00:58 +02:00

1.6 KiB

kubectx - show active kubectl context

This plugins adds kubectx_prompt_info() function. It shows name of the active
kubectl context (kubectl config current-context).

You can use it to customize prompt and know if You are on prod cluster ;)

To use this plugin, add kubectx to the plugins array in your zshrc file:

plugins=(... kubectx)

Usage

Add to .zshrc:

# right prompt
RPS1='$(kubectx_prompt_info)'
# left prompt
PROMPT="$PROMPT"'$(kubectx_prompt_info)'

Custom context names

You can rename the default context name for better readability or additional formatting.
These values accept prompt expansion sequences
such as %F{color}, %f, %K{color}, %k, %B, %b, %U, %u, %S, %s, %{...%}.

Example: add this to your .zshrc file:

kubectx_mapping[minikube]="mini"
kubectx_mapping[context_name_from_kubeconfig]="$emoji[wolf_face]"
kubectx_mapping[production_cluster]="%{$fg[yellow]%}prod!%{$reset_color%}"
# contexts with spaces
kubectx_mapping[context\ with\ spaces]="%F{red}spaces%f"
# don't use quotes as it will break the prompt
kubectx_mapping["context with spaces"]="%F{red}spaces%f" # ti

You can also define the whole mapping array at once:

typeset -A kubectx_mapping
kubectx_mapping=(
  minikube                      "mini"
  context_name_from_kubeconfig  "$emoji[wolf_face]"
  production_cluster            "%{$fg[yellow]%}prod!%{$reset_color%}"
  "context with spaces"         "%F{red}spaces%f"
)

staging
production