ey_cloud_awareness 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,17 +1,92 @@
 = ey_cloud_awareness
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+Make your EngineYard cloud instances aware of each other.
+
+Never download a new <tt>deploy.rb</tt> again.
+
+== Quick start
+
+Put this in <tt>config/environment.rb</tt>:
+
+  config.gem 'ey_cloud_awareness', :version => '[WHATEVER THE CURRENT GEM VERSION IS]', :lib => false, :source => 'http://gemcutter.org'
+
+Put this in your <tt>config/deploy.rb</tt> (or wherever your deploy-related Capfile is):
+
+  load "#{Gem.searcher.find('ey_cloud_awareness').full_gem_path}/lib/tasks/capistrano_tasks.rb"
+
+  task :my_app_production do
+    role :app_master, 'my_app.com'          # or you can use its Elastic IP
+    set :rails_env, 'production'            # required
+    set :deploy_to, '/data/my_app'          # required
+    find_and_execute_task 'eyc_setup'       # note that we don't use eyc: namespace
+  end
+
+  task :my_app_staging do
+    role :app_master, 'staging.my_app.com'  # or you can use its Elastic IP
+    set :rails_env, 'production'            # required
+    set :deploy_to, '/data/my_app'          # required
+    find_and_execute_task 'eyc_setup'       # note that we don't use eyc: namespace
+  end
+  
+  # add more tasks if you have more cloud environments
+
+Now you should be able to eycap stuff like:
+
+  cap my_app_production monit:status
+
+...and <b>capistrano will always have a fresh list of your environment's instances</b>. Roles like <tt>:app</tt>, <tt>:db</tt>, and <tt>:utility</tt> are set properly.
+
+== Just dumping information about your instances
+
+Once you've done the quickstart, try:
+
+  cap my_app_production eyc:app         # gets a list of your app instances, including app_master
+  cap my_app_production eyc:utility     # ditto for utility instances
+  cap my_app_production eyc:db          # gets your master db instance (FIXME: I don't think it will find slaves)
+  cap my_app_production eyc:all         # gets a list of all your instances
+
+== Using the EngineYardCloudInstance class inside Rails
+
+I run a memcached server on every app instance, so I have this in <tt>config/environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    [...]
+    config.cache_store = :mem_cache_store, EngineYardCloudInstance.app.map { |i| "#{i.private_dns_name}:11211" }
+    [...]
+  end
+
+Or whatever you want:
+
+  >> all_app_instances = EngineYardCloudInstance.app      
+  => [#<EngineYardCloudInstance:0xb5e12f70 @instance_id="i-50cf5838">, #<EngineYardCloudInstance:0xb5e12f5c @instance_id="i-dc9207b4">, #<EngineYardCloudInstance:0xb5e12f34 @instance_id="i-b2d84fda">]
+  >> all_app_instances.first.dns_name
+  => "ec2-67-202-43-40.compute-1.amazonaws.com"
+  >> pp all_app_instances.first.to_hash
+  {:dns_name=>"ec2-67-202-43-40.compute-1.amazonaws.com",
+   :instance_role=>"app",
+   :aws_groups=>["ey-app1_production-1256085955-3205-13340"],
+   :aws_instance_id=>"i-50cf5838",
+   :private_dns_name=>"domU-12-31-39-01-99-D3.compute-1.internal",
+   :aws_state=>"running"}
+  => nil
+
+== A note on EngineYard dependence
+
+This gem depends on
+
+  /etc/chef/dna.json
+
+being present and containing certain attributes as named by EngineYard. Please let me know if something changes.
+
+== A note on caching and network needs
+
+I tried to be smart about caching the results of network calls.
+
+Stuff like the current instance id, which is pulled from an EC2 metadata server, is stored in
+
+  CURRENT_INSTANCE_ID_CACHE_PATH = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config/engine_yard_cloud_instance_id" : '/etc/engine_yard_cloud_instance_id'
+
+Please let me know if this causes problems.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/ey_cloud_awareness.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ey_cloud_awareness}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seamus Abshere"]
-  s.date = %q{2009-11-03}
+  s.date = %q{2009-11-04}
   s.description = %q{Make your EngineYard cloud instances aware of each other.}
   s.email = %q{seamus@abshere.net}
   s.extra_rdoc_files = [
@@ -26,6 +26,8 @@ Gem::Specification.new do |s|
      "ey_cloud_awareness.gemspec",
      "lib/engine_yard_cloud_instance.rb",
      "lib/ey_cloud_awareness.rb",
+     "lib/tasks/capistrano_tasks.rb",
+     "lib/tasks/ey_cloud_awareness.rake",
      "spec/ey_cloud_awareness_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"

data/lib/engine_yard_cloud_instance.rb

@@ -1,23 +1,28 @@
 class EngineYardCloudInstance
   CURRENT_INSTANCE_ID_CACHE_PATH = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config/engine_yard_cloud_instance_id" : '/etc/engine_yard_cloud_instance_id'
+  CURRENT_SECURITY_GROUPS_CACHE_PATH = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config/engine_yard_cloud_security_groups" : '/etc/engine_yard_cloud_security_groups'
   INSTANCE_DESCRIPTIONS_CACHE_PATH = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/config/engine_yard_cloud_instance_descriptions.yml" : '/etc/engine_yard_cloud_instance_descriptions.yml'
   DNA_PATH = '/etc/chef/dna.json'
   
   attr_reader :instance_id
   def initialize(instance_id)
-    @instance_id = instance_id.to_sym
+    @instance_id = instance_id.to_s
   end
   
   def valid?
     data.present?
   end
   
-  def refresh
-    self.class.refresh
+  def clear
+    self.class.clear
+  end
+  
+  def to_hash
+    data.deep_copy
   end
   
   def data
-    self.class.data[instance_id]
+    self.class.data[instance_id.to_sym]
   end
   
   def method_missing(name, *args, &block)
@@ -29,7 +34,20 @@ class EngineYardCloudInstance
     end
   end
   
+  class_inheritable_accessor :proxy
+  
   class << self
+    def to_hash
+      clear
+      data.deep_copy
+    end
+    
+    def from_hash(hash)
+      self.proxy = true
+      @_data = hash.recursive_symbolize_keys!
+      self
+    end
+    
     def app
       find_all_by_instance_roles :app, :app_master
     end
@@ -59,58 +77,73 @@ class EngineYardCloudInstance
     end
     
     def find_all_by_instance_roles(*args)
-      data.select { |_, v| Array.wrap(args).include? v[:instance_role] }.map { |k, _| new k }
+      data.select { |_, v| Array.wrap(args).map(&:to_s).include? v[:instance_role] }.map { |k, _| new k }
     end
     
-    def refresh
+    def clear
+      raise "[EY CLOUD AWARENESS GEM] Can't clear if we used from_hash" if self.proxy
       @_data = nil
       @_dna = nil
       cached_instance_descriptions true
+      cached_current_security_groups true
       cached_current_instance_id true
     end
     
     def data
       return @_data if @_data
+      raise "[EY CLOUD AWARENESS GEM] Can't calculate data if we used from_hash" if self.proxy
       hash = Hash.new
       cached_instance_descriptions.each do |instance_description|
+        next unless Set.new(Array.wrap(cached_current_security_groups)).superset? Set.new(instance_description[:aws_groups])
         hash[instance_description[:aws_instance_id]] ||= Hash.new
         current = hash[instance_description[:aws_instance_id]]
         # using current as a pointer
         if dna[:db_host] == instance_description[:dns_name] or dna[:db_host] == instance_description[:private_dns_name]
-          current[:instance_role] = :db
+          current[:instance_role] = 'db'
         elsif Array.wrap(dna[:utility_instances]).include? instance_description[:private_dns_name]
-          current[:instance_role] = :utility
+          current[:instance_role] = 'utility'
         elsif dna[:master_app_server][:private_dns_name] == instance_description[:private_dns_name]
-          current[:instance_role] = :app_master
-        else
-          current[:instance_role] = :app
+          current[:instance_role] = 'app_master'
+        elsif instance_description[:aws_state] == 'running'
+          current[:instance_role] = 'app'
         end
         current[:private_dns_name] = instance_description[:private_dns_name]
         current[:dns_name] = instance_description[:dns_name]
         current[:aws_state] = instance_description[:aws_state]
+        current[:aws_groups] = instance_description[:aws_groups]
+        current[:aws_instance_id] = instance_description[:aws_instance_id]
       end
       @_data = hash.recursive_symbolize_keys!
     end
     
     def dna
+      raise "[EY CLOUD AWARENESS GEM] Can't see DNA if we used from_hash" if self.proxy
       @_dna ||= JSON.load(IO.read(DNA_PATH)).recursive_symbolize_keys!
     end
     
     private
     
-    def cached_current_instance_id(refresh = false)
-      if refresh or !File.readable?(CURRENT_INSTANCE_ID_CACHE_PATH)
-        @_cached_current_instance_id = open("http://169.254.169.254/latest/meta-data/instance-id").gets
-        begin
-          File.open(CURRENT_INSTANCE_ID_CACHE_PATH, 'w') { |f| f.write @_cached_current_instance_id }
-        rescue Errno::EACCES
-          $stderr.puts "[EY CLOUD AWARENESS GEM] Not caching current instance id because #{CURRENT_INSTANCE_ID_CACHE_PATH} can't be written to"
+    # def cached_current_instance_id
+    # def cached_current_security_groups
+    %w{ current_instance_id current_security_groups }.each do |name|
+      eval %{
+        def cached_#{name}(refresh = false)
+          raise "[EY CLOUD AWARENESS GEM] Can't call #{name} if we used from_hash" if self.proxy
+          if refresh or !File.readable?(#{name.upcase}_CACHE_PATH)
+            @_cached_#{name} = open("http://169.254.169.254/latest/meta-data/#{name.gsub('current_', '').dasherize}").gets
+            begin
+              File.open(#{name.upcase}_CACHE_PATH, 'w') { |f| f.write @_cached_#{name} }
+            rescue Errno::EACCES
+              $stderr.puts "[EY CLOUD AWARENESS GEM] Not caching #{name.humanize.downcase} because \#{#{name.upcase}_CACHE_PATH} can't be written to"
+            end
+          end
+          @_cached_#{name} ||= IO.read(#{name.upcase}_CACHE_PATH)
         end
-      end
-      @_cached_current_instance_id ||= IO.read(CURRENT_INSTANCE_ID_CACHE_PATH)
+      }
     end
     
     def cached_instance_descriptions(refresh = false)
+      raise "[EY CLOUD AWARENESS GEM] Can't call cached_instance_descriptions if we used from_hash" if self.proxy
       if refresh or !File.readable?(INSTANCE_DESCRIPTIONS_CACHE_PATH)
         ec2 = RightAws::Ec2.new dna[:aws_secret_id], dna[:aws_secret_key]
         @_cached_instance_descriptions = ec2.describe_instances.map(&:recursive_symbolize_keys!)

data/lib/ey_cloud_awareness.rb

@@ -1,4 +1,5 @@
 require 'open-uri'
+require 'set'
 require 'active_support'
 require 'right_aws'
 require File.expand_path(File.join(File.dirname(__FILE__), 'engine_yard_cloud_instance'))
@@ -10,4 +11,8 @@ class Hash
     values.select { |v| v.is_a?(Hash) }.each { |h| h.recursive_symbolize_keys! }
     self
   end
+  
+  def deep_copy
+    Marshal.load(Marshal.dump(self))
+  end
 end

data/lib/tasks/capistrano_tasks.rb

@@ -0,0 +1,39 @@
+require 'ey_cloud_awareness'
+require 'pp'
+
+task :eyc_setup, :roles => :app_master do
+  version = Gem.searcher.find('ey_cloud_awareness').version.to_s
+  begin
+    run "gem list ey_cloud_awareness --installed --version #{version}"
+  rescue
+    $stderr.puts "[EY CLOUD AWARENESS GEM] app_master doesn't have ey_cloud_awareness --version #{version} installed. You need to have the exact same version installed."
+    raise $!
+  end
+
+  upload File.expand_path(File.join(File.dirname(__FILE__), 'ey_cloud_awareness.rake')), "#{deploy_to}/current/lib/tasks/ey_cloud_awareness.rake"
+  
+  output = capture("cd #{deploy_to}/current && rake --silent eyc:to_json RAILS_ENV=#{rails_env}").gsub(/\s+/, ' ')
+  if /(\{.*\})/.match(output)
+    begin
+      set :eyc_proxy, EngineYardCloudInstance.from_hash(ActiveSupport::JSON.decode($1))
+    rescue
+      $stderr.puts "[EY CLOUD AWARENESS GEM] Couldn't parse JSON, so just dumping what we got"
+      $stderr.puts $1
+      raise $!
+    end
+  else
+    $stderr.puts "[EY CLOUD AWARENESS GEM] Didn't get JSON we recognized back, just dumping what we got"
+    $stderr.puts output
+    raise
+  end
+  eyc_proxy.app.each { |i| role :app, i.dns_name }
+  eyc_proxy.db.each { |i| role :db, i.dns_name }
+end
+
+namespace :eyc do
+  %w{ app db utility all first }.each do |name|
+    task name, :roles => :app_master do
+      pp eyc_proxy.send(name).map(&:to_hash)
+    end
+  end
+end

data/lib/tasks/ey_cloud_awareness.rake

@@ -0,0 +1,7 @@
+require 'ey_cloud_awareness'
+
+namespace :eyc do
+  task :to_json do
+    puts EngineYardCloudInstance.to_hash.to_json
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ey_cloud_awareness
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 -05:00
+date: 2009-11-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,6 +61,8 @@ files:
 - ey_cloud_awareness.gemspec
 - lib/engine_yard_cloud_instance.rb
 - lib/ey_cloud_awareness.rb
+- lib/tasks/capistrano_tasks.rb
+- lib/tasks/ey_cloud_awareness.rake
 - spec/ey_cloud_awareness_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb