Skip to main content

A powerline segment to show kubernetes context items, with toggling and alert color functionality

Project description

Powerkube-fork

pypi Supported Python Versions License

Powerkube-fork is a Powerline segment that shows your current Kubernetes context. It can be configured to show any or all of:

  • the current cluster
  • the current namespace
  • the current user

Two other nifty features that it has are:

  1. The ability to toggle on or off the powerkube-fork segment using an environment variable which can easily be mapped to a function in your ~/.bash_profile.
  2. The ability to define certain namespaces to be colored differently for alerting purposes. For example, you could have your production namespaces show up in bright red.

The screenshot below demonstrates this functionality:

Installation

  1. Add the Python package. powerkube-fork is available on pypi so you can install it with pip:
pip install --user powerkube-fork
  1. Create a user configuration directory.

Once powerkube-fork has been installed, we'll need to add it to our powerline shell's theme and colorscheme.

Alter your powerline user config:

If you don't already have a ~/.config/powerline/ folder, create it. Next we'll be copying some of the default powerline configs into this location. Find where powerline is installed by using pip show powerline-status | grep 'Location', then navigate to the config_files/ folder there. We'll be copying config.json, themes/shell/default.json, and colorschemes/shell/default.json to our ~/.config/powerline/ folder, adding the necessary folders to match that original file structure (i.e. adding the themes/ and colorschemes/ folders, etc.

  1. Add powerkube-fork to your user config.

Within our user config, we'll need to add the powerkube-fork segment to our shell by adding the following lines to our ~/.config/powerline/themes/shell/default.json:

    {
	    "function": "powerkube_fork.context",
	    "priority": 30,
	    "args": {"show_cluster": true,
		     "show_namespace": true,
		     "show_user": true,
		     "alert_namespaces": ["data-prod", "infra-prod"]}
    }

Next we'll add the highlighting colors we'll use to our ~/.config/powerline/colorschemes/shell/default.json:

    {
	    "name": "Default",
	    "groups": {
		    "kubernetes_cluster":         { "fg": "white", "bg": "gray6",     "attrs": [] },
		    "kubernetes_namespace":       { "fg": "white", "bg": "gray8",     "attrs": [] },
		    "kubernetes_namespace:alert": { "fg": "white", "bg": "brightred", "attrs": [] },
		    "kubernetes_user":            { "fg": "white", "bg": "gray9",     "attrs": [] }
	    }
    }
  1. You may need to reload powerline with powerline-daemon --replace to load the new settings. That's it!

  2. (Optional) By default powerkube-fork will render the kubernetes context if the environment variable RENDER_POWERLINE_KUBERNETES is either set to YES or is not set at all. Rather than setting this variable manually, you can create a simple kshow function by placing the following in your ~/.bash_profile:

function powerline-kubernetes-toggle() {
    if [[ $RENDER_POWERLINE_KUBERNETES = "NO" ]]; then
    export RENDER_POWERLINE_KUBERNETES=YES
    else
    export RENDER_POWERLINE_KUBERNETES=NO
    fi
}

You're all set up! Happy coding!

License

Licensed under the Apache License 2.0.
Original fork is at https://github.com/zcmarine/powerkube.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for powerkube-fork, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size powerkube_fork-0.2.1-py3-none-any.whl (8.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size powerkube-fork-0.2.1.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page