gitlab-janitor 0.0.3 → 1.0.2.92939

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a74b385cc01ef9b3fcaf380a1186f3f8bb24b278aa496d38cfc859889301bc
-  data.tar.gz: 2488753090d283ed78422395dded9e8935f060285987b032aae9350b3aecb3b4
+  metadata.gz: 754be135680d4f02cc976507e6909cad85fa9610ba686be487517a64ac205b85
+  data.tar.gz: a849dcf8db984238cd90084df0601ada8c16c8e3d1fc012da434d2a754c6fe4d
 SHA512:
-  metadata.gz: 39f830eb28f777462808abea43295d2e7297eed919028661bbfae9d213eb45f2c2e66ed3daea021fb48a790186bb2c678d287b0881c8580f82e5fc203ee650fa
-  data.tar.gz: cdbbeaa361c77f3aeb5deb707000c2ca93e0c0d26381f5c6b2be63c24917e95586b834fa17bcddfe15a80607c736be1961048c18ce75a7606fe306927877e82f
+  metadata.gz: cbf5f383e72d1aeda4fc8426997633035b79db4111d41c5a6afa2743856ad2d0e5d03b14a0d8802a54c42442b740f46facfa641f40bf7129833ae851e6dfd258
+  data.tar.gz: 6fe45e92c6488892fa1838c654c535f394775b844bc7e999eee51248379bec91cdf7c4984eaacb636e309c4a9bdcc1c7bbb6b4779a8ad6afa3679d88607d844a

data/Dockerfile

@@ -11,23 +11,48 @@ RUN mkdir -p /usr/local/etc \
   } >> /usr/local/etc/gemrc \
   && echo 'gem: --no-document' > ~/.gemrc
 
-# RUN set -ex \
-#   && apk add --no-cache build-base git curl
+RUN set -ex \
+  && apk add --no-cache docker-cli
+
 
-ADD Gemfile Gemfile.lock /home/app/
+ADD Gemfile Gemfile.lock gitlab-janitor.gemspec /home/app/
+ADD lib/gitlab_janitor/version.rb /home/app/lib/gitlab_janitor/
 
 RUN set -ex \
   && gem install bundler && gem update bundler \
   && bundle config set --local system 'true' \
+  && bundle config set --local without 'development' \
   && bundle install --jobs=3 \
