awsclean 1.0

data/lib/awsclean/aws_command.rb

@@ -0,0 +1,30 @@
+# (c) 2017 Ribose Inc.
+#
+
+module Awsclean
+  class AwsCommand
+
+    class << self
+
+      def supported_regions
+        Aws.partition('aws').regions
+          .select { |region| region.services.include?(self.const_get(:SERVICE_IDENTIFIER)) }
+          .map(&:name)
+      end
+
+      def filter_regions(regions)
+        supported = supported_regions
+
+        if regions.first == "all"
+          supported_regions
+        else
+          # TODO: throw something if region not available
+          regions.select { |r| supported.include? r }
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/awsclean/aws_extensions.rb

@@ -0,0 +1,66 @@
+require 'aws-sdk'
+
+module Aws
+  module EC2
+    module Types
+      class Image
+
+        attr_accessor :in_use, :elegible_for_cleanup
+
+        def days_since_creation
+          (DateTime.now - DateTime.parse(creation_date)).to_i
+        end
+
+        def stale?(max_age)
+          days_since_creation >= max_age
+        end
+      end
+    end
+  end
+
+  module ECR
+    module Types
+      class ImageDetail
+
+        attr_accessor :region, :in_use, :elegible_for_cleanup
+
+        def days_since_creation
+          (DateTime.now - image_pushed_at.to_datetime).to_i
+        end
+
+        def stale?(max_age)
+          days_since_creation >= max_age
+        end
+
+        def image_uris
+          (image_tags || []).map { |tag| repository_uri << ':' << tag }
+        end
+
+        def repository_uri
+          sprintf('%i.dkr.ecr.%s.amazonaws.com/%s',
+            registry_id, region, repository_name,
+          )
+        end
+      end
+    end
+
+    class Client
+
+      def describe_all_repositories
+        repositories = []
+        next_token   = nil
+
+        loop do
+          res = describe_repositories(next_token: next_token)
+          repositories << res.repositories
+          next_token    = res.next_token
+          break unless next_token
+        end
+
+        Types::DescribeRepositoriesResponse.new(
+          repositories: repositories.flatten
+        )
+      end
+    end
+  end
+end

data/lib/awsclean/commands.rb

@@ -0,0 +1,41 @@
+# (c) 2017 Ribose Inc.
+#
+
+module Awsclean
+  class Commands < Thor
+
+=begin
+-- -l only list out "unused" images with name, AMI ID, size, region, date created (and how many days it has been) and who created
+-- -c to clean up all "unused" containers
+-- -e [days] the number of days considered "unused", default is 60
+-- -l and -c can be used with -e but -l and -c cannot be used together. Default mode is -l.
+-- -r [regions] to specify regions to check, in the form of "us-west-1,us-east-1,..." separated by comma
+=end
+
+    option :l, type: :boolean, default: true #list
+    option :c, type: :boolean
+    option :e, type: :numeric, default: 60
+    option :r, type: :array, default: %w(all)
+
+    # TODO: dynamically generate these based on listing out subclasses of AwsCommand?
+
+    desc 'clean_amis', "Cleanup unused AMI's"
+    def clean_amis
+      puts "[clean_amis] Running AmiClean"
+      AmiClean.run options
+    end
+
+    option :l, type: :boolean, default: true #list
+    option :c, type: :boolean
+    option :e, type: :numeric, default: 60
+    option :r, type: :array, default: %w(all)
+
+    desc 'clean_ecr_images', "Cleanup unused ECR container images"
+    def clean_ecr_images
+      puts "[clean_ecr_images] Running EcrClean"
+      EcrClean.run options
+    end
+
+  end
+end
+

data/lib/awsclean/ecr_clean.rb

