cap-ec2 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092240e7eaab751a6904e3aca76edf76f9d2465d
+  data.tar.gz: 1749028233473e4273d3e9179c748ddb9531ea78
+SHA512:
+  metadata.gz: f82a05e873cea98c83b7512d306e39e6db38fe627747c53ade46b2c2ada8c60972f71f4460837b4cf1788ad7f275ee90d19a3faa9fb265bdde02edef017f0df3
+  data.tar.gz: 4e40c794ca64fe95890df5f0d83795f2c2bb63dcc530fa62a00f74e30f53563b2ad40dc394888d013cf7d8ded7f68f1aedd51b226d4dec1d4d6d8c6263f97429

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Cap-EC2 changelog
 
+## 0.0.8
+
+* Made `config/ec2.yml` optional, set all options by Capistrano variable. [@rjocoleman](https://github.com/rjocoleman)
+* Remove requirement for default region to be set. [@rjocoleman](https://github.com/rjocoleman)
+
 ## 0.0.7
 
 * Removed monkey patching of `Capistrano::TaskEnhancements` [@rjocoleman](https://github.com/rjocoleman)
@@ -29,4 +34,4 @@
 
 ## 0.0.1
 
-* Initial release
+* Initial release

data/README.md

@@ -2,23 +2,22 @@
 
 [![Code Climate](https://codeclimate.com/github/forward3d/cap-ec2.png)](https://codeclimate.com/github/forward3d/cap-ec2)
 
-Cap-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, 
+Cap-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags,
 dynamically building the list of servers to be deployed to.
 
 ## Notes
 
-Cap-EC2 is only compatible with Capistrano 3.x or later; if you want the Capistrano 2.x version, 
+Cap-EC2 is only compatible with Capistrano 3.x or later; if you want the Capistrano 2.x version,
 use [Capify-EC2](https://github.com/forward/capify-ec2). Note that the configuration file (`config/ec2.yml`)
 is not compatible between versions either.
 
 This documentation assumes familiarity with Capistrano 3.x.
 
-A number of features that are in Capify-EC2 are not yet available in Cap-EC2, due to the 
+A number of features that are in Capify-EC2 are not yet available in Cap-EC2, due to the
 architectural changes in Capistrano 3.x. The following features are missing (this is not
 an exhaustive list!):
 * rolling deploy (this should be implemented via [SSHKit](https://github.com/capistrano/sshkit))
 * ELB registration/de-registration (not widely used)
-* using IAM roles to provide credentials
 * Variables set by EC2 tags
 * Connecting to instances via SSH using a convenience task
 
@@ -31,34 +30,49 @@ features you would like.
 
 or add the gem to your project's Gemfile.
 
-You will need to create a YAML configuration file at `config/ec2.yml` that looks like the following:
+You also need to add the gem to your Capfile:
 
 ```ruby
-access_key_id: "YOUR ACCESS KEY"
-secret_access_key: "YOUR SECRET KEY"
-regions:
- - 'eu-west-1'
+require "cap-ec2/capistrano"
 ```
 
-You also need to add the gem to your Capfile:
+
+## Configuration
+
+Configurable options, shown here with defaults:
 
 ```ruby
-require "cap-ec2/capistrano"
+set :ec2_config, 'config/ec2.yml'
+
+set :ec2_project_tag, 'Project'
+set :ec2_roles_tag, 'Roles'
+set :ec2_stages_tag, 'Stages'
+
+set :ec2_access_key_id, nil
+set :ec2_secret_access_key, nil
+set :ec2_region, %w{}
 ```
 
-## Configuration
+#### Order of inheritance
+`cap-ec2` supports multiple methods of configuration. The order of inheritance is:
+YAML File > User Capistrano Config > Default Capistrano Config > ENV variables.
+
+#### Regions
+`:ec2_region` is an array of [AWS regions](http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region), if not present all regions will be checked for matching instances - this the default behavior and can be slow, if speed is an issue consider setting your required regions.
 
-Your `config/ec2.yml` file must contain at least the information above (`access_key_id`, `secret_access_key`, `regions`).
-Omitting any of these will raise an exception.
+If`:ec2_access_key_id` or `:ec2_secret_access_key` are not set in any configuration the environment variables
+`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION` will be checked.
+If running on EC2 the IAM instance profile credentials will be used if credentials are not set by any other method.
 
-The following are optional settings you can use.
+
+#### Misc settings
 
 * project_tag
-  
+
   If this is defined, Cap-EC2 will look for a tag with this name when searching for instances belong
   to this project. Cap-EC2 will look for a value which matches the `:application` setting in your
   `deploy.rb`. The tag name defaults to "Project".
-  
+
 * stages_tag
 
   If this is defined, Cap-EC2 will look for a tag with this name to determine which instances belong to
@@ -67,7 +81,29 @@ The following are optional settings you can use.
 * roles_tag
 
   If this is defined, Cap-EC2 will look for a tag with this name to determine which instances belong to
-  a given role. The tag name defaults to "Roles". 
+  a given role. The tag name defaults to "Roles".
+
+
+### YAML Configuration
+
+
+If you'd prefer do your configuration via a YAML file `config/ec2.yml` can be used, (or an alternative name/location set via `set :ec2_config`):
+
+If so YAML file will look like this:
+
+```ruby
+access_key_id: "YOUR ACCESS KEY"
+secret_access_key: "YOUR SECRET KEY"
+regions:
+ - 'eu-west-1'
+ project_tag: "Project"
+ roles_tag: "Roles"
+ stages_tag: "Stages"
+```
+
+
+Your `config/ec2.yml` file can contain (`access_key_id`, `secret_access_key`, `regions`) - if a value is omitted then the order of inheritance is followed.
+
 
 ## Usage
 
@@ -160,7 +196,7 @@ trivial to add.
 ### Tasks and deployment
 
 You can now define your tasks for these roles in exactly the same way as you would if you weren't
-using this gem. 
+using this gem.
 
 ## Utility tasks
 
@@ -176,7 +212,7 @@ This command will show you information all the instances your configuration matc
 Example:
 
     $ cap production ec2:status
-    
+
     Num  Name                          ID          Type      DNS              Zone        Roles         Stage
     00:  server-1-20131030-1144-0      i-abcdefgh  m1.small  192.168.202.248  us-west-2c  banana,apple  production
     01:  server-2-20131118-1839-0      i-hgfedcba  m1.small  192.168.200.60   us-west-2a  banana        production
@@ -191,23 +227,23 @@ Example:
 
     $ cap production ec2:server_names
     server-1-20131030-1144-0
-    server-2-20131118-1839-0 
+    server-2-20131118-1839-0
 
 ### View server instance IDs
-  
+
 This command will show the instance IDs of the instances matching the given stage:
-  
+
     cap [stage] ec2:instance_ids
-  
+
 Example:
-  
+
     $ cap production ec2:instance_ids
     i-abcdefgh
     i-hgfedcba
 
 ## Acknowledgements
 
-Thanks to [Rylon](https://github.com/Rylon) for maintaining Capify-EC2 and 
+Thanks to [Rylon](https://github.com/Rylon) for maintaining Capify-EC2 and
 reviewing my thought processes for this project.
 
 ## Contributing

data/cap-ec2.gemspec

@@ -6,8 +6,8 @@ require 'cap-ec2/version'
 Gem::Specification.new do |spec|
   spec.name          = "cap-ec2"
   spec.version       = CapEC2::VERSION
-  spec.authors       = ["Andy Sykes"]
-  spec.email         = ["github@tinycat.co.uk"]
+  spec.authors       = ["Andy Sykes", "Robert Coleman"]
+  spec.email         = ["github@tinycat.co.uk", "github@robert.net.nz"]
   spec.description   = %q{Cap-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, dynamically building the list of servers to be deployed to.}
   spec.summary       = %q{Cap-EC2 is used to generate Capistrano namespaces and tasks from Amazon EC2 instance tags, dynamically building the list of servers to be deployed to.}
   spec.homepage      = "https://github.com/forward3d/cap-ec2"
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  
+
   spec.add_dependency "aws-sdk"
   spec.add_dependency "capistrano", ">= 3.0"
   spec.add_dependency "terminal-table"

data/lib/cap-ec2/capistrano.rb

@@ -7,7 +7,6 @@ require 'yaml'
 require_relative 'utils'
 require_relative 'ec2-handler'
 require_relative 'status-table'
-require_relative 'instance'
 
 # Load extra tasks
 load File.expand_path("../tasks/ec2.rake", __FILE__)
@@ -17,19 +16,19 @@ module Capistrano
     module Ec2
 
       def ec2_handler
-        @ec2_handler ||= CapEC2::EC2Handler.new(env.fetch(:ec2_config, "config/ec2.yml"))
+        @ec2_handler ||= CapEC2::EC2Handler.new
       end
-    
+
       def ec2_role(name, options={})
         ec2_handler.get_servers_for_role(name).each do |server|
-          env.role(name, server.contact_point, options)
+          env.role(name, CapEC2::Utils.contact_point(server), options)
         end
       end
-    
+
       def env
         Configuration.env
       end
-    
+
     end
   end
 end

data/lib/cap-ec2/ec2-handler.rb

@@ -1,26 +1,30 @@
 module CapEC2
   class EC2Handler
     include CapEC2::Utils
-    
-    def initialize(ec2_config = "config/ec2.yml")
-      @ec2_config = YAML.load_file ec2_config
+
+    def initialize
+      load_config
+      configured_regions = get_regions(fetch(:ec2_region))
       @ec2 = {}
-      @ec2_config["regions"].each do |region|
-        @ec2[region] = AWS::EC2.new(
-        access_key_id: @ec2_config["access_key_id"],
-        secret_access_key: @ec2_config["secret_access_key"],
+      configured_regions.each do |region|
+        @ec2[region] = ec2_connect(region)
+      end
+    end
+
+    def ec2_connect(region=nil)
+      AWS::EC2.new(
+        access_key_id: fetch(:ec2_access_key_id),
+        secret_access_key: fetch(:ec2_secret_access_key),
         region: region
       )
-      end
     end
-    
+
     def status_table
       CapEC2::StatusTable.new(
-        defined_roles.map {|r| get_servers_for_role(r)}.flatten.uniq {|i| i.instance_id},
-        @ec2_config
+        defined_roles.map {|r| get_servers_for_role(r)}.flatten.uniq {|i| i.instance_id}
       )
     end
-    
+
     def server_names
       puts defined_roles.map {|r| get_servers_for_role(r)}
                    .flatten
@@ -28,7 +32,7 @@ module CapEC2
                    .map {|i| i.tags["Name"]}
                    .join("\n")
     end
-    
+
     def instance_ids
       puts defined_roles.map {|r| get_servers_for_role(r)}
                    .flatten
@@ -36,41 +40,35 @@ module CapEC2
                    .map {|i| i.instance_id}
                    .join("\n")
     end
-    
+
     def defined_roles
       Capistrano::Configuration.env.send(:servers).send(:available_roles)
     end
-    
+
     def stage
       Capistrano::Configuration.env.fetch(:stage).to_s
     end
-    
+
     def application
       Capistrano::Configuration.env.fetch(:application).to_s
     end
-    
+
     def tag(tag_name)
       "tag:#{tag_name}"
     end
-    
+
     def get_servers_for_role(role)
       servers = []
-      each_region do |ec2|
+      @ec2.each do |_, ec2|
         instances = ec2.instances
           .filter(tag(project_tag), application)
           .filter('instance-state-code', '16')
-        servers << instances.select do |i| 
+        servers << instances.select do |i|
           i.tags[roles_tag] =~ /,{0,1}#{role}(,|$)/ && i.tags[stages_tag] =~ /,{0,1}#{stage}(,|$)/
         end
       end
       servers.flatten
     end
-    
-    def each_region
-      @ec2.keys.each do |region|
-        yield @ec2[region]
-      end
-    end
-    
+
   end
-end
+end

data/lib/cap-ec2/status-table.rb

@@ -2,9 +2,8 @@ module CapEC2
   class StatusTable
     include CapEC2::Utils
     
-    def initialize(instances, ec2_config)
+    def initialize(instances)
       @instances = instances
-      @ec2_config = ec2_config
       output
     end
     
@@ -42,7 +41,7 @@ module CapEC2
         (instance.tags["Name"] || '').green,
         instance.id.red,
         instance.instance_type.cyan,
-        instance.contact_point.blue.bold,
+        CapEC2::Utils.contact_point(instance).blue.bold,
         instance.availability_zone.magenta,
         instance.tags[roles_tag].yellow,
         instance.tags[stages_tag].yellow

data/lib/cap-ec2/tasks/ec2.rake

@@ -15,4 +15,21 @@ namespace :ec2 do
     ec2_handler.instance_ids
   end
   
-end
+end
+
+
+namespace :load do
+  task :defaults do
+
+    set :ec2_config, 'config/ec2.yml'
+
+    set :ec2_project_tag, 'Project'
+    set :ec2_roles_tag, 'Roles'
+    set :ec2_stages_tag, 'Stages'
+    
+    set :ec2_access_key_id, nil
+    set :ec2_secret_access_key, nil
+    set :ec2_region, %w{}
+
+  end
+end

data/lib/cap-ec2/utils.rb

@@ -1,15 +1,45 @@
 module CapEC2
   module Utils
     def project_tag
-      @ec2_config["project_tag"] || "Project"
+      fetch(:ec2_project_tag)
     end
     
     def roles_tag
-      @ec2_config["roles_tag"] || "Roles"
+      fetch(:ec2_roles_tag)
     end
     
     def stages_tag
-      @ec2_config["stages_tag"] || "Stages"
+      fetch(:ec2_stages_tag)
     end 
+    
+    def self.contact_point(instance)
+      instance.public_dns_name || instance.public_ip_address || instance.private_ip_address
+    end
+    
+    def load_config
+      config_location = File.expand_path(fetch(:ec2_config), Dir.pwd) if fetch(:ec2_config)
+      if config_location && File.exists?(config_location)
+        config = YAML.load_file fetch(:ec2_config)
+        if config
+          set :ec2_project_tag, config['project_tag'] if config['project_tag']
+          set :ec2_roles_tag, config['roles_tag'] if config['roles_tag']
+          set :ec2_stages_tag, config['stages_tag'] if config['stages_tag']
+    
+          set :ec2_access_key_id, config['access_key_id'] if config['access_key_id']
+          set :ec2_secret_access_key, config['secret_access_key'] if config['secret_access_key']
+          set :ec2_region, config['regions'] if config['regions']
+        end
+      end
+    end
+    
+    def get_regions(regions_array=nil)
+      unless regions_array.empty?
+        return regions_array
+      else
+        @ec2 = ec2_connect
+        @ec2.regions.map(&:name)
+      end
+    end
+    
   end
 end

data/lib/cap-ec2/version.rb

@@ -1,3 +1,3 @@
 module CapEC2
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,121 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: cap-ec2
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - Andy Sykes
+- Robert Coleman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Cap-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:
 - github@tinycat.co.uk
+- github@robert.net.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -124,7 +113,6 @@ files:
 - cap-ec2.gemspec
 - lib/cap-ec2/capistrano.rb
 - lib/cap-ec2/ec2-handler.rb
-- lib/cap-ec2/instance.rb
 - lib/cap-ec2/status-table.rb
 - lib/cap-ec2/tasks/ec2.rake
 - lib/cap-ec2/utils.rb
@@ -132,33 +120,27 @@ files:
 homepage: https://github.com/forward3d/cap-ec2
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1426469508856454138
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1426469508856454138
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cap-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: []
+has_rdoc: 

data/lib/cap-ec2/instance.rb

@@ -1,11 +0,0 @@
-# Monkey patch the AWS SDK to return a variable
-# "contact point" we can reach the server on
-module AWS
-  class EC2
-    class Instance
-      def contact_point
-        public_dns_name || public_ip_address || private_ip_address
-      end
-    end
-  end
-end