aws_tracker 0.0.1 → 0.0.2

data/.gitignore

@@ -7,6 +7,7 @@ pkg/*
 *.tmproj
 config/database.yml
 config/tracker_db.yml
+config/accounts.yml
 db/*.sqlite3
 log/*.log
 tmp/**/*

data/README.md

@@ -41,18 +41,25 @@ Usage [from the command line]
 
 2) Create the database to contain the data. This is not necessary if using sqlite.
 
-3) To store your AWS account information in the database, export the credentials as environment variables. This is only needed the first time you run.
+3) The AWS Account information is stored in a (YAML) configuration file. Name this `accounts.yml` and store it alongside the above `tracker_db.yml` file.
 
-    export AWS_ACCOUNT_NUMBER=[your AWS account number]
-    export AWS_ACCESS_KEY_ID=[your EC2 access key ID]
-    export AWS_ACCESS_KEY_SECRET=[your EC2 access key secret]
+    development account:
+      account_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      access_key_id: xxxxxxxxxxxxxxxxxxxx
+      secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+    testing account:
+      account_id: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+      access_key_id: xxxxxxxxxxxxxxxxxxxx
+      secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+  When the tracker command-line program runs, these accounts are written into the database, but without the secret information. This allows external processes to read the AWS state database safely.
     
 4) Run the tracker, and point it at the database config file
 
-    tracker tracker_db.yml --migrate --create-account
+    tracker tracker_db.yml --migrate
 
-  * The `--migrate` argument updates the database to the latest version of the schema, and is only necessary for new databases, or when upgrading to a new version of the Tracker gem.  
-  * The `--create-account` argument stores the above environment values as an AWSAccount object in the tracker database.
+  The `--migrate` argument updates the database to the latest version of the schema, and is only necessary for new databases, or when upgrading to a new version of the Tracker gem.  
 
 
 ----------------
@@ -77,14 +84,14 @@ Usage [from within Ruby]
   * AWSTracker::Instance
   * AWSTracker::EBSVolume
 
-But first, you need to create an AWSAccount, and use a Tracker object to fetch its status from AWS:
+4) Then load your AWSAccounts from YAML, and use a Tracker object to fetch their status from AWS:
 
-    include AWSTracker          # Load model class names into namespace
-    a = AWSAccount.from_memory  # Create an account (see command-line usage)
-    a.save!                     # Save it in the database
-    t = Tracker.new             # A Tracker updates all accounts in the DB
-    t.delay = 15                # Update every 15 seconds
-    t.start                     # Runs in the background. Call 'stop' later
+    include AWSTracker            # Load model class names into namespace
+    accounts = AWSAccount.from_yaml_file('config/accounts.yml')
+    accounts.each {|a| a.save!}   # Save them in the database
+    t = Tracker.new               # A Tracker updates all accounts in the DB
+    t.delay = 15                  # Update every 15 seconds
+    t.start                       # Runs in the background. Call 'stop' later
 
 
 ----------------

data/aws_tracker.gemspec

@@ -29,5 +29,6 @@ Gem::Specification.new do |s|
   # Development / Test dependencies
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "bundler"
 
 end

data/bin/tracker

@@ -4,7 +4,7 @@
 #   Monitors one or more AWS accounts and pushes their status into a database.
 #
 # == Usage 
-#   tracker.rb [options] DB_CONFIG_FILE.YML
+#   tracker.rb [options] DB_CONFIG_FILE.YML [ACCOUNTS.YML]
 #
 # == Options (all options can be put into the config file)
 #   -d, --delay [INTEGER]       Seconds between status updates. default = 180
@@ -36,11 +36,11 @@ class AWSTrackerConsoleApp
     }
     parse_options
     (@log.error "A database config file must be specified" ; exit) if ARGV.empty?
-    db_config_file = ARGV.first
-    @log.info "Loading database configuration from #{db_config_file}"
-    db_config = YAML::load(File.open(db_config_file))
+    @db_config_file = ARGV.first
+    @log.info "Loading database configuration from #{@db_config_file}"
+    db_config = YAML::load(File.open(@db_config_file))
     connect_to_database(db_config)
-    create_account if @opts[:create_account]
+    sync_accounts
     go
   end
 
@@ -52,6 +52,23 @@ class AWSTrackerConsoleApp
     require 'aws_tracker'
   end
 
