Kuberneat

A visualization and monitoring tool for Kubernetes clusters

Supported Platforms

Overview • Features • Getting Started • Tech Stack • Contributing • Team

Overview

Kuberneat provides insights into Kubernetes environments through interactive visualizations. Originally released as Zeus in 2022, this project aims to offer a monitoring experience with Prometheus and Grafana integration. The project is currently in active development and welcomes community contributions.

Features

Note: Kuberneat is under active development. The features shown below represent both current capabilities and development goals. Community contributions are welcome to help enhance these features.

Interactive Cluster Visualization Explore connections between Kubernetes resources with dynamic graph visualizations	Kubelet Metrics Monitor Kubelet performance metrics integrated from Prometheus
Kube-State-Metrics Integration Access comprehensive state metrics for cluster management	Kubernetes API Monitoring Track API server performance and request patterns

Getting Started

Prerequisites

• Kubernetes cluster (local or remote)
• Prometheus and Grafana set up in your cluster
• Node.js 16+ and npm/yarn

Development Setup

• Clone the repository:

git clone https://github.com/oslabs-beta/Kuberneat.git
   cd Kuberneat

• Install dependencies:

npm install

• Create environment configuration:

# Create a .env file in the root directory
   touch .env
# Add your MongoDB connection string    echo "mongoURI = \"Your NoSQL URI string\"" > .env

• Launch the application in development mode:

# For the web application
   npm run dev
   
   # For the Electron application
   npm run electron

Note: This project is in development. You may encounter issues that require troubleshooting or configuration adjustments.

Tech Stack

Contributing

We welcome contributions to help improve Kuberneat! Here's how you can help:

• Fork the repository
• Create a feature branch:

git checkout -b your-name/awesome-feature

• Make your changes and commit them:

git commit -m 'Add some awesome feature'

• Push to your branch:

git push origin your-name/awesome-feature

• Open a pull request with a detailed description of your changes

Development Focus Areas

We're currently focusing on:

• Improving Prometheus/Grafana integration
• Enhancing D3.js visualizations
• Updating dependencies
• Expanding documentation
• Addressing compatibility issues

Team

Harvey Li LinkedIn

Amy Nguyen LinkedIn

John Wroge LinkedIn

Ed Cho LinkedIn

License

This project is licensed under the MIT License - see the LICENSE file for details.

© 2025 Kuberneat • Originally released as Zeus in 2022