+  && bundle clean --force \
   && rm -rf /tmp/* /var/tmp/* /usr/src/ruby /root/.gem /usr/local/bundle/cache
 
 ADD . /home/app/
 
 RUN set -ex \
   && bundle install --jobs=3 \
+  && bundle clean --force \
   && rm -rf /tmp/* /var/tmp/* /usr/src/ruby /root/.gem /usr/local/bundle/cache
 
-CMD ["bundle", "exec", "giltab-janitor"]
+ARG \
+  CREATED="2022-08-05 15:22:36+03:00" \
+  VERSION="unknown" \
+  REVISION="unknown" \
+  REFNAME="unknown"
+
+LABEL \
+  org.opencontainers.image.created="${CREATED}" \
+  org.opencontainers.image.authors="Samoylenko Yuri <kinnalru@yandex.ru>" \
+  org.opencontainers.image.url="https://github.com/RND-SOFT/gitlab-janitor" \
+  org.opencontainers.image.documentation="https://github.com/RND-SOFT/gitlab-janitor" \
+  org.opencontainers.image.source="https://github.com/RND-SOFT/gitlab-janitor" \
+  org.opencontainers.image.version="${VERSION}" \
+  org.opencontainers.image.revision="${REVISION}" \
+  org.opencontainers.image.vendor="RNDSOFT" \
+  org.opencontainers.image.licenses="MIT" \
+  org.opencontainers.image.ref.name="${REFNAME}" \
+  org.opencontainers.image.title="GitLab Janitor is a tool to automatically manage stalled and dangling resources when using Docker in Gitlab CI/CD" \
+  org.opencontainers.image.description="GitLab Janitor is a tool to automatically manage stalled and dangling resources when using Docker in Gitlab CI/CD"
+
+CMD ["bundle", "exec", "bin/gitlab-janitor"]
 
 

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 gemspec
 
-
-
-

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    gitlab-janitor (0.0.3)
+    gitlab-janitor (1.0.2.92939)
       activesupport (~> 6.0)
       docker-api
       fugit
       optparse
+      redis
+      tzinfo-data
 
 GEM
   remote: https://rubygems.org/
@@ -37,6 +39,7 @@ GEM
     optparse (0.2.0)
     raabro (1.4.0)
     rake (13.0.6)
+    redis (4.7.1)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -66,6 +69,8 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2022.1)
+      tzinfo (>= 1.0.0)
     unicode-display_width (2.2.0)
     zeitwerk (2.6.0)
 
@@ -83,4 +88,4 @@ DEPENDENCIES
   simplecov-console
 
 BUNDLED WITH
-   2.3.15
+   2.3.11

data/README.md

@@ -1,52 +1,171 @@
 # gitlab-janitor
 
-GitLab Janitor is a tool to automatically manage stalled containers when using Docker.
-
-Commain line options and default valuee:
-
-```bash
-$ ./gitlab-janitor.rb --help
-
-Usage: gitlab-janitor.rb [options] 
-        --clean-delay=30m            Delay between clean operation ENV[CLEAN_DELAY]
-        --include=*units*            <List> Include container for removal. ENV[INCLUDE]
-        --exclude=*gitlab*           <List> Exclude container from removal by name. ENV[EXCLUDE]
-        --container-deadline=1s      Maximum container run duration. ENV[CONTAINER_DEADLINE]
-        --volume-deadline=2d6h       Maximum volume life dudation. ENV[VOLUME_DEADLINE]
-        --image-deadline=20d         Maximum image life duration. ENV[IMAGE_DEADLINE]
-        --remove                     Real remove instead of dry run. ENV[REMOVE]
-        --docker=unix:///var/run/docker.sock
-                                     Docker api endpoint. ENV[DOCKER_HOST]
+<div align="center">
+
+[![Gem Version](https://badge.fury.io/rb/gitlab-janitor.svg)](https://rubygems.org/gems/gitlab-janitor)
+[![Gem](https://img.shields.io/gem/dt/gitlab-janitor.svg)](https://rubygems.org/gems/gitlab-janitor/versions)
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/gitlab-janitor)
+
+[![Docker Pulls](https://badgen.net/docker/pulls/rnds/gitlab-janitor?icon=docker&label=pulls)](https://hub.docker.com/r/rnds/gitlab-janitor/)
+[![Docker Stars](https://badgen.net/docker/stars/rnds/gitlab-janitor?icon=docker&label=stars)](https://hub.docker.com/r/rnds/gitlab-janitor/)
+
+</div>
+
+Gitlab Janitor это утилита для автоматической очистки зависших и брошенных ресурсов при использовании Docker в `Gitlab` CI/CD. Проект вдохновлён утилитой [GitLab Runner Docker Cleanup](https://gitlab.com/gitlab-org/gitlab-runner-docker-cleanup).
+
+---
+
+GitLab Janitor is a tool to automatically manage stalled and dangling resources when using Docker in `Gitlab` CI/CD. Project inpired by [GitLab Runner Docker Cleanup](https://gitlab.com/gitlab-org/gitlab-runner-docker-cleanup).
+
+Возможности / Features
+
+- Удаление повисших контейнеров / Remove dangling containers
+- Удаление неиспользуемых хранилищ / Remove unused anonymous volumes
+- Удаление неиспользуемых образов / Remove unused images
+- Отслеживание вререни использвоания образов / Track image usage timestamp 
+- Очистка кешей Docker (build cache) / Cleanup docker build cache
+- Готовый [docker-образ](https://hub.docker.com/r/rnds/gitlab-janitor) / Production ready [docker image](https://hub.docker.com/r/rnds/gitlab-janitor)
+
+## Установка / Installation
+
+```sh
+$ gem install gitlab-janitor
+```
+
+При установке `Gitlab Janitor` через bundler добавте следующую строку в `Gemfile`, установив `require` параметр в `false`:
+
+---
+
+If you'd rather install `Gitlab Janitor` using bundler, add a line for it in your `Gemfile` (but set the `require` option to `false`, as it is a standalone tool):
+
+```sh
+gem 'rubocop', require: false
+```
+
+Для установки с помощью docker контейнера [скачайте образ](https://hub.docker.com/r/rnds/gitlab-janitor):
+
+---
+
+To install as docker container just [pull the image](https://hub.docker.com/r/rnds/gitlab-janitor):
+
+
+```sh
+docker pull rnds/gitlab-janitor:latest
+```
+
+## Быстрый запуск / Quickstart
+
+Запустите `gitlab-janitor` и смотрите за процессом или запустите docker:
+
+---
+
+Just type `gitlab-janitor` and watch the magic happen or run in docker:
+
+```sh
+docker run --rm -v /var/run/docker.sock:/var/run/docker.sock rnds/gitlab-janitor:latest
 ```
 
+## Документация / Documentation
+
+Параметры командной строки, переменные окружения и занчения по-умолчанию:
+
+Commain line options, environment variables and default values:
+
+```sh
+$ gitlab-janitor --help
+
+Usage: gitlab-janitor [options] 
+        --clean-delay=30m            ENV[CLEAN_DELAY]         Delay between clean operation.
+        --include=*units*            ENV[INCLUDE]             <List> Include container for removal.
+        --exclude=*gitlab*           ENV[EXCLUDE]             <List> Exclude container from removal by name.
+        --container-deadline=1h10m   ENV[CONTAINER_DEADLINE]  Maximum container run duration.
+        --volume-include=runner*cache*
+                                     ENV[VOLUME_INCLUDE]      <List> Include volumes for removal.
+        --volume-deadline=2d6h       ENV[VOLUME_DEADLINE]     Maximum volume life duration.
+        --image-deadline=20d         ENV[IMAGE_DEADLINE]      Maximum image life duration.
+        --image-store=./images.txt   ENV[IMAGE_STORE]         File to store images timestamps.
+        --cache-size=10G             ENV[CACHE_SIZE]          Size of docker cache to keep.
+        --remove                     ENV[REMOVE]              Real remove instead of dry run.
+        --docker=unix:///tmp/mysock  ENV[DOCKER_HOST]         Docker api endpoint.
+        --debug                      ENV[LOG_LEVEL]           Verbose logs. ENV values: debug, info, warn, error
+```
 
-## Удаление зависших контейнеров
+### Удаление зависших контейнеров / Removing stalled containers
 
 Порядок определения контейнреов для удаления:
 
-- `include=*units*` - в список на удаление включаются контейнеры удовлетворябющие шаблону;
-- `exclude=*gitlab*` - из спсика исключаются контейнеры по шаблону;
+- `include=[*units*]` - в список на удаление включаются контейнеры удовлетворябющие шаблону;
+- `exclude=[*gitlab*]` - из спсика исключаются контейнеры по шаблону;
 - `container-deadline=[1h10m]` - результирующий список проверяется на длительность запуска контенйра;
 
-## Удаление ненужных volumes
+---
 
-Порядок определения вольюмов для удалени:
+Containers deleted when:
 
-- на удаление попадают только вольюмы, не являющиеся именованными;
+- `include=[*units*]` - select containers by matching name by pattern;
+- `exclude=[*gitlab*]` - **reject** containers by matching name by pattern;
+- `container-deadline=[1h10m]` - when container lifetime exceeding the deadline it is removed;
+
+### Удаление ненужных volumes / Removing unused volumes
+
+Порядок определения вольюмов для удаления:
+
+- на удаление попадают вольюмы, не являющиеся именованными;
+- `volume-include=[runner*cache*]`- дополнительные волюмы для удаления;
 - `volume-deadline=[2d6h]` - результирующий список проверяется на длительность существования вольюма;
 
-## Удаление образов
+---
+
+Volumes deleted when:
+
+- select all anonymous volumes;
+- `volume-include=[runner*cache*]`- add volumes by matching name by pattern;
+- `volume-deadline=[2d6h]` -  when volume lifetime exceeding the deadline it is removed;
 
-Docker не сохраняет временную метку образа при скачивании (pull), там образом используя средства Docker API невозможно понять как давно образ был скачан и когда его поря удалять. Для решения этой задачи сервис сохраняет информацию о скачанных образах, отслеживая там образом интервалы устаревания.
+### Removing images / Удаление образов
 
-Порядок определения образов для удалени:
+Docker не сохраняет временную метку образа при скачивании (pull), таким образом используя средства `Docker API` невозможно понять как давно образ был скачан и когда его пора удалять. Для решения этой задачи сервис сохраняет информацию о скачанных образах, отслеживая таким образом интервалы устаревания.
 
-- на удаление попадают только образы, не имеющие тэг `latest`;
+Порядок определения образов для удаления:
+
+- При первой встрече нового образа врменная метка сохраняется в локальное хранилище (файл);
+- При достижении лимита хранения образ удаляется;
+- При обнаружении запущенного контейнера временная метка для соответствующего образа обнуляется;
 - `image-deadline=[20d]` - результирующий список проверяется на длительность существования образа;
 
 
-## Пример запуска
+---
+
+Docker don't track timestamp when puling image, so there is impossible track lifetime through `Docker API`. To solve this problem, the service saves information about downloaded images, thus keeping track of lifetime deadline. 
+
+Images deleted when:
+
+- When a new image is first encountered, the timestamp is stored in local storage (file);
+- When a running container is found, the timestamp for the corresponding image is reset to zero;
+- `image-deadline=[20d]` - when lifetime exceeding the deadline image it is removed (`docker rmi <image>`);
+
+## Приеры / Examples
+
+Конфиг для продуктового режима / Production ready config:
+
+```sh
+REMOVE=true INCLUDE="*integr*, *units*" EXCLUDE="*gitlab*" CONTAINER_DEADLINE="1h10m" VOLUME_DEADLINE="3d" IMAGE_DEADLINE="20d" gitlab-janitor
+```
+
+## Запуск в докере / Running in docker
+
+```sh
+docker run --rm \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -e REMOVE=true \
+  -e INCLUDE="*integr*, *units*" \
+  -e EXCLUDE="*gitlab*" \
+  -e CONTAINER_DEADLINE="1h10m" \
+  -e VOLUME_DEADLINE="3d" \
+  -e IMAGE_DEADLINE="20d" \
+  rnds/gitlab-janitor:latest
+```
+
+## Лицензия / License
 
-```bash
-REMOVE=true INCLUDE="*integr*, *units*" EXCLUDE="*gitlab*" CONTAINER_DEADLINE="1h10m" VOLUME_DEADLINE="3d" IMAGE_DEADLINE="20d" ./main.rb
-```
+[MIT](./LICENSE)

data/bin/gitlab-janitor

@@ -1,19 +1,18 @@
 #!/usr/bin/env ruby
 
-#cwd = __dir__
-#$root = "#{cwd}/"
-#$: << $root
+# cwd = __dir__
+# $root = "#{cwd}/"
+# $: << $root
 
-#lib = File.expand_path('lib', __dir__)
-#$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# lib = File.expand_path('lib', __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 
-#require 'rubygems'
-#require 'bundler'
-#require 'bundler/setup'
-#Bundler.require(:default)
+# require 'rubygems'
+# require 'bundler'
+# require 'bundler/setup'
+# Bundler.require(:default)
 
-require 'active_support/all'
 require 'docker-api'
 require 'fugit'
 require 'optparse'
@@ -25,80 +24,129 @@ UTIL = File.basename(__FILE__)
 GitlabJanitor::Util.setup
 
 @opts = {
-  includes:           [ENV.fetch('INCLUDE', '*units*')],
-  excludes:           [ENV.fetch('EXCLUDE', '*gitlab*')],
-  clean_delay:        ENV.fetch('CLEAN_DELAY', '30m'),
+  includes:           [ENV.fetch('INCLUDE', '*units*').split(/[,;]/)].flatten.compact,
+  excludes:           [ENV.fetch('EXCLUDE', '*gitlab*').split(/[,;]/)].flatten.compact,
+  clean_delay:        ENV.fetch('CLEAN_DELAY', '10m'),
   container_deadline: ENV.fetch('CONTAINER_DEADLINE', '1h10m'),
-  volume_deadline:    ENV.fetch('VOLUME_DEADLINE', '2d6h'),
-  image_deadline:     ENV.fetch('IMAGE_DEADLINE', '20d'),
+  volume_includes:    [ENV.fetch('IMAGE_INCLUDE', 'runner*cache*').split(/[,;]/)].flatten.compact,
+  volume_deadline:    ENV.fetch('VOLUME_DEADLINE', '3d'),
+  image_deadline:     ENV.fetch('IMAGE_DEADLINE', '14d'),
+  image_store:        ENV.fetch('IMAGE_STORE', './images.txt'),
+  cache_size:         ENV.fetch('CACHE_SIZE', '10G'),
   remove:             ENV.fetch('REMOVE', 'false').to_bool,
-  docker_host:        ENV.fetch('DOCKER_HOST', 'unix:///var/run/docker.sock')
+  log_level:          ENV.fetch('LOG_LEVEL', ::Logger::INFO),
+  docker_host:        ENV.fetch('DOCKER_HOST', 'unix:///var/run/docker.sock'),
+  redis_url:          ENV.fetch('REDIS_URL', 'redis://127.0.0.1:6379/0')
 }
 
 parser = OptionParser.new do |o|
   o.banner = "Usage: #{UTIL} [options] "
 
-  o.on("--clean-delay=#{@opts[:clean_delay]}", 'Delay between clean operation ENV[CLEAN_DELAY]') do |pattern|
+  o.on("--clean-delay=#{@opts[:clean_delay]}",
+       'ENV[CLEAN_DELAY]'.ljust(25) + 'Delay between clean operation.') do |pattern|
     @opts[:clean_delay] = pattern.strip
   end
 
-  o.on("--include=#{@opts[:includes].join(',')}", '<List> Include container for removal. ENV[INCLUDE]') do |pattern|
+  o.on("--include=#{@opts[:includes].join(',')}",
+       'ENV[INCLUDE]'.ljust(25) + '<List> Include container for removal.') do |pattern|
     @opts[:includes] += pattern.split(/[,;]/)
   end
 
-  o.on("--exclude=#{@opts[:excludes].join(',')}", '<List> Exclude container from removal by name. ENV[EXCLUDE]') do |pattern|
+  o.on("--exclude=#{@opts[:excludes].join(',')}",
+       'ENV[EXCLUDE]'.ljust(25) + '<List> Exclude container from removal by name.') do |pattern|
     @opts[:excludes] += pattern.split(/[,;]/)
   end
 
-  o.on("--container-deadline=#{@opts[:container_deadline]}", 'Maximum container run duration. ENV[CONTAINER_DEADLINE]') do |pattern|
+  o.on("--container-deadline=#{@opts[:container_deadline]}",
+       'ENV[CONTAINER_DEADLINE]'.ljust(25) + 'Maximum container run duration.') do |pattern|
     @opts[:container_deadline] = pattern.strip
   end
 
-  o.on("--volume-deadline=#{@opts[:volume_deadline]}", 'Maximum volume life dudation. ENV[VOLUME_DEADLINE]') do |pattern|
+  o.on("--volume-include=#{@opts[:volume_includes].join(',')}",
+       'ENV[VOLUME_INCLUDE]'.ljust(25) + '<List> Include volumes for removal.') do |pattern|
+    @opts[:volume_includes] += pattern.split(/[,;]/)
+  end
+
+  o.on("--volume-deadline=#{@opts[:volume_deadline]}",
+       'ENV[VOLUME_DEADLINE]'.ljust(25) + 'Maximum volume life duration.') do |pattern|
     @opts[:volume_deadline] = pattern.strip
   end
 
-  o.on("--image-deadline=#{@opts[:image_deadline]}", 'Maximum image life duration. ENV[IMAGE_DEADLINE]') do |pattern|
+  o.on("--image-deadline=#{@opts[:image_deadline]}",
+       'ENV[IMAGE_DEADLINE]'.ljust(25) + 'Maximum image life duration.') do |pattern|
     @opts[:image_deadline] = pattern.strip
   end
 
-  o.on("--remove", 'Real remove instead of dry run. ENV[REMOVE]') do |value|
+  o.on("--image-store=#{@opts[:image_store]}",
+       'ENV[IMAGE_STORE]'.ljust(25) + 'File to store images timestamps.') do |value|
+    @opts[:image_store] = value.strip
+  end
+
+  o.on("--cache-size=#{@opts[:cache_size]}",
+       'ENV[CACHE_SIZE]'.ljust(25) + 'Size of docker cache to keep.') do |value|
+    @opts[:cache_size] = value.strip
+  end
+
+  o.on('--remove', 'ENV[REMOVE]'.ljust(25) + 'Real remove instead of dry run.') do |value|
     @opts[:remove] = value.strip.to_bool
   end
 
-  o.on("--docker=#{@opts[:docker_host]}", 'Docker api endpoint. ENV[DOCKER_HOST]') do |url|
-    @opts[:docker_host] = value.strip
+  o.on("--docker=#{@opts[:docker_host]}", 'ENV[DOCKER_HOST]'.ljust(25) + 'Docker api endpoint.') do |url|
+    @opts[:docker_host] = url.strip
+  end
+
+  o.on("--redis=#{@opts[:redis_url]}", 'ENV[REDIS_URL]'.ljust(25) + 'Redis endpoint.') do |url|
+    @opts[:redis_url] = url.strip
   end
 
+  o.on('--debug', 'ENV[LOG_LEVEL]'.ljust(25) + 'Verbose logs. ENV values: debug, info, warn, error') do
+    @opts[:log_level] = ::Logger::DEBUG
+  end
 end
 parser.parse!
 
 Docker.url = @opts[:docker_host]
 
-GitlabJanitor::Util::logger.debug do
+GitlabJanitor::Util.logger.level = @opts[:log_level]
+
+GitlabJanitor::Util.logger.debug do
   "Config: #{JSON.pretty_generate(@opts)}"
 end
 
 containers = GitlabJanitor::ContainerCleaner.new(
-  delay: Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
   includes: @opts[:includes],
   excludes: @opts[:excludes],
+  delay:    Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
   deadline: Fugit::Duration.parse(@opts[:container_deadline]).to_sec
 )
 
 volumes = GitlabJanitor::VolumeCleaner.new(
-  delay: Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
+  includes: @opts[:volume_includes],
+  delay:    Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
   deadline: Fugit::Duration.parse(@opts[:volume_deadline]).to_sec
 )
 
+images = GitlabJanitor::ImageCleaner.new(
+  image_store: File.expand_path(@opts[:image_store]),
+  redis:       @opts[:redis_url],
+  delay:       Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
+  deadline:    Fugit::Duration.parse(@opts[:image_deadline]).to_sec
+)
+
+cache = GitlabJanitor::CacheCleaner.new(
+  keep_size: @opts[:cache_size],
+  delay:     Fugit::Duration.parse(@opts[:clean_delay]).to_sec,
+  deadline:  Fugit::Duration.parse(@opts[:image_deadline]).to_sec
+)
+
+until GitlabJanitor::Util.exiting?
+  File.write('/tmp/service.pid', Process.pid)
 
-while !$exiting do
   containers.clean(remove: @opts[:remove])
   volumes.clean(remove: @opts[:remove])
+  images.clean(remove: @opts[:remove])
+  cache.clean(remove: @opts[:remove])
 
   sleep 3
 end
 
-
-
-

data/docker-compose.yml

@@ -9,6 +9,10 @@ services:
       context: .
       args:
         RUBY_VERSION: 3.1
+        CREATED:  ${OC_IMAGE_CREATED-2022-08-05 15:22:36+03:00}
+        VERSION:  ${OC_IMAGE_VERSION-unknown}
+        REVISION: ${OC_IMAGE_REVISION-unknown}
+        REFNAME:  ${OC_IMAGE_REFNAME-unknown}
     image: ${SERVICE_IMAGE-rnds/gitlab-janitor}:${SERVICE_TAG-latest}
     working_dir: /home/app
     tmpfs: /tmp

data/gitlab-janitor.gemspec

@@ -2,32 +2,35 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 # Maintain your gem's version:
-require 'gitlab-janitor/version'
+require 'gitlab_janitor/version'
 
 Gem::Specification.new 'gitlab-janitor' do |spec|
-  spec.version       = ENV['BUILDVERSION'].to_i > 0 ? "#{Lusnoc::VERSION}.#{ENV['BUILDVERSION'].to_i}" : GitlabJanitor::VERSION
+  spec.version       = ENV['BUILDVERSION'].to_i > 0 ? "#{GitlabJanitor::VERSION}.#{ENV['BUILDVERSION'].to_i}" : GitlabJanitor::VERSION
   spec.authors       = ['Samoilenko Yuri']
   spec.email         = ['kinnalru@gmail.com']
   spec.description   = spec.summary = 'GitLab Janitor is a tool to automatically manage stalled containers when using Docker.'
   spec.homepage      = 'https://github.com/RnD-Soft/gitlab-janitor'
   spec.license       = 'MIT'
 
-  spec.files         = Dir['bin/**/*', 'lib/**/*', 'Gemfile*', 'LICENSE', 'README.md', 'Dockerfile*', 'docker-compose.yml', '*.gemspec']
+  spec.files         = Dir['bin/**/*', 'lib/**/*', 'Gemfile*', 'LICENSE', 'README.md',
+                           'Dockerfile*', 'docker-compose.yml', '*.gemspec']
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/gitlab-janitor}) {|f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.1'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-console'
-  spec.add_development_dependency 'awesome_print'
 
   spec.add_runtime_dependency 'activesupport', '~> 6.0'
   spec.add_runtime_dependency 'docker-api'
   spec.add_runtime_dependency 'fugit'
+  spec.add_runtime_dependency 'redis'
   spec.add_runtime_dependency 'optparse'
+  spec.add_runtime_dependency 'tzinfo-data'
 end
 

data/lib/gitlab-janitor.rb

@@ -1,5 +1,2 @@
-require_relative 'gitlab-janitor/version'
-require_relative 'gitlab-janitor/utils'
-require_relative 'gitlab-janitor/base-cleaner'
-require_relative 'gitlab-janitor/container-cleaner'
-require_relative 'gitlab-janitor/volume-cleaner'
+require_relative './gitlab_janitor'
+

data/lib/{gitlab-janitor/base-cleaner.rb → gitlab_janitor/base_cleaner.rb}

@@ -2,9 +2,11 @@ module GitlabJanitor
   class BaseCleaner
 
     class Model
+
       attr_reader :model
-      def initialize(m)
-        @model = m
+
+      def initialize(model)
+        @model = model
       end
 
       def method_missing(method, *args, &block)
@@ -20,11 +22,12 @@ module GitlabJanitor
       def respond_to_missing?(method_name, include_private = false)
         model.send(:respond_to_missing?, method_name, include_private) || super
       end
+
     end
 
     attr_reader :delay, :deadline, :logger
 
-    def initialize delay: 10, deadline: 1.second, logger: GitlabJanitor::Util::logger, **args
+    def initialize(delay: 10, deadline: 1.second, logger: GitlabJanitor::Util.logger, **_args)
       @delay = delay
       @deadline = deadline
       @logger = logger.tagged(self.class.to_s)
@@ -36,7 +39,11 @@ module GitlabJanitor
       do_clean(remove: remove)
 
       @cleaned_at = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      return true
+      true
+    end
+
+    def exiting?
+      GitlabJanitor::Util.exiting?
     end
 
     def log_exception(text)
@@ -47,4 +54,5 @@ module GitlabJanitor
     end
 
   end
-end
+end
+

data/lib/gitlab_janitor/cache_cleaner.rb

@@ -0,0 +1,24 @@
+require 'open3'
+
+module GitlabJanitor
+  class CacheCleaner < BaseCleaner
+
+    def initialize(**kwargs)
+      super(**kwargs)
+    end
+
+    def do_clean(keep_size: '10G', remove: false)
+      logger.info 'Removing cache...'
+      if remove
+        out, _status = Open3.capture2e("docker builder prune --keep-storage #{keep_size} -f")
+        logger.info(out)
+      else
+        logger.info 'Skip removal due to dry run'
+      end
+      out, _status = Open3.capture2e('docker system df')
+      logger.info(out)
+    end
+
+  end
+end
+