aws_ami_cleanup 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db5bf4d59de51127ee6dab8a547cce124a734dd1c628096e59509ea21dd572d4
+  data.tar.gz: 5a6aa3840422b64a71be65ce11ac2a290e4e46a2e5f8730865537ce8676c3368
+SHA512:
+  metadata.gz: 8f6000074b50a25f566478022a78a341b676a0fa10eb8cc7945043889035bf5b0b080bac0eede9748ce1886db13c0f92745f0fe2f0abe254acc2a80d93f95f16
+  data.tar.gz: 212429abd100adba8cf1be8cbda5a322237a5114ffba2114b3266bce54e1be56d5f1a1dad184f1d2a5245b9713f039063ab2c33f6359a3d506f1d0b3769fadf3

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.byebug_history
+Gemfile.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+aws_ami_cleanup

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.6

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,20 @@
+# AWS AMI Cleanup
+
+This gem provides the `cleanup_amis` script that allows deregistering unused AMIs. The IAM user running the command must have at the very least the following permissions:
+
+- ec2:DescribeImages
+- ec2:DescribeLaunchTemplateVersions
+- ec2:DescribeInstances
+- ec2:DeregisterImage
+- ec2:DeleteSnapshot
+- autoscaling:DescribeAutoScalingGroups
+
+Script should be invoked as follows:
+
+```
+cleanup_amis clean_amis --ami_name 'my-ami' --ami_owner 'self'
+```
+
+Where `ami_owner` can be a combination of AWS account IDs, `self`, `amazon`, and `aws-marketplace`.
+
+Additionally you can provide the `number_of_amis_to_keep` argument to specify how many AMIs to keep (default is 3) and `region` for the AWS region (default is `us-east-1`).

data/aws_ami_cleanup.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "aws_ami_cleanup/version"
+
+Gem::Specification.new do |s|
+  s.name = "aws_ami_cleanup".freeze
+  s.version = AwsAmiCleanup::VERSION
+
+  s.authors = ["Diego Marcet"]
+  s.date = "2021-02-19"
+  s.summary = "Script for deleting obsolete AMIs"
+  s.email = "diego@controlshiftlabs.com"
+  s.executables = ["cleanup_amis"].freeze
+  s.require_paths = ["lib"]
+  s.homepage = "http://github.com/controlshift/aws_ami_cleanup"
+  s.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.add_runtime_dependency "aws-sdk-ec2", "~> 1"
+  s.add_runtime_dependency "aws-sdk-autoscaling", "~> 1"
+  s.add_runtime_dependency "thor", "~> 1"
+  s.add_development_dependency("byebug", "~> 11")
+end

data/bin/cleanup_amis

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../../lib", __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_ami_cleanup'
+
+AwsAmiCleanup::Commands.start(ARGV)

data/lib/aws_ami_cleanup.rb

@@ -0,0 +1,7 @@
+require 'thor'
+
+module AwsAmiCleanup
+end
+
+require 'aws_ami_cleanup/cleanup_amis'
+require 'aws_ami_cleanup/commands'

