https://github.com/oslabs-beta/navigate

A Kubernetes cluster visualizer for DevOps engineers - network policies, aggregated scheduler logs, deployments and pods before your cluster is running!
https://github.com/oslabs-beta/navigate

Last synced: 9 days ago
JSON representation

A Kubernetes cluster visualizer for DevOps engineers - network policies, aggregated scheduler logs, deployments and pods before your cluster is running!

• Host: GitHub
• URL: https://github.com/oslabs-beta/navigate
• Owner: oslabs-beta
• License: mit
• Created: 2021-10-01T20:38:33.000Z (about 3 years ago)
• Default Branch: develop
• Last Pushed: 2021-12-04T06:42:34.000Z (almost 3 years ago)
• Last Synced: 2024-08-17T01:19:08.750Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.95 MB
• Stars: 164
• Watchers: 8
• Forks: 15
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        







A visual overview of your Kubernetes cluster - with network policies, scheduler decisions, and live logs.



## Visualize your cluster before it starts running

Whether the cluster is live or not, upload your YAML config files to **Navigate**. Here you can see the network structure of your cluster, observing

the connections between your stateful sets, deployments, services, and other Kubernetes objects. 

 





 You can double check for mistakes!



Click on the deployment nodes in your graph to zoom into the Node View, seeing the various containers and connections each deployment brings.






## Visualize all your network policies

Want to check that your network policies are correct? Use the "Network Policies" tab to view them all, one at a time.

![image](https://user-images.githubusercontent.com/5425746/139293239-f8c0db76-b6df-491a-a005-563456ca9060.png)

## Get aggregated Live Logs

While the cluster is live, see: 

  -  etcd/node scheduler decisions, aggregated across many different logs

  -  live deployment data, including statuses and conditions

  -  live pod data that you would normally only get with `kubectl` commands



## How to use Navigate

Prerequisites: npm 


FOR WINDOWS USERS: you will need to run `npm run server & npm run dev` instead - Electron app coming soon. 
 


Here are the steps for getting started after cloning:

1. Run `npm install`, then run `npm run build` followed by `npm run both` in your terminal.

2. From there, the dev server should launch, and you will be prompted to upload your Kubernetes yaml config files. The app will display your cluster in a network graph without your Kubernetes cluster running. At this point, only deployments and pods can be interacted with in the graph.

3. To see live deployment and pod log data, your cluster needs to be currently running on your system.

4. If there are network policy objects within your files, the top left network policy tab will provide a dropdown menu so you can inspect each policy.

Currently, we are working on packaging and distributing our app cross-platform via electron. Right now the alpha version for macOS is out, which you can find on our website.

## How to contribute

We're actively developing! If you've found a bug or want to help, feel free to take a look at our Issues.

## Contributors

Brian Kang | Joel Park | Hemwatie Persaud