Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digillect/registry-cleaner
Tool to remove unused images from Docker registries
https://github.com/digillect/registry-cleaner
Last synced: 15 days ago
JSON representation
Tool to remove unused images from Docker registries
- Host: GitHub
- URL: https://github.com/digillect/registry-cleaner
- Owner: Digillect
- License: mit
- Created: 2018-05-23T17:58:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-17T01:56:20.000Z (almost 2 years ago)
- Last Synced: 2024-03-27T02:49:47.448Z (10 months ago)
- Language: Ruby
- Size: 43 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Registry Cleaner
Registry Cleaner is a tool to take care of Docker images that were created
and published as a result of CI/CD process and are not used anymore.
## Documentation
- [How the Registry Cleaner works](docs/algorithm.md)
- [Configuring Registry Cleaner](docs/configuration.md)
- [Kubernetes Scanner details](docs/kubernetes_scanner.md)
## Installation and usage
First of all you have to prepare a configuration file (see
[Configuring Registry Cleaner](docs/configuration.md)) that describes
required registries and scanners. You can put it anywhere in case of using Docker
or you'll need to change an existing one in the `deploy` folder in case of
Kubernetes installation.
### Using Docker
To run the latest version of Registry Cleaner:
```bash
docker run --rm -it \
-v :/app/config.yaml \
-v /.kube/config:/root/kube/config \
digillect/registry-cleaner
```
### Using deployment to Kubernetes Cluster
The Helm chart to deploy Registry Cleaner to Kubernetes cluster can be found in
the `deploy` folder.
To deploy latest version of Registry Cleaner:
```bash
helm upgrade --install registry-cleaner deploy
```
To deploy a specified version of Registry Cleaner:
```bash
helm upgrade --install --set imageTag= registry-cleaner deploy
```
By default Registry Cleaner spawns every night at 2 am. To change cleaning schedule
pass `--set schedule=""` parameter, where `` is a Cron schedule
specification.
#### RBAC
RBAC support is enabled by default and deployment will create all required resources. To disable
RBAC (for old clusters) just add `--set rbac=false` to `helm` command.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details