preserve-rds-snapshot 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af7578d5b6ba4324962222bf6bd9cf4644e62989
-  data.tar.gz: 13a489abbdce7d030d46814c6580546b4392029e
+  metadata.gz: 81954fb5d44f1f9e831c994e02583453d74f413c
+  data.tar.gz: 9c4b7851629b3e1540ed11f2071b58aa8d5c8ab2
 SHA512:
-  metadata.gz: cfdcfa7f4f7c88dbf8425130c1b1ad54e04b6edf947b46a1ff248d45402c52ba3066a943cfa671fa88da2cdad08eb9284a009e4a231d8b567d73d4faff5e41d4
-  data.tar.gz: 767ffdf614c32684300dda5b69aa508814f099b6f3610f825f8e590e0a4cbb1b3c7d7bdcf7a74669a68dcc13aab4d0fe07f130253911f712fcea419f57a46323
+  metadata.gz: de72b07225b860dfb120607dfdaa9f700a2e985086f88ae72c875db49a3b8c548e06bbe5b7f8084f2b0c8266652a80e3949de15c764dc2c3679a85020694d2a8
+  data.tar.gz: f994b08e6b03f707663b1746c7051de638ba3fe8d87a9584ef789eac82ba3ed358fc2c5ec5c944d74ab27ae66a328768406691ad770cca1d49aaa9be8df4271e

data/README.md

@@ -10,10 +10,12 @@ Amazon RDS create a snapshot automatically. Snapshot that is created automatical
   * copy_db_snapshot
   * delete_db_snapshots
   * list_tags_for_resources
+  * add_tags_to_resources
+  * remove_tags_from_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.
+NOTE: describe_security_groups is required to get the AWS Account Number. You can use the `--aws-account-number` option instead.
 
 ## Installation
 
@@ -37,6 +39,7 @@ Or install it yourself as:
 Commands:
   preserve-rds-snapshot copy -o src -t target  # copy snapshot
   preserve-rds-snapshot help [COMMAND]         # Describe available commands or one specific command
+  preserve-rds-snapshot init                   # initialize instance
   preserve-rds-snapshot latest                 # show latest snapshot
   preserve-rds-snapshot list                   # Show list of RDS Snapshots
   preserve-rds-snapshot preserve               # copy automated snapshot to manual
@@ -48,16 +51,25 @@ Options:
   r, [--region=REGION]                                     # AWS region.
       [--shared-credentials-path=SHARED_CREDENTIALS_PATH]  # AWS shared credentials path.
   i, [--instance=INSTANCE]                                 # target DB Instance
