capistrano-aws 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9a08454f9875f788224339ae54185ca956ea899
-  data.tar.gz: dc9b7706d0373bb002500afde3cd815ef8218f94
+SHA256:
+  metadata.gz: 9a292ddac98e4d209192705dd84fb673078fc3e920431d3ee443fe4d46fb014c
+  data.tar.gz: 95b3803b24e7ea003c2b4df69b75306898d980e60caa8f94076141dd69431d94
 SHA512:
-  metadata.gz: 15ab2c9d09f60403b2433c83a7f30938c14ba5d0027cb032975294fec0779b56b4545028675964fc6b2460cd052dc1433496f3f86b895aa644c086dc3cdd5b62
-  data.tar.gz: 9baad33b5e7d6b205670369416d82f9f615c5ffd1ac8a4796f9f7edba0cb9b766bd2787147a3b429be0bdf4b1b78ddf39228446e2d7b4af2ad38c5cc2851c8f9
+  metadata.gz: 78635604ddd07f9a0df3e6cfc9d9653c3af87380940b729431f94f2a1c73521475d0fd5685078a7d0075d5f0ac43ca1412a549e9fdec53765c399d31d4e673dd
+  data.tar.gz: 79d35c68f7bb28d24170c552d51e59d966e9bd1a78420b37aeffd88ed192c3e4a3edaa96086ba216a755bb1109a8a36808f3a0d8ff17611289f3c5bd6c8e24e7

data/.gitignore

@@ -1,2 +1,3 @@
 .bundle
+Gemfile.lock
 vendor

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+2018-03-08 - 1.1.0 - Custom filters
+
+* Support extra filters for retrieving EC2 instances.
+* Allow customization of the stage filter value.
+* Improved description of the :aws_ec2_roles_tag variable.
+* Removed Gemfile.lock.
+* Order instances by name in the instances table.
+
 2017-05-05 - 1.0.1 - Improved instances access
 
 * Turn instances result into a hash, being able to access the instance by its id.

data/README.md

@@ -35,15 +35,24 @@ set :aws_ec2_regions, ['us-east-1']
 # Application name to match application tag.
 set :aws_ec2_application, (proc { fetch(:application) })
 
+# Stage to match stage tag.
+set :aws_ec2_stage, (proc { fetch(:stage) })
+
 # Tag to be used for Capistrano stage.
 set :aws_ec2_stage_tag, 'Stage'
 
 # Tag to be used to match the application.
 set :aws_ec2_application_tag, 'Application'
 
-# Tag to be used for Capistrano roles of the server (comma separated list).
+# Tag to be used for Capistrano roles of the server (the tag value can be a comma separated list).
 set :aws_ec2_roles_tag, 'Roles'
 
+# Extra filters to be used to retrieve the instances. See the README.md for more information.
+set :aws_ec2_extra_filters, []
+
+# Tag to be used as the instance name in the instances table (aws:ec2:instances task).
+set :aws_ec2_name_tag, 'Name'
+
 # How to contact the instance (:public_ip, :public_dns, :private_ip).
 set :aws_ec2_contact_point, :public_ip
 ```
@@ -64,6 +73,46 @@ It will use the instance tags to call the `server` function in capistrano. You c
 aws_ec2_register user: 'hello', port: 2222
 ```
 