data/lib/aws_ami_cleanup/cleanup_amis.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-ec2'
+require 'aws-sdk-autoscaling'
+
+module AwsAmiCleanup
+  class CleanupAmis
+    DEFAULT_NUMBER_OF_AMIS_TO_KEEP = 3
+
+    attr_accessor :region, :number_of_amis_to_keep
+
+    def initialize(region, number_of_amis_to_keep)
+      @region = region
+
+      @number_of_amis_to_keep = number_of_amis_to_keep || DEFAULT_NUMBER_OF_AMIS_TO_KEEP
+      if number_of_amis_to_keep <= 0
+        raise 'Number of AMIs to keep must be higher than 0.'
+      end
+    end
+
+    def execute!(ami_name:, ami_owner:)
+      potential_amis_to_remove = amis(ami_name, ami_owner)
+      ami_ids = potential_amis_to_remove.collect(&:image_id)
+      ami_ids_to_remove = ami_ids - amis_in_use
+      potential_amis_to_remove.keep_if {|a| ami_ids_to_remove.include?(a.image_id) }
+
+      if potential_amis_to_remove.count > number_of_amis_to_keep
+        amis_to_remove = potential_amis_to_remove[number_of_amis_to_keep..-1]
+        amis_to_keep = potential_amis_to_remove[0..(number_of_amis_to_keep-1)]
+
+        puts "Deregistering old AMIs..."
+        amis_to_remove.each do |ami|
+          ebs_mappings = ami.block_device_mappings
+          puts "Deregistering #{ami.image_id}"
+          ami.deregister
+          delete_ami_snapshots(ebs_mappings)
+        end
+
+        puts "Currently active AMIs..."
+        amis_to_keep.each do |ami|
+          puts ami.image_id
+        end
+      else
+        puts "no AMIs to clean."
+      end
+    end
+
+    protected
+
+    def ec2
+      @__ec2 ||= Aws::EC2::Client.new(region: region)
+    end
+
+    def auto_scaling
+      @__auto_scaling ||= Aws::AutoScaling::Client.new(region: region)
+    end
+
+    def amis(ami_name, ami_owner)
+      return @__amis unless @__amis.nil?
+
+      # Cannot lookup by Name tag because that's only available from the owner account.
+      describe_images_params = { owners: [ ami_owner ] }
+      all_images_from_owner = ec2.describe_images(describe_images_params).images
+      name_matching_images = all_images_from_owner.filter {|i| i.name.match?(ami_name) }
+
+      @__amis = sort_by_created_at(name_matching_images)
+    end
+
+    def sort_by_created_at(collection)
+      # Returns items oredered by creation_date from newer to older
+      collection.sort {|a, b| DateTime.parse(b.creation_date) <=> DateTime.parse(a.creation_date) }
+    end
+
+    def amis_in_use
+      image_ids = []
+
+      autoscaling_groups = auto_scaling.describe_auto_scaling_groups.auto_scaling_groups
+
+      # Find AMIs used by auto scaling groups with launch templates
+      launch_template_ids = autoscaling_groups.reject {|asg| asg.launch_template.nil? }
+                                              .collect {|asg| asg.launch_template.launch_template_id }
+      launch_template_ids.each do |launch_template_id|
+        image_ids << ec2.describe_launch_template_versions(launch_template_id: launch_template_id, max_results: 1)
+                        .launch_template_versions
+                        .first
+                        .launch_template_data
+                        .image_id
+      end
+
+      # Find AMIs used by auto scaling groups with launch configurations
+      launch_configuration_names = autoscaling_groups.filter {|asg| asg.launch_template.nil? }
+                                                     .collect {|asg| asg.launch_configuration_name }
+      launch_configurations = auto_scaling.describe_launch_configurations(launch_configuration_names: launch_configuration_names).launch_configurations
+      image_ids += launch_configurations.map(&:image_id)
+
+      # Finally, find AMIs used by instances not belonging to auto scaling groups
+      ec2_reservations = ec2.describe_instances
+      image_ids += ec2_reservations.reservations.collect {|res| res.instances.map(&:image_id) }.flatten
+
+      image_ids.flatten
+    end
+
+    def delete_ami_snapshots(ebs_mappings)
+      ebs_mappings.each do |ebs_mapping|
+        # Skip ephimeral block devices
+        next if ebs_mapping.ebs.nil? || ebs_mapping.ebs.snapshot_id.nil?
+
+        snapshot_id = ebs_mapping.ebs.snapshot_id
+        puts "Deleting snapshot #{snapshot_id}"
+        snapshot = Aws::EC2::Snapshot.new(snapshot_id)
+        snapshot.delete
+      end
+    end
+  end
+end

data/lib/aws_ami_cleanup/commands.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AwsAmiCleanup
+  class Commands < Thor
+    desc "clean_amis", "delete unused AMIs owned by ami_owner with ami_name name"
+    option :ami_name, required: true
+    option :ami_owner, required: true
+    option :number_of_amis_to_keep, required: false
+    option :region, required: false
+    def clean_amis
+      cleanup_amis = AwsAmiCleanup::CleanupAmis.new(region, options[:number_of_amis_to_keep]&.to_i)
+
+      cleanup_amis.execute!(ami_name: options[:ami_name], ami_owner: options[:ami_owner])
+    end
+
+    desc "console", "interactive session"
+    def console
+      require 'byebug'
+      byebug
+    end
+
+    protected
+
+    def region
+      options[:region] || 'us-east-1'
+    end
+  end
+end

data/lib/aws_ami_cleanup/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AwsAmiCleanup
+  VERSION = "0.1"
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: aws_ami_cleanup
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Diego Marcet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-autoscaling
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+description:
+email: diego@controlshiftlabs.com
+executables:
+- cleanup_amis
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- aws_ami_cleanup.gemspec
+- bin/cleanup_amis
+- lib/aws_ami_cleanup.rb
+- lib/aws_ami_cleanup/cleanup_amis.rb
+- lib/aws_ami_cleanup/commands.rb
+- lib/aws_ami_cleanup/version.rb
+homepage: http://github.com/controlshift/aws_ami_cleanup
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Script for deleting obsolete AMIs
+test_files: []