preserve-rds-snapshot 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ac1fad7b038d2f7714ce5775f6faca3f607865d
-  data.tar.gz: 9c4b3e1d56a99892049df09479be7d2196a5164e
+  metadata.gz: af7578d5b6ba4324962222bf6bd9cf4644e62989
+  data.tar.gz: 13a489abbdce7d030d46814c6580546b4392029e
 SHA512:
-  metadata.gz: 8b22cbca0519b61ada69d8ec3d0a2bfe29fd1af82c869d158694a493a5f23f22a1772ec42c599e944e0870eb6972814a281e8aecd5f22db33d7cea671beeb9e8
-  data.tar.gz: 58ea25f44eaef6accac79fe4e6a811c9570034a362038d4464f67ef1269833b72184517bf80f1157c71a5999d9fe93e0cd361f8607d55520d3d90376da18d7df
+  metadata.gz: cfdcfa7f4f7c88dbf8425130c1b1ad54e04b6edf947b46a1ff248d45402c52ba3066a943cfa671fa88da2cdad08eb9284a009e4a231d8b567d73d4faff5e41d4
+  data.tar.gz: 767ffdf614c32684300dda5b69aa508814f099b6f3610f825f8e590e0a4cbb1b3c7d7bdcf7a74669a68dcc13aab4d0fe07f130253911f712fcea419f57a46323

data/README.md

@@ -2,6 +2,19 @@
 
 Amazon RDS create a snapshot automatically. Snapshot that is created automatically, will be lost when the instance is terminated. This script preserve db snapshots by copy snapshots.
 
