⚓️⚡️
Allok8 is a dynamic, conventional, and uncomplicated web-based UI Kubernetes visualization tool. Current tooling only enables resource portraits at the pod level. When the application adds layers of complexity, it is advantageous to visualize when pods have multiple containers. This enables users to manage resource levels, navigate clusters, and display all relevant information down to the container level.
The standard practice of one container per pod works most of the time because it lends to better portability, but when containers are interdependent, keeping track of the resource utilization is sparse. Allok8 wishes to showcase that hidden data in hopes of empowering users to further synthesize their K8s implementation.
Further data within containers that is provided (but not limited to):
- CPU
- Memory
- Capacity
🏗⚙️
In order to access the dashboard, the user must input the K8s cluster API and token which is typically provided by the system administrator.
To check the location and credentials that kubectl knows about, use the following command:
kubectl config view
Alternatively, you can refer to the offical K8s documents for more information.
To access a cluster, you would need the location of the cluster and have credentials to access it. Once aquired, simply type in the credentials in the input fields provided, hit fetch, and enjoy! ~
🔑🕹
We chose not to use expose the proxy for further security and prevent MITM attacks. Connections to clusters usually happen with a self-signed server certificate that may take special configuration to get your http client to use, thus providing no protection against man-in-the-middle attacks. By passing the authentication token directly to the API server, we hope to mitigate this by creating an internal certification that secures the connection.
🗺📙📊
Navigation
- Use the sidebar to access different views.
- Switch between tabs to get access to charts.
Graph
- Click on the icons to view access to various levels of information using a sunburst graph.
View
- Use the dropdown menu to toggle between graph and table views.
🧰🚢
✏️👩💻👨💻📓
- Bahram B - @bahrambds
- Jason Seidler - @jsonseidler
- Rella Cruz - @rllzrc
- Rex Osariemen - @rexosariemen
- Tyler Meyerson - @tdmeyerson
🔖⛴
This project is licensed under the MIT License - see the LICENSE.md file for details.