Metadata-Version: 2.1
Name: k8sfoams
Version: 1.1.1
Summary: K8s pod foamtree visualizer
Home-page: https://github.com/mmpyro/k8s-pod-foamtree
Author: Michal Marszalek
Author-email: mmpyro@gmail.com
License: Apache 2.0
Keywords: foamtree,k8s,visualization
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bandit==1.8.0
Requires-Dist: bitmath==1.3.3.1
Requires-Dist: blinker==1.9.0
Requires-Dist: cachetools==5.5.0
Requires-Dist: certifi==2024.12.14
Requires-Dist: charset-normalizer==3.4.1
Requires-Dist: click==8.1.8
Requires-Dist: durationpy==0.9
Requires-Dist: exceptiongroup==1.2.2
Requires-Dist: flake8==7.1.1
Requires-Dist: flask==3.1.0
Requires-Dist: google-auth==2.37.0
Requires-Dist: idna==3.10
Requires-Dist: iniconfig==2.0.0
Requires-Dist: itsdangerous==2.2.0
Requires-Dist: jinja2==3.1.5
Requires-Dist: kubernetes==31.0.0
Requires-Dist: markdown-it-py==3.0.0
Requires-Dist: markupsafe==3.0.2
Requires-Dist: mccabe==0.7.0
Requires-Dist: mdurl==0.1.2
Requires-Dist: mock==5.1.0
Requires-Dist: mypy==1.14.1
Requires-Dist: mypy-extensions==1.0.0
Requires-Dist: oauthlib==3.2.2
Requires-Dist: packaging==24.2
Requires-Dist: pbr==6.1.0
Requires-Dist: pluggy==1.5.0
Requires-Dist: pyasn1==0.6.1
Requires-Dist: pyasn1-modules==0.4.1
Requires-Dist: pycodestyle==2.12.1
Requires-Dist: pydash==8.0.4
Requires-Dist: pyflakes==3.2.0
Requires-Dist: pygments==2.19.1
Requires-Dist: pytest==8.3.4
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: pyyaml==6.0.2
Requires-Dist: requests==2.32.3
Requires-Dist: requests-oauthlib==2.0.0
Requires-Dist: rich==13.9.4
Requires-Dist: rsa==4.9
Requires-Dist: six==1.17.0
Requires-Dist: stevedore==5.4.0
Requires-Dist: tomli==2.2.1
Requires-Dist: typing-extensions==4.12.2
Requires-Dist: urllib3==2.3.0
Requires-Dist: websocket-client==1.8.0
Requires-Dist: werkzeug==3.1.3

# k8s-pod-foamtree

It's web server which uses *~/.kube/config* file for presenting resource request set for pods. It uses foamtree package for visualization. Dashboard has two option for visualization:
- cpu
- memory

Foamtree view is refreshed automaticaly every 60 seconds by default. Refresh frequency might be change by range slider.

![Drag Racing](k8s-foam-tree.png)

Node is represented by square shape box. Foams are pods. If pod contains more than one container pod foam is splited into sub-foams. Empty foam represents unused (free) resources avaiable on node.

## Memory unit
Below memory units are avaiable for displaing:
- KB
- MB
- GB
- TB

## Context
Context combobox allows for switching current k8s context. **Context is changed only in k8s-pod-foamtree web server not in ~/.kube/config file.**

## Run k8s-pod-foamtree
Before run k8s-pod-foamtree run below command:
```
make build install
```

This command builds and install package in your local environment.
To run it type in your shell:
```
k8sfoams
```

## Install via PyPi
```
pip install k8sfoams
```

## Command lines arguments
- host: host IP address on which server listen, default is **127.0.0.1**
- port: port number on which server listen, default is **8080**
- d: turn on **debug** mode when server starts
