capify-ec2 1.5.1 → 1.5.2

data/Changelog.md

@@ -1,3 +1,10 @@
+## 1.5.2 (Oct 2, 2013)
+
+Features:
+
+  - The current and total servers will now be displayed during rolling deployments, to help track progress.
+  - Added support for 'ssh_options[:keys]'' being an array or a string.
+
 ## 1.5.1 (Sep 2, 2013)
 
 Bugfixes:

data/lib/capify-ec2/capistrano.rb

@@ -2,13 +2,13 @@ require File.join(File.dirname(__FILE__), '../capify-ec2')
 require 'colored'
 require 'pp'
 
-Capistrano::Configuration.instance(:must_exist).load do  
+Capistrano::Configuration.instance(:must_exist).load do
   def capify_ec2
     @capify_ec2 ||= CapifyEc2.new(fetch(:ec2_config, 'config/ec2.yml'), fetch(:stage, ''))
   end
 
   namespace :ec2 do
-    
+
     desc "Prints out all ec2 instances. index, name, instance_id, size, DNS/IP, region, tags"
     task :status do
       capify_ec2.display_instances
@@ -42,16 +42,19 @@ Capistrano::Configuration.instance(:must_exist).load do
       if "ec2:ssh" == server then
         server = variables[:logger].instance_variable_get("@options")[:actions][2]
       end
-      
+
       if server
         instance = numeric?(server) ? capify_ec2.desired_instances[server.to_i] : capify_ec2.get_instance_by_name(server)
 
         if instance and instance.contact_point then
-          port = ssh_options[:port] || 22 
+          port = ssh_options.fetch(:port, 22)
           key = ""
-          if !ssh_options[:keys].to_s.empty?
+          if ssh_options[:keys].is_a?(String) && !ssh_options[:keys].to_s.empty?
             key = "-i #{ssh_options[:keys]}"
           end
+          if ssh_options[:keys].is_a?(Array) && ssh_options[:keys].length > 0
+            key = "-i #{ssh_options[:keys].first}"
+          end
           command = "ssh -p #{port} #{key} #{user}@#{instance.contact_point}"
           puts "Running `#{command}`"
           exec(command)
@@ -71,7 +74,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     after "deploy", "ec2:register_instance"
     after "deploy:rollback", "ec2:register_instance"
   end
-    
+
   desc "Deploy to servers one at a time."
   task :rolling_deploy do
     puts "[Capify-EC2] Performing rolling deployment..."
@@ -101,7 +104,10 @@ Capistrano::Configuration.instance(:must_exist).load do
       puts "[Capify-EC2] Determining release revision..."
       set :revision, (fetch :real_revision)
 
-      all_servers.each do |server_dns,server_roles|
+      all_servers.each_with_index do |server,index|
+
+        server_dns = server[0]
+        server_roles = server[1]
 
         roles.clear
 
@@ -112,9 +118,9 @@ Capistrano::Configuration.instance(:must_exist).load do
           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]"
-        puts "[Capify-EC2] Beginning deployment to #{instance_dns_with_name_tag(server_dns)} with #{server_roles.count > 1 ? 'roles' : 'role'} '#{server_roles.join(', ')}'...".bold
+        puts "[Capify-EC2] (#{index+1} of #{all_servers.length}) Beginning deployment to #{instance_dns_with_name_tag(server_dns)} with #{server_roles.count > 1 ? 'roles' : 'role'} '#{server_roles.join(', ')}'...".bold
 
         unless dry_run
           load_balancer_to_reregister = capify_ec2.deregister_instance_from_elb_by_dns(server_dns) if is_load_balanced
@@ -124,7 +130,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         top.deploy.default
 
         server_roles.each do |a_role|
-        
+
           # If healthcheck(s) are defined for this role, run them.
           if all_options[a_role][server_dns][:healthcheck]
             healthchecks_for_role = [ all_options[a_role][server_dns][:healthcheck] ].flatten
