aws_helper 0.0.1 → 0.0.2

data/README.md

@@ -19,24 +19,36 @@ Or install it yourself as:
 
     $ gem install aws_helper
 
-## Usage
+## Minimal Usage
 
-Snapshot EBS attached to device /dev/sdf
+Assuming server start with an IAM role that have read access to AWS can create and delete snapshots: 
+
+Snapshot EBS root device at /dev/sda1
+
+    aws_helper snap /dev/sda1 --description zzzzzzzzz
+
+Prune so only keep 7 snapshots: 
+
+    aws_helper snap_prune /dev/sda1 --snapshots_to_keep=7
+
+## Complex Usage
+
+If your server does not have a role then you need to code the AWS keys which is not best practice:
+
+Snapshot EBS attached to device /dev/sdf volume vol-123456 access AWS through an http proxy: 
 
     export AWS_ACCESS_KEY_ID ='xxxxxxxxxxxx'
     export AWS_SECRET_ACCESS_KEY ='yyyyyyyy'
     export HTTP_PROXY=http://myproxy:port
-    aws_helper snap /dev/sdf --description zzzzzzzzz
+    aws_helper snap /dev/sdf vol-123456 --description zzzzzzzzz
 
 Prune so only keep 7 snapshots: 
 
     export AWS_ACCESS_KEY_ID ='xxxxxxxxxxxx'
     export AWS_SECRET_ACCESS_KEY ='yyyyyyyy'
-    aws_helper snap_prune /dev/sdf --snapshots_to_keep=7
-    
-NOTE: Best Practice is for your server to have an IAM role then you don't
-need to specify AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
-    
-Other functions to follow    
+    export HTTP_PROXY=http://myproxy:port
+    aws_helper snap_prune /dev/sdf vol-123456 --snapshots_to_keep=7
+ 
+Other functions to follow     
 
 

data/lib/awshelper/ec2.rb

@@ -81,20 +81,20 @@ require 'right_aws'
       end
 
       def query_role
-        r = open("http://169.254.169.254/latest/meta-data/iam/security-credentials/",options = {:proxy => proxy}).readlines.first
+        r = open("http://169.254.169.254/latest/meta-data/iam/security-credentials/",options = {:proxy => false}).readlines.first
         r
       end
 
       def query_role_credentials(role = query_role)
         log("Instance has no IAM role.",'err') if role.to_s.empty?
         fail "Instance has no IAM role." if role.to_s.empty?
-        creds = open("http://169.254.169.254/latest/meta-data/iam/security-credentials/#{role}",options = {:proxy => proxy}){|f| JSON.parse(f.string)}
+        creds = open("http://169.254.169.254/latest/meta-data/iam/security-credentials/#{role}",options = {:proxy => false}){|f| JSON.parse(f.string)}
         log("Retrieved instance credentials for IAM role #{role}")
         creds
       end
 
       def query_instance_id
-        instance_id = open('http://169.254.169.254/latest/meta-data/instance-id',options = {:proxy => proxy}){|f| f.gets}
+        instance_id = open('http://169.254.169.254/latest/meta-data/instance-id',options = {:proxy => false}){|f| f.gets}
         log("Cannot find instance id!",'err') unless instance_id
         raise "Cannot find instance id!" unless instance_id
         log("Instance ID is #{instance_id}")
@@ -102,7 +102,7 @@ require 'right_aws'
       end
       
       def query_ami_id
-        ami_id = open('http://169.254.169.254/latest/meta-data/ami-id',options = {:proxy => proxy}){|f| f.gets}
+        ami_id = open('http://169.254.169.254/latest/meta-data/ami-id',options = {:proxy => false}){|f| f.gets}
         log("Cannot find ami id!",'err') unless ami_id
         raise "Cannot find instance id!" unless ami_id
         log("Aim ID is #{ami_id}")
@@ -110,7 +110,7 @@ require 'right_aws'
       end 
       
       def query_local_ipv4
-        local_ipv4 = open('http://169.254.169.254/latest/meta-data/local-ipv4',options = {:proxy => proxy}){|f| f.gets}
+        local_ipv4 = open('http://169.254.169.254/latest/meta-data/local-ipv4',options = {:proxy => false}){|f| f.gets}
         log("Cannot find local_ipv4!",'err') unless local_ipv4
         raise "Cannot find local_ipv4!" unless local_ipv4
         log("local_ipv4 is #{local_ipv4}")
@@ -118,7 +118,7 @@ require 'right_aws'
       end      
 
       def query_instance_availability_zone
-        availability_zone = open('http://169.254.169.254/latest/meta-data/placement/availability-zone/', options = {:proxy => proxy}){|f| f.gets}
+        availability_zone = open('http://169.254.169.254/latest/meta-data/placement/availability-zone/', options = {:proxy => false}){|f| f.gets}
         log("Cannot find availability zone!",'err') unless availability_zone
         raise "Cannot find availability zone!" unless availability_zone
         log("Instance's availability zone is #{availability_zone}")

data/lib/awshelper/version.rb

@@ -1,3 +1,3 @@
 module Awshelper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_aws