Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j4ckofalltrades/powerline-k8s
Powerline segment for displaying the current Kubernetes context and namespace
https://github.com/j4ckofalltrades/powerline-k8s
kubernetes powerline
Last synced: 15 days ago
JSON representation
Powerline segment for displaying the current Kubernetes context and namespace
- Host: GitHub
- URL: https://github.com/j4ckofalltrades/powerline-k8s
- Owner: j4ckofalltrades
- License: mit
- Created: 2021-05-22T14:21:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T03:26:39.000Z (4 months ago)
- Last Synced: 2024-10-11T00:21:58.740Z (about 1 month ago)
- Topics: kubernetes, powerline
- Language: Python
- Homepage: https://pypi.org/p/powerline-k8s
- Size: 380 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/powerline-k8s/)
[](https://pypi.python.org/pypi/powerline-k8s)
[](https://j4ckofalltrades.github.io/powerline-k8s)
[](https://github.com/j4ckofalltrades/powerline-k8s/actions/workflows/build.yml)
[](https://codecov.io/gh/j4ckofalltrades/powerline-k8s)
A custom [Powerline](https://github.com/powerline/powerline) segment for displaying the current Kubernetes context and namespace.
## Installation
### Using pip
`$ pip install powerline-k8s`
## Configuration
### Colorscheme
Add the following config items to your Powerline colorscheme config file (usually located at `~/.config/powerline/colorschemes/`),
see [Powerline Colorschemes](https://powerline.readthedocs.io/en/master/configuration/reference.html#colorschemes) for more info.
```json
{
"k8s": { "fg": "solarized:blue", "bg": "solarized:base02", "attrs": [] },
"k8s_namespace": { "fg": "solarized:red", "bg": "solarized:base02", "attrs": [] },
"k8s_context": { "fg": "solarized:blue", "bg": "solarized:base02", "attrs": [] },
"k8s:divider": { "fg": "gray4", "bg": "solarized:base02", "attrs": [] }
}
```
### Segment
Add the following config item to your Powerline segments config file,
see [Powerline Segment reference](https://powerline.readthedocs.io/en/master/configuration/segments.html#segment-reference) for more info.
```json
{
"function": "powerline_k8s.k8s",
"priority": 30
}
```
- If adding the segment to the shell, edit `~/.config/powerline/themes/shell/default.json`.
- If adding the segment to the tmux status line, edit `~/.config/powerline/themes/tmux/default.json`.
### Alternative config location
If your Kubernetes config file is not in the default location `~/.kube/config`, you can point to it by setting
the value of the `$KUBECONFIG` environment variable to where your config file is.
### Toggle visibility
Toggle entire segment or specific section's visibility with the following environment variables:
- `POWERLINE_K8S_SHOW`
- `POWERLINE_K8S_SHOW_NS`
Note: Full segment visibility takes precedence over namespace section visibility.
```shell
# toggle segment visibility
$ POWERLINE_K8S_SHOW=0 powerline-daemon --replace # hide powerline-k8s segment
$ POWERLINE_K8S_SHOW=1 powerline-daemon --replace # show powerline-k8s segment (default)
# toggle namespace section visibility
$ POWERLINE_K8S_SHOW_NS=0 powerline-daemon --replace # hide namespace section
$ POWERLINE_K8S_SHOW_NS=1 powerline-daemon --replace # show namespace section (default)
```
Alternatively you can add the following function to your shell for easier toggling:
```shell
toggle_powerline_k8s() {
case "$1" in
# pass the '-ns' flag to toggle namespace visibility
"-ns" | "--namespace")
if [[ "${POWERLINE_K8S_SHOW_NS:-1}" -eq 1 ]]; then
export POWERLINE_K8S_SHOW_NS=0
else
export POWERLINE_K8S_SHOW_NS=1
fi
;;
*)
# toggle segment visibility
if [[ "${POWERLINE_K8S_SHOW:-1}" -eq 1 ]]; then
export POWERLINE_K8S_SHOW=0
else
export POWERLINE_K8S_SHOW=1
fi
;;
esac
}
```
## Demo
[](https://asciinema.org/a/424536?autoplay=1&speed=2)
## Stats
