capistrano-aws 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a292ddac98e4d209192705dd84fb673078fc3e920431d3ee443fe4d46fb014c
-  data.tar.gz: 95b3803b24e7ea003c2b4df69b75306898d980e60caa8f94076141dd69431d94
+  metadata.gz: cbec575475bb720dc8ca561f8e26c9cb2c1280bdc6535ae5bed01a709e506ab5
+  data.tar.gz: 741650bc0b0945fbbbb4df0394babe26bcc3791c0784e28d547b6841f227c3ba
 SHA512:
-  metadata.gz: 78635604ddd07f9a0df3e6cfc9d9653c3af87380940b729431f94f2a1c73521475d0fd5685078a7d0075d5f0ac43ca1412a549e9fdec53765c399d31d4e673dd
-  data.tar.gz: 79d35c68f7bb28d24170c552d51e59d966e9bd1a78420b37aeffd88ed192c3e4a3edaa96086ba216a755bb1109a8a36808f3a0d8ff17611289f3c5bd6c8e24e7
+  metadata.gz: 83eeab8d5f62b97858d0200cd50affcf0aad3c688cbcad5f2da06574ca1424b09c077e4cca6b28fb25fb96cf5e2e42e848cbbc5e700c94ecc5d0ec2f330a3773
+  data.tar.gz: ecf4f0433304eca8f38b31cd6005001de6079a4654c69afc3800df076b747fd3b684fb0434d81c885174f7d117bb9a299769d145c5dd3485953979fe486f8278

data/.gitignore

@@ -1,3 +1 @@
-.bundle
-Gemfile.lock
-vendor
+*.gem

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+2021-11-10 - 1.3.0 - Fix License!
+
+* Move from colorize to rainbow due to license incompatibiliy (Thanks @andyspix!)
+
+2020-04-22 - 1.2.2 - Extra EC2 contact point
+
+* Added extra EC2 contact point with instance id and private DNS (for SSM usage)
+
 2018-03-08 - 1.1.0 - Custom filters
 
 * Support extra filters for retrieving EC2 instances.

data/README.md

