Merge pull request #73 from oslabs-beta/dev

merges v201 into main

Author: brecht-horn

CHANGELOG.md

@@ -0,0 +1,45 @@
+Changelog for kaptn v2.0.1 and earlier.
+
+
+## Version 2.0.1 -
+
+- Adds interactive, expandable visx graphs for pods' and nodes' historical cpu and memory usage.
+
+- Adds variable refresh rate.
+
+- Adds various other bugs fixes and additions including: Fixes bug with user directory in CLI
+
+
+## Version 2.0.0 -
+
+- **Kaptn Krane Cluster Manager:**
+  View live and historical metrics, and scale, delete or restart resources like pods, nodes, and deployments in our revolutionary, easy-to-use interface that harnesses the power of kubectl commands. Features including filtering by namespace, sorting by cpu and memory percent, one-click control of your clusters, and much more makes taking command of Kubernetes easier than ever before!
+
+- **New Start Page:**
+  We've completely revamped the start page, including the addition of installation checks and quickstart links. Now you can troubleshoot problems more quickly, and get right into your workflow.
+
+- Adds various other bugs fixes and additions including: clear terminal log button, redesign of CLI, Instant Help Desk, Learning Center and much more!
+
+## Version 1.2.0 -
+
+- Adds ability to use kubectl commands without choosing a working directory.
+
+## Version 1.1.0 -
+
+- **_Now available for Mac, Windows, and Linux_**
+
+- **Cluster Metrics Visualizer:**
+  Easily sync your Kaptn workspace to Grafana and Prometheus to allow for clear and real-time visualization of your clusters' health. Utilize our quick set-up if you are not already connected, and consider Kaptn your only stop for working with and monitoring your Kubernetes clusters.
+
+- **Instant Help Desk:**
+  Get help information on demand and at the click of a button with the Instant Help Desk. Now you can get more info about any command or type without leaving the command line, and losing the code you've already written.
+
+- **Kaptn Learning Center:**
+  Inside the Easy Setup page you can now find the Learning Center with resources you need to learn Kubernetes. You can follow tutorials, read articles and documentation, and master Kubernetes faster than ever.
+
+- **Light/Dark Mode:**
+  Whether it's eye strain, or just personal preference, we know engineers can be selective about their work environments. So we created a Light/Dark mode that allows you to work with your favorite color combination. Now you can focus on coding with no distractions to your workflow.
+
+This update also includes various bugs fixes, including:
+
+- Bug where kubectl commands could not be used on some Mac operating systems.

README.md

@@ -30,10 +30,11 @@ Kaptn is a fully downloadable desktop application that provides a user-friendly
 ## Features
 
 - Kaptn Krane Cluster Manager - NEW!
-  - View live metrics and refresh on demand
+  - View live and historical metrics, and refresh stats at adjustable intervals
   - Scale, delete/restart, and rollback deployments, nodes, and pods
   - View logs, yamls, and describe resources
-  - Intuitive UI including custom speedometer-style gauges for CPU and Memory Usage, and one-click control of your clusters
+  - Intuitive UI including custom speedometer-style gauges for CPU and Memory Usage, visx graphs, and one-click control of your clusters
+  - Filter and sort resources by namespace, max CPU and memory, and more.
 - User-friendly terminal interface
   - Take command of the command line interface with pre-selected kubectl options, or free-type
   - Clearly visualize the commands within our interactive terminal
@@ -48,62 +49,93 @@ Kaptn is a fully downloadable desktop application that provides a user-friendly
 
 ## Updates
 
-Version 2.0.0 -
 
-- **Kaptn Krane Cluster Manager:**
-  View live metrics and scale, delete or restart resources like pods, nodes, and deployments in our revolutionary, easy-to-use interface that harnesses the power of kubectl commands. Features including filtering by namespace, sorting by cpu and memory percent, one-click control of your clusters, and much more makes taking command of Kubernetes easier than ever before!
+Version 2.0.1 -
 
