K8R visualizes real-time Kubernetes cluster and hardware metrics with an emphasis on customization.
Table of Contents
K8R is Purpose-built to deliver maximum out of the box productivity without the headaches of traditional solutions, K8R delivers at-a-glance insights into detailed and executive KPIs for your local and cloud based clusters. With K8Rs lightweight and unified user-experience, K8R works for you, not the other way around.
-
-
Fork and Clone the Project
-
Run
node -v
to confirm your version of node. K8R requires node 18 or later.- To install latest version of node, run
nvm install --lts
- To install latest version of node, run
-
Run
npm i
to install all package dependencies. -
Create a MongoDB database and Google OAuth credentials to use within your app.
-
Create a .env file and assign the following environment variables according to your MongoDB and Google OAuth setup.
// MONGO MONGO_URL= MONGO_PORT= MONGO_USERNAME= MONGO_PASSWORD= // Google OAuth GOOGLE_CLIENT_SECRET= GOOGLE_CLIENT_ID= GOOGLE_CALLBACKURL='http://localhost:8888/auth/google/callback' SESSION_SECRET=[Randomized String for Express Sessions]
-
Run
npm run dev
to initialize the application onhttp://localhost:8888/
-
-
-
Use the Cluster Editor to add or remove clusters to your account.
- Users can add additional clusters from any cluster source you prefer; including cloud hosted or local clusters.
- K8R allows users to see all of your clusters in one place regardless of their source, without having to switch to different windows for each cluster.
-
Contributions are a great way to contribute to the open source community as a whole. If you'd like to contribute to K8R, please follow the steps below to get started.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/yourNewFeature
) - Commit your Changes (
git commit -m 'Add some a fantastic new feature'
) - Push to the Branch (
git push origin feature/yourNewFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Developed By | ||
---|---|---|
Josh Howard | ||
Brian Jaber | ||
Anthony Cho | ||
Chris Oakes |