updated Known Issues, ReadMe, Docketeer 19.0 change log, added pseudocode to changed files

Co-authored-by: Ellis <[email protected]>
Co-authored-by: Chris <[email protected]>
Co-authored-by: Joseph <[email protected]>
Co-authored-by: Dylan <[email protected]>
Co-authored-by: Aiden <[email protected]>

Author: 5 people

README.md

@@ -65,7 +65,6 @@
     <li><a href="#contributing">Contributing</a></li> 
     <li><a href="#license">License</a></li>
     <li><a href="#authors">Authors</a></li>
-    <li><a href="#troubleshooting">Troubleshooting</a></li>
   </ol>
 
 <!-- ABOUT THE PROJECT -->
@@ -80,15 +79,17 @@
 
 Docketeer is an open source initiative comprising contributions from dozens of talented and passionate software engineers. Our application provides a simple interface to manage Docker resources & visualize both host and container metric data. Docketeer is a containerized application that can be deployed alongside your application cluster with hardly any effort. To learn more about our application and how to get started, keep reading!
 
-### What's New in Version 18.0.0?
+### What's New in Version 19.0.0?
 
 | Feature                                                                                                                                     | Status    |
 |---------------------------------------------------------------------------------------------------------------------------------------------|-----------|
-| More vulnerability info such as packages name & CVE ID with link.                                                                           | ✅        |
-| Data visualization graph for each image.                                                                                                    | ✅        |
-| Users can now `Rescan` to bypass Redis Caching from Version 17.0.                                                                         | ✅        |
-| Ability to `Save Scan` and retrieve history scans to compare on a time series graph.                                                        | ✅        |
-| **New updated UI and utilities.**                                                                                                           | ✅        |
+| Image vulnerability scans utilizing Memcached to replace non-open source Redis                                                              | ✅        |
+| Added critical details to vulnerabilities, such as links to all vulnerability types and information on patched package versions             | ✅        |
+| Users can now use the Configuration Page to modify Prometheus target/metric settings, and restart Prometheus container within the app       | ✅        |
+| Users can now save newly modified Prometheus settings to MongoDB database                                                                   | ✅        |
+| Loading and error modals added to avoid waiting on potential crashes                                                                        | ✅        |
+| Updated color schemes for better readability, and high contrast mode for color-deficient users                                              | ✅        |
+| Functional network and list reducer tests                                                                                                   | ✅        |
 
 - ✅ = Ready to use
 
@@ -127,6 +128,7 @@ Docketeer is an open source initiative comprising contributions from dozens of t
 - Docketeer offers the ability to create, delete, and attach containers to networks.
 - It's a community-maintained project, with frequent updates and bug fixes.
 - Docketeer is licensed under the MIT license, meaning it can be used and modified freely, even for commercial projects.
+- Read, modify, and save Prometheus configurations all within the extension
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -164,18 +166,18 @@ Dev & Contributors - See [DevGettingStarted](/docs/DevGettingStarted.md) & Contr
 
 | Feature                                                                                                                                     | Status    |
 |---------------------------------------------------------------------------------------------------------------------------------------------|-----------|
-| More advanced container configuration options within Docketeer.                                                                             | ⏳        |
 | CI/CD pipeline for Docketeer repo.                                                                                                          | ⏳        |
 | Improve test coverage with additional unit tests and integration tests.                                                                     | ⏳        |
 | Optimize frontend rendering performance with lazy loading to reduce initial bundle size and eliminating redundant re-renders.               | ⏳        |
 | Add support for more advanced Docker features, like multi-stage builds or Docker secrets, to expand the capabilities of Docketeer.          | ⏳        |
 | Add the ability to control Docker containers deployed in AWS.                                                                               | ⏳        |
 | Develop aggregation service to collect and cache data from prometheus data sources.                                                         | ⏳        |
 | Implement endpoint scraping of any kubernetes cluster running prometheus. ([Read more](/docs/dev/features/Configuration(Alpha).md))         | ⏳        |
