capify-ec2 1.7.0 → 1.8.0.pre

data/Changelog.md

@@ -1,3 +1,14 @@
+## 1.8.0.pre (Nov 14, 2014)
+
+Features:
+
+  - Support for IAM temporary security credentials (thanks jeffdevine).
+  - Added new `ec2:graph` command which shows an enhanced status along with instance CPU utilisation powered by CloudWatch (thanks stuartquin).
+
+Bugfixes:
+
+  - Fixed issue with chaining multiple roles (thanks marcinc).
+
 ## 1.7.0 (Aug 26, 2014)
 
 Bugfixes:

data/lib/capify-ec2.rb

@@ -1,9 +1,14 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
 require 'rubygems'
 require 'fog'
 require 'colored'
 require 'net/http'
 require 'net/https'
 require File.expand_path(File.dirname(__FILE__) + '/capify-ec2/server')
+require File.expand_path(File.dirname(__FILE__) + '/capify-ec2/cloudwatch')
+
 
 class CapifyEc2
 
@@ -59,12 +64,16 @@ class CapifyEc2
   def security_credentials
     if @ec2_config[:use_iam_profile]
       { :use_iam_profile       => true }
+    elsif aws_session_token
+      { :aws_access_key_id     => aws_access_key_id,
+        :aws_secret_access_key => aws_secret_access_key,
+        :aws_session_token     => aws_session_token }
     else
       { :aws_access_key_id     => aws_access_key_id,
         :aws_secret_access_key => aws_secret_access_key }
     end
   end
-  
+
   def determine_regions()
     @ec2_config[:aws_params][:regions] || [@ec2_config[:aws_params][:region]]
   end
