capify-ec2 1.4.3 → 1.4.4

data/Changelog.md

@@ -1,3 +1,14 @@
+## 1.4.4 (May 15, 2013)
+
+Features:
+
+  - The EC2 instance tag used to determine instance options can now be customised. Defaults to 'Options' if this setting is ommited.
+  - If the 'Roles' or 'Options' tags are customised, this custom text will be used as the appropriate column headers in the 'ec2:status' command.
+
+Bugfixes:
+
+  - Fix some issues with customised 'Roles' tags not being respected in all situations.
+
 ## 1.4.3 (Apr 19, 2013)
 
 Summary of the changes merged from the 'rolling_deploy' branch, from v1.4.0.pre1 to v1.4.3.pre7.

data/lib/capify-ec2.rb

@@ -5,7 +5,7 @@ require File.expand_path(File.dirname(__FILE__) + '/capify-ec2/server')
 
 class CapifyEc2
 
-  attr_accessor :load_balancer, :instances
+  attr_accessor :load_balancer, :instances, :ec2_config
   
   unless const_defined? :SLEEP_COUNT
     SLEEP_COUNT = 5
@@ -25,6 +25,9 @@ class CapifyEc2
     @ec2_config[:project_tags] ||= []
     # User can change the Roles tag string
     @ec2_config[:aws_roles_tag] ||= "Roles"
+    # User can change the Options tag string.
+    @ec2_config[:aws_options_tag] ||= "Options"
+
     @ec2_config[:project_tags] << @ec2_config[:project_tag] if @ec2_config[:project_tag]
     
     regions = determine_regions()
@@ -51,36 +54,36 @@ class CapifyEc2
     end
     
     # Set minimum widths for the variable length instance attributes.
-    column_widths = { :name_min => 4, :type_min => 4, :dns_min => 5, :roles_min => 5, :options_min => 6 }
+    column_widths = { :name_min => 4, :type_min => 4, :dns_min => 5, :roles_min => @ec2_config[:aws_roles_tag].length, :options_min => @ec2_config[:aws_options_tag].length }
 
     # Find the longest attribute across all instances, to format the columns properly.
-    column_widths[:name]    = desired_instances.map{|i| i.name.to_s.ljust( column_widths[:name_min] )                               || ' ' * column_widths[:name_min]    }.max_by(&:length).length
-    column_widths[:type]    = desired_instances.map{|i| i.flavor_id                                                                 || ' ' * column_widths[:type_min]    }.max_by(&:length).length
-    column_widths[:dns]     = desired_instances.map{|i| i.contact_point.to_s.ljust( column_widths[:dns_min] )                       || ' ' * column_widths[:dns_min]     }.max_by(&:length).length
-    column_widths[:roles]   = desired_instances.map{|i| i.tags[@ec2_config[:aws_roles_tag]].to_s.ljust( column_widths[:roles_min] ) || ' ' * column_widths[:roles_min]   }.max_by(&:length).length
-    column_widths[:options] = desired_instances.map{|i| i.tags["Options"].to_s.ljust( column_widths[:options_min] )                 || ' ' * column_widths[:options_min] }.max_by(&:length).length
+    column_widths[:name]    = desired_instances.map{|i| i.name.to_s.ljust( column_widths[:name_min] )                                   || ' ' * column_widths[:name_min]    }.max_by(&:length).length
+    column_widths[:type]    = desired_instances.map{|i| i.flavor_id                                                                     || ' ' * column_widths[:type_min]    }.max_by(&:length).length
+    column_widths[:dns]     = desired_instances.map{|i| i.contact_point.to_s.ljust( column_widths[:dns_min] )                           || ' ' * column_widths[:dns_min]     }.max_by(&:length).length
+    column_widths[:roles]   = desired_instances.map{|i| i.tags[@ec2_config[:aws_roles_tag]].to_s.ljust( column_widths[:roles_min] )     || ' ' * column_widths[:roles_min]   }.max_by(&:length).length
+    column_widths[:options] = desired_instances.map{|i| i.tags[@ec2_config[:aws_options_tag]].to_s.ljust( column_widths[:options_min] ) || ' ' * column_widths[:options_min] }.max_by(&:length).length
 
     # Title row.
     puts sprintf "%-3s   %s   %s   %s   %s   %s   %s   %s", 
-      'Num'                                     .bold,
-      'Name'   .ljust( column_widths[:name]    ).bold,
-      'ID'     .ljust( 10                      ).bold,
-      'Type'   .ljust( column_widths[:type]    ).bold,
-      'DNS'    .ljust( column_widths[:dns]     ).bold,
-      'Zone'   .ljust( 10                      ).bold,
-      'Roles'  .ljust( column_widths[:roles]   ).bold,
-      'Options'.ljust( column_widths[:options] ).bold
+      'Num'                                                         .bold,
+      'Name'                       .ljust( column_widths[:name]    ).bold,
+      'ID'                         .ljust( 10                      ).bold,
+      'Type'                       .ljust( column_widths[:type]    ).bold,
+      'DNS'                        .ljust( column_widths[:dns]     ).bold,
+      'Zone'                       .ljust( 10                      ).bold,
+      @ec2_config[:aws_roles_tag]  .ljust( column_widths[:roles]   ).bold,
+      @ec2_config[:aws_options_tag].ljust( column_widths[:options] ).bold
 
     desired_instances.each_with_index do |instance, i|
       puts sprintf "%02d:   %-10s   %s   %s   %s   %-10s   %s   %s",
         i, 
