Set Up

Prerequisites:

• Install Docker Desktop on your machine: https://www.docker.com/products/docker-desktop/
• Enable Kubernetes in Docker Desktop settings
• Install kubectl on your machine:
  • For MacOS: https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/
  • For Windows: https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/
  • For Linux: https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/

Terminal Commands:

1. Clone this repository onto your local machine git clone https://github.com/oslabs-beta/KubernOcular.git

2. Install Helm using the appropriate terminal commands

   For MacOS/Homebrew:

     brew install helm
   

   For Windows/Chocolatey:

     choco install kubernetes-helm
   

   For Linux/Ubuntu:

     curl https://baltocdn.com/helm/signing.asc | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
   
     sudo apt-get install apt-transport-https --yes
   
     echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/helm.gpg] https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
   
     sudo apt-get install helm
   

3. Once Helm is properly installed, add the helm-charts repository

     helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
   

4. Install the kube-prometheus-stack manifests collection with this command in your terminal

     helm install --set prometheus-node-exporter.hostRootFsMount.enabled=false prometheus prometheus-community/kube-prometheus-stack
   

5. Port-forward the Prometheus API to http://localhost:9090

     kubectl port-forward svc/prometheus-kube-prometheus-prometheus 9090
   

6. Run this command in a separate terminal in the KubernOcular directory and visit http://localhost:8080 to begin your KubernOcular experience

     npm run dev
   

7. When you are finished using KubernOcular, uninstall the prometheus monitoring stack — this should also delete the prometheus running cluster

     helm uninstall prometheus
   

Technologies

• React
• TypeScript
• React Router
• Material UI
• Cytoscape
• Chart.js
• Kubernetes
• Docker
• Helm
• Node
• Express
• Kubernetes-Client
• Prometheus/PromQL
• Jest
• Supertest
• Puppeteer
• Webpack

The KubernOcular Team

• Adam Selph: Github | LinkedIn
• Shirley Luu: Github | LinkedIn
• Brian Preston: Github | LinkedIn
• Evan Emenegger: Github | LinkedIn
• Michael Mezhiritskiy: Github | LinkedIn

License

This project is licensed under Mozilla Public License Version 2.0 - see the LICENSE.md file for details.