@@ -0,0 +1,104 @@
+# (c) 2017 Ribose Inc.
+#
+
+module Awsclean
+  class EcrClean < AwsCommand
+
+    SERVICE_IDENTIFIER = "ECR"
+
+    IMAGE_LIST_HEADER = [
+      'REGION', 'IN USE?', 'REPOSITORY URI', 'TAGS',
+      'IMAGE ID', 'CREATED', 'SIZE', 'ELEGIBLE FOR CLEANUP?'
+    ]
+    IMAGE_LIST_FORMAT = '%-16s%-12s%-64s%-24s%-24s%-42s%-12s%-24s'
+
+    def self.run options
+      regions = filter_regions(options[:r])
+
+      if regions.empty?
+        puts "Please specify region with -r [regions, e.g., 'all' or 'us-west-1 us-east-1']"
+        exit 1
+      end
+
+      # List images used in active task definitions from all regions.
+      # This is a global operation so we run it once.
+      #
+      images_in_active_task_defs = supported_regions.flat_map do |region|
+        ecs = Aws::ECS::Client.new(region: region)
+        res = ecs.list_task_definitions(status: 'ACTIVE', max_results: 100)
+
+        res.task_definition_arns.flat_map do |td|
+          ecs.describe_task_definition(task_definition: td)
+            .task_definition.container_definitions.map(&:image)
+        end
+      end
+
+      regions.each do |region|
+        puts "[clean_ecr_images] Checking region: #{region}"
+
+        ecr = Aws::ECR::Client.new(region: region)
+
+        # List all image repositories
+        #
+        res    = ecr.describe_all_repositories
+        images = res.repositories.flat_map do |repo|
+          ecr.describe_images(repository_name: repo.repository_name)
+            .image_details
+        end
+
+        images.each do |image|
+          image.region = region
+          image.in_use = !(images_in_active_task_defs & image.image_uris).empty?
+          image.elegible_for_cleanup = (image.stale?(options[:e]) && !image.in_use)
+        end
+
+        # We always show a list of images
+        #
+        print_image_list_header
+        images.each { |image| print_image_list_entry(image) }
+
+        if options[:c]
+          images_to_delete =
+            images.select(&:elegible_for_cleanup).group_by(&:repository_name)
+
+          images_to_delete.each do |repository_name, pack|
+            ecr.batch_delete_image(
+              repository_name: repository_name,
+              image_ids: pack.map { |i| { image_digest: i.image_digest } }
+            )
+          end
+        end
+      end
+    end
+
+    private
+
+    def self.print_image_list_header
+      puts sprintf(IMAGE_LIST_FORMAT, *IMAGE_LIST_HEADER)
+    end
+
+    def self.print_image_list_entry(image)
+      created  = image.image_pushed_at.iso8601
+      created << " (#{image.days_since_creation} days ago)"
+
+      size  = (image.image_size_in_bytes / 1024 / 1024).round(2).to_s
+      size << ' MB'
+
+      unless image.image_tags
+        puts sprintf(IMAGE_LIST_FORMAT,
+          image.region, image.in_use,              image.repository_uri,
+          "(!TAG)",     image.image_digest[0,19],  created,
+          size,         image.elegible_for_cleanup
+        )
+      else
+        image.image_tags.each do |tag|
+          puts sprintf(IMAGE_LIST_FORMAT,
+            image.region, image.in_use,              image.repository_uri,
+            tag,          image.image_digest[0,19],  created,
+            size,         image.elegible_for_cleanup
+          )
+        end
+      end
+    end
+  end
+end

data/lib/awsclean/version.rb

@@ -0,0 +1,7 @@
+# (c) 2017 Ribose Inc.
+#
+
+module Awsclean
+  VERSION = "1.0"
+end
+

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: awsclean
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+description: CLI to clean up AWS AMIs and ECR images
+email:
+- open.source@ribose.com
+executables:
+- awsclean
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- awsclean.gemspec
+- bin/awsclean
+- bin/console
+- bin/setup
+- lib/awsclean.rb
+- lib/awsclean/ami_clean.rb
+- lib/awsclean/aws_command.rb
+- lib/awsclean/aws_extensions.rb
+- lib/awsclean/commands.rb
+- lib/awsclean/ecr_clean.rb
+- lib/awsclean/version.rb
+homepage: https://www.ribose.com
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: CLI to clean up AWS AMIs and ECR images
+test_files: []