@@ -1,15 +1,14 @@
-Capistrano AWS
-==============
+# Capistrano AWS [![Gem Version](https://badge.fury.io/rb/capistrano-aws.svg)](https://badge.fury.io/rb/capistrano-aws)
 
 This gem is slightly based on [cap-ec2](https://github.com/forward3d/cap-ec2), which is not maintained for a while, becoming outdated.
 
 The purpose of this gem is to provide a flexible and simple integration to AWS EC2, exposing the aws-sdk connection in order to allow any customization.
 
-# Requirements
+## Requirements
 
 * Capistrano 3
 
-# Installation
+## Installation
 
 Add to your `Gemfile` and run `bundler`:
 ```ruby
@@ -18,7 +17,7 @@ gem 'capistrano-aws'
 
 Or install the gem system-wide:
 ```bash
-gem install cap-ec2
+gem install capistrano-aws
 ```
 
 In your `Capfile`:
@@ -26,7 +25,7 @@ In your `Capfile`:
 require 'capistrano/aws'
 ```
 
-# Configuration
+## Configuration
 
 ```ruby
 # AWS regions to use.
@@ -53,16 +52,17 @@ 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).
+# How to contact the instance (:public_ip, :public_dns, :private_ip, :private_dns, :id).
 set :aws_ec2_contact_point, :public_ip
 ```
 
 The AWS credentials are loaded from your system. Check https://github.com/aws/aws-sdk-ruby#configuration for more information.
 
-# Usage
+## Usage
 
 The instances must be registered in each stage. In your `config/deploy/<stage_name>.rb`, add the following line:
 
+*This must be placed after you have configured your AWS settings*
 ```ruby
 aws_ec2_register
 ```
@@ -73,7 +73,7 @@ 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
+### 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.
 
@@ -113,9 +113,9 @@ set :aws_ec2_extra_filters, [
 
 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
+## Utility tasks
 
-## aws:ec2:instances
+### aws:ec2:instances
 
 List all the instances found for with the current configuration.
 
@@ -123,6 +123,6 @@ List all the instances found for with the current configuration.
 cap production aws:ec2:instances
 ```
 
-# Contributing
+## Contributing
 
 Open an issue or make a PR, feel free to contribute!

data/capistrano-aws.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name = 'capistrano-aws'
-  gem.version = '1.1.0'
+  gem.version = '1.3.0'
   gem.author = 'Fernando Carletti'
   gem.email = 'contact@fernandocarletti.net'
   gem.homepage = 'http://github.com/fernandocarletti/capistrano-aws'
@@ -21,9 +21,10 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.0'
 
-  gem.add_dependency 'aws-sdk', '~>2.9'
-  gem.add_dependency 'terminal-table', '~>1.7'
-  gem.add_dependency 'colorize', '~>0.8'
+  gem.add_dependency 'capistrano', '~> 3.1'
+  gem.add_dependency 'aws-sdk-ec2', '~> 1'
+  gem.add_dependency 'terminal-table', '>= 1.7', '< 4.0'
+  gem.add_dependency 'rainbow', '~> 3'
 
-  gem.add_development_dependency 'rubocop', '~>0.53'
+  gem.add_development_dependency 'rubocop', '~> 0.53'
 end

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

@@ -1,5 +1,5 @@
 require 'singleton'
-require 'aws-sdk'
+require 'aws-sdk-ec2'
 
 module Capistrano
   module Aws
@@ -22,25 +22,9 @@ module Capistrano
         end
 
         def instances
-          application = fetch(:aws_ec2_application)
-          raise 'application not set.' if application.nil?
-
           instances = {}
 
-          filters = [
-            {
-              name: "tag:#{fetch(:aws_ec2_application_tag)}",
-              values: [fetch(:aws_ec2_application)]
-            },
-            {
-              name: "tag:#{fetch(:aws_ec2_stage_tag)}",
-              values: [fetch(:aws_ec2_stage)]
-            },
-            {
-              name: 'instance-state-name',
-              values: ['running']
-            }
-          ]
+          filters = fetch(:aws_ec2_default_filters)
 
           filters.concat fetch(:aws_ec2_extra_filters)
 
@@ -58,6 +42,10 @@ module Capistrano
         case fetch(:aws_ec2_contact_point)
         when :private_ip
           instance.private_ip_address
+        when :private_dns
+          instance.private_dns_name
+        when :id
+          instance.id
         when :public_dns
           instance.public_dns_name
         else

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

@@ -1,5 +1,5 @@
 require 'terminal-table'
-require 'colorize'
+require 'rainbow'
 
 module Capistrano
   module Aws
@@ -34,27 +34,27 @@ module Capistrano
 
         def header_row
           [
-            'Num'.colorize(mode: :bold),
-            'ID'.colorize(mode: :bold),
-            'Name'.colorize(mode: :bold),
-            'Type'.colorize(mode: :bold),
-            'Contact Point'.colorize(mode: :bold),
-            'Availability Zone'.colorize(mode: :bold),
-            'Roles'.colorize(mode: :bold),
-            'Stages'.colorize(mode: :bold)
+            Rainbow('Num').bright,
+            Rainbow('ID').bright,
+            Rainbow('Name').bright,
+            Rainbow('Type').bright,
+            Rainbow('Contact Point').bright,
+            Rainbow('Availability Zone').bright,
+            Rainbow('Roles').bright,
+            Rainbow('Stages').bright
           ]
         end
 
         def instance_row(number, instance)
           [
             format('%02d:', number),
-            instance.id.colorize(:red),
-            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),
-            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag)).colorize(:yellow),
-            Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_stage_tag)).colorize(:yellow)
+            Rainbow(instance.id).red,
+            Rainbow(Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_name_tag))).green,
+            Rainbow(instance.instance_type).cyan,
+            Rainbow(Capistrano::Aws::EC2.contact_point(instance)).blue,
+            Rainbow(instance.placement.availability_zone).magenta,
+            Rainbow(Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag))).yellow,
+            Rainbow(Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_stage_tag))).yellow
           ]
         end
       end

data/lib/capistrano/aws.rb

@@ -1,13 +1,9 @@
 require 'capistrano/aws/ec2/ec2'
 require 'capistrano/dsl/aws'
+
 extend Capistrano::DSL::Aws
 
 SSHKit::Backend::Netssh.send(:include, Capistrano::DSL::Aws)
 
 load File.expand_path('../tasks/ec2.rake', __FILE__)
-
-namespace :load do
-  task :defaults do
-    load 'capistrano/aws/defaults.rb'
-  end
-end
+load File.expand_path("../tasks/defaults.rake", __FILE__)

data/lib/capistrano/dsl/aws.rb

@@ -9,7 +9,7 @@ module Capistrano
       def aws_ec2_register(options = {})
         aws_ec2.instances.each do |_id, instance|
           ip = Capistrano::Aws::EC2.contact_point(instance)
-          roles = Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag)).split(',')
+          roles = Capistrano::Aws::EC2.parse_tag(instance, fetch(:aws_ec2_roles_tag)).split(",").map(&:strip)
 
           server ip, options.merge(roles: roles, aws_instance_id: instance.id)
         end

data/lib/capistrano/tasks/defaults.rake

@@ -0,0 +1,48 @@
+namespace :load do
+  task :defaults do
+    # AWS regions to use.
+    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 (the tag value can be a comma separated list).
+    set :aws_ec2_roles_tag, 'Roles'
+
+    # Default filters used for all requests, set to an empty array [] to disable completely
+    set :aws_ec2_default_filters, (proc {
+      [
+        {
+          name: "tag:#{fetch(:aws_ec2_application_tag)}",
+          values: [fetch(:aws_ec2_application)]
+        },
+        {
+          name: "tag:#{fetch(:aws_ec2_stage_tag)}",
+          values: [fetch(:aws_ec2_stage)]
+        },
+        {
+          name: 'instance-state-name',
+          values: ['running']
+        }
+      ]
+    })
+
+    # 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, :private_dns, :id).
+    set :aws_ec2_contact_point, :public_ip
+  end
+end

metadata

@@ -1,57 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-aws
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Fernando Carletti
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: aws-sdk-ec2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,17 +100,18 @@ files:
 - LICENSE
 - README.md
 - capistrano-aws.gemspec
+- lib/capistrano-aws.rb
 - lib/capistrano/aws.rb
-- lib/capistrano/aws/defaults.rb
 - lib/capistrano/aws/ec2/ec2.rb
 - lib/capistrano/aws/ec2/instances_table.rb
 - lib/capistrano/dsl/aws.rb
+- lib/capistrano/tasks/defaults.rake
 - lib/capistrano/tasks/ec2.rake
 homepage: http://github.com/fernandocarletti/capistrano-aws
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,9 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.2.21
+signing_key:
 specification_version: 4
 summary: Integrates capistrano with AWS.
 test_files: []

data/lib/capistrano/aws/defaults.rb

@@ -1,26 +0,0 @@
-# AWS regions to use.
-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 (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