Skip to content

Latest commit

 

History

History
420 lines (351 loc) · 28.8 KB

README.md

File metadata and controls

420 lines (351 loc) · 28.8 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo
https://docketeer.io/

Docketeer is a developer-friendly application that provides a single interface for container and network management as well as metric visualization.
Explore the code & contribute here!»
See the extension version's code here!»

Report Bug · Request Feature


Table of Contents

  1. About Docketeer
  2. Installation
  3. In Development
  4. Documentation
  5. Contributing
  6. License
  7. Authors

About The Project

DockerTypescriptJavaScriptReactReduxRTKNodeExpressRedisMongoDBPostgresGrafanaPrometheusJestViteHTML5CSS3SASSD3MUIGit

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 19.0.0?

Feature Status
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 ✅
Consistent styles between pages for upgraded user experience ✅
Functional network and list reducer tests ✅
  • ✅ = Ready to use

Container Page:

Containers Page

Image Page:

Image Page

Image Page - Visualization:

Image Page - Visualizatio

Image Page - Time Series:

Image Page - Time Series

Image Page High Contrast:

High Contrast

Container Metrics Page:

Container Metrics Page

Configuration Page:

Configuration Page

Kubernetes Page (In Development):

Kubernates Metrics Page

Volume Page:

Volume Page

Other Tab Demo:

Others gif

Spooler:

Spooler

(back to top)

Features:

  • Docketeer is a Docker developer tool that's available as an open-source project on GitHub or as an extension on Docker Desktop.
  • It aims to simplify the development process for projects that use Docker containers.
  • Visualize and compare previously saved health metric snapshots to offer users a comprehensive understanding of historical performance.
  • Allows you to filter through both your running and stopped container logs.
  • Provides image vulnerability data for each image for enhanced understanding of the security of used images
  • Docketeer provides an easy-to-use GUI for managing Docker containers, images, and networks.
  • With Docketeer, developers can quickly start, stop, and delete containers, as well as manage run Docker images.
  • 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

(back to top)

Installation

Open your Docker Desktop and search Docketeer and install the extension!

Dev & Contributors - See DevGettingStarted & Contributing section below!


Notes: If you encounter any <dependency/package> not found by vite:

  • Turn off the server such as
# Example: stop Browser Dev environment
  make browser-down

  • Delete everything Docketeer related - images, volumes, containers (should be deleted when you "make browser-down")

  • Run Docker compose without cache using this Makefile command:

# Example: To build without cached image layers
  make browser-new

In Development

Feature Status
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) ⏳
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

See the Known Issues Docs for a list of known issues.

(back to top)

Documentation

For more details, please read the docs folder, which covers the following:

  • API
  • Assets
  • Changelogs (V1-V18)
  • Features
    • Configuration.md
    • Models.md
  • DevGettingStarted.md
  • DevWorkingWithGrafana.md
  • KnownIssues.md

When you are ready to launch, make sure to follow the instructions under Makefile.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also simply open an issue describing your contribution. Don't forget to give the project a star! Thanks again!

  1. Fork the project and clone onto your local machine
  2. Create your Feature Branch (git checkout -b feature/NewFeatureName)
  3. Commit your Changes (git commit -m '(feature/bugfix/style/etc.): [commit message here]')
  4. Push to the Branch (git push origin feature/NewFeatureName)
  5. Open a Pull Request
  6. Create an issue on GitHub (as mentioned above!)

Read our contributing guide for more information on how to purpose bugfixes and improvements to Docketeer.

Need ideas for improvement? Check our known issues for possible improvements / fixes!


Read More


License

Distributed under the MIT License. See License for more information.

(back to top)

Show Your Support

Please ⭐️ this project if you found it helpful, thank you!

Contributors

(back to top)