-- **New Start Page:**
-  We've completely revamped the start page, including the addition of installation checks and quickstart links. Now you can troubleshoot problems more quickly, and get right into your workflow.
+- Adds interactive, expandable visx graphs for pods' and nodes' historical cpu and memory usage.
 
-- Adds various other bugs fixes and additions including: clear terminal log button, redesign of CLI, Instant Help Desk, Learning Center and much more!
+- Adds variable refresh rate.
 
-Version 1.2.0 -
+- Adds various other bugs fixes and additions including: Fixes bug with user directory in CLI
 
-- Adds ability to use kubectl commands without choosing a working directory.
+For details on all previous updates and releases, please see the [CHANGELOG](https://github.com/oslabs-beta/kaptn/blob/main/CHANGELOG.md), or [Releases](https://github.com/oslabs-beta/kaptn/releases) page.
 
-Version 1.1.0 -
+#
 
-- **_Now available for Mac, Windows, and Linux_**
+## Getting Started
 
-- **Cluster Metrics Visualizer:**
-  Easily sync your Kaptn workspace to Grafana and Prometheus to allow for clear and real-time visualization of your clusters' health. Utilize our quick set-up if you are not already connected, and consider Kaptn your only stop for working with and monitoring your Kubernetes clusters.
+1. Download the latest release [here](https://github.com/oslabs-beta/kaptn/releases).
 
-- **Instant Help Desk:**
-  Get help information on demand and at the click of a button with the Instant Help Desk. Now you can get more info about any command or type without leaving the command line, and losing the code you've already written.
 
-- **Kaptn Learning Center:**
-  Inside the Easy Setup page you can now find the Learning Center with resources you need to learn Kubernetes. You can follow tutorials, read articles and documentation, and master Kubernetes faster than ever.
+__For Windows (portable) -__ Open the .exe file.
 
-- **Light/Dark Mode:**
-  Whether it's eye strain, or just personal preference, we know engineers can be selective about their work environments. So we created a Light/Dark mode that allows you to work with your favorite color combination. Now you can focus on coding with no distractions to your workflow.
+__For Linux (AppImage) -__ Follow the instructions [here](https://docs.appimage.org/introduction/quickstart.html) to run the application.
 
-This update also includes various bugs fixes, including:
+__For Mac (Intel/x64/Universal) -__ Double-click the .dmg installer, and drag and drop Kaptn in your Applications folder. If you get a warning that the app is from an unidentified developer, go to System Preferences > Security & Privacy > General and click "Open Anyway".
 
-- Bug where kubectl commands could not be used on some Mac operating systems.
+__For Mac (Apple Silicon/ARM64) -__ We do not have Mac code-signing, and therefore cannot offically offer an Apple Silicon/ARM64 version for download here. You can still use the "Mac Universal" version above, OR there is this work-around to create an Apple Silicon version on your computer:
 
-#
+First fork/clone the project. Then open a terminal in the project, and run:
 
-## Getting Started
+    npm i
 
-1. Download the latest release [here](https://github.com/oslabs-beta/kaptn/releases).
-2. Run the installer.
+After that, run:
+
+    npm run build:mac
 
-If you get a warning that the app is from an unidentified developer, go to System Preferences > Security & Privacy > General and click "Open Anyway".
+After completion, the .dmg file will be available in the "dist" folder. If you get a warning that the app is from an unidentified developer, go to System Preferences > Security & Privacy > General and click "Open Anyway".
+
+#
 
 ## Usage Guidelines
 
 ### Overview
 
-Our application defaults to start page, where you will be able to choose which page you'd like to visit.
+Our application defaults to start page, where installation checks will run, and where you will be able to choose which page you'd like to visit.
 
 ![newStartPage](https://github.com/oslabs-beta/kaptn/assets/119518056/a2d473da-37a9-4b6d-b69d-f8fcd95f2b41)
 
 ### Krane Cluster Manager
 
-Our all-new Krane Cluster Manager allows you to control your clusters at the click of a button. Simply choose from the options at the top of the screen, and you can view live metrics on your nodes, pods, and deployments. You can scale, delete/restart, rollback your resources, and filter by namespace, sort by CPU, Memory, and much more.
-
-![kraneNodesGIF](https://github.com/oslabs-beta/kaptn/assets/119518056/25abaa5e-54b5-4d92-9b83-52d32fe96605)
+Our all-new Krane Cluster Manager allows you to control your clusters at the click of a button. Simply choose "Nodes & Pods" or "Deployments" at the top of the screen, and you'll have the following options:
+
+- Nodes:
+    - View Live CPU and Memory Use
+    - View Graphs of Historical CPU and Memory Use
+    - View Node Yaml
+    - Decribe Node 
+    - Drain Node
+    - Cordon Node
+    - Uncordon Node
+    - Delete / Restart Node
+
+- Pods:
+    - View Live CPU and Memory Use
+    - View Graphs of Historical CPU and Memory Use
+    - View Pod Logs
+    - View Pod Yaml
+    - Decribe Pod
+    - Delete / Restart Pod
+    - Filter by Namespace
+    - Sort by Namespace, Max CPU and Memory, and more. 
+
+![v201screencaps-nodesPods](https://github.com/oslabs-beta/kaptn/assets/119518056/60f19526-8c79-40c9-9a8c-000d38240dc6)
+
+
+- Deployments:
+    - View ReplicaSets and Statuses
+    - View Deployment Yaml
+    - View Deployment Logs
+    - Describe Deployment
+    - View Rollout Status
+    - View Rollout History
+    - Rollback to Previous Version
+    - Perform Rolling Restart
+    - Scale Deployment
+    - Delete Deployment
+    - Filter by Namespace
+
+![v201screencaps-Deploys](https://github.com/oslabs-beta/kaptn/assets/119518056/33a362be-1be1-404e-9018-a3599735b9c7)
 
 ### Supercharged CLI
 

main.js

@@ -1,8 +1,10 @@
 const path = require("path");
-const { app, BrowserWindow, ipcMain } = require("electron");
+const { app, BrowserWindow, ipcMain, ipcRenderer } = require("electron");
 const { exec, spawnSync, spawn, execSync } = require("child_process");
 const fixPath = require("fix-path");
 
+// const storage = require("electron-json-storage");
+
 const isDev = process.env.NODE_ENV === "development";
 
 function createMainWindow() {
@@ -17,6 +19,7 @@ function createMainWindow() {
     webPreferences: {
       nodeIntegration: true,
       contextIsolation: false,
+      // enableRemoteModule: true,
     },
   });
 
@@ -45,28 +48,28 @@ ipcMain.on("getDirectory_command", (event, arg) => {
       // Handle failed command execution
       if (err) {
         let output = kubDir;
-        return event.sender.send("got_directory", kubDir);
+        return event.sender.send("got_directory", app.getPath("home"));
       }
       // Handle successful command execution but returned error (stderr)
       if (stderr) {
-        return event.sender.send("got_directory", kubDir);
+        return event.sender.send("got_directory", app.getPath("home"));
       }
       // Handle successful command execution with no errors
-      return event.sender.send("got_directory", kubDir);
+      return event.sender.send("got_directory", app.getPath("home"));
     });
   } else {
     exec(` ${getDirectoryCommand}`, { cwd: currDir }, (err, stdout, stderr) => {
       // Handle failed command execution
       if (err) {
         let output = kubDir;
-        return event.sender.send("got_directory", kubDir);
+        return event.sender.send("got_directory", app.getPath("home"));
       }
       // Handle successful command execution but returned error (stderr)
       if (stderr) {
-        return event.sender.send("got_directory", kubDir);
+        return event.sender.send("got_directory", app.getPath("home"));
       }
       // Handle successful command execution with no errors
-      return event.sender.send("got_directory", kubDir);
+      return event.sender.send("got_directory", app.getPath("home"));
     });
   }
 });