sport_ngin_aws_auditor 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33ff924df614bb4d8e056200750c9775c0fcc315
-  data.tar.gz: 10a1994780b54551f47de7e4694578ae5a2e24e6
+  metadata.gz: 1f426df86916c5bfc67f5365e79ac2513b4d483b
+  data.tar.gz: 156e31cd09966a7ba2b0711806590db245720905
 SHA512:
-  metadata.gz: a0e52ae4fb44a5f22b05b328f3e672ce28398546a332d743df5eeaa6f093297e698e97484091976b547faa0f472f8d99ed299491ad934ba92cd552ef5ab6a5e0
-  data.tar.gz: ded631320ab25cb82105342458693a3bef36c2c0fe6d2aaede106ffbc92233c9c2ef3a7c36c29561843f4d822961d50ff84c654027c29011b27b8a6f5a2e12d1
+  metadata.gz: cadd9bc310d7059b7d87e32435a0f62ea4ca0e061dd4ad738f3acb92e529f48db26f18ac619524ed31fa8774cd98200c2504e0836318ead5a9c96650d0095cbd
+  data.tar.gz: a2d1514429102855e104085528102e9c04959292a6e32121539a34336672e9d12bd91070f9c232c9243c7a27ba018656a0e03bbb78d91efec4d01a7a50ffc18c

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v4.0.2
+* Define availability zone as attribute for RDS object to avoid errors
+
+  > Emma Sax: Unknown User: https://github.com/sportngin/sport_ngin_aws_auditor/pull/35
+
 #### v4.0.1
 * Concat all of the similar values into one value right before printing
 

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 ## How-to
 
 ### AWS Setup
-Either create an `~/.aws/credentials` file that should have the following structure:
+There are three ways to authenticate AWS. The first is to create an `~/.aws/credentials` file that should have the following structure:
 
 ```
 [ACCOUNT 1]
@@ -37,10 +37,18 @@ aws_access_key_id = [AWS ACCESS KEY]
 aws_secret_access_key = [SECRET ACCESS KEY]
 ```
 
-Then this gem will use [AWS Shared Credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) with your credentials file. However, if you'd like to run these through either a default profile in your credentials file or through [User Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html), then use the flag `aws_roles`:
+Then this gem will use [AWS Shared Credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) with your credentials file. This is the default. If you'd like to pass a different config file, use the `--config` flag. 
+
+The second way to authenticate is through [User Roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html), then use the flag `aws_roles`:
 
     $ sport-ngin-aws-auditor --aws_roles [command] account1
 
+The third way to authenticate is authentication by assumed roles. To indicate this, use the `--assume_roles` switch. If using assumed roles, then the auditor needs a role name, which is defaulted to 'CrossAccountAuditorAccess'. Alternatively, a role name can be passed in with `--role_name`. Lastly, if using assumed roles, the auditor will also need an arn id. Identify this with the `--arn_id` option. The arn id is the identifying digits of the AWS arn arn:aws:iam::999999999999:role/#{role_name}.
+
+```
+$ sport-ngin-aws-auditor --assume_roles --role_name=MyRoleName --arn_id=999999999999 [command] account1
+```
+
 ### Google Setup (optional)
 You can export audit information to a Google Spreadsheet, but you must first follow “Create a client ID and client secret” on [this page](https://developers.google.com/drive/web/auth/web-server) to get a client ID and client secret for OAuth. Then create a `.google.yml` in your home directory with the following structure.
 
@@ -56,21 +64,29 @@ file:
  
 ## Usage
 
+### Global Options
+
+When auditing, it can be handy to pass in a special name to be printed describing the account that's being audited. This can be done through the `--display=Example` flag.
+
+Lastly, a user can tell the auditor which region to run the auditor in through the `--region=us-east-1` flag. If no region is specified, it will be run in every U.S. region: us-east-1, us-east-2, us-west-1, and us-west-2.
+
 ### The Audit Command
 
 To find discrepancies between number of running instances and purchased instances, run:
 
     $ sport-ngin-aws-auditor audit account1
 
-Any running instances that are not matched with a reserved instance with show up as yellow, the reserved instances that are not matched with a running instance will show up in red, and any reserved instances and running instances that match will show up in green. Any instances in blue with asteriks have a special tag that can either be specified in the audit command or will be defaulted to `no-reserved-instance`.
+Any running instances that are not matched with a reserved instance with show up as yellow, the reserved instances that are not matched with a running instance will show up in red, and any reserved instances and running instances that match will show up in green. Any instances in blue either have a special tag or are being ignored.
 
-To specify your own tag name, run:
+You can also audit just EC2 instances, just RDS instances, or just CacheInstances. To do this, use `--ec2`, `--rds`, and `--cache` respectively. Or, you can use the audit account to just show counts of reserved instances and reserved instances. To do that, use the `--reserved` and `--instances` options.
 
-    $ sport-ngin-aws-auditor audit --tag=your_custom_tag account1
+The tag can be specified through the `--tag=tag_name` option. Or, it will be defaulted to 'no-reserved-instance'. This means that when an instance is found that contains the tag 'no-reserved-instance', it will evaluate it separately from the other running instances, and list it in blue.
 
-If you don't want to use any tag at all, run:
+If a user wants to completely ignore tags, then use the `--no_tag` switch to turn tags off.
 
-    $ sport-ngin-aws-auditor audit --no_tag account1
+If an instance is ignored, it means that the name of the instance matches one of the ignore_instances_patterns. These patterns can be specified through the `--ignore_instances_patterns='string1, string2, string3'` flag, or they will be defaulted to 'kitchen' and 'auto'. Like the tagged instances, if an instance name matches one of these patterns, it will be listed separately and not used in calculating red/yellow/green instances.
+
+To ignore instance regexes, pass in an empty string or nil as the instances.
 
 To print a condensed version of the discrepancies to a Slack account (instead of printing to the terminal), run:
 
@@ -92,6 +108,8 @@ The default is for the file to be called `.aws_auditor.yml` in your home directo
 
 The webhook urls for slack can be obtained [here](https://api.slack.com/incoming-webhooks).
 
+In AWS, when booting reserved instances, a user can choose between an availability zone RI, where the RI will cover an instance in that specific zone, such as us-east-1b, or it can be a region RI, where it will just cover any instance in the region us-east-1 (that matches in size, of course). Therefore, there are two ways to audit the data to account for this. To print the data with zones, use the `--zone_output` option. Without the `--zone_output`, the data will ignore zone-based data to just print region-based data. 
+
 ### The Inspect Command
 
 To list information about all running instances in your account, run:

data/lib/sport_ngin_aws_auditor/rds_instance.rb

@@ -30,11 +30,12 @@ module SportNginAwsAuditor
       end
     end
 
-    attr_accessor :id, :name, :multi_az, :scope, :instance_type, :engine, :count, :tag_value, :tag_reason, :expiration_date
+    attr_accessor :id, :name, :multi_az, :scope, :instance_type, :engine, :count, :tag_value, :tag_reason, :expiration_date, :availability_zone
     def initialize(rds_instance, account_id=nil, tag_name=nil, client=nil)
       if rds_instance.class.to_s == "Aws::RDS::Types::ReservedDBInstance"
         self.id = rds_instance.reserved_db_instances_offering_id
         self.scope = nil
+        self.availability_zone = nil
         self.multi_az = rds_instance.multi_az ? "Multi-AZ" : "Single-AZ"
         self.instance_type = rds_instance.db_instance_class
         self.engine = engine_helper(rds_instance.product_description)
@@ -44,6 +45,7 @@ module SportNginAwsAuditor
         self.id = rds_instance.db_instance_identifier
         self.name = rds_instance.db_name
         self.scope = nil
+        self.availability_zone = rds_instance.availability_zone
         self.multi_az = rds_instance.multi_az ? "Multi-AZ" : "Single-AZ"
         self.instance_type = rds_instance.db_instance_class
         self.engine = engine_helper(rds_instance.engine)

data/lib/sport_ngin_aws_auditor/scripts/audit.rb

@@ -124,7 +124,7 @@ module SportNginAwsAuditor
           if tag.reason
             description ="#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value} because #{tag.reason}\n"
           else
-            description = "#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value}"
+            description = "#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value}\n"
           end
 
           @message << description.colorize(:color => color)

data/lib/sport_ngin_aws_auditor/version.rb

@@ -1,3 +1,3 @@
 module SportNginAwsAuditor
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 end

data/spec/sport_ngin_aws_auditor/rds_instance_spec.rb

@@ -58,6 +58,7 @@ module SportNginAwsAuditor
         expect(instance.multi_az).to eq("Single-AZ")
         expect(instance.instance_type).to eq("db.t2.small")
         expect(instance.engine).to eq("MySQL")
+        expect(instance.availability_zone).to eq('us-east-1a')
       end
     end
 
@@ -100,6 +101,7 @@ module SportNginAwsAuditor
         expect(reserved_instance.multi_az).to eq("Single-AZ")
         expect(reserved_instance.instance_type).to eq("db.t2.small")
         expect(reserved_instance.engine).to eq("Oracle SE Two")
+        expect(reserved_instance.availability_zone).to eq(nil)
       end
 
       context "for retired_reserved_rds_instances" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sport_ngin_aws_auditor
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Elliot Hursh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk