docker-cleaner 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '015757094769f89ae1df19627fe0157b3e874e67a153a5482e9b34399f4a1ddf'
-  data.tar.gz: c65353e36a434ee17eb8152f1bba8977a25aef48c974ddf5471b7e6244b0d9ed
+  metadata.gz: 9245c57a0622e847a3c14b3bbcf81d98db2c0a538729da29cbfef0ca21f6a4c3
+  data.tar.gz: cabe356f1d6fe998b4d0000b80d4cbd90f1d0e7d7e8e04ccd17776a4718320d8
 SHA512:
-  metadata.gz: a156b7096e1ff001f8f60047794411cfb45bb3647046ae835c8ee0c08bf1fcc7ea8b379731f2fc91f93c8db7a48004d8273d3589a1ce90769fd30b645b4e1ad6
-  data.tar.gz: a7727a5bd7a06b9b135d7ded6ca3bd40af7d1d35502c9ce0d19c0136169c098476c78975b6b23d36f52280570405b585567b8d7d9cef644af9d0001f8a909c81
+  metadata.gz: 64c3d9a8953e7718b4bebd0050aef32510e955494d1945c0bda06c0a4b8a60065f38b14bae8b8eb4b309343815b7ffceaddeba653a34dd9f23592f535830d146
+  data.tar.gz: b7050f77ed5bd4880c4ecc83c2eaaaa20b7dcd8f7098927e8c12146adac5c6d75d06f7a125d99712eea8166fb9877ea011981431c2b711f8de1dfdb50e675a3c

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    allow:
+      - dependency-type: "all"
+    versioning-strategy: lockfile-only
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "leo-scalingo"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "leo-scalingo"

data/.github/workflows/dependabot.yml

@@ -0,0 +1,17 @@
+name: Dependabot auto-approve
+on: pull_request
+
+permissions:
+  # Mandatory for both the auto-merge enabling and approval steps
+  pull-requests: write
+  # Mandatory for the auto-merge enabling step
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Automatically merge Dependabot PRs
+        uses: scalingo/ghaction-dependabot-automerge@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -1,2 +1,6 @@
 /.bundle
 /binstubs
+
+# IDE
+.idea/
+.vscode/

data/.sclng/metadata.toml

@@ -0,0 +1,7 @@
+dependencies = []
+description = "Small ruby script to remove old containers and old images"
+flags = ["deployed-by-chef"]
+languages = ["ruby"]
+owner = "leo@scalingo.com"
+team = "IST"
+version = "1.1.0"

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'docker-api', '~> 1.18'
+gem 'docker-api'
+
+# For compat with ruby 2.7
+gem 'multi_json', '1.15'
+
 gem 'docker-cleaner', path: "."

data/Gemfile.lock

@@ -1,24 +1,27 @@
 PATH
   remote: .
   specs:
