Skip to content

Latest commit

 

History

History
146 lines (104 loc) · 6.47 KB

README.md

File metadata and controls

146 lines (104 loc) · 6.47 KB

Logo

Dockular

An all in one solution that provides granular control over image pruning and container resource management.
Explore the docs »

Report Bug · Request Feature


Table of Contents
  1. About The Project
  2. Installation
  3. Open Source Information
  4. Enhancement Ideas
  5. Contributing
  6. License
  7. Creators
  8. Contact

The Vision

Dockular is an open source product developed to combat the resource usage challenges of working with Docker. Our application is a docker desktop extension that currently provides two main features; Metrics and Prune.

Metrics provides container CPU/RAM monitoring allowing users to montior individual container CPU and RAM usage. As needed the user can then set hard usage limits for each container.

Prune provides granular Control of image pruning and is accomplished by grouping images into categories such as "Dangling Images", "UnUsed Containers", and "Build Cache". The user can then select as many, or as little, individual images or entire categories to prune at the same time.

Built With

Installation

NOTE: Product is currently in Beta, not all features are complete and bugs are expected.

Download link Here: Dockular.

Or follow the instructions below:

  1. Open the docker desktop application.
  2. Navigate to "Add Extensions" in the left toolbar and click.
  3. Search "Dockular" then click install.

Open Source Information

Feature Status
Pruning Dangling Images
Pruning Unused Images
Pruning Images in use
Pruning Exited Containers
Pruning Running Containers
Pruning Paused Containers
Pruning Build Cache
Scheduled Prune 🙏🏻
CPU Percent Metrics Visualization
RAM Percent Metrics Visualization
Setting RAM Hard Limits for Containers
Setting CPU Limits for Containers 🙏🏻
  • ✅ = Ready to use
  • ⏳ = In progress
  • 🙏🏻 = Looking for contributors

Enhancement Ideas

  • Utilize Go to save pruned images/containers. Grant users the ability to visualize these containers/images within the datagrid by clicking a “Already pruned” button. This will allow the user to check if they accidentally pruned an image/container.
  • When the user’s machine gets overwhelmed by large files saved locally and/or if they forget to prune docker containers, images and build cache for an extended period of time, their machine will experience system issues and the Dockular extension will not operate efficiently. This issue is due to the user reaching the limits to the machine’s storage capacity. Create an alert that warns the user that they are approaching maximum storage capacity. You can accomplish this by comparing the amount of local storage the user’s machine comes with, the amount of storage their local files are taking up, and lastly the amount of storage left available to utilize by Docker.
  • The extension is not re-rendering when the user runs a command on their local machine. By accomplishing this task, the user will have the most up-to-date data on new containers, images, and build cache without having to click in and out of the prune section.
  • Expand pruning capability for Docker Volumes, Logs, and Instances.

Contributing

We are always open to accepting any potential contributions, please feel free to check out our feature table for any ideas for potential features to contribute! Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Meet the Team

Andranik Agamalian

LinkedIn Github

Alex Dawkins

LinkedIn Github

Darren Im

LinkedIn Github

Vishal Vivekanandan

LinkedIn Github

Contact

LinkedIn