docker-cleaner 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03ac980101dedfb38b309cc3464a839141a54361
+  data.tar.gz: 8accceff7c76e77e357d1cfd81bd0e6ded224789
+SHA512:
+  metadata.gz: 15d8c9d9469c5a62ad7931f1a9665270ac607d50b1223c33da84954f0e1674842391010b5b8442dd3afab0e3a5ef1288f0676a85b6ba9481f86af69668fabdd1
+  data.tar.gz: ecaa894f663a25bee97164aaff6b1f6b49edfcc3c372b7cc37146362b6ef44cb455a5bce50de280bcff0c1a99abc1813bd7675310e69d49f8e0d0eb2ae373f2e

data/.gitignore

@@ -0,0 +1,2 @@
+/.bundle
+/binstubs

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'docker-api', '~> 1.18'
+gem 'docker-cleaner', path: "."

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    docker-cleaner (0.1)
+      docker-api (~> 1.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docker-api (1.21.4)
+      excon (>= 0.38.0)
+      json
+    excon (0.45.3)
+    json (1.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  docker-api (~> 1.18)
+  docker-cleaner!
+
+BUNDLED WITH
+   1.12.5

data/bin/docker-cleaner

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+
+path = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+$LOAD_PATH << path
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require :default
+require 'docker'
+
+require 'optparse'
+require 'logger'
+
+STOP_DOCKER_CLEANER_FILE = '/tmp/stop-docker-cleaner'.freeze
+
+options = {}
+options[:registry] = ENV["REGISTRY"]
+options[:prefix] = ENV["PREFIX"]
+options[:log] = ENV["LOG_FILE"]
+options[:docker] = ENV["DOCKER_HOST"]
+options[:delete_delay] = ENV["DELETE_DELAY"]
+options[:registries] = ENV["REGISTRIES"] || options[:registry]
+options[:retention] = ENV["RETENTION"]
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: docker_clean [options]"
+
+  opts.on("--delete-delay=DELAY", "Delay in seconds between container/image deletion") do |r|
+    options[:delete_delay] = r
+  end
+  opts.on("-pPREFIX", "--prefix=PREFIX", "Prefix of images your want to clean") do |r|
+    options[:prefix] = r
+  end
+  opts.on("-rREGISTRY", "--registry=REGISTRY", "Registry") do |r|
+    options[:registries] = r
+  end
+  opts.on("--registries=REGISTRIES", "Registries") do |r|
+    options[:registries] = r
+  end
+  opts.on("-lLOG", "--log=LOG", "Log file") do |r|
+    options[:log] = r
+  end
+  opts.on("-dDOCKER", "--docker=DOCKER", "Docker endpoint") do |r|
+    options[:docker] = r
+  end
+  opts.on("--retention=RETENTION", "How long images should be kept before deletion (in hours)") do |r|
+    options[:retention] = r
+  end
+
+  opts.on("--force", "Force the clean even if the #{STOP_DOCKER_CLEANER_FILE} file is present") do |r|
+    options[:force] = true
+  end
+end.parse!
+
+logger = Logger.new options[:log] || $stdout
+
+if options[:registries].nil?
+  $stderr.puts "--registries option should be filled"
+  exit -1
+end
+
+options[:registries] = options[:registries].split(",").map(&:chomp)
+
+options[:retention]  = options[:retention].to_i
+options[:retention]  = 6 if options[:retention] == 0
+
+Docker.url = options[:docker] || "http://localhost:4243"
+Docker.options = { read_timeout: 300, write_timeout: 300 }
+
+if File.file? STOP_DOCKER_CLEANER_FILE
+  logger.info 'Stop docker cleaner file is present'
+
+  if !options[:force]
+    logger.info 'Aborting'
+    exit 0
+  else
+    logger.info 'Force flag is present, continuing...'
+  end
+end
+
+require 'docker_cleaner'
+
+DockerCleaner.run(
+  options[:registries], options[:prefix], logger,
+  delay: options[:delete_delay].to_i,
+  retention: options[:retention],
+)

data/docker-cleaner.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/docker_cleaner/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "docker-cleaner"
+  s.version     = DockerCleaner::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Leo Unbekandt"]
+  s.email       = ["leo@scalingo.com"]
+  s.homepage    = "https://github.com/Scalingo/docker-cleaner"
+  s.summary     = "Small utility to clean old containers and images"
+  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.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path = 'lib'
+end
+

data/lib/docker_cleaner.rb

@@ -0,0 +1,9 @@
+require 'docker_cleaner/containers'
+require 'docker_cleaner/images'
+
+module DockerCleaner
+  def self.run(registries, prefix, logger, opts)
+    DockerCleaner::Containers.new(logger, opts).run
+    DockerCleaner::Images.new(registries, prefix, logger, opts).run
+  end
+end

data/lib/docker_cleaner/containers.rb

@@ -0,0 +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
+
+  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

data/lib/docker_cleaner/images.rb

@@ -0,0 +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
+
+  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}"
+      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}"
+          end
+        end
+      end
+    end
+  end
+
+  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"
+
+        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"]
+        end
+      end
+    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
+
+    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
+
+  protected
+
+  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
+end
+end

data/lib/docker_cleaner/version.rb

@@ -0,0 +1,3 @@
+module DockerCleaner
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: docker-cleaner
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Leo Unbekandt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Small utility to clean old docker data, containers according to some
+  settings
+email:
+- leo@scalingo.com
+executables:
+- docker-cleaner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- bin/docker-cleaner
+- docker-cleaner.gemspec
+- lib/docker_cleaner.rb
+- lib/docker_cleaner/containers.rb
+- lib/docker_cleaner/images.rb
+- lib/docker_cleaner/version.rb
+homepage: https://github.com/Scalingo/docker-cleaner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Small utility to clean old containers and images
+test_files: []