Metadata-Version: 2.1
Name: k8sfoams
Version: 1.1.2
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: flask==3.1.0
Requires-Dist: kubernetes==31.0.0
Requires-Dist: pydash==8.0.4
Requires-Dist: bitmath==1.3.3.1
Requires-Dist: requests==2.32.3
Provides-Extra: dev
Requires-Dist: pytest==8.3.4; extra == "dev"
Requires-Dist: flake8==7.1.1; extra == "dev"
Requires-Dist: mypy==1.14.1; extra == "dev"
Requires-Dist: mock==5.1.0; extra == "dev"
Requires-Dist: bandit==1.8.0; extra == "dev"

# 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
