Free as in Freedom: Codeberg.org. Create your repos!
Report Kubernetes cluster and pod resource requests vs usage and generate static HTML
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Henning Jacobs 94c3754b62
Clean up (#87)
4 days ago
deploy v0.12 6 days ago
kube_resource_report Clean up (#87) 4 days ago
sample-report refactor to Python package (#25) 10 months ago
tests use pykube-ng (#70) 2 months ago
.gitignore Add some tests (#59) 5 months ago
.travis.yml More tests (#60) 5 months ago
Dockerfile allow custom links e.g. to monitoring tools (#67) 2 months ago
LICENSE add README 1 year ago
Makefile Add some tests (#59) 5 months ago
Pipfile use pykube-ng (#70) 2 months ago
Pipfile.lock Application page (#79) 1 week ago
README.rst v0.10 1 week ago
pipenv-install.py #24 reduce Docker image size 10 months ago
tox.ini Travis CI 11 months ago

README.rst

==========================
Kubernetes Resource Report
==========================

.. image:: https://travis-ci.org/hjacobs/kube-resource-report.svg?branch=master
:target: https://travis-ci.org/hjacobs/kube-resource-report
:alt: Travis CI Build Status

.. image:: https://coveralls.io/repos/github/hjacobs/kube-resource-report/badge.svg?branch=master;_=1
:target: https://coveralls.io/github/hjacobs/kube-resource-report?branch=master
:alt: Code Coverage

.. image:: https://img.shields.io/docker/pulls/hjacobs/kube-resource-report.svg
:target: https://hub.docker.com/r/hjacobs/kube-resource-report
:alt: Docker pulls

**This version only supports node costs for AWS EC2 (all regions, On Demand, Linux)**

Script to generate a HTML report of CPU/memory requests vs. usage (collected via Metrics API/Heapster) for one or more Kubernetes clusters.

Want to see how the report looks? `Check out the sample HTML report! <https://hjacobs.github.io/kube-resource-report/sample-report/output/index.html>`_

What the script does:

* Discover all clusters (either via ``~/.kube/config``, via in-cluster serviceAccount, or via custom Cluster Registry REST endpoint)
* Collect all cluster nodes and their estimated costs (AWS only)
* Collect all pods and use the ``application`` or ``app`` label as application ID
* Get additional information for each app from the application registry (``team_id`` and ``active`` field)
* Group and aggregate resource usage and slack costs per cluster, team and application
* Allow custom links to existing systems (e.g. link to a monitoring dashboard for each cluster)


-----
Usage
-----

The usage requires `Pipenv <https://docs.pipenv.org/>`_ (see below for alternative with Docker):

.. code-block::

$ pipenv install && pipenv shell
$ mkdir output
$ python3 -m kube_resource_report output/ # uses clusters defined in ~/.kube/config
$ OAUTH2_ACCESS_TOKENS=read-only=mytok python3 -m kube_resource_report --cluster-registry=https://cluster-registry.example.org output/ # discover clusters via registry
$ OAUTH2_ACCESS_TOKENS=read-only=mytok python3 -m kube_resource_report --cluster-registry=https://cluster-registry.example.org output/ --application-registry=https://app-registry.example.org # get team information

The output will be HTML files plus multiple tab-separated files:

``output/index.html``
Main HTML overview page, links to all other HTML pages.
``output/clusters.tsv``
List of cluster summaries with number of nodes and overall costs.
``output/slack.tsv``
List of potential savings (CPU/memory slack).
``output/ingresses.tsv``
List of ingress host rules (informational).
``output/pods.tsv``
List of all pods and their CPU/memory requests and usages.


---------------------
Deploying to Minikube
---------------------

This will deploy a single pod with kube-resource-report and nginx (to serve the static HTML):

.. code-block::

$ minikube start
$ kubectl apply -f deploy/
$ pod=$(kubectl get pod -l application=kube-resource-report -o jsonpath='{.items[].metadata.name}')
$ kubectl port-forward $pod 8080:80

Now open http://localhost:8080/ in your browser.


---------------------------
Running as Docker container
---------------------------

.. code-block::

$ kubectl proxy & # start proxy to your cluster (e.g. Minikube)
$ # run kube-resource-report and generate static HTML to ./output (this trick does not work with Docker for Mac!)
$ docker run -it --user=$(id -u) --net=host -v $(pwd)/output:/output hjacobs/kube-resource-report:0.10 /output


--------------------
Application Registry
--------------------

The optional application registry can provide information per application ID, it needs to have a REST API like:

.. code-block::

$ curl -H 'Authorization: Bearer <mytok>' https://app-registry.example.org/apps/<application-id>
{
"team_id": "<team-id>",
"active": true
}

See the ``application-registry.py`` script in the ``sample-report`` folder for an example implementation.


------------
Custom Links
------------

The generated report can be enhanced with custom links to existing systems, e.g. to link to monitoring dashboards or similar.
This currently works for clusters, teams, and applications. Custom links can be specified by providing the ``--links-file`` option which must point to a YAML file
with the links per entity. Example file:

.. code-block:: yaml

cluster:
- href: "https://mymonitoringsystem.example.org/dashboard?cluster={name}"
title: "Grafana dashboard for cluster {name}"
icon: chart-area
application:
- href: "https://mymonitoringsystem.example.org/dashboard?application={id}"
title: "Grafana dashboard for application {id}"
icon: chart-area
- href: "https://apps.mycorp.example.org/apps/{id}"
title: "Go to detail page of application {id}"
icon: search
team:
- href: "https://people.mycorp.example.org/search?q=team:{id}"
title: "Search team {id} on people.mycorp"
icon: search

For available icon names, see the `Font Awesome gallery with free icons <https://fontawesome.com/icons?d=gallery&m=free>`_.