-        (instance.name || '')                             .ljust( column_widths[:name]    ).green,
-        instance.id                                       .ljust( 2                       ).red,
-        instance.flavor_id                                .ljust( column_widths[:type]    ).cyan,
-        instance.contact_point                            .ljust( column_widths[:dns]     ).blue.bold,
-        instance.availability_zone                        .ljust( 10                      ).magenta,
-        (instance.tags[@ec2_config[:aws_roles_tag]] || '').ljust( column_widths[:roles]   ).yellow,
-        (instance.tags["Options"] || '')                  .ljust( column_widths[:options] ).yellow
+        (instance.name || '')                               .ljust( column_widths[:name]    ).green,
+        instance.id                                         .ljust( 2                       ).red,
+        instance.flavor_id                                  .ljust( column_widths[:type]    ).cyan,
+        instance.contact_point                              .ljust( column_widths[:dns]     ).blue.bold,
+        instance.availability_zone                          .ljust( 10                      ).magenta,
+        (instance.tags[@ec2_config[:aws_roles_tag]] || '')  .ljust( column_widths[:roles]   ).yellow,
+        (instance.tags[@ec2_config[:aws_options_tag]] || '').ljust( column_widths[:options] ).yellow
     end
   end
 
@@ -102,7 +105,7 @@ class CapifyEc2
   
   def get_instances_by_region(roles, region)
     return unless region
-    desired_instances.select {|instance| instance.availability_zone.match(region) && instance.tags['Roles'].split(%r{,\s*}).include?(roles.to_s) rescue false}
+    desired_instances.select {|instance| instance.availability_zone.match(region) && instance.tags[@ec2_config[:aws_roles_tag]].split(%r{,\s*}).include?(roles.to_s) rescue false}
   end 
   
   def get_instance_by_name(name)

data/lib/capify-ec2/capistrano.rb

@@ -70,13 +70,15 @@ Capistrano::Configuration.instance(:must_exist).load do
     puts "[Capify-EC2] Performing rolling deployment..."
 
     all_servers       = {}
-    all_roles         = {}
+    all_options       = {}
 
     roles.each do |role|
       role[1].servers.each do |s|
-        all_servers[ s.host.to_s ] ||= []
-        all_servers[ s.host.to_s ] << role[0]
-        all_roles[ role[0] ] = {:options => (s.options ||= nil)} unless all_roles[ role[0] ]
+        server_dns = s.host.to_s
+        all_servers[ server_dns ] ||= []
+        all_servers[ server_dns ] << role[0]
+        all_options[ role[0] ] ||= {}
+        all_options[ role[0] ][ server_dns ] = (s.options || {})
       end
     end
 
@@ -95,8 +97,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         is_load_balanced = false
 
         server_roles.each do |a_role|
-          role a_role, server_dns, all_roles[a_role][:options]
-          is_load_balanced = true if all_roles[a_role][:options][:load_balanced]
+          role a_role, server_dns, all_options[a_role][server_dns]
+          is_load_balanced = true if all_options[a_role][server_dns][:load_balanced]
         end
         
         puts "[Capify-EC2]"
@@ -110,8 +112,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         server_roles.each do |a_role|
         
           # If healthcheck(s) are defined for this role, run them.
-          if all_roles[a_role][:options][:healthcheck]
-            healthchecks_for_role = [ all_roles[a_role][:options][:healthcheck] ].flatten
+          if all_options[a_role][server_dns][:healthcheck]
+            healthchecks_for_role = [ all_options[a_role][server_dns][:healthcheck] ].flatten
 
             puts "[Capify-EC2] Starting #{pluralise(healthchecks_for_role.size, 'healthcheck')} for role '#{a_role}'..."
 
@@ -204,7 +206,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         if named_instance.respond_to?(:roles)
           roles = named_instance.roles
         else
-          roles = [named_instance.tags["Roles"]].flatten
+          roles = [named_instance.tags[ @ec2_config[:aws_roles_tag] ]].flatten
         end    
         
         roles.each do |role|
@@ -275,7 +277,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       cap_options
     end 
 
-    ec2_options = instance.tags["Options"] || ""
+    ec2_options = instance.tags[capify_ec2.ec2_config[:aws_options_tag]] || ""
     ec2_options.split(%r{,\s*}).compact.each { |ec2_option|  cap_options[ec2_option.to_sym] = true }
 
     variables.each do |key, value| 

data/lib/capify-ec2/version.rb

@@ -1,6 +1,6 @@
 module Capify
   module Ec2
-    VERSION = "1.4.3"
+    VERSION = "1.4.4"
   end
 end
 

data/readme.md

@@ -50,6 +50,14 @@ Note: 'aws_access_key_id', 'aws_secret_access_key', and 'region' are required. O
   When ':load_balanced' is set to 'true', Capify-EC2 uses pre and post-deploy hooks to deregister the instance from an associated Elastic Load Balancer, perform the actual deploy, then finally reregister with the ELB and validated the instance health.
   Note: This options only applies to deployments made to an individual instance, using the command 'cap INSTANCE_NAME_HERE deploy' - it doesn't apply to roles.
 
+* :aws_roles_tag
+
+  Use this option to change which EC2 instance tag Capify-EC2 uses to determine instance roles. Defaults to 'Roles' if ommited.
+
+* :aws_options_tag
+
+  Use this option to change which EC2 instance tag Capify-EC2 uses to determine instance options. Defaults to 'Options' if ommited.
+
 
 
 #### EC2 Tags

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capify-ec2
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: 
   segments: 
   - 1
   - 4
-  - 3
-  version: 1.4.3
+  - 4
+  version: 1.4.4
 platform: ruby
 authors: 
 - Noah Cantor
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-04-19 00:00:00 Z
+date: 2013-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fog