-| Work on improving the connect/disconnnect button under networks button in Containers Tab.                                                   | ⏳        |
+| Work on improving the connect/disconnect button under networks button in Containers Tab.                                                    | ⏳        |
 | Adding additional key metrics to the snapshot functionality.                                                                                | ⏳        |
 | Setup a error catcher to alert Users of errors that are in the Docker Container Log.                                                        | ⏳        |
 | Implement functionality that alerts users when certain metrics reach critical threshold.                                                    | ⏳        |
+| Add functionality to load previously saved Prometheus configurations to the current container                                               | ⏳        |
 
 - ✅ = Ready to use
 - ⏳ = In progress
@@ -222,10 +224,11 @@ Read our [contributing guide](https://github.com/open-source-labs/Docketeer/blob
 <br />
 
 ## <b>Read More</b>
+- [Docketeer XIX: New Features in Uncharted Seas](https://medium.com/@ellissong/docketeer-xix-new-features-in-uncharted-seas-3baf72099488)
 - [Docketeer XVIII: A Whale of An Improvement](https://medium.com/@docketeerxii/announcing-docketeer-18-0-a-whale-of-an-improvement-67282fbbbe61)
 - [Docketeer XVII: Transforming with Security](https://medium.com/@docketeerxii/docketeer-xvii-transforming-with-security-45cd06da061d)
 - [Docketeer XVI: The Journey Continues](https://medium.com/@docketeerxii/introducing-docketeer-xvi-the-journey-continues-f34fc5bf7749)
-- [Docketeer XV: Naviating the Seas of Docker with Docketeer v15](https://medium.com/@christiandoescoding/navigating-the-seas-of-docker-with-docketeer-v15-0-ad5bd9540d14)
+- [Docketeer XV: Navigating the Seas of Docker with Docketeer v15](https://medium.com/@christiandoescoding/navigating-the-seas-of-docker-with-docketeer-v15-0-ad5bd9540d14)
 - [Docketeer XIV: Coming Home](https://medium.com/@grantschussler/docketeer-xiv-coming-home-6eb011990a34)
 - [Docketeer XIII: A Tool for Docker!](https://medium.com/@michael_kwon_liu/docketeer-a-tool-for-docker-273793014eb0)
 - [Docketeer XII: Now Ready for Launch!](https://medium.com/@jaenixlee/docketeer-xii-now-ready-for-launch-d06e8f26cd0f)
@@ -254,6 +257,11 @@ Please ⭐️ this project if you found it helpful, thank you!
 <br />
 
 ## Contributors
+- Aiden Carere [@AidenCarere](https://github.com/AidenCarere) | [Linkedin](https://www.linkedin.com/in/aidencarere/)
+- Chris Rodriguez [@chrisr0892](https://github.com/chrisr0892) | [Linkedin](https://www.linkedin.com/in/chris-kossky-rodriguez/)
+- Dylan Sterling [@dsterling7](https://github.com/dsterling7) | [Linkedin](https://www.linkedin.com/in/dylan-sterling-2b7256180/)
+- Ellis Song [@elsong86](https://github.com/elsong86) | [Linkedin](http://www.linkedin.com/in/ellissong)
+- Joseph Ahn [@joeahn95](https://github.com/joeahn95) | [Linkedin](https://www.linkedin.com/in/dohyun-joseph-ahn/)
 - Quan Nguyen [@ZinWR](https://github.com/ZinWR) | [Linkedin](https://www.linkedin.com/in/quan-nguyen27/)
 - Alexander David [@alexjosephdavid](https://github.com/alexjosephdavid) | [Linkedin](https://www.linkedin.com/in/alexander-joseph-david)
 - Andy White [@ComfyClicks](https://github.com/ComfyClicks) | [Linkedin](https://www.linkedin.com/in/andywhite5)

assets/error_screenshots/Screenshot 2024-05-03 at 12.22.12.png

@@ -4,7 +4,7 @@
 // See https://hub.docker.com/_/memcached for docker image
 const Memcached = require('memcached');
 
-//Connect to the Memcached server
+// Connect to the Memcached server
 const memcachedClient: any = new Memcached('memcached:11211', { retries: 1, retry: 5000 });
 
 export default memcachedClient;

assets/error_screenshots/Screenshot 2024-05-04 at 10.13.37 AM.png

@@ -178,8 +178,6 @@ containerController.removeContainer = async (req, res, next) => {
     const { stdout, stderr } = await execAsync(`docker rm ${id}`);
     if (stderr.length) throw new Error(stderr);
 
-    // remove once verified
-    console.log(stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {
@@ -237,7 +235,7 @@ containerController.getAllLogs = async (req, res, next) => {
 }
 
 /**
- * @todo finish implementing
+ * @todo Partially built. Currently not integrated into codebase.
  */
 containerController.inspectContainer = async (req, res, next) => {
   try {

assets/error_screenshots/Screenshot 2024-05-09 at 10.47.43.png

@@ -149,8 +149,6 @@ imageController.buildContainerFromImage = async (req, res, next) => {
     const { stdout, stderr } = await execAsync(`docker run --name ${containerName} ${imageName}:${tag}`);
     if (stderr.length) throw new Error(stderr);
 
-    //Remove once verified working
-    console.log(stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {

backend/cache/cache.ts

@@ -90,8 +90,6 @@ networkController.createNetwork = async (req, res, next) => {
     const { networkName } = req.body;
     const { stdout, stderr } = await execAsync(`docker network create ${networkName}`);
     if (stderr) throw new Error(stderr);
-    //Remove once verified working
-    // console.log('this is stdout:', stdout);
     res.locals.result = { hash: stdout };
     return next();
   } catch (error) {
@@ -107,12 +105,10 @@ networkController.createNetwork = async (req, res, next) => {
 
 networkController.removeNetwork = async (req, res, next) => {
   try {
-    // console.log('remove container test is coming here')
     const { id } = req.params;
     const { stdout, stderr } = await execAsync(`docker network rm ${id}`);
     if (stderr.length) throw new Error(stderr);
     //Delete once verified
-    // console.log('this is:', stdout);
     res.locals.result = { hash: stdout };
     return next();
   } catch (error) {
@@ -130,8 +126,6 @@ networkController.connectContainerToNetwork = async (req, res, next) => {
     const { networkName, containerName } = req.body;
     const { stdout, stderr } = await execAsync(`docker network connect ${networkName} ${containerName}`);
     if (stderr.length) throw new Error(stderr);
-    // Delete below once verified working
-    // console.log('this is stdout in connectContainerNetworl', stdout);
 
     return next();
   } catch (error) {
@@ -150,8 +144,6 @@ networkController.disconnectContainerFromNetwork = async (req, res, next)=> {
     const { stdout, stderr } = await execAsync(`docker network disconnect ${networkName} ${containerName}`);
     if (stderr.length) throw new Error(stderr);
 
-    // Delete console log when confirmed working
-    // console.log('this is disconnect container network middleware stdout:', stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {
@@ -195,8 +187,6 @@ networkController.prune = async (req, res, next) => {
     const { stdout, stderr } = await execAsync('docker network prune --force');
     if (stderr.length) throw new Error(stderr);
 
-    // Print stdout for now
-    console.log(stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {

backend/controllers/docker/containersController.ts

@@ -20,8 +20,6 @@ systemController.prune = async (req, res, next) => {
     const { stdout, stderr } = await execAsync('docker system prune --force');
     if (stderr.length) throw new Error(stderr);
 
-    // Print stdout for now
-    console.log(stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {

backend/controllers/docker/imagesController.ts

@@ -72,8 +72,6 @@ volumeController.removeVolume = async(req, res, next) => {
     const { stdout, stderr } = await execAsync(`docker volume rm ${id}`);
     if (stderr.length) throw new Error(stderr);
 
-    /**@todo Remove this console log once verified */
-    console.log(stdout);
     return next();
   } catch (error) {
     const errObj: ServerError = {