+### AWS API requirement
+
+* RDS
+  * describe_db_instances
+  * describe_db_snapshots
+  * copy_db_snapshot
+  * delete_db_snapshots
+  * list_tags_for_resources
+* EC2
+  * describe_security_groups
+
+NOTE: describe_security_groups is required to get the AWS Account Number. You can use the '--aws-account-number' option instead.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -45,6 +58,7 @@ Options:
   i, [--instance=INSTANCE]                                 # target DB Instance
  ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec preserve-rds-snapshot` to use the code located in this directory, ignoring other installed copies of this gem.

data/lib/preserve-rds-snapshot/cli.rb

@@ -4,11 +4,19 @@ require 'thor/aws'
 module PreserveRdsSnapshot
   class CLI < Thor
     include Thor::Aws
+    PRESERVE_TAG_NAME = 'preserve-rds-snapshot'
 
     class_option :instance,
       aliases: [:i],
       type: :string,
       desc: 'target DB Instance'
+    class_option :aws_account_number,
+      aliases: [:n],
+      type: :string,
+      desc: 'AWS Account Number (ex: 012345678901)'
+    class_option :dry_run,
+      type: :boolean,
+      desc: "show only, don't modify"
 
     desc :list, 'Show list of RDS Snapshots'
     option :snapshot_type,
@@ -29,21 +37,55 @@ module PreserveRdsSnapshot
       end
     end
 
+    desc :init, "initialize instance"
+    option :generations,
+      aliases: [:g],
+      type: :numeric,
+      desc: "preserved snapshot generations",
+      default: 10
+    def init
+      begin
+        rds.db_instances.each do |instance|
+          if options[:dry_run]
+            puts "init(dry run)\t#{instance.db_instance_identifier}\t#{options[:generations]}"
+          else
+            if enable_preserve(instance.db_instance_identifier, options[:generations])
+              puts "init\t#{instance.db_instance_identifier}\t#{options[:generations]}"
+            end
+          end
+        end
+        fix_tags
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+    end
+
     desc :preserve, 'copy automated snapshot to manual'
     def preserve
       begin
         instances = db_instances(options[:instance])
         instances.each do |i|
-          latest = latest_auto_snapshot(i.db_instance_identifier)
+          instance = i.db_instance_identifier
+          latest = latest_auto_snapshot(instance)
           if latest
-            db_snapshot_identifier = latest.db_snapshot_identifier
-            resp = rds.client.copy_db_snapshot(
-              source_db_snapshot_identifier: db_snapshot_identifier,
-              target_db_snapshot_identifier: preserve_snapshot_name(db_snapshot_identifier),
-              tags: [key: 'type', value: 'preserve']
-            )
-            s = resp.db_snapshot
-            puts "#{s.db_snapshot_identifier}\t#{s.snapshot_create_time}"
+            if options[:dry_run]
+              puts "#{latest.db_snapshot_identifier}\t-\t-"
+            else
+              s = copy_snapshot(latest.db_snapshot_identifier)
+              puts "copy\t#{latest.db_snapshot_identifier}\t#{s.db_snapshot_identifier}\t#{s.snapshot_create_time}" if s
+            end
+          end
+
+          tag = preserve_tag(instance, 'db')
+          expireds = expired_snapshots(instance, tag[:value].to_i)
+          dry_run_msg = '(dry run)' if options[:dry_run]
+          expireds.each do |expired|
+            unless options[:dry_run]
+              rds.client.delete_db_snapshot(
+                db_snapshot_identifier: expired.db_snapshot_identifier
+              )
+            end
+            puts "delete#{dry_run_msg}\t#{expired.db_snapshot_identifier}"
           end
         end
       rescue ::Aws::Errors::ServiceError => e
@@ -60,14 +102,20 @@ module PreserveRdsSnapshot
     option :target_db_snapshot_identifier,
       aliases: [:t],
       type: :string,
-      desc: 'target snapshot identifier',
-      required: true
+      desc: 'target snapshot identifier'
     def copy
+      if options[:target_db_snapshot_identifier]
+        target = options[:target_db_snapshot_identifier]
+      else
+        target = preserve_snapshot_name(options[:source_db_snapshot_identifier])
+      end
+      source = options[:source_db_snapshot_identifier]
+
       begin
         resp = rds.client.copy_db_snapshot(
-          source_db_snapshot_identifier: options[:source_db_snapshot_identifier],
-          target_db_snapshot_identifier: options[:target_db_snapshot_identifier],
-          tags: [key: 'type', value: 'preserve']
+          source_db_snapshot_identifier: source,
+          target_db_snapshot_identifier: target,
+          tags: [key: PRESERVE_TAG_NAME, value: 'true']
         )
         s = resp.db_snapshot
         puts "#{s.db_snapshot_identifier}\t#{s.snapshot_create_time}"
@@ -107,15 +155,120 @@ module PreserveRdsSnapshot
         if db_instance_identifier
           list << rds.db_instance(db_instance_identifier)
         else
-          list = rds.db_instances.to_a
+          rds.db_instances.each do |i|
+            list << i if preserve_tag(i.db_instance_identifier, 'db')
+          end
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
       end
+      list
     end
 
     def preserve_snapshot_name(db_snapshot_identifier)
       'preserve-' + db_snapshot_identifier.gsub(/^rds:/, '')
     end
+
+    def aws_account_number
+      if options[:aws_account_number]
+        return options[:aws_account_number]
+      else
+        begin
+          return ec2.security_groups(group_names: ['default']).first.owner_id
+        rescue ::Aws::Errors::ServiceError => e
+          $stderr.puts e
+        end
+      end
+    end
+
+    def rds_arn(resource_id, type)
+      "arn:aws:rds:#{options[:region]}:#{aws_account_number}:#{type}:#{resource_id}"
+    end
+
+    def preserve_tag(resource_id, type)
+      tag = nil
+      begin
+        resp = rds.client.list_tags_for_resource(
+          resource_name: rds_arn(resource_id, type)
+        )
+        tag = resp.tag_list.find {|t| t[:key] == PRESERVE_TAG_NAME}
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+      tag
+    end
+
+    def enable_preserve(resource_id, generations)
+      return false unless generations.kind_of? Integer
+      begin
+        tag = preserve_tag(resource_id, 'db')
+        unless tag
+          resp = rds.client.add_tags_to_resource(
+            resource_name: rds_arn(resource_id, 'db'),
+            tags: [{key: PRESERVE_TAG_NAME, value: generations.to_s}]
+          )
+          return resp.successful?
+        end
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+    end
+
+    # fix v0.2.0 format tag to latest
+    def fix_tags
+      begin
+        rds.client.describe_db_snapshots(
+          snapshot_type: 'manual'
+        ).db_snapshots.each do |s|
+          arn = rds_arn(s.db_snapshot_identifier, 'snapshot')
+          resp = rds.client.list_tags_for_resource(
+            resource_name: arn
+          )
+          tag = resp.tag_list.find {|t| t[:key] == 'type' && t[:value] == 'preserve'}
+          if tag
+            rds.client.add_tags_to_resource(
+              resource_name: arn,
+              tags: [{key: PRESERVE_TAG_NAME, value: 'true'}]
+            )
+            rds.client.remove_tags_from_resource(
+              resource_name: arn,
+              tag_keys: ['type']
+            )
+          end
+        end
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+    end
+
+    def copy_snapshot(db_snapshot_identifier)
+      begin
+        resp = rds.client.copy_db_snapshot(
+          source_db_snapshot_identifier: db_snapshot_identifier,
+          target_db_snapshot_identifier: preserve_snapshot_name(db_snapshot_identifier),
+          tags: [key: PRESERVE_TAG_NAME, value: 'true']
+        )
+        return resp.db_snapshot
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+    end
+
+    def expired_snapshots(db_instance_identifier, generations)
+      expired_snapshots = []
+      begin
+        resp = rds.client.describe_db_snapshots(
+          snapshot_type: 'manual',
+          db_instance_identifier: db_instance_identifier
+        )
+        snapshots = resp.db_snapshots.select {|s|
+          preserve_tag(s.db_snapshot_identifier, 'snapshot')
+        }.sort_by(&:snapshot_create_time).reverse
+        expired_snapshots = snapshots[generations..-1] if snapshots.size > generations
+      rescue ::Aws::Errors::ServiceError => e
+        $stderr.puts e
+      end
+      expired_snapshots
+    end
   end
 end

data/lib/preserve-rds-snapshot/version.rb

@@ -1,3 +1,3 @@
 module PreserveRdsSnapshot
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: preserve-rds-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ISOBE Kazuhiko