aws_ami_cleanup 0.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db5bf4d59de51127ee6dab8a547cce124a734dd1c628096e59509ea21dd572d4
-  data.tar.gz: 5a6aa3840422b64a71be65ce11ac2a290e4e46a2e5f8730865537ce8676c3368
+  metadata.gz: fdb3d28f7c0eb4b2c6acd19468ff42990802239afed6d39d966bdf9e314af913
+  data.tar.gz: aec4c2d2bea2f67e295df587023c300075602037c093063d726e3a9dffe797b0
 SHA512:
-  metadata.gz: 8f6000074b50a25f566478022a78a341b676a0fa10eb8cc7945043889035bf5b0b080bac0eede9748ce1886db13c0f92745f0fe2f0abe254acc2a80d93f95f16
-  data.tar.gz: 212429abd100adba8cf1be8cbda5a322237a5114ffba2114b3266bce54e1be56d5f1a1dad184f1d2a5245b9713f039063ab2c33f6359a3d506f1d0b3769fadf3
+  metadata.gz: 00bc9351ee496669abbc4e5c0bb66c6ece7c7ad4f71ea3e1607785fa9f4a2890066d9d94cffc10c5b998cb99afa17ad0bf2535cc305e7655303f40151a668e2e
+  data.tar.gz: 3c2741cb1ae825e8ee0e6433914635839415c8365f2fdb5244e8c6a7c5d9fcfb99c8aa83f95a2936ef79a6c058e580d726dd1e36f88efc51441279eaedad374f

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.6
+ruby-3.1.2

data/README.md

@@ -8,6 +8,7 @@ This gem provides the `cleanup_amis` script that allows deregistering unused AMI
 - ec2:DeregisterImage
 - ec2:DeleteSnapshot
 - autoscaling:DescribeAutoScalingGroups
+- autoscaling:DescribeLaunchConfigurations
 
 Script should be invoked as follows:
 
