capify-ec2 1.5.3 → 1.6.0

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea
+

data/Changelog.md

@@ -1,3 +1,14 @@
+## 1.6.0 (Aug 26, 2014)
+
+Features:
+
+  - Added a new 'ec2:elbs' command which allows you to list ELBs and the instances registered to them (thanks to stevewoolley).
+  - Added the ability to perform post deploy healthchecks using POST requests rather than just GET (thanks alangalvino).
+
+Bugfixes:
+
+  - Fixed load balancer registration / de-registering within EC2 VPC (thanks davie).
+
 ## 1.5.3 (Nov 15, 2013)
 
 Bugfixes:

data/lib/capify-ec2.rb

@@ -40,6 +40,7 @@ class CapifyEc2
     regions = determine_regions()
 
     @instances = []
+    @elbs = elb.load_balancers
 
     regions.each do |region|
       begin
@@ -130,6 +131,68 @@ class CapifyEc2
     end
   end
 
+  def display_elbs
+    unless @elbs.any?
+      puts "[Capify-EC2] No elastic load balancers were found using your 'ec2.yml' configuration.".red.bold
+      return
+    end
+    puts "Elastic Load Balancers".bold
+    puts "#{@ec2_config[:aws_project_tag].bold}: #{@ec2_config[:project_tags].join(', ')}." if @ec2_config[:project_tags].any?
+    
+    # Set minimum widths for the variable length lb attributes.
+    column_widths = { :id_min => 4, :dns_min => 4, :zone_min => 5}
+
+    # Find the longest attribute across all instances, to format the columns properly.
+    column_widths[:id] = @elbs.map{|i| i.id.to_s.ljust( column_widths[:id_min] ) || ' ' * column_widths[:id_min]}.max_by(&:length).length
+    column_widths[:dns] = @elbs.map{|i| i.dns_name || ' ' * column_widths[:dns_min]}.max_by(&:length).length
+    column_widths[:zone] = @elbs.map{|i| i.availability_zones.join(",").to_s.ljust( column_widths[:zone_min] ) || ' ' * column_widths[:zone_min]}.max_by(&:length).length
+
+    # Title row.
+    status_output = []
+    status_output << 'ID'                                .ljust( column_widths[:id]                      ).bold
+    status_output << 'DNS'                               .ljust( column_widths[:dns]                     ).bold
+    status_output << 'Zone'                              .ljust( column_widths[:zone]                    ).bold
+    puts status_output.join("   ")
+
+    elbs_found_for_project = false
+
+    @elbs.each_with_index do |lb, i|
+      
+      status_output = []
+      sub_output    = []
+      lb.instances.each do |instance|
+        first_match = @instances.select {|x| instance.include?(x.id)}.first
+
+        # Skip any instances which don't match the current Project tag, if set.
+        if @ec2_config[:project_tags].any?
+          break unless @ec2_config[:project_tags].include?(first_match.tags[ @ec2_config[:aws_project_tag] ])
+        end
+
+        elbs_found_for_project = true
+
+        instance_row = []
+        instance_row << " ".ljust( column_widths[:id] )  # indent the length of the id column
+        instance_row << "+"
+        instance_row << (instance || '')                .ljust( 10 ).red
+        instance_row << instance_health(lb, first_match)            .yellow
+        instance_row << (first_match.name || '' )                   .cyan
+        sub_output << instance_row.join("   ")
+      end
+
+      # Only display the ELB if instances matching the current Project tag were found.
+      if sub_output.any?
+        status_output << (lb.id || '')                   .ljust( column_widths[:id]   ).green
+        status_output << lb.dns_name                     .ljust( column_widths[:dns]  ).blue.bold
+        status_output << lb.availability_zones.join(",") .ljust( column_widths[:zone] ).magenta
+      
+        puts status_output.join("   ")
+        puts sub_output.join("\n")
+      end
+    end
+
+    puts "Capify-EC2] No elastic load balancers were found containing instances tagged with this project.".red.bold unless elbs_found_for_project
+  end
+
   def server_names
     desired_instances.map {|instance| instance.name}
   end
@@ -161,7 +224,7 @@ class CapifyEc2
   end
 
   def get_instance_by_dns(dns)
-    desired_instances.select {|instance| instance.dns_name == dns}.first
+    desired_instances.select {|instance| instance.contact_point == dns}.first
   end
 
   def instance_health(load_balancer, instance)
@@ -297,7 +360,11 @@ class CapifyEc2
     begin
       Timeout::timeout(options[:timeout]) do
         begin
-          result = http.get(uri.path)
+          if(options[:via].to_s.downcase == "post")
+            result = http.post(uri.path, options[:data])
+          else
+            result = http.get(uri.path)
+          end
           raise "Server responded with '#{result.code}: #{result.body}', expected '#{expected_response}'" unless response_matches_expected?(result.body, expected_response)
         rescue => e
           puts "[Capify-EC2] Unexpected response: #{e}..."

data/lib/capify-ec2/capistrano.rb

