ohmyzsh/plugins/kube-ps1

Kubernetes prompt for zsh

A Kubernetes (k8s) zsh prompt that displays the current cluster cluster and the namespace.

Inspired by several tools used to simplify usage of kubectl

NOTE: If you are not using zsh, check out kube-ps1 designed for bash as well as zsh.

Requirements

The default prompt assumes you have the kubectl command line utility installed. It can be obtained here:

Install and Set up kubectl

If using this with OpenShift, the oc tool needs installed. It can be obtained from here:

OC Client Tools

Helper utilities

There are several great tools that make using kubectl very enjoyable.

kubectx and kubenx are great for fast switching between clusters and namespaces.

Prompt Structure

The prompt layout is:

(<logo>|<cluster>:<namespace>)

Supported platforms:

• k8s - Kubernetes
• ocp - OpenShift

Install

1. Clone this repository
2. Source the kube-ps1.zsh in your ~./.zshrc

ZSH:

source path/kube-ps1.sh
PROMPT='$(kube_ps1) '

Colors

The colors are of my opinion. Blue was used as the prefix to match the Kubernetes color as closely as possible. Red was chosen as the cluster name to stand out, and cyan for the namespace. These can of course be changed.

Customization

The default settings can be overridden in ~/.zshrc

Variable	Default	Meaning
KUBE_PS1_DEFAULT	true	Default settings for the prompt
KUBE_PS1_PREFIX	(	Prompt opening character
KUBE_PS1_DEFAULT_LABEL	⎈	Default prompt symbol
KUBE_PS1_SEPERATOR	|	Separator between symbol and cluster name
KUBE_PS1_PLATFORM	kubectl	Cluster type and binary to use
KUBE_PS1_DIVIDER	:	Separator between cluster and namespace
KUBE_PS1_SUFFIX	)	Prompt closing character
KUBE_PS1_DEFAULT_LABEL_IMG	false	Use Kubernetes img as the label: ☸️

Contributors

Jared Yanovich