-    docker-cleaner (0.3.0)
-      docker-api (~> 1.0)
+    docker-cleaner (0.7.0)
+      docker-api (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docker-api (1.34.2)
-      excon (>= 0.47.0)
+    docker-api (2.4.0)
+      excon (>= 0.64.0)
       multi_json
-    excon (0.72.0)
-    multi_json (1.14.1)
+    excon (1.3.0)
+      logger
+    logger (1.7.0)
+    multi_json (1.15.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  docker-api (~> 1.18)
+  docker-api
   docker-cleaner!
+  multi_json (= 1.15)
 
 BUNDLED WITH
-   1.17.2
+   2.2.17

data/README.md

@@ -0,0 +1,34 @@
+# Docker Cleaner v0.6.0
+
+Small ruby script to remove old containers and old images.
+
+For containers, this removes containers that have been stopped for more than 2 hours.
+For images, this removes unused and untagged images.
+
+## Release a New Version
+
+Bump new version number in:
+- README.md
+- lib/docker_cleaner/version.rb
+- Gemfile.lock (docker-cleaner specs entry)
+
+Commit, tag and create a new release:
+```shell
+version="0.6.0"
+
+git switch --create release/${version}
+git add Gemfile.lock README.md lib/docker_cleaner/version.rb
+git commit -m "release: Bump v${version}"
+git push --set-upstream origin release/${version}
+gh pr create --reviewer=EtienneM --title "$(git log -1 --pretty=%B)"
+```
+
+Once the pull request merged, you can tag the new release.
+
+```shell
+git tag v${version}
+git push origin master v${version}
+gh release create v${version}
+```
+
+The title of the release should be the version number.

data/docker-cleaner.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.description = "Small utility to clean old docker data, containers according to some settings"
   s.license     = "MIT"
 
-  s.add_dependency "docker-api", "~> 1.0"
+  s.add_dependency "docker-api", "~> 2.0"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }

data/lib/docker_cleaner/containers.rb

@@ -1,46 +1,46 @@
 module DockerCleaner
-class Containers
-  def initialize(logger, opts = {})
-    @logger = logger
-    @delay = opts.fetch(:delay, 0)
-  end
-
-  def remove(container)
-    @logger.info "Remove #{container.id[0...10]} - #{container.info["Image"]} - #{container.info["Names"][0]}"
-    container.remove v: true
-    @logger.info "Remove #{container.id[0...10]} - #{container.info["Image"]} - #{container.info["Names"][0]}... OK"
-  end
+  class Containers
+    def initialize(logger, opts = {})
+      @logger = logger
+      @delay = opts.fetch(:delay, 0)
+    end
 
-  def run
-    # Remove stopped container which stopped with code '0'
-    two_hours_ago = Time.now.to_i - 2 * 3600
-    Docker::Container.all(all: true).select{ |container|
-      status = container.info["Status"]
-      (status == "Created" && container.info["Created"].to_i < two_hours_ago) ||
-        (status.include?("Exited (") && container.info["Created"].to_i < two_hours_ago)
-    }.each do |container|
-      remove(container)
-      sleep(@delay)
+    def remove(container)
+      @logger.info "Remove #{container.id[0...10]} - #{container.info["Image"]} - #{container.info["Names"][0]}"
+      container.remove v: true
+      @logger.info "Remove #{container.id[0...10]} - #{container.info["Image"]} - #{container.info["Names"][0]}... OK"
     end
 
-    containers_per_app = {}
-    Docker::Container.all(all: true).select{ |container|
-      container.info["Status"].include?("Exited")
-    }.each{ |container|
-      app = container.info["Image"].split(":", 2)[0]
-      if containers_per_app[app].nil?
-        containers_per_app[app] = [container]
-      else
-        containers_per_app[app] << container
-      end
-    }
-    containers_per_app.each do |app, containers|
-      containers.shift
-      containers.each do |container|
+    def run
+      # Remove stopped container which stopped with code '0'
+      two_hours_ago = Time.now.to_i - 2 * 3600
+      Docker::Container.all(all: true).select{ |container|
+        status = container.info["Status"]
+        (status == "Created" && container.info["Created"].to_i < two_hours_ago) ||
+          (status.include?("Exited (") && container.info["Created"].to_i < two_hours_ago)
+      }.each do |container|
         remove(container)
         sleep(@delay)
       end
+
+      containers_per_app = {}
+      Docker::Container.all(all: true).select{ |container|
+        container.info["Status"].include?("Exited")
+      }.each{ |container|
+        app = container.info["Image"].split(":", 2)[0]
+        if containers_per_app[app].nil?
+          containers_per_app[app] = [container]
+        else
+          containers_per_app[app] << container
+        end
+      }
+      containers_per_app.each do |app, containers|
+        containers.shift
+        containers.each do |container|
+          remove(container)
+          sleep(@delay)
+        end
+      end
     end
   end
 end
-end

data/lib/docker_cleaner/images.rb

@@ -1,117 +1,117 @@
 module DockerCleaner
-class Images
-  def initialize registries, prefix, logger, opts = {}
-    @prefix = prefix || ""
-    @registries = registries
-    @logger = logger
-    @delay = opts.fetch(:delay, 0)
-    @retention = Time.now.to_i - opts.fetch(:retention, 6) * 3600
-  end
+  class Images
+    def initialize(registries, prefix, logger, opts = {})
+      @prefix = prefix || ""
+      @registries = registries
+      @logger = logger
+      @delay = opts.fetch(:delay, 0)
+      @retention = Time.now.to_i - opts.fetch(:retention, 6) * 3600
+    end
 
-  def run
-    clean_old_images
-    clean_unnamed_images
-    clean_unused_images
-  end
+    def run
+      clean_old_images
+      clean_unnamed_images
+      clean_unused_images
+    end
 
-  def clean_unnamed_images
-    Docker::Image.all.select do |image|
-      image.info["RepoTags"].nil? || image.info["RepoTags"][0] == "<none>:<none>"
-    end.each do |image|
-      @logger.info "Remove unnamed image #{image.id[0...10]}"
-      begin
-        image.remove
-        sleep(@delay)
-      rescue Docker::Error::NotFoundError
-      rescue Docker::Error::ConflictError => e
-        @logger.warn "Conflict when removing #{image.id[0...10]}"
-        @logger.warn " !     #{e.message}"
+    def clean_unnamed_images
+      Docker::Image.all.select do |image|
+        image.info["RepoTags"].nil? || image.info["RepoTags"][0] == "<none>:<none>"
+      end.each do |image|
+        @logger.info "Remove unnamed image #{image.id[0...10]}"
+        begin
+          image.remove
+          sleep(@delay)
+        rescue Docker::Error::NotFoundError
+        rescue Docker::Error::ConflictError => e
+          @logger.warn "Conflict when removing #{image.id[0...10]}"
+          @logger.warn " !     #{e.message}"
+        end
       end
     end
-  end
 
-  def clean_old_images
-    apps = images_with_latest
-    apps.each do |app, images|
-      if app =~ /.*-tmax$/
-        next
-      end
-      images.each do |i|
-        unless i.info["Created"] == apps["#{app}-tmax"]
-          @logger.info "Remove #{i.info['RepoTags'][0]} => #{i.id[0...10]}"
-          begin
-            i.remove
-            sleep(@delay)
-          rescue Docker::Error::NotFoundError
-          rescue Docker::Error::ConflictError => e
-            @logger.warn "Conflict when removing #{i.info['RepoTags'][0]} - ID: #{i.id[0...10]}"
-            @logger.warn " !     #{e.message}"
+    def clean_old_images
+      apps = images_with_latest
+      apps.each do |app, images|
+        if app =~ /.*-tmax$/
+          next
+        end
+        images.each do |i|
+          unless i.info["Created"] == apps["#{app}-tmax"]
+            @logger.info "Remove #{i.info['RepoTags'][0]} => #{i.id[0...10]}"
+            begin
+              i.remove
+              sleep(@delay)
+            rescue Docker::Error::NotFoundError
+            rescue Docker::Error::ConflictError => e
+              @logger.warn "Conflict when removing #{i.info['RepoTags'][0]} - ID: #{i.id[0...10]}"
+              @logger.warn " !     #{e.message}"
+            end
           end
         end
       end
     end
-  end
 
-  def images_with_latest
-    images ||= Docker::Image.all
-    apps = {}
+    def images_with_latest
+      images ||= Docker::Image.all
+      apps = {}
 
-    images.each do |i|
-      # RepoTags can be nil sometimes, in this case we ignore the image
-      next if i.info["RepoTags"].nil?
-      if registries_include?(i.info["RepoTags"][0])
-        name = i.info["RepoTags"][0].split(":")[0]
-        tmax = "#{name}-tmax"
+      images.each do |i|
+        # RepoTags can be nil sometimes, in this case we ignore the image
+        next if i.info["RepoTags"].nil?
+        if registries_include?(i.info["RepoTags"][0])
+          name = i.info["RepoTags"][0].split(":")[0]
+          tmax = "#{name}-tmax"
 
-        if apps[name].nil?
-          apps[name] = [i]
-        else
-          apps[name] << i
-        end
+          if apps[name].nil?
+            apps[name] = [i]
+          else
+            apps[name] << i
+          end
 
-        if apps[tmax].nil?
-          apps[tmax] = i.info["Created"]
-        elsif apps[tmax] < i.info["Created"]
-          apps[tmax] = i.info["Created"]
+          if apps[tmax].nil?
+            apps[tmax] = i.info["Created"]
+          elsif apps[tmax] < i.info["Created"]
+            apps[tmax] = i.info["Created"]
+          end
         end
       end
+      apps
     end
-    apps
-  end
 
-  def clean_unused_images
-    used_images = Docker::Container.all.map{|c| c.info["Image"]}.select{|i| registries_include?(i) }.uniq
-    # Images older than 2 months
-    images = Docker::Image.all.select{|i| i.info["RepoTags"] && registries_include?(i.info["RepoTags"][0]) && i.info["Created"] < @retention }
-    image_repos = images.map{|i| i.info["RepoTags"][0]}
-    unused_images = image_repos - used_images
+    def clean_unused_images
+      used_images = Docker::Container.all.map{|c| c.info["Image"]}.select{|i| registries_include?(i) }.uniq
+      # Images older than 2 months
+      images = Docker::Image.all.select{|i| i.info["RepoTags"] && registries_include?(i.info["RepoTags"][0]) && i.info["Created"] < @retention }
+      image_repos = images.map{|i| i.info["RepoTags"][0]}
+      unused_images = image_repos - used_images
 
-    unused_images.each do |i|
-      image = images.select{|docker_image| docker_image.info["RepoTags"][0] == i}[0]
-      @logger.info "Remove unused image #{image.info['RepoTags'][0]} => #{image.id[0...10]}"
-      begin
-        image.remove
-        sleep(@delay)
-      rescue Docker::Error::NotFoundError
-      rescue Docker::Error::ConflictError => e
-        @logger.warn "Conflict when removing #{image.info['RepoTags'][0]} - ID: #{image.id[0...10]}"
-        @logger.warn " !     #{e.message}"
+      unused_images.each do |i|
+        image = images.select{|docker_image| docker_image.info["RepoTags"][0] == i}[0]
+        @logger.info "Remove unused image #{image.info['RepoTags'][0]} => #{image.id[0...10]}"
+        begin
+          image.remove
+          sleep(@delay)
+        rescue Docker::Error::NotFoundError
+        rescue Docker::Error::ConflictError => e
+          @logger.warn "Conflict when removing #{image.info['RepoTags'][0]} - ID: #{image.id[0...10]}"
+          @logger.warn " !     #{e.message}"
+        end
       end
     end
-  end
 
-  protected
+    protected
 
-  def registries_include?(image)
-    if image.nil? || image == ''
-      return false
-    end
-    @registries.each do |registry|
-      if image =~ /^#{registry}\/#{@prefix}/
-        return true
+    def registries_include?(image)
+      if image.nil? || image == ''
+        return false
+      end
+      @registries.each do |registry|
+        if image =~ /^#{registry}\/#{@prefix}/
+          return true
+        end
       end
+      return false
     end
-    return false
   end
 end
-end

data/lib/docker_cleaner/version.rb

@@ -1,3 +1,3 @@
 module DockerCleaner
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Leo Unbekandt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2025-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: Small utility to clean old docker data, containers according to some
   settings
 email:
@@ -33,9 +33,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/dependabot.yml"
 - ".gitignore"
+- ".sclng/metadata.toml"
 - Gemfile
 - Gemfile.lock
+- README.md
 - bin/docker-cleaner
 - docker-cleaner.gemspec
 - lib/docker_cleaner.rb
@@ -46,7 +50,7 @@ homepage: https://github.com/Scalingo/docker-cleaner
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Small utility to clean old containers and images
 test_files: []