@@ -77,12 +86,18 @@ class CapifyEc2
     @ec2_config[:aws_secret_access_key] || Fog.credentials[:aws_secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY'] || @ec2_config[:use_iam_profile] || raise("Missing AWS Secret Access Key")
   end
 
-  def display_instances
+  def aws_session_token
+    @ec2_config[:aws_session_token] || Fog.credentials[:aws_session_token] || ENV['AWS_SESSION_TOKEN'] || nil
+  end
+
+  def display_instances(graph: false)
     unless desired_instances and desired_instances.any?
       puts "[Capify-EC2] No instances were found using your 'ec2.yml' configuration.".red.bold
       return
     end
 
+    cw = CapifyCloudwatch.new(aws_access_key_id, aws_secret_access_key) if graph
+
     # Set minimum widths for the variable length instance attributes.
     column_widths = { :name_min => 4, :type_min => 4, :dns_min => 5, :roles_min => @ec2_config[:aws_roles_tag].length, :stages_min => @ec2_config[:aws_stages_tag].length, :options_min => @ec2_config[:aws_options_tag].length }
 
@@ -114,6 +129,7 @@ class CapifyEc2
     status_output << @ec2_config[:aws_stages_tag] .ljust( column_widths[:stages]  ).bold if stages_present
     status_output << @ec2_config[:aws_roles_tag]  .ljust( column_widths[:roles]   ).bold if roles_present
     status_output << @ec2_config[:aws_options_tag].ljust( column_widths[:options] ).bold if options_present
+    status_output << 'CPU'                       .ljust( 16                      ).bold if graph
     puts status_output.join("   ")
     
     desired_instances.each_with_index do |instance, i|
@@ -127,6 +143,7 @@ class CapifyEc2
       status_output << (instance.tags[@ec2_config[:aws_stages_tag]]  || '').ljust( column_widths[:stages]  ).yellow if stages_present
       status_output << (instance.tags[@ec2_config[:aws_roles_tag]]   || '').ljust( column_widths[:roles]   ).yellow if roles_present
       status_output << (instance.tags[@ec2_config[:aws_options_tag]] || '').ljust( column_widths[:options] ).yellow if options_present
+      status_output << cw.get_metric(instance.id, "CPUUtilization").ljust(16) if graph
       puts status_output.join("   ")
     end
   end

data/lib/capify-ec2/capistrano.rb

@@ -14,6 +14,11 @@ Capistrano::Configuration.instance(:must_exist).load do
       capify_ec2.display_instances
     end
 
+    desc "As status but with CPU usage graphs (slower due to Cloudwatch requests)"
+    task :graph do
+      capify_ec2.display_instances(graph: true)
+    end
+
     desc "Prints out all ec2 load balancers"
     task :elbs do
       capify_ec2.display_elbs
@@ -225,7 +230,6 @@ Capistrano::Configuration.instance(:must_exist).load do
       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
 
         if named_instance.respond_to?(:roles)
@@ -268,7 +272,6 @@ Capistrano::Configuration.instance(:must_exist).load do
       region_instances.each {|instance| instances << instance} unless region_instances.nil?
     end
     task region.to_sym do
-      remove_default_roles
       instances.each do |instance|
         define_role(role, instance)
       end
@@ -278,7 +281,6 @@ Capistrano::Configuration.instance(:must_exist).load do
   def define_instance_roles(role, instances)
     instances.each do |instance|
       task instance.name.to_sym do
-        remove_default_roles
         define_role(role, instance)
       end
     end
@@ -286,7 +288,6 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   def define_role_roles(role, instances)
     task role[:name].to_sym do
-      remove_default_roles
       instances.each do |instance|
         define_role(role, instance)
       end
@@ -326,9 +327,4 @@ Capistrano::Configuration.instance(:must_exist).load do
         "#{singular}s"
     end
   end
-
-  def remove_default_roles
-    roles.reject! { true }
-  end
-
-end
+end

data/lib/capify-ec2/cloudwatch.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'fog'
+
+class CapifyCloudwatch
+  # Threshold => color
+  # Color is applied if metric exceeds the threshold, KEEP IN ORDER
+  Colors = {
+    0 => :green,
+    70 => :yellow,
+    90 => :red
+  }
+
+  def initialize(key_id, secret)
+    @ticks = %w[▁ ▂ ▃ ▄ ▅ ▆ ▇]
+    @cw = Fog::AWS::CloudWatch.new(:aws_access_key_id => key_id,
+                                   :aws_secret_access_key => secret)
+  end
+
+  def get_metric(instance_id, metric, hours = 1)
+    range = hours * (60 * 60)
+    time = Time.new
+    start = DateTime.parse((time - range).to_s)
+    finish = DateTime.parse(time.to_s)
+
+    dimensions = [{
+      "Name" => "InstanceId",
+      "Value" => instance_id
+    }]
+
+    result = @cw.get_metric_statistics({'Namespace' => 'AWS/EC2',
+                                        'MetricName' => metric,
+                                        'Period' => 120,
+                                        'Statistics' => ['Average'],
+                                        'StartTime' => start,
+                                        'EndTime' => finish,
+                                        'Dimensions' => dimensions})
+
+    dp = result.body.fetch("GetMetricStatisticsResult", {})["Datapoints"]
+
+    if dp
+      return get_spark_line(dp.map {|x| x["Average"]})
+    end
+    return ""
+  end
+
+  def colorize_output(output, value)
+    colored = output
+    Colors.each do |threshold, color|
+      if value >= threshold
+        colored = output.send(color)
+      end
+    end
+    colored
+  end
+
+  def get_spark_line(values)
+    scale = @ticks.length - 1
+
+    if values and values.count > 0
+      final = values.last.round
+      bar = values.map { |x| @ticks[(x / 100.0 * scale).floor] }.join
+      return colorize_output(bar.rjust(13, @ticks.first) + " #{final}%", final)
+    else
+      ""
+    end
+  end
+end

data/lib/capify-ec2/version.rb

@@ -1,6 +1,6 @@
 module Capify
   module Ec2
-    VERSION = "1.7.0"
+    VERSION = "1.8.0.pre"
   end
 end
 

data/readme.md

@@ -72,6 +72,10 @@ Note: `:aws_access_key_id` and `:aws_secret_access_key` are required, unless you
 
   Use this option to use IAM roles for authentication, rather than an access key id and secret access key.
 
+* :aws_session_token
+
+  If you are an IAM user that only has access to temporary credentials, you can provide your session token here to authenticate.
+
 
 ##### AWS Credentials
 
@@ -81,16 +85,18 @@ By default, Capify-EC2 will attempt to use the credentials found in your `ec2.ym
 
 ###### Via Fog Configuration
 
-If you wish, you can have Capify-EC2 use the AWS credentials found in your Fog configuration, instead of instead of specifying `:aws_access_key_id` and `:aws_secret_access_key` in the YML configuration file. Refer to the Fog documentation for details on specifying AWS credentials.
+If you wish, you can have Capify-EC2 use the AWS credentials found in your Fog configuration, instead of instead of specifying `:aws_access_key_id` and `:aws_secret_access_key` in the YML configuration file. Optionally, if you requires session tokens or federated users, you can set ` :aws_session_token `. Refer to the Fog documentation for details on specifying AWS credentials.
 
 ###### Via Environment Variables
 
-If you wish, you can define AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables, instead of specifying `:aws_access_key_id` and `:aws_secret_access_key` in the YML configuration file.
+If you wish, you can define AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables, instead of specifying `:aws_access_key_id` and `:aws_secret_access_key` in the YML configuration file. Optionally, if you requires session tokens or federated users, you can set the environment variable AWS_SESSION_TOKEN.
 
 ###### Via AWS IAM Roles
 
 If you have IAM roles set up on your box to allow querying EC2 information you tell Fog to use IAM roles and you will not need to provide any credentials at runtime. For more information on IAM roles read Amazon's [IAM documentation](http://aws.amazon.com/iam/).
 
+If you are an IAM user that only has access to temporary credentials, you can use `:aws_session_token: "YOUR TOKEN HERE"` to authenticate.
+
 ###### Ordering
 
 Capify-EC2 will attempt to load your AWS credentials first from the `ec2.yml` configuration file, then from your Fog configuration file, and finally from environment variables. It will display an error if no credentials are found by any of these methods.
@@ -550,6 +556,14 @@ The following command will generate a listing of all instances that match your c
 cap ec2:status
 ```
 
+##### Viewing CPU Utilisation
+
+The following command will generate an enhanced listing of all instances that match your configuration (projects and roles) as with `ec2:status`, with the addition of CPU utilisation graphs powered by CloudWatch. You will need to ensure your IAM permissions allow this.
+
+```ruby
+cap ec2:graph
+```
+
 
 #### Viewing ELBs
 
@@ -768,10 +782,10 @@ Report Issues/Feature requests on [GitHub Issues](http://github.com/forward/capi
  * 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)
+ * Commit, do not change the version, or changelog.
+   (if you want to have your own version, that is fine but bump version in a commit by itself so I can ignore it when I pull)
  * Send me a pull request. Bonus points for topic branches.
 
 ### 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, 2014 Forward. See [LICENSE](https://github.com/forward/capify-ec2/blob/master/LICENSE) for details.

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: capify-ec2
 version: !ruby/object:Gem::Version
-  version: 1.7.0
-  prerelease: 
+  version: 1.8.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Noah Cantor
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -78,6 +78,7 @@ files:
 - capify-ec2.gemspec
 - lib/capify-ec2.rb
 - lib/capify-ec2/capistrano.rb
+- lib/capify-ec2/cloudwatch.rb
 - lib/capify-ec2/server.rb
 - lib/capify-ec2/version.rb
 - readme.md
@@ -97,9 +98,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: capify-ec2
 rubygems_version: 1.8.23