+## Custom EC2 Filters
+
+If you need to identify the instances based on more information, you can specify extra filters to be used in the `filters` option in the [Aws::EC2::Resource.instances](https://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Resource.html#instances-instance_method) call.
+
+Imagine you have some split test servers for your production environment, so you can use another tag for specifying the variation of some servers:
+
+| Name      | Application | Environment | Roles  | SplitTestVariation |
+|-----------|-------------|-------------|--------|--------------------|
+| foo-app01 | foo-app     | production  | app,db | 0                  |
+| foo-app02 | foo-app     | production  | app    | 0                  |
+| foo-app03 | foo-app     | production  | app    | 1                  |
+| foo-app04 | foo-app     | production  | app    | 1                  |
+
+In your environment files:
+
+```ruby
+# production.rb
+
+set :aws_ec2_extra_filters, [
+  {
+    name: "tag:SplitTestVariation",
+    values: ["0"],
+  },
+]
+```
+
+```ruby
+# production-b.rb
+
+set :aws_ec2_stage, "production" # Optional. Use if you have the same environment for the B servers.
+set :aws_ec2_extra_filters, [
+  {
+    name: "tag:SplitTestVariation",
+    values: ["1"],
+  },
+]
+```
+
+The `:aws_ec2_stage` variable is needed in order to override the default value of the stage fielter(`:stage`). If you really have a different environment for your `B` servers, you can just use the name of the environment as the file name and remove this line.
+
 # Utility tasks
 
 ## aws:ec2:instances

data/capistrano-aws.gemspec

@@ -5,10 +5,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name = 'capistrano-aws'
-  gem.version = '1.0.1'
+  gem.version = '1.1.0'
   gem.author = 'Fernando Carletti'
   gem.email = 'contact@fernandocarletti.net'
-  gem.homepage = 'http://github.com/xurumelous/capistrano-aws'
+  gem.homepage = 'http://github.com/fernandocarletti/capistrano-aws'
   gem.summary = 'Integrates capistrano with AWS.'
   gem.description = 'Allow dynamically add servers based on EC2.'
 
@@ -25,5 +25,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'terminal-table', '~>1.7'
   gem.add_dependency 'colorize', '~>0.8'
 
-  gem.add_development_dependency 'rubocop', '~>0.48'
+  gem.add_development_dependency 'rubocop', '~>0.53'
 end

data/lib/capistrano/aws/defaults.rb

@@ -4,14 +4,23 @@ set :aws_ec2_regions, ['us-east-1']
 # Application name to match application tag.
 set :aws_ec2_application, (proc { fetch(:application) })
 
+# Stage to match stage tag.
+set :aws_ec2_stage, (proc { fetch(:stage) })
+
 # Tag to be used for Capistrano stage.
 set :aws_ec2_stage_tag, 'Stage'
 
 # Tag to be used to match the application.
 set :aws_ec2_application_tag, 'Application'
 
-# Tag to be used for Capistrano roles of the server (comma separated list).
+# Tag to be used for Capistrano roles of the server (the tag value can be a comma separated list).
 set :aws_ec2_roles_tag, 'Roles'
 
+# Extra filters to be used to retrieve the instances. See the README.md for more information.
+set :aws_ec2_extra_filters, []
+
+# Tag to be used as the instance name in the instances table (aws:ec2:instances task).
+set :aws_ec2_name_tag, 'Name'
+
 # How to contact the instance (:public_ip, :public_dns, :private_ip).
 set :aws_ec2_contact_point, :public_ip

data/lib/capistrano/aws/ec2/ec2.rb

@@ -34,7 +34,7 @@ module Capistrano
             },
             {
               name: "tag:#{fetch(:aws_ec2_stage_tag)}",
-              values: [fetch(:stage)]
+              values: [fetch(:aws_ec2_stage)]
             },
             {
               name: 'instance-state-name',
@@ -42,6 +42,8 @@ module Capistrano
             }
           ]
 
+          filters.concat fetch(:aws_ec2_extra_filters)
+
           @ec2.each do |_region, client|
             client.instances(filters: filters).each do |instance|
               instances[instance.id] = instance

data/lib/capistrano/aws/ec2/instances_table.rb

@@ -7,7 +7,9 @@ module Capistrano
       # Generates instances table.
       class InstancesTable
         def initialize(instances)
-          @instances = instances
+          @instances = instances.sort_by do |_id, instance|
+            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_name_tag))
+          end
         end
 
         def render
@@ -47,7 +49,7 @@ module Capistrano
           [
             format('%02d:', number),
             instance.id.colorize(:red),
-            Capistrano::Aws::EC2.parse_tag(instance, 'Name').colorize(:green),
+            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_name_tag)).colorize(:green),
             instance.instance_type.colorize(:cyan),
             Capistrano::Aws::EC2.contact_point(instance).colorize(:blue),
             instance.placement.availability_zone.colorize(:magenta),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-aws
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Fernando Carletti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-05 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.53'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.53'
 description: Allow dynamically add servers based on EC2.
 email: contact@fernandocarletti.net
 executables: []
@@ -77,7 +77,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - capistrano-aws.gemspec
@@ -87,7 +86,7 @@ files:
 - lib/capistrano/aws/ec2/instances_table.rb
 - lib/capistrano/dsl/aws.rb
 - lib/capistrano/tasks/ec2.rake
-homepage: http://github.com/xurumelous/capistrano-aws
+homepage: http://github.com/fernandocarletti/capistrano-aws
 licenses:
 - MIT
 metadata: {}
@@ -107,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Integrates capistrano with AWS.

data/Gemfile.lock

@@ -1,48 +0,0 @@
-PATH
-  remote: .
-  specs:
-    capistrano-aws (1.0.0)
-      aws-sdk (~> 2.9)
-      colorize (~> 0.8)
-      terminal-table (~> 1.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.3.0)
-    aws-sdk (2.9.15)
-      aws-sdk-resources (= 2.9.15)
-    aws-sdk-core (2.9.15)
-      aws-sigv4 (~> 1.0)
-      jmespath (~> 1.0)
-    aws-sdk-resources (2.9.15)
-      aws-sdk-core (= 2.9.15)
-    aws-sigv4 (1.0.0)
-    colorize (0.8.1)
-    jmespath (1.3.1)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    rainbow (2.2.2)
-      rake
-    rake (12.0.0)
-    rubocop (0.48.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    terminal-table (1.7.0)
-      unicode-display_width (~> 1.1)
-    unicode-display_width (1.2.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  capistrano-aws!
-  rubocop (~> 0.48)
-
-BUNDLED WITH
-   1.14.6