Skip to content

Commit dda0bae

Browse files
chrisr0892elsong86joeahn95dsterling7AidenCarere
committed
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]>
1 parent 2d07e0b commit dda0bae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+545
-569
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
<li><a href="#contributing">Contributing</a></li>
6666
<li><a href="#license">License</a></li>
6767
<li><a href="#authors">Authors</a></li>
68-
<li><a href="#troubleshooting">Troubleshooting</a></li>
6968
</ol>
7069

7170
<!-- ABOUT THE PROJECT -->
@@ -80,15 +79,17 @@
8079

8180
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!
8281

83-
### What's New in Version 18.0.0?
82+
### What's New in Version 19.0.0?
8483

8584
| Feature | Status |
8685
|---------------------------------------------------------------------------------------------------------------------------------------------|-----------|
87-
| More vulnerability info such as packages name & CVE ID with link. ||
88-
| Data visualization graph for each image. ||
89-
| Users can now `Rescan` to bypass Redis Caching from Version 17.0. ||
90-
| Ability to `Save Scan` and retrieve history scans to compare on a time series graph. ||
91-
| **New updated UI and utilities.** ||
86+
| Image vulnerability scans utilizing Memcached to replace non-open source Redis ||
87+
| Added critical details to vulnerabilities, such as links to all vulnerability types and information on patched package versions ||
88+
| Users can now use the Configuration Page to modify Prometheus target/metric settings, and restart Prometheus container within the app ||
89+
| Users can now save newly modified Prometheus settings to MongoDB database ||
90+
| Loading and error modals added to avoid waiting on potential crashes ||
91+
| Updated color schemes for better readability, and high contrast mode for color-deficient users ||
92+
| Functional network and list reducer tests ||
9293

9394
- ✅ = Ready to use
9495

@@ -127,6 +128,7 @@ Docketeer is an open source initiative comprising contributions from dozens of t
127128
- Docketeer offers the ability to create, delete, and attach containers to networks.
128129
- It's a community-maintained project, with frequent updates and bug fixes.
129130
- Docketeer is licensed under the MIT license, meaning it can be used and modified freely, even for commercial projects.
131+
- Read, modify, and save Prometheus configurations all within the extension
130132

131133
<p align="right">(<a href="#readme-top">back to top</a>)</p>
132134

@@ -164,18 +166,18 @@ Dev & Contributors - See [DevGettingStarted](/docs/DevGettingStarted.md) & Contr
164166

165167
| Feature | Status |
166168
|---------------------------------------------------------------------------------------------------------------------------------------------|-----------|
167-
| More advanced container configuration options within Docketeer. ||
168169
| CI/CD pipeline for Docketeer repo. ||
169170
| Improve test coverage with additional unit tests and integration tests. ||
170171
| Optimize frontend rendering performance with lazy loading to reduce initial bundle size and eliminating redundant re-renders. ||
171172
| Add support for more advanced Docker features, like multi-stage builds or Docker secrets, to expand the capabilities of Docketeer. ||
172173
| Add the ability to control Docker containers deployed in AWS. ||
173174
| Develop aggregation service to collect and cache data from prometheus data sources. ||
174175
| Implement endpoint scraping of any kubernetes cluster running prometheus. ([Read more](/docs/dev/features/Configuration(Alpha).md)) ||
175-
| Work on improving the connect/disconnnect button under networks button in Containers Tab. ||
176+
| Work on improving the connect/disconnect button under networks button in Containers Tab. ||
176177
| Adding additional key metrics to the snapshot functionality. ||
177178
| Setup a error catcher to alert Users of errors that are in the Docker Container Log. ||
178179
| Implement functionality that alerts users when certain metrics reach critical threshold. ||
180+
| Add functionality to load previously saved Prometheus configurations to the current container ||
179181

