k8sfoams

Name	k8sfoams JSON
Version	1.1.3 JSON
	download
home_page	https://github.com/mmpyro/k8s-pod-foamtree
Summary	K8s pod foamtree visualizer
upload_time	2025-01-31 07:29:14
maintainer	None
docs_url	None
author	Michal Marszalek
requires_python	None
license	Apache 2.0
keywords	foamtree k8s visualization
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mmpyro/k8s-pod-foamtree",
    "name": "k8sfoams",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "foamtree, k8s, visualization",
    "author": "Michal Marszalek",
    "author_email": "mmpyro@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b6/bb/9a18c066a27255f371ed8dd3f6b0dc9258c8625873e8f4f7461174b2303f/k8sfoams-1.1.3.tar.gz",
    "platform": null,
    "description": "# k8s-pod-foamtree\n\nIt'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:\n- cpu\n- memory\n\nFoamtree view is refreshed automaticaly every 60 seconds by default. Refresh frequency might be change by range slider.\n\n![Drag Racing](k8s-foam-tree.png)\n\nNode 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.\n\n## Memory unit\nBelow memory units are avaiable for displaing:\n- KB\n- MB\n- GB\n- TB\n\n## Context\nContext combobox allows for switching current k8s context. **Context is changed only in k8s-pod-foamtree web server not in ~/.kube/config file.**\n\n## Run k8s-pod-foamtree\nBefore run k8s-pod-foamtree run below command:\n```\nmake build install\n```\n\nThis command builds and install package in your local environment.\nTo run it type in your shell:\n```\nk8sfoams\n```\n\n## Install via PyPi\n```\npip install k8sfoams\n```\n\n## Command lines arguments\n- host: host IP address on which server listen, default is **127.0.0.1**\n- port: port number on which server listen, default is **8080**\n- d: turn on **debug** mode when server starts\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "K8s pod foamtree visualizer",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://github.com/mmpyro/k8s-pod-foamtree"
    },
    "split_keywords": [
        "foamtree",
        " k8s",
        " visualization"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4e2b3b7a4a135b2d4ba049f29fda53b06572e9af3947372e94b1fcae0d0ddd2f",
                "md5": "e044e8e475bdc26ef80d5a1b3a4666f1",
                "sha256": "9f14e97093d00d76e3cfc7d21a10f33d29dfa6a2d81cd4f7f55d182b64606878"
            },
            "downloads": -1,
            "filename": "k8sfoams-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e044e8e475bdc26ef80d5a1b3a4666f1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 128727,
            "upload_time": "2025-01-31T07:29:12",
            "upload_time_iso_8601": "2025-01-31T07:29:12.742648Z",
            "url": "https://files.pythonhosted.org/packages/4e/2b/3b7a4a135b2d4ba049f29fda53b06572e9af3947372e94b1fcae0d0ddd2f/k8sfoams-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b6bb9a18c066a27255f371ed8dd3f6b0dc9258c8625873e8f4f7461174b2303f",
                "md5": "90d2d396a9b79ebd2af3e51cc80b5f57",
                "sha256": "29f2b1a01207f8697579c4ae1c2157a4c9f6a7cbb5e4b4c3cd472b8aaf222c79"
            },
            "downloads": -1,
            "filename": "k8sfoams-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "90d2d396a9b79ebd2af3e51cc80b5f57",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 123640,
            "upload_time": "2025-01-31T07:29:14",
            "upload_time_iso_8601": "2025-01-31T07:29:14.622312Z",
            "url": "https://files.pythonhosted.org/packages/b6/bb/9a18c066a27255f371ed8dd3f6b0dc9258c8625873e8f4f7461174b2303f/k8sfoams-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-31 07:29:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mmpyro",
    "github_project": "k8s-pod-foamtree",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "k8sfoams"
}