+  def sync_accounts
+    new_accounts = accounts_from_yaml
+    if @opts[:create_account]
+      new_accounts << AWSTracker::AWSAccount.from_memory
+    end
+    existing_accounts = AWSTracker::AWSAccount.all
+    new_accounts.each do |a|
+      @log.info "Syncing account #{a.name} into database..."
+      write_account = 
+        AWSTracker::AWSAccount.find_or_initialize_by_account_id(a.account_id)
+      write_account.name = a.name
+      write_account.access_key_id = a.access_key_id
+      write_account.secret_access_key = a.secret_access_key
+      write_account.save!
+    end
+  end
+
   def go
     @tracker = AWSTracker::Tracker.new(:logger => @log)
     @tracker.delay = @opts[:delay]
@@ -92,11 +109,11 @@ class AWSTrackerConsoleApp
     ActiveRecord::Migrator.migrate migration_dir
   end
 
-  def create_account
-    @log.info "Creating account from environment..."
-    a = AWSTracker::AWSAccount.from_memory
-    a.log.info "Loaded account #'#{a.account_id}' from memory"
-    a.save!
+  def accounts_from_yaml
+    accounts_file = ARGV[1] || File.expand_path(
+      File.join(File.dirname(@db_config_file), 'accounts.yml'))
+    @log.info "Loading accounts from #{accounts_file}..."
+    AWSTracker::AWSAccount.from_yaml_file accounts_file
   end
 
 end

data/config/accounts.yml.example

@@ -0,0 +1,9 @@
+development account:
+  account_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+  access_key_id: xxxxxxxxxxxxxxxxxxxx
+  secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+testing account:
+  account_id: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+  access_key_id: xxxxxxxxxxxxxxxxxxxx
+  secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

data/db/migrate/20110427222809_remove_aws_creds.rb

@@ -0,0 +1,14 @@
+class RemoveAwsCreds < ActiveRecord::Migration
+  def self.up
+    change_table :aws_accounts do |t|
+      t.remove :access_key_id, :secret_access_key
+    end
+  end
+
+  def self.down
+    change_table :aws_accounts do |t|
+      t.string :access_key_id
+      t.string :secret_access_key
+    end
+  end
+end

data/lib/aws_tracker/models/_taggable.rb

@@ -0,0 +1,13 @@
+module AWSTracker
+  module Taggable
+    
+    # returns the collection of AWSTracker::Tags as a Hash
+    def tag_hash
+      Tag.where(:resource_id => self).inject({}) do |hash, tag|
+        hash[tag.key] = tag.value
+        hash
+      end
+    end
+
+  end
+end

data/lib/aws_tracker/models/aws_account.rb

@@ -1,15 +1,19 @@
 require 'right_aws'
+require 'yaml'
 
 module AWSTracker
   class AWSAccount < ActiveRecord::Base
 
+    # Credentials - these must be loaded from YAML or set programmatically
+    attr_accessor               :access_key_id, :secret_access_key
+
     # Relationships
     has_many :instances,        :dependent => :destroy
     has_many :security_groups,  :dependent => :destroy
     has_many :ebs_volumes,      {:dependent => :destroy, :class_name  => 'EBSVolume'}
     has_many :tags,             :dependent => :destroy
     # Validations
-    validates_presence_of :account_id, :access_key_id, :secret_access_key
+    validates_presence_of :account_id
     validates_uniqueness_of :name, :account_id
 
     # Configure logging
@@ -65,5 +69,18 @@ module AWSTracker
       end
     end
     
+    # Returns an Array of AWSAccount objects created from a YAML file
+    def self.from_yaml_file(yaml_file)
+      account_hash = YAML::load(File.open(yaml_file)).to_hash
+      account_hash.map do |name, hash|
+        AWSAccount.new({
+          :name               => name,
+          :account_id         => hash["account_id"],
+          :access_key_id      => hash["access_key_id"],
+          :secret_access_key  => hash["secret_access_key"],
+        })
+      end
+    end
+
   end
 end

data/lib/aws_tracker/models/ebs_volume.rb

@@ -6,6 +6,7 @@ module AWSTracker
       :foreign_key => "aws_account_id"
     belongs_to :instance
     has_many :tags, :as => :resource, :dependent => :destroy
+    include AWSTracker::Taggable
 
     validates_presence_of :account, :volume_id, :size, :status
     validates_uniqueness_of :volume_id

data/lib/aws_tracker/models/instance.rb

