Kubehawk is a open source monitoring solution designed for Kubernetes clusters. With support for multicluster monitoring and RBAC visualization, Kubehawk simplifies the monitoring process of multiple production deployed Kubernetes clusters.

Check out our website!

Features

1. Intuitive visualization of RBAC in your Kubernetes cluster
2. Real-time cluster health metrics monitoring, including pod status, resource utilization, and network traffic
3. No online database! We keep your data on your local machine for maximum security
4. Lightweight and highly efficient design for minimal impact on cluster performance
5. Cross-platform compatibility (Local, GKE, AWS) for seamless integration into your existing infrastructure
6. Easily extensible for future improvements, making it an ideal choice for teams looking to customize and enhance their security monitoring capabilities
7. Enhanced security and adherence to best practices, ensuring the safety and integrity of your valuable data and applications

Prerequisites

Before you begin, ensure you have met the following requirements:

Kubernetes cluster version 1.18 or higher kubectl version 1.18 or higher Docker installed (if running locally)

Getting Started

1. Fork and clone the repo:
   git clone https://github.com/oslabs-beta/kubehawk.git

2. Install dependencies:
   npm install

3. Make sure your Kubernetes cluster is up and running with Prometheus and Grafana exposed.

   • Expose your Prometheus and Grafana endpoints
   • Export your RBAC bindings to your local computer

4. Run our program and visit the localhost it is being hosted on.
   npm run dev

5. Add a cluster using the Grafana external IP retrieved in Step 3
   

6. Drag and drop your exported RBAC bindings you received in Step 3 to visualize your RBAC metrics
   

Contributing

Contributions are a great way to contribute to the open source community as a whole. If you'd like to start a new PR, we recommend creating an issue for discussion first. This lets us open a conversation, ensuring work is not duplicated unnecessarily and that the proposed PR is a fix or feature we're actively looking to add. If you'd like to contribute to Kubehawk, please follow the steps below to get started.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/yourNewFeature)
3. Commit your Changes (git commit -m 'Add some a fantastic new feature')
4. Push to the Branch (git push origin feature/yourNewFeature)
5. Open a Pull Request

KubeHawk Team

Developed By	Github	LinkedIn
Steven Wu
Kyle Brandt
PJ Bannon
Spencer White

License

Kubehawk is designed under the MIT License