summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/kubectx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'zsh/oh-my-zsh/plugins/kubectx/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/kubectx/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/zsh/oh-my-zsh/plugins/kubectx/README.md b/zsh/oh-my-zsh/plugins/kubectx/README.md
new file mode 100644
index 0000000..98f1cf0
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/kubectx/README.md
@@ -0,0 +1,26 @@
+# 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 ;)
+
+_Example_. Add to **.zshrc**:
+
+```
+RPS1='$(kubectx_prompt_info)'
+```
+
+### custom ctx names
+
+One can rename default context name for better readability.
+
+_Example_. Add to **.zshrc**:
+```
+kubectx_mapping[minikube]="mini"
+kubectx_mapping[context_name_from_kubeconfig]="$emoji[wolf_face]"
+kubectx_mapping[production_cluster]="%{$fg[yellow]%}prod!%{$reset_color%}"
+```
+
+![staging](stage.png)
+![production](prod.png)