aws_ami_cleanup 0.3 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ac02ebfcda946944410be7a4044e5a01949152337baa037f3fa9ea9be8b9a2
-  data.tar.gz: 91e0c6ceb77364a9ba929b693b7f33a0ff2e742ce889eeb33cfb1bf29368b007
+  metadata.gz: fdb3d28f7c0eb4b2c6acd19468ff42990802239afed6d39d966bdf9e314af913
+  data.tar.gz: aec4c2d2bea2f67e295df587023c300075602037c093063d726e3a9dffe797b0
 SHA512:
-  metadata.gz: 797cdde4f267868ae2287ae5fc46ac8c30dc711dee230dda7563ee498dc0d523eee165543808f7474c6ec00ee135f08dd9037dfc4a627eec6c5c605c815fd756
-  data.tar.gz: 4dc150e871dece040998b2e87ef6fe851e636869c4768578b7b629b226bd4e2aa01606ae2097bf12ffc209615495edcc650d2d0b4ebd1ffa9420786dfbae7559
+  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:
 

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

@@ -9,7 +9,7 @@ module AwsAmiCleanup
 
     attr_accessor :region, :number_of_amis_to_keep, :skip_image_under_use_verification
 
-    def initialize(region, number_of_amis_to_keep, skip_image_under_use_verification)
+    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
@@ -18,6 +18,16 @@ module AwsAmiCleanup
       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:, dry_run:)
@@ -45,7 +55,7 @@ module AwsAmiCleanup
           puts "Deregistering #{ami.image_id}"
 
           begin
-            ec2.deregister_image(image_id: ami.image_id, dry_run: dry_run)
+            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
@@ -64,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)
@@ -77,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)
@@ -97,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
@@ -111,7 +149,7 @@ 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
@@ -125,7 +163,7 @@ module AwsAmiCleanup
         snapshot_id = ebs_mapping.ebs.snapshot_id
         puts "Deleting snapshot #{snapshot_id}"
         begin
-          ec2.delete_snapshot(snapshot_id: snapshot_id, dry_run: dry_run)
+          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

data/lib/aws_ami_cleanup/commands.rb

@@ -5,15 +5,19 @@ 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
-    option :dry_run, type: :boolean, required: false
     def clean_amis
       cleanup_amis = AwsAmiCleanup::CleanupAmis.new(
                       region,
                       options[:number_of_amis_to_keep]&.to_i,
-                      options[:skip_verification]
+                      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],
@@ -23,8 +27,8 @@ module AwsAmiCleanup
 
     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.3"
+  VERSION = "1.1"
 end
 

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: aws_ami_cleanup
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  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: []