Kleric - An open source Kubernetes cluster monitoring tool

What is Kleric?

Kleric is an open source Kubernetes cluster monitoring tool. We implement a friendly and easy to use UI to serve you your most essential metrics without the hassle of setting it all up yourself, saving you time and a headache.

Current Features

  • Display a Dashboard that shows metrics and a graph that shows reports

  • Get an Alert any time the memory exceeds a number in memory

Strech Goals

  • Build a Desktop App use Electron
  • Cloud Deployment to AWS
  • Database storage for capturing historic data on cluster metric and previous rollouts

Installation

  1. Clone this repo down to your local machine
  2. Install minikube from here https://minikube.sigs.k8s.io/docs/start/
  3. Run minikube with minikube start
  4. Open new second tab to run kubectl proxy --port=8080 &, which gives us access to the Kubernetes API on localhost:8080
  5. Open a third tab to run kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml, which gives us access to the kubernetes metrics servers
  6. Verify that the metrics-server service is currently enabled by running minikube addons list
  7. Enable our metrics server, if necessary: minikube addons enable metrics-server
  8. Initialize Kleric by running npm run dev. You can now access the kubernetes metrics API at localhost:3000/api/metrics!

Built With

  • Docker

  • Grafana

  • Kubernetes

  • Node.js/Express

  • Prometheus

  • React

  • React Router

  • Typescript

Core Team:

An Le | GithubLinkedIn

Chris Jamali | GithubLinkedIn

Crystal Agoncillo | GithubLinkedIn

Rosendo De Luna | GithubLinkedIn

GitHub

View Github