@@ -137,9 +143,9 @@ Capistrano::Configuration.instance(:must_exist).load do
               options[:timeout] = healthcheck_for_role[:timeout] ||= 60
 
               healthcheck = capify_ec2.instance_health_by_url( server_dns,
-                                                               healthcheck_for_role[:port], 
-                                                               healthcheck_for_role[:path], 
-                                                               healthcheck_for_role[:result], 
+                                                               healthcheck_for_role[:port],
+                                                               healthcheck_for_role[:path],
+                                                               healthcheck_for_role[:result],
                                                                options )
               if healthcheck
                 puts "[Capify-EC2] Healthcheck #{i+1} of #{healthchecks_for_role.size} for role '#{a_role}' successful.".green.bold
@@ -161,7 +167,7 @@ Capistrano::Configuration.instance(:must_exist).load do
             raise CapifyEC2RollingDeployError.new("ELB registration timeout exceeded", server_dns)
           end
         end
-   
+
         puts "[Capify-EC2] Deployment successful to #{instance_dns_with_name_tag(server_dns)}.".green.bold
         successful_deploys << server_dns
 
@@ -186,7 +192,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       exit 1
     else
       puts "[Capify-EC2]"
-      puts "[Capify-EC2] Rolling deployment completed.".green.bold  
+      puts "[Capify-EC2] Rolling deployment completed.".green.bold
 
       rolling_deploy_status(all_servers, successful_deploys, failed_deploys)
     end
@@ -196,11 +202,11 @@ Capistrano::Configuration.instance(:must_exist).load do
     puts "[Capify-EC2]"
     puts "[Capify-EC2]   Successful servers:"
     format_rolling_deploy_results( all_servers, successful_deploys )
-     
+
     puts "[Capify-EC2]"
     puts "[Capify-EC2]   Failed servers:"
     format_rolling_deploy_results( all_servers, failed_deploys )
-    
+
     puts "[Capify-EC2]"
     puts "[Capify-EC2]   Pending servers:"
     pending_deploys = (all_servers.keys - successful_deploys) - failed_deploys
@@ -209,10 +215,10 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   def ec2_roles(*roles)
     server_name = variables[:logger].instance_variable_get("@options")[:actions].first unless variables[:logger].instance_variable_get("@options")[:actions][1].nil?
-    
+
     if !server_name.nil? && !server_name.empty?
       named_instance = capify_ec2.get_instance_by_name(server_name)
-  
+
       task named_instance.name.to_sym do
         remove_default_roles
         server_address = named_instance.contact_point
@@ -221,8 +227,8 @@ Capistrano::Configuration.instance(:must_exist).load do
           roles = named_instance.roles
         else
           roles = [named_instance.tags[ capify_ec2.ec2_config[:aws_roles_tag] ]].flatten
-        end    
-        
+        end
+
         roles.each do |role|
           define_role({:name => role, :options => {:on_no_matching_servers => :continue}}, named_instance)
         end
@@ -230,10 +236,10 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
     roles.each {|role| ec2_role(role)}
   end
-  
+
   def ec2_role(role_name_or_hash)
     role = role_name_or_hash.is_a?(Hash) ? role_name_or_hash : {:name => role_name_or_hash, :options => {}, :variables => {}}
-        
+
     instances = capify_ec2.get_instances_by_role(role[:name])
     if role[:options] && role[:options].delete(:default)
       instances.each do |instance|
@@ -248,7 +254,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     define_role_roles(role, instances)
     define_instance_roles(role, instances)
-  end  
+  end
 
   def define_regions(region, role)
     instances = []
@@ -279,29 +285,29 @@ Capistrano::Configuration.instance(:must_exist).load do
       instances.each do |instance|
         define_role(role, instance)
       end
-    end 
+    end
   end
 
   def define_role(role, instance)
     options     = role[:options] || {}
     variables   = role[:variables] || {}
 