-
-Options:
-  p, [--profile=PROFILE]                                   # Load credentials by profile name from shared credentials file.
-  k, [--access-key-id=ACCESS_KEY_ID]                       # AWS access key id.
-  s, [--secret-access-key=SECRET_ACCESS_KEY]               # AWS secret access key.
-  r, [--region=REGION]                                     # AWS region.
-      [--shared-credentials-path=SHARED_CREDENTIALS_PATH]  # AWS shared credentials path.
-  i, [--instance=INSTANCE]                                 # target DB Instance
+  n, [--aws-account-number=AWS_ACCOUNT_NUMBER]             # AWS Account Number (ex: 012345678901)
+      [--dry-run], [--no-dry-run]                          # show only, don't modify
  ```
 
+### initialize instance
+
+```
+$ preserve-rds-snapshot init
+```
+
+init subcommand add 'preserve-rds-snapshot' tag to RDS instance.
+
+### preserve snapshot
+
+```
+$ preserve-rds-snapshot preserve
+```
+
+preserve subcommand copy automated snapshot to manual snapshot.
 
 ## Development
 

data/README_ja.md

@@ -0,0 +1,90 @@
+# preserve-rds-snapshot
+
+Amazo RDSの自動バックアップによって作成されるスナップショット（automatedスナップショット）は、インスタンスが削除されたら消えてしまうので、それを manualスナップショットにコピーして保護することを目的としたスクリプトである。
+
+automatedスナップショットは、RDSのBackup Windowの中で作成される。cronやタスクスケジューラなどを使って、Backup Windowの後にこのスクリプトを実行すれば、常に最新のコピーを作成することができる。
+
+## 導入
+
+Rubygemsのパッケージなので、gemコマンドでインストールできる。
+
+```
+$ gem install preserve-rds-snapshot
+```
+
+## AWS認証情報（credentials）
+
+AWSの認証情報は、AWS CLIと同様に使用することができる。[thor-aws](http://github.com/y13i/thor-aws)を使っているので、詳細はそちらを参照のこと。EC2上で実行するのであれば、IAM Roleが利用できる。手元の環境で実行するのであれば、--profileがおすすめ。
+
+## 初期化
+
+まずは、対象となるRDSインスタンスを初期化する。
+
+```
+$ preserve-rds-snapshot init --region ap-northeast-1 --generations 5 --instance my-rds
+```
+
+`--instance` オプションでインスタンスを指定しなかった場合は、指定したリージョンの全てのRDSインスタンスが対象となる。その他のサブコマンドも全て同様。
+
+`--generations` オプションは、スナップショットを残す世代数となる。 automatedスナップショットと違い、 manualスナップショットは自動的に削除されないため、新しくコピーを作成した際に、指定した世代数を超えた分のスナップショットを削除するようになっている。指定しなかった場合は10となる。
+
+初期化処理は、RDSインスタンスに `preserve-rds-snapshot` タグを付与する。値には指定した世代数が入る。
+
+## 実行
+
+スナップショットをコピーする。
+
+```
+$ preserve-rds-snapshot preserve --region ap-northeast-1 --instance my-rds
+```
+
+preserveサブコマンドは、 `preserve-rds-snapshot` タグが付与されているインスタンスの、 automated スナップショットのうち、最新のスナップショットをコピーする。コピーする際には、インスタンスと同様に `preserve-rds-snapshot` タグを付与する。
+
+コピー後、 `preserve-rds-snapshot` タグが付与されたスナップショットのうち、指定の世代数を超えた分のスナップショットを、snapshot create timeの古いものから削除する。
+
+automatedスナップショットは、Backup Windowに合わせて毎日作成されるので、このスクリプトも、それに合わせて毎日実行される想定となっている。
+
+## その他
+
+最新のスナップショット以外を対象にしたい場合は、copyサブコマンドが使える。対象となるスナップショットを指定すれば良い。
+
+あるスナップショットを、自動削除の対象外にしたい場合は、 `preserve-rds-snapshot` タグを削除すれば良い。
+
+タグを生成する際に、AWSアカウント番号を使用する（対象のARNが必要となる）。そのため、EC2のセキュリティグループからAWSアカウント番号を取得している。EC2のDescribeSecurityGroups APIを実行する権限が必要となる（[参考](http://muramasa64.fprog.org/diary/?date=20141208)）。もし権限が付与できない場合は、`--aws-account-number` オプションを付与すること。
+
+### 使用する AWS API
+
+* RDS
+  * describe_db_instances
+  * describe_db_snapshots
+  * copy_db_snapshot
+  * delete_db_snapshots
+  * list_tags_for_resources
+  * add_tags_to_resources
+  * remove_tags_from_resources
+* EC2
+  * describe_security_groups
+
+註: describe_security_groupsはAWS Account Numberを取得するのに利用する。 `--aws-account-number` オプションに値を渡せば、describe_security_groupsの実行権限は不要。
+
+## コマンド一覧
+
+```
+Commands:
+  preserve-rds-snapshot copy -o src -t target  # copy snapshot
+  preserve-rds-snapshot help [COMMAND]         # Describe available commands or one specific command
+  preserve-rds-snapshot init                   # initialize instance
+  preserve-rds-snapshot latest                 # show latest snapshot
+  preserve-rds-snapshot list                   # Show list of RDS Snapshots
+  preserve-rds-snapshot preserve               # copy automated snapshot to manual
+
+Options:
+  p, [--profile=PROFILE]                                   # Load credentials by profile name from shared credentials file.
+  k, [--access-key-id=ACCESS_KEY_ID]                       # AWS access key id.
+  s, [--secret-access-key=SECRET_ACCESS_KEY]               # AWS secret access key.
+  r, [--region=REGION]                                     # AWS region.
+      [--shared-credentials-path=SHARED_CREDENTIALS_PATH]  # AWS shared credentials path.
+  i, [--instance=INSTANCE]                                 # target DB Instance
+  n, [--aws-account-number=AWS_ACCOUNT_NUMBER]             # AWS Account Number (ex: 012345678901)
+      [--dry-run], [--no-dry-run]                          # show only, don't modify
+ ```

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

@@ -34,6 +34,7 @@ module PreserveRdsSnapshot
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -57,6 +58,7 @@ module PreserveRdsSnapshot
         fix_tags
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -90,6 +92,7 @@ module PreserveRdsSnapshot
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -121,6 +124,7 @@ module PreserveRdsSnapshot
         puts "#{s.db_snapshot_identifier}\t#{s.snapshot_create_time}"
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -145,6 +149,7 @@ module PreserveRdsSnapshot
         latest = resp.db_snapshots.sort_by(&:snapshot_create_time).last
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
       latest
     end
@@ -161,6 +166,7 @@ module PreserveRdsSnapshot
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
       list
     end
@@ -177,6 +183,7 @@ module PreserveRdsSnapshot
           return ec2.security_groups(group_names: ['default']).first.owner_id
         rescue ::Aws::Errors::ServiceError => e
           $stderr.puts e
+          exit 1
         end
       end
     end
@@ -194,6 +201,7 @@ module PreserveRdsSnapshot
         tag = resp.tag_list.find {|t| t[:key] == PRESERVE_TAG_NAME}
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
       tag
     end
@@ -211,6 +219,7 @@ module PreserveRdsSnapshot
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -238,6 +247,7 @@ module PreserveRdsSnapshot
         end
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -251,6 +261,7 @@ module PreserveRdsSnapshot
         return resp.db_snapshot
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
     end
 
@@ -267,6 +278,7 @@ module PreserveRdsSnapshot
         expired_snapshots = snapshots[generations..-1] if snapshots.size > generations
       rescue ::Aws::Errors::ServiceError => e
         $stderr.puts e
+        exit 1
       end
       expired_snapshots
     end

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

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

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: preserve-rds-snapshot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - ISOBE Kazuhiko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: thor-aws
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Amazon RDS create a snapshot automatically. Snapshot that is created
@@ -62,11 +62,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- README_ja.md
 - Rakefile
 - bin/console
 - bin/setup
@@ -85,12 +86,12 @@ 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: []