@@ -17,4 +18,9 @@ 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`).
+Additionally you can provide the following arguments:
+
+- `number_of_amis_to_keep` to specify how many AMIs to keep (default is 3).
+- `region` for the AWS region (default is `us-east-1`).
+- `dry_run` for running without deleting any resources in AWS.
+- `skip_image_under_use_verification` for skipping verification on whether the AMI is being used by any auto scaling group or reserved EC2 instance.

data/aws_ami_cleanup.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |s|
   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")
+  s.add_development_dependency("debug")
 end

data/lib/aws_ami_cleanup/cleanup_amis.rb

@@ -7,21 +7,41 @@ module AwsAmiCleanup
   class CleanupAmis
     DEFAULT_NUMBER_OF_AMIS_TO_KEEP = 3
 
-    attr_accessor :region, :number_of_amis_to_keep
+    attr_accessor :region, :number_of_amis_to_keep, :skip_image_under_use_verification
 
-    def initialize(region, number_of_amis_to_keep)
+    def initialize(region, number_of_amis_to_keep, skip_image_under_use_verification:, assume_role_for_querying_state:, aws_role_for_querying_state:)
       @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
+
+      @skip_image_under_use_verification = skip_image_under_use_verification
+      @assume_role_for_querying_state = assume_role_for_querying_state
+
+      if @skip_image_under_use_verification && @assume_role_for_querying_state
+        raise 'Cannot include skip image under use verification and assume role for querying state options'
+      end
+
+      if @assume_role_for_querying_state
+        raise "Must include the IAM role's ARN to assume if using a different role for querying state" if aws_role_for_querying_state.nil?
+        @aws_role_for_querying_state = aws_role_for_querying_state
+      end
     end
 
-    def execute!(ami_name:, ami_owner:)
+    def execute!(ami_name:, ami_owner:, dry_run:)
+      puts "RUNNING IN DRY MODE." if dry_run
+
       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
+
+      if skip_image_under_use_verification
+        ami_ids_to_remove = ami_ids
+      else
+        ami_ids_to_remove = ami_ids - amis_in_use
+      end
+
       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
@@ -29,11 +49,18 @@ module AwsAmiCleanup
         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)
+
+          begin
+            ec2_client_for_cleanup.deregister_image(image_id: ami.image_id, dry_run: dry_run)
+          rescue Aws::EC2::Errors::DryRunOperation
+            # When running in dry mode, EC2 raises this exception if operation would have succeeded, we catch them so the full process can run
+          end
+
+          delete_ami_snapshots(ebs_mappings, dry_run)
         end
 
         puts "Currently active AMIs..."
@@ -47,12 +74,40 @@ module AwsAmiCleanup
 
     protected
 
-    def ec2
+    def ec2_client_for_query_state
+      return @__ec2_client_for_query_state if defined?(@__ec2_client_for_query_state)
+
+      @__ec2_client_for_query_state =
+        if @assume_role_for_querying_state
+          role_credentials = Aws::AssumeRoleCredentials.new(
+            role_arn: @aws_role_for_querying_state,
+            role_session_name: 'ami-cleanup',
+            region: region
+          )
+          Aws::EC2::Client.new(credentials: role_credentials, region: region)
+        else
+          ec2_client_for_cleanup
+        end
+    end
+
+    def ec2_client_for_cleanup
       @__ec2 ||= Aws::EC2::Client.new(region: region)
     end
 
     def auto_scaling
-      @__auto_scaling ||= Aws::AutoScaling::Client.new(region: region)
+      return @__auto_scaling if defined?(@__auto_scaling)
+
+      @__auto_scaling =
+        if @aws_role_for_querying_state
+          role_credentials = Aws::AssumeRoleCredentials.new(
+            role_arn: @aws_role_for_querying_state,
+            role_session_name: 'ami-cleanup',
+            region: region
+          )
+          Aws::AutoScaling::Client.new(credentials: role_credentials, region: region)
+        else
+          Aws::AutoScaling::Client.new(region: region)
+        end
     end
 
     def amis(ami_name, ami_owner)
@@ -60,7 +115,7 @@ module AwsAmiCleanup
 
       # 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
+      all_images_from_owner = ec2_client_for_query_state.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)
@@ -80,11 +135,11 @@ module AwsAmiCleanup
       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
+        image_ids << ec2_client_for_query_state.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
@@ -94,21 +149,24 @@ module AwsAmiCleanup
       image_ids += launch_configurations.map(&:image_id)
 
       # Finally, find AMIs used by instances not belonging to auto scaling groups
-      ec2_reservations = ec2.describe_instances
+      ec2_reservations = ec2_client_for_query_state.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)
+    def delete_ami_snapshots(ebs_mappings, dry_run)
       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
+        begin
+          ec2_client_for_cleanup.delete_snapshot(snapshot_id: snapshot_id, dry_run: dry_run)
+        rescue Aws::EC2::Errors::DryRunOperation
+          # When running in dry mode, EC2 raises this exception if operation would have succeeded, we catch them so the full process can run
+        end
       end
     end
   end

data/lib/aws_ami_cleanup/commands.rb

@@ -5,18 +5,30 @@ module AwsAmiCleanup
     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 :number_of_amis_to_keep, required: true
+    option :assume_role_for_querying_state, type: :boolean, required: false
+    option :aws_role_for_querying_state, required: false
+    option :dry_run, type: :boolean, required: false
     option :region, required: false
+    option :skip_verification, type: :boolean, required: false
     def clean_amis
-      cleanup_amis = AwsAmiCleanup::CleanupAmis.new(region, options[:number_of_amis_to_keep]&.to_i)
+      cleanup_amis = AwsAmiCleanup::CleanupAmis.new(
+                      region,
+                      options[:number_of_amis_to_keep]&.to_i,
+                      skip_image_under_use_verification: options[:skip_verification],
+                      assume_role_for_querying_state: options[:assume_role_for_querying_state],
+                      aws_role_for_querying_state: options[:aws_role_for_querying_state]
+                    )
 
-      cleanup_amis.execute!(ami_name: options[:ami_name], ami_owner: options[:ami_owner])
+      cleanup_amis.execute!(ami_name: options[:ami_name],
+                            ami_owner: options[:ami_owner],
+                            dry_run: options[:dry_run])
     end
 
     desc "console", "interactive session"
     def console
-      require 'byebug'
-      byebug
+      require 'debug'
+      debugger
     end
 
     protected

data/lib/aws_ami_cleanup/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: aws_ami_cleanup
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '1.1'
 platform: ruby
 authors:
 - Diego Marcet
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2021-02-19 00:00:00.000000000 Z
@@ -53,20 +53,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
-description:
+        version: '0'
+description: 
 email: diego@controlshiftlabs.com
 executables:
 - cleanup_amis
@@ -88,7 +88,7 @@ homepage: http://github.com/controlshift/aws_ami_cleanup
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.3.19
+signing_key: 
 specification_version: 4
 summary: Script for deleting obsolete AMIs
 test_files: []