-    cap_options = options.inject({}) do |cap_options, (key, value)| 
+    cap_options = options.inject({}) do |cap_options, (key, value)|
       cap_options[key] = true if value.to_s == instance.name
       cap_options
-    end 
+    end
 
     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| 
+    variables.each do |key, value|
       set key, value
       cap_options[key] = value unless cap_options.has_key? key
     end
 
     role role[:name].to_sym, instance.contact_point, cap_options
   end
-  
+
   def numeric?(object)
     true if Float(object) rescue false
   end
@@ -315,9 +321,9 @@ Capistrano::Configuration.instance(:must_exist).load do
         "#{singular}s"
     end
   end
-  
-  def remove_default_roles	 	
+
+  def remove_default_roles
     roles.reject! { true }
   end
-  
+
 end

data/lib/capify-ec2/version.rb

@@ -1,6 +1,6 @@
 module Capify
   module Ec2
-    VERSION = "1.5.1"
+    VERSION = "1.5.2"
   end
 end
 

data/readme.md

@@ -147,7 +147,7 @@ In our examples, imagine that you have three servers on EC2 named and tagged as
 You need to add a call to `ec2_roles` in your `deploy.rb`, like so:
 
 ```ruby
-ec2_roles :web
+ec2_roles {:name => :web}
 ```
 
 This will generate the following tasks:
@@ -170,7 +170,7 @@ end
 Note that there are no tasks created for 'server-2', as it does not have the role 'web'. If we were to change the `ec2_roles` definition in your `deploy.rb` to the following:
 
 ```ruby
-ec2_roles :db
+ec2_roles {:name => :db}
 ```
 
 Then we will instead see the following tasks generated:
@@ -257,6 +257,15 @@ end
 
 
 
+#### Shorthand Role Definition
+If you are defining a role with no options or variables, you can define it using the following shorthand:
+
+```ruby
+ec2_roles :web
+```
+
+
+
 #### Options
 
 ##### Via EC2 Tags
@@ -548,7 +557,7 @@ Using the `cap ec2:ssh` command, you can quickly connect to a specific instance,
 cap ec2:ssh 1
 ```
 
-will attempt to connect to instance number 1 (as shown in `ec2:status`), using the public DNS address provided by AWS.
+will attempt to connect to instance number 1 (as shown in `ec2:status`), using the public DNS address provided by AWS and the first SSH key listed in ` ssh_options[:keys] `.
 
 
 
@@ -640,25 +649,25 @@ In our examples, imagine that you have three servers on EC2 named and tagged as
     <td>'Name' Tag</td>
     <td>'Roles' Tag</td>
     <td>'Options' Tag</td>
-		<td>'Stages' Tag</td>
+    <td>'Stages' Tag</td>
   </tr>
   <tr>
     <td>server-1</td>
     <td>web</td>
     <td>cron,resque</td>
-		<td>production</td>
+    <td>production</td>
   </tr>
   <tr>
     <td>server-2</td>
     <td>db</td>
     <td></td>
-		<td>production</td>
+    <td>production</td>
   </tr>
   <tr>
     <td>server-3</td>
     <td>web,db</td>
     <td></td>
-		<td>staging</td>
+    <td>staging</td>
   </tr>
 </table>
 
@@ -736,4 +745,4 @@ Report Issues/Feature requests on [GitHub Issues](http://github.com/forward/capi
 
 ### Copyright
 
-Copyright (c) 2011, 2012, 2013 Forward. See [LICENSE](https://github.com/forward/capify-ec2/blob/master/LICENSE) for details.
+Copyright (c) 2011, 2012, 2013 Forward. See [LICENSE](https://github.com/forward/capify-ec2/blob/master/LICENSE) for details.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capify-ec2
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 1
   - 5
-  - 1
-  version: 1.5.1
+  - 2
+  version: 1.5.2
 platform: ruby
 authors: 
 - Noah Cantor
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-09-02 00:00:00 Z
+date: 2013-10-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fog