Welcome to K8 Mate, a light-weight, easy-to-use Kubernetes management and observability tool.
| Features |
|---|
| Dashboard for key metrics monitoring via Prometheus API |
| Real-time alerts for resource usage, pod outages, restarts, and other structural changes |
| K8 cluster visualization tool via React Flow to manage and cluster architecture |
| Built-in Terminal view to manage your cluster, nodes, pods, and services |
IMPORTANT -- Requirements to Use K8 Mate
✅ Active Kubernetes cluster spun up
✅ Kubectl configured on local machine
✅ Prometheus installed on your K8 cluster
✅ Grafana installed on your K8 cluster
✅ An active database for your team in PostgresQL (only supported at this time)
How to Run the App
- Install npm dependencies
npm installin the root, front-end, and backend directories, for a total of 3 times. - Expose port 9090 to the Prometheus API
kubectl port-forward svc/prometheus-node-port-service 9090:9090 - Expose port 3000 to the Grafana service node
kubectl port-forward svc/grafana-node-port-service 3000:80 - Run the development server
npm run devfrom the root directory - Connect your DB in the settings tab! Setup is already provided in our backend directory to interact with your DB.
- All done!
| Reports | Alerts |
|---|---|
 |
 |
| K8 Visualization | In-App Terminal |
|---|---|
 |
 |
Our goal is to continue to evolve K8 Mate, expanding features while maintaing its ease-of-use. We're grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving K8 Mate.
- Fork the project.
- Create and work off of your feature branch.
- Create a pull request with a detailed description of your changes from your feature branch to dev branch.
- Please let us know when PR submission is done. Once the changes are reviewed and approved, we will merge your code into the main repository.
Follow our dev READme to learn more
| Owners | GitHub | |
|---|---|---|
| Jonathan Si |  |
 |
| Aaron Thien | |
|
| Richard To | |
|
| Stephen Sinco | |
|