Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d2iq-shadowbq/powerkube-fork
A powerline segment to show kubernetes context items, with toggling and alert color functionality
https://github.com/d2iq-shadowbq/powerkube-fork
Last synced: 15 days ago
JSON representation
A powerline segment to show kubernetes context items, with toggling and alert color functionality
- Host: GitHub
- URL: https://github.com/d2iq-shadowbq/powerkube-fork
- Owner: d2iq-shadowbq
- License: apache-2.0
- Fork: true (nrobert13/powerkube)
- Created: 2020-01-14T01:22:29.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-23T19:01:41.000Z (over 4 years ago)
- Last Synced: 2024-09-25T21:59:56.137Z (about 2 months ago)
- Language: Python
- Size: 143 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Powerkube-fork
[](https://pypi.python.org/pypi/powerkube-fork)
[](https://pypi.python.org/pypi/powerkube-fork/)
[](https://pypi.python.org/pypi/powerkube-fork/)
Powerkube-fork is a [Powerline](https://github.com/powerline/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:
```bash
pip install --user powerkube-fork
```
2. **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.
3. **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`:
```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`:
```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": [] }
}
}
```
4. You may need to reload powerline with `powerline-daemon --replace` to load the new settings. That's it!
5. (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`:
```bash
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](LICENSE).
Original fork is at https://github.com/zcmarine/powerkube.