180182
- ✅ = Ready to use
181183
- ⏳ = In progress
@@ -222,10 +224,11 @@ Read our [contributing guide](https://github.com/open-source-labs/Docketeer/blob
222224
<br />
223225

224226
## <b>Read More</b>
227+
- [Docketeer XIX: New Features in Uncharted Seas](https://medium.com/@ellissong/docketeer-xix-new-features-in-uncharted-seas-3baf72099488)
225228
- [Docketeer XVIII: A Whale of An Improvement](https://medium.com/@docketeerxii/announcing-docketeer-18-0-a-whale-of-an-improvement-67282fbbbe61)
226229
- [Docketeer XVII: Transforming with Security](https://medium.com/@docketeerxii/docketeer-xvii-transforming-with-security-45cd06da061d)
227230
- [Docketeer XVI: The Journey Continues](https://medium.com/@docketeerxii/introducing-docketeer-xvi-the-journey-continues-f34fc5bf7749)
228-
- [Docketeer XV: Naviating the Seas of Docker with Docketeer v15](https://medium.com/@christiandoescoding/navigating-the-seas-of-docker-with-docketeer-v15-0-ad5bd9540d14)
231+
- [Docketeer XV: Navigating the Seas of Docker with Docketeer v15](https://medium.com/@christiandoescoding/navigating-the-seas-of-docker-with-docketeer-v15-0-ad5bd9540d14)
229232
- [Docketeer XIV: Coming Home](https://medium.com/@grantschussler/docketeer-xiv-coming-home-6eb011990a34)
230233
- [Docketeer XIII: A Tool for Docker!](https://medium.com/@michael_kwon_liu/docketeer-a-tool-for-docker-273793014eb0)
231234
- [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!
254257
<br />
255258

256259
## Contributors
260+
- Aiden Carere [@AidenCarere](https://github.com/AidenCarere) | [Linkedin](https://www.linkedin.com/in/aidencarere/)
261+
- Chris Rodriguez [@chrisr0892](https://github.com/chrisr0892) | [Linkedin](https://www.linkedin.com/in/chris-kossky-rodriguez/)
262+
- Dylan Sterling [@dsterling7](https://github.com/dsterling7) | [Linkedin](https://www.linkedin.com/in/dylan-sterling-2b7256180/)
263+
- Ellis Song [@elsong86](https://github.com/elsong86) | [Linkedin](http://www.linkedin.com/in/ellissong)
264+
- Joseph Ahn [@joeahn95](https://github.com/joeahn95) | [Linkedin](https://www.linkedin.com/in/dohyun-joseph-ahn/)
257265
- Quan Nguyen [@ZinWR](https://github.com/ZinWR) | [Linkedin](https://www.linkedin.com/in/quan-nguyen27/)
258266
- Alexander David [@alexjosephdavid](https://github.com/alexjosephdavid) | [Linkedin](https://www.linkedin.com/in/alexander-joseph-david)
259267
- Andy White [@ComfyClicks](https://github.com/ComfyClicks) | [Linkedin](https://www.linkedin.com/in/andywhite5)
Loading
Loading
Loading

backend/cache/cache.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// See https://hub.docker.com/_/memcached for docker image
55
const Memcached = require('memcached');
66

7-
//Connect to the Memcached server
7+
// Connect to the Memcached server
88
const memcachedClient: any = new Memcached('memcached:11211', { retries: 1, retry: 5000 });
99

1010
export default memcachedClient;

backend/controllers/docker/containersController.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,6 @@ containerController.removeContainer = async (req, res, next) => {
178178
const { stdout, stderr } = await execAsync(`docker rm ${id}`);
179179
if (stderr.length) throw new Error(stderr);
180180

181-
// remove once verified
182-
console.log(stdout);
183181
return next();
184182
} catch (error) {
185183
const errObj: ServerError = {
@@ -237,7 +235,7 @@ containerController.getAllLogs = async (req, res, next) => {
237235
}
238236

239237
/**
240-
* @todo finish implementing
238+
* @todo Partially built. Currently not integrated into codebase.
241239
*/
242240
containerController.inspectContainer = async (req, res, next) => {
243241
try {

backend/controllers/docker/imagesController.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,6 @@ imageController.buildContainerFromImage = async (req, res, next) => {
149149
const { stdout, stderr } = await execAsync(`docker run --name ${containerName} ${imageName}:${tag}`);
150150
if (stderr.length) throw new Error(stderr);
151151

152-
//Remove once verified working
153-
console.log(stdout);
154152
return next();
155153
} catch (error) {
156154
const errObj: ServerError = {

backend/controllers/docker/networksController.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,6 @@ networkController.createNetwork = async (req, res, next) => {
9090
const { networkName } = req.body;
9191
const { stdout, stderr } = await execAsync(`docker network create ${networkName}`);
9292
if (stderr) throw new Error(stderr);
93-
//Remove once verified working
94-
// console.log('this is stdout:', stdout);
9593
res.locals.result = { hash: stdout };
9694
return next();
9795
} catch (error) {
@@ -107,12 +105,10 @@ networkController.createNetwork = async (req, res, next) => {
107105

108106
networkController.removeNetwork = async (req, res, next) => {
109107
try {
110-
// console.log('remove container test is coming here')
111108
const { id } = req.params;
112109
const { stdout, stderr } = await execAsync(`docker network rm ${id}`);
113110
if (stderr.length) throw new Error(stderr);
114111
//Delete once verified
115-
// console.log('this is:', stdout);
116112
res.locals.result = { hash: stdout };
117113
return next();
118114
} catch (error) {
@@ -130,8 +126,6 @@ networkController.connectContainerToNetwork = async (req, res, next) => {
130126
const { networkName, containerName } = req.body;
131127
const { stdout, stderr } = await execAsync(`docker network connect ${networkName} ${containerName}`);
132128
if (stderr.length) throw new Error(stderr);
133-
// Delete below once verified working
134-
// console.log('this is stdout in connectContainerNetworl', stdout);
135129

136130
return next();
137131
} catch (error) {
@@ -150,8 +144,6 @@ networkController.disconnectContainerFromNetwork = async (req, res, next)=> {
150144
const { stdout, stderr } = await execAsync(`docker network disconnect ${networkName} ${containerName}`);
151145
if (stderr.length) throw new Error(stderr);
152146

153-
// Delete console log when confirmed working
154-
// console.log('this is disconnect container network middleware stdout:', stdout);
155147
return next();
156148
} catch (error) {
157149
const errObj: ServerError = {
@@ -195,8 +187,6 @@ networkController.prune = async (req, res, next) => {
195187
const { stdout, stderr } = await execAsync('docker network prune --force');
196188
if (stderr.length) throw new Error(stderr);
197189

198-
// Print stdout for now
199-
console.log(stdout);
200190
return next();
201191
} catch (error) {
202192
const errObj: ServerError = {

backend/controllers/docker/systemController.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ systemController.prune = async (req, res, next) => {
2020
const { stdout, stderr } = await execAsync('docker system prune --force');
2121
if (stderr.length) throw new Error(stderr);
2222

23-
// Print stdout for now
24-
console.log(stdout);
2523
return next();
2624
} catch (error) {
2725
const errObj: ServerError = {

backend/controllers/docker/volumesController.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,6 @@ volumeController.removeVolume = async(req, res, next) => {
7272
const { stdout, stderr } = await execAsync(`docker volume rm ${id}`);
7373
if (stderr.length) throw new Error(stderr);
7474

75-
/**@todo Remove this console log once verified */
76-
console.log(stdout);
7775
return next();
7876
} catch (error) {
7977
const errObj: ServerError = {

0 commit comments

Comments
 (0)