@@ -14,6 +14,11 @@ Capistrano::Configuration.instance(:must_exist).load do
       capify_ec2.display_instances
     end
 
+    desc "Prints out all ec2 load balancers"
+    task :elbs do
+      capify_ec2.display_elbs
+    end
+
     desc "Deregisters instance from its ELB"
     task :deregister_instance do
       instance_name = variables[:logger].instance_variable_get("@options")[:actions].first

data/lib/capify-ec2/version.rb

@@ -1,6 +1,6 @@
 module Capify
   module Ec2
-    VERSION = "1.5.3"
+    VERSION = "1.6.0"
   end
 end
 

data/readme.md

@@ -2,7 +2,7 @@
 
 Capify-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, dynamically building the list of servers to be deployed to.
 
-__Note__: Capistrano 3 is completely incompatible with Capistrano 2, and therefore Capify-EC2 will not function with Capistrano 3.
+__Note__: Capistrano 3 is completely incompatible with Capistrano 2, and therefore Capify-EC2 will not function with Capistrano 3. If you are using Capistrano 3, you can use [Cap-EC2](https://github.com/forward3d/cap-ec2), however note that the configuration (`config/ec2.yml`) is not compatible between Capify-EC2 and Cap-EC2.
 
 
 
@@ -149,7 +149,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 {:name => :web}
+ec2_roles :name => :web
 ```
 
 This will generate the following tasks:
@@ -172,7 +172,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 {:name => :db}
+ec2_roles :name => :db
 ```
 
 Then we will instead see the following tasks generated:
@@ -237,7 +237,7 @@ end
 You can define custom variables which will be set as standard Capistrano variables within the scope of the role you define them one, for example:
 
 ```ruby
-ec2_roles {:name=>"web", :variables => {:rails_env => 'staging'}}
+ec2_roles :name=>"web", :variables => {:rails_env => 'staging'}
 ```
 
 In this case, instances that that are tagged with the 'web' role will have the custom variable 'rails_env' available to them in any tasks they use. The following tasks would be generated:
@@ -317,7 +317,7 @@ end
 As well as defining Options at an instance level via EC2 tags, you can define an Option in your `deploy.rb` at the same time as defining the role, as follows:
 
 ```ruby
-ec2_roles {:name=>"web", :options=>{:worker=>"server-C"}}
+ec2_roles :name=>"web", :options=>{:worker=>"server-C"}
 ```
 
 In this case, you set the value of `:worker` equal to the instance name you want to be a worker. The task definition remains the same:
@@ -490,6 +490,23 @@ ec2_roles :name => "web",
           }
 ```
 
+By default, healthchecks are made using GET requests, but you make can use POST instead by specifying `:via` as either `:post` or `'POST'` and adding ':data' attributes, as follows:
+
+```ruby
+ec2_roles :name => "web",
+          :variables => {
+            :healthcheck => {
+              :path    => '/status',
+              :port    => 80,
+              :result  => '{ json_response: as_string }'
+              :https   => true,
+              :timeout => 10,
+              :via     => :post,
+              :data    => '{ json_request: as_string }'
+            }
+          }
+```
+
 ##### Usage with Elastic Load Balancers
 
 You can have Capify-EC2 automatically deregister and reregister an instance from whichever ELB it is associated with, before and after the deployment, by setting `:load_balanced` to 'true' in the role definition, for example:
@@ -534,6 +551,16 @@ cap ec2:status
 ```
 
 
+#### Viewing ELBs
+
+The following command will generate a listing of all ELBs with instances that match your configuration (projects):
+
+```ruby
+cap ec2:elbs
+```
+
+Note: if no `project` tag is specified in your `ec2.yml` configuration, then all ELBs and their associated instances are shown when using this command.
+
 
 #### Managing Load Balancers
 

metadata

@@ -1,15 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: capify-ec2
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 1.6.0
   prerelease: 
-  segments: 
-  - 1
-  - 5
-  - 3
-  version: 1.5.3
 platform: ruby
-authors: 
+authors:
 - Noah Cantor
 - Siddharth Dawara
 - Jon Spalding
@@ -17,65 +12,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-11-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: fog
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 1
-        - 12
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.12.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: colored
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: capistrano
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 2
-        - 14
-        version: "2.14"
+      - !ruby/object:Gem::Version
+        version: '2.14'
   type: :runtime
-  version_requirements: *id003
-description: Capify-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, dynamically building the list of servers to be deployed to.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Capify-EC2 is used to generate Capistrano namespaces and tasks from Amazon
+  EC2 instance tags, dynamically building the list of servers to be deployed to.
+email:
 - capify-ec2@forwardtechnology.co.uk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Changelog.md
 - Gemfile
@@ -88,37 +82,29 @@ files:
 - lib/capify-ec2/version.rb
 - readme.md
 homepage: http://github.com/forward/capify-ec2
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: capify-ec2
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Capify-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, dynamically building the list of servers to be deployed to.
+summary: Capify-EC2 is used to generate Capistrano namespaces and tasks from Amazon
+  EC2 instance tags, dynamically building the list of servers to be deployed to.
 test_files: []
-