https://github.com/so0k/powerline-kubernetes

A Powerline segment to show your current Kubernetes context
https://github.com/so0k/powerline-kubernetes

kubernetes kubernetes-context kubernetes-segment pipeline powerline powerline-kubernetes python segment

Last synced: 13 days ago
JSON representation

A Powerline segment to show your current Kubernetes context

• Host: GitHub
• URL: https://github.com/so0k/powerline-kubernetes
• Owner: so0k
• License: mit
• Created: 2016-10-28T07:19:34.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-11T10:58:45.000Z (over 4 years ago)
• Last Synced: 2024-10-27T22:06:16.616Z (18 days ago)
• Topics: kubernetes, kubernetes-context, kubernetes-segment, pipeline, powerline, powerline-kubernetes, python, segment
• Language: Python
• Homepage:
• Size: 84 KB
• Stars: 41
• Watchers: 6
• Forks: 19
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Powerline Kubernetes [![PyPI version](https://badge.fury.io/py/powerline-kubernetes.svg)](https://badge.fury.io/py/powerline-kubernetes)

A [Powerline](https://github.com/powerline/powerline) segment to show the current Kubernetes context.

This segment shows the Kubernetes context together with a nice looking helm. Please feel free to propose more features and give me ideas on how to improve it.



**Update:** Now completely compatible with Kubernetes API 9.0.

## Requirements

The Kubernetes segment requires kubectl and official [kubernetes Python API](https://pypi.org/project/kubernetes/).

## Installation

Installing the Kubernetes segment can be done with `pip`:

```

$ pip install powerline-kubernetes

```

The Kubernetes segment uses a couple of custom highlight groups. You'll need to define those groups in your colorscheme, for example in `.config/powerline/colorschemes/default.json`:

```json

{

  "groups": {

    "kubernetes_cluster":         { "fg": "gray10", "bg": "darkestblue", "attrs": [] },

    "kubernetes_cluster:alert":   { "fg": "gray10", "bg": "darkestred",  "attrs": [] },

    "kubernetes_namespace":       { "fg": "gray10", "bg": "darkestblue", "attrs": [] },

    "kubernetes_namespace:alert": { "fg": "gray10", "bg": "darkred",     "attrs": [] },

    "kubernetes:divider":         { "fg": "gray4",  "bg": "darkestblue", "attrs": [] },

  }

}

```

Then you can activate the Kubernetes segment by adding it to your segment configuration, for example in `.config/powerline/themes/shell/default.json`:

```javascript

{

    "function": "powerline_kubernetes.kubernetes",

    "priority": 30,

    "args": {

        "show_kube_logo": true, // set to false to omit the Kube logo

        "show_cluster": true, // show cluster name

        "show_namespace": true, // show namespace name

        "show_default_namespace": false, // do not show namespace name if it's "default"

        "alerts": [

          "live", // show line in different color when namespace matches

          "cluster:live"  // show line in different color when cluster name and namespace match

        ]

    }

}

```

By default the segment will look for the Kubernetes config under `~/.kube/config`.

## License

Licensed under the [MIT License](LICENSE).

## Authors

Created by [so0k](https://github.com/so0k/). Code contributions by:

- [bokysan](https://github.com/bokysan)

---

Inspired by [powerline-docker](https://github.com/adrianmo/powerline-docker).