awsclean 1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+ruby   '>= 2.3'
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    awsclean (1.0)
+      aws-sdk (~> 2.7.4)
+      bundler (~> 1.14)
+      pry
+      thor (~> 0.19.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.7.4)
+      aws-sdk-resources (= 2.7.4)
+    aws-sdk-core (2.7.4)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.7.4)
+      aws-sdk-core (= 2.7.4)
+    aws-sigv4 (1.0.0)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    jmespath (1.3.1)
+    json (2.1.0)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    slop (3.6.0)
+    thor (0.19.4)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awsclean!
+  bundler (~> 1.14)
+  codecov (~> 0.1.10)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-expectations (~> 3.0)
+
+RUBY VERSION
+   ruby 2.3.3p222
+
+BUNDLED WITH
+   1.15.1

data/README.md

@@ -0,0 +1,100 @@
+# Awsclean
+
+[![codecov.io](https://codecov.io/github/riboseinc/awsclean/coverage.svg?branch=master)](https://codecov.io/github/riboseinc/awsclean?branch=master)
+[![Build Status](https://travis-ci.org/riboseinc/awsclean.svg?branch=master)](https://travis-ci.org/riboseinc/awsclean)
+
+CLI to clean up AWS AMIs and ECR images.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'awsclean'
+```
+
+And then execute:
+
+```ruby
+bundle
+```
+
+Or install it yourself as:
+
+```ruby
+gem install awsclean
+```
+
+## Usage
+
+### clean_ecr_images
+
+Locates and deletes stale docker images stored in Amazon ECR.
+
+An ECR image is considered stale when:
+
+1. It was created over `--e` days ago (default: 60).
+2. It's not being used by any ECS active task definition.
+
+#### Listing images eligible for cleanup:
+
+```
+$ awsclean clean_ecr_images
+```
+
+```
+[clean_ecr_images] Checking region: us-east-2
+REGION          IN USE?     REPOSITORY URI                                            TAGS            IMAGE ID                CREATED                                   SIZE        ELEGIBLE FOR CLEANUP?
+us-east-2       true        3333344444.dkr.ecr.us-east-2.amazonaws.com/foobar         baz             sha256:464ea4713d51     2017-04-05T21:00:45+00:00 (100 days ago)  184.0 MB    false
+us-east-2       true        3333344444.dkr.ecr.us-east-2.amazonaws.com/foobar         latest          sha256:464ea4713d51     2017-04-05T21:00:45+00:00 (100 days ago)  184.0 MB    false
+us-east-2       false       3333344444.dkr.ecr.us-east-2.amazonaws.com/foobar_v2      (!TAG)          sha256:f47d0c6acbe9     2017-06-22T22:55:44+00:00 (21 days ago)   136.0 MB    false
+us-east-2       false       3333344444.dkr.ecr.us-east-2.amazonaws.com/foobar_v2      latest          sha256:58e584fd7654     2017-06-23T16:13:22+00:00 (21 days ago)   15.0 MB     false
+```
+
+### clean_amis
+
+Locates and deletes stale Amazon Machine Images (AMI).
+
+An AMI is considered stale when:
+
+1. It was created over `--e` days ago (default: 60).
+2. It's not being used by any EC2 instance.
+
+#### Listing images eligible for cleanup:
+
+```
+$ awsclean clean_amis
+```
+
+The following flags are available to use in both commands:
+
+* `--c`: delete images marked as eligible for cleanup. (default: false)
+* `--e`: images older than `--e` days are considered old. (default: 60)
+* `--r`: select which AWS regions to perform on. (default: all)
+
+The `--r` flag accepts a space separated list of region names.
+
+```
+$ awsclean clean_amis -r us-east-2 ca-central-1
+```
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `rake spec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/awsclean.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awsclean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "awsclean"
+  spec.version       = Awsclean::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = %q{CLI to clean up AWS AMIs and ECR images}
+  spec.description   = %q{CLI to clean up AWS AMIs and ECR images}
+  spec.homepage      = "https://www.ribose.com"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "https://gems.ribose.com"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "awsclean"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.14"
+  spec.add_dependency "thor",    "~> 0.19.4"
+  spec.add_dependency "aws-sdk", "~> 2.7.4"
+  spec.add_dependency "pry"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-expectations", "~> 3.0"
+  spec.add_development_dependency "codecov", "~> 0.1.10"
+end

data/bin/awsclean

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# (c) 2017 Ribose Inc.
+#
+
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# Fixes https://github.com/rubygems/rubygems/issues/1420
+require "rubygems/specification"
+
+class Gem::Specification
+  def this; self; end
+end
+
+# start up the CLI
+require "bundler/setup"
+require "awsclean"
+
+Awsclean::Commands.start(ARGV)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "awsclean"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+#require "irb"
+#IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/awsclean.rb

@@ -0,0 +1,16 @@
+# (c) 2017 Ribose Inc.
+#
+
+require 'thor'
+require 'pry'
+
+module Awsclean
+end
+
+require 'aws-sdk'
+require 'awsclean/aws_extensions'
+
+require 'awsclean/commands'
+require 'awsclean/aws_command'
+require 'awsclean/ami_clean'
+require 'awsclean/ecr_clean'

data/lib/awsclean/ami_clean.rb

@@ -0,0 +1,79 @@
+# (c) 2017 Ribose Inc.
+#
+
+module Awsclean
+  class AmiClean < AwsCommand
+
+    SERVICE_IDENTIFIER = "EC2"
+
+    IMAGE_LIST_HEADER = ['REGION', 'IN USE?', 'AMI ID', 'CREATED', 'ELEGIBLE FOR CLEANUP?']
+    IMAGE_LIST_FORMAT = '%-16s%-12s%-16s%-42s%-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
+
+      regions.each do |region|
+        puts "[clean_amis] checking region: #{region}"
+
+        ec2 = Aws::EC2::Client.new(region: region)
+
+        # Get a list of all AMIs in use.
+        #
+        res = ec2.describe_instances(
+          filters: [{ name: 'instance-state-name', values: %w(running) }],
+          max_results: 1000
+        )
+        instances   = res.reservations.flat_map(&:instances)
+        amis_in_use = instances.map(&:image_id).uniq
+
+        # Get a list of all of AMI's owned by the account.
+        #
+        res = ec2.describe_images(owners: %w(self))
+        images = res.images
+
+        images.each do |image|
+          image.in_use = amis_in_use.include?(image.image_id)
+          image.elegible_for_cleanup = (image.stale?(options[:e]) && !image.in_use)
+        end
+
+        # We always show a list of images
+        #
+        puts build_image_list_header
+        images.each { |image| puts build_image_list_entry(region, image) }
+
+        if options[:c]
+          images.select(&:elegible_for_cleanup).each do |image|
+            puts "[#{region}] Deregistering image: #{image.image_id} #{image.creation_date}"
+            ec2.deregister_image(image_id: image.image_id)
+
+            image.block_device_mappings.each { |bdm|
+              puts "[#{region}] Deregistering image #{image.image_id}: deleting snapshot #{bdm.ebs.snapshot_id}..."
+              ec2.delete_snapshot(snapshot_id: bdm.ebs.snapshot_id)
+            }
+            puts "[#{region}] Deregister image complete: #{image.image_id}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def self.build_image_list_header
+      sprintf(IMAGE_LIST_FORMAT, *IMAGE_LIST_HEADER)
+    end
+
+    def self.build_image_list_entry(region, image)
+      created  = DateTime.parse(image.creation_date).iso8601
+      created << " (#{image.days_since_creation} days ago)"
+
+      sprintf(IMAGE_LIST_FORMAT,
+              region, image.in_use, image.image_id,
+              created, image.elegible_for_cleanup)
+    end
+  end
+end