){kind=icon}
){kind=icon}
For those experienced with the Kubernetes environment, the intricacies of monitoring cluster health are well understood. Navigating the complexities inherent in visualizing a cluster is a challenge that necessitates attention to a multitude of factors. The challenge lies in discerning which metrics hold critical significance and which ones might be relegated to a less prominent role. Get ready to be ready with kubeready! With our tool, visualizing kubernetes metrics from any local cluster becomes simple. Crafted with a developer-centric approach, kubeready boasts a user-friendly platform, delivering real-time metric visualization. By offering an instantaneous display of these metrics, kubeready empowers developers to promptly address performance issues as they emerge, significantly elevating their responsiveness and efficacy in tackling such challenges.
The kubeready tool is designed to streamline and enhance your experience with Kubernetes cluster management, monitoring, and analysis. kubeready was built with comprehensive pre-built metrics, automated dependency installation, seamless Grafana and Prometheus integration, custom dashboard generation, password encryption, and a comprehensive developer-side testing suite.
- Connect your Kubernetes clusters to pre-built metrics, allowing you to visualize detailed CPU, Memory, Network, and Disk metrics.
- Automated dependency installation, running commands upon account creation to connect Helm charts and custom Grafana configurations.
- Automated Grafana dashboard creation, rendering a new dashboard specific to the user's machine.
- Automated connection to Prometheus, scraping metrics more quickly without additional user setup.
- Security is a top priority in any Kubernetes environment. kubeready provides password encryption through bcrypt.
- Test-driven development: kubeready's comprehensive testing suite (using Jest and React Testing Library) enables future developers to assess code functionality throughout the frontend and backend of the application.
Please free up the following ports:
| Technology | Port Number |
|---|---|
| Grafana | 3000 |
| server | 3001 |
| kubeready | 8080 |
- Install Docker on your OS so a container can be spun up.
- Begin running a minikube to create a kubernetes cluster by running the command
minikube start
- Install Helm.
- Clone this respository onto your local machine.
- Run the following commands in your local repository directory.
npm install
npm run build
npm run start
- Open localhost:3001
https://localhost:3001/
- Create an account or sign in.
💯 = Ready to use
👨💻 = In progress
🙏🏻 = Looking for contributors
| Feature | Status |
|---|---|
| Seamless grafana integration | 💯 |
| Seamless prometheus integration | 💯 |
| Password encryption | 💯 |
| Addition of testing suite | 💯 |
| Custom dashboard creation and render | 💯 |
| Automate login proccess using CLI for grafana | 👨💻 |
| Implement typescript conversion | 🙏🏻 |
| Add functionality to monitor health of invididual pods | 🙏🏻 |
| Add an overall health score for each metric to allow for more immediate response by developer when metric dips to critical level | 🙏🏻 |
| Implement typescript conversion for codebase | 🙏🏻 |
| Addition of a notification/alert system when metrics dip to critical | 🙏🏻 |
Read our Medium Article Here!
 Alana Herlands GitHub | LinkedIn Software Engineer |
 Diane Moon GitHub | LinkedIn Software Engineer |
 Serena Romano GitHub | LinkedIn Software Engineer |
 Alvin Cheung GitHub | LinkedIn Software Engineer |
 Noel Pallivathucal GitHub | LinkedIn Software Engineer |