@@ -7,6 +7,7 @@ module AWSTracker
     has_and_belongs_to_many :security_groups
     has_many :ebs_volumes, :class_name  => 'EBSVolume'
     has_many :tags, :as => :resource, :dependent => :destroy
+    include AWSTracker::Taggable
 
     validates_presence_of :account, :instance_id, :image_id, :instance_state
     validates_uniqueness_of :instance_id

data/lib/aws_tracker/version.rb

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

data/spec/lib/aws_tracker/models/aws_account_spec.rb

@@ -21,14 +21,13 @@ module AWSTracker
       @account.should_not be_valid
     end
 
-    it "is not valid without an access key" do
-      @account.access_key_id = nil
-      @account.should_not be_valid
-    end
-
-    it "is not valid without a secret access key" do
-      @account.secret_access_key = nil
-      @account.should_not be_valid
+    describe "#from_yaml_file" do
+      it "creates an Array of AWSAccounts from a YAML file" do
+        yaml_path = '../../../../../config/accounts.yml.example'
+        accounts = AWSAccount.from_yaml_file File.expand_path(yaml_path,__FILE__)
+        accounts.should_not be_empty
+        accounts.first.should be_an_instance_of AWSAccount
+      end
     end
 
     describe "#update_instances" do

data/spec/lib/aws_tracker/models/ebs_volume_spec.rb

@@ -47,6 +47,18 @@ module AWSTracker
       @volume.should_not be_valid
     end
 
+    describe "#tag_hash" do
+      it "should return its Tags as a Hash" do
+        @volume.tags.create!({
+          :key => "TAG_KEY", :value => "TAG_VALUE",
+          :account => @account
+        })
+        tags = @volume.tag_hash
+        tags.should be_an_instance_of(Hash)
+        tags["TAG_KEY"].should == "TAG_VALUE"
+      end
+    end
+
     describe "#refresh_from_account" do
       it "should fetch a list of EBS Volumes from AWS" do
         @account.ebs_volumes.delete_all

data/spec/lib/aws_tracker/models/instance_spec.rb

@@ -43,6 +43,18 @@ module AWSTracker
       @instance.should_not be_valid
     end
 
+    describe "#tag_hash" do
+      it "should return its Tags as a Hash" do
+        @instance.tags.create!({
+          :key => "TAG_KEY", :value => "TAG_VALUE",
+          :account => @account
+        })
+        tags = @instance.tag_hash
+        tags.should be_an_instance_of(Hash)
+        tags["TAG_KEY"].should == "TAG_VALUE"
+      end
+    end
+
     describe "#refresh_from_account" do
       it "should fetch a list of Instances from AWS" do
         @account.instances.clear

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aws_tracker
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Benton Roberts
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 -04:00
-default_executable: 
+date: 2011-04-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: activerecord
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,11 +29,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   requirement: *id001
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: right_aws
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   requirement: *id002
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: sqlite3
+  type: :runtime
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -59,11 +57,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
   name: rake
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -73,11 +71,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
   name: rspec
+  type: :development
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -87,7 +85,22 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  prerelease: false
   requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id006
 description: This gem peridically queries AWS for information about Instances, SecurityGroups, EBSVolumes, etc., and saves the data as interconnected ActiveRecord objects.aws_tracker
 email: 
 - benton@bentonroberts.com
@@ -105,6 +118,7 @@ files:
 - Rakefile
 - aws_tracker.gemspec
 - bin/tracker
+- config/accounts.yml.example
 - config/database.yml.example
 - db/migrate/20110331145142_create_aws_accounts.rb
 - db/migrate/20110331152735_create_instances.rb
@@ -112,7 +126,9 @@ files:
 - db/migrate/20110403060000_create_instance_groups.rb
 - db/migrate/20110404014218_create_ebs_volumes.rb
 - db/migrate/20110408193824_create_tags.rb
+- db/migrate/20110427222809_remove_aws_creds.rb
 - lib/aws_tracker.rb
+- lib/aws_tracker/models/_taggable.rb
 - lib/aws_tracker/models/aws_account.rb
 - lib/aws_tracker/models/ebs_volume.rb
 - lib/aws_tracker/models/instance.rb
@@ -132,7 +148,6 @@ files:
 - spec/spec_helper.rb
 - spec/support/_configure_logging.rb
 - spec/support/create_testing_objects.rb
-has_rdoc: true
 homepage: http://github.com/benton/aws_tracker
 licenses: []
 
@@ -162,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: aws_tracker
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Models the state of Amazon Web Services accounts in ActiveRecord