capistrano-aws-hosts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e77ffd50a4ac9dc978149cf4e1d1273473497970
+  data.tar.gz: 2d3a4844ea7b9b098231bc5c4e035f813a7c2a6c
+SHA512:
+  metadata.gz: 2bdefb9729bd4308f1cda3250d500bcb0670b127e951ea1521665f9f54d6bffa176aab06190b976e4e0c03a5a75548be99dd49f85bf23e49f27b15d2e0566c2b
+  data.tar.gz: 7e387afc6a27d2a8df491d409b0aa5e7e1c35ec59185ba346ee52fdfef9129660b930c8c73d6e0dd00d61f59dad83d29aca3b105065314ca40a7fa2b8d00873f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-aws-hosts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matthew Savage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Capistrano::Aws::Hosts
+
+Provides an interface to retrieve host inventory from AWS for deployment to a dynamic range of targets.
+
+This depends on EC2 hosts being tagged with the Role tag (e.g. Role=Dashboard)
+
+This plugin is for Capistrano 3 - sorry, no love for version 2...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+    gem 'capistrano-aws-hosts'
+end
+```
+
+And then add the following to your Capfile:
+
+```ruby
+require 'capistrano/aws/hosts'
+```
+
+Add defaults to your config/deploy.rb file:
+
+```ruby
+set :aws_hosts_filter, 'Dashboard'
+set :aws_region, 'ap-southeast-2'
+```
+
+Finally, in your config/deploy/environment_name.rb files:
+
+```ruby
+set :aws_profile, 'sandbox' # Optional
+hosts = fetch_aws_hosts.map(&:private_ip)
+role :web, hosts
+role :app, hosts
+role :worker, hosts
+role :db,  hosts.first
+```
+
+## Usage
+
+The call to `fetch_aws_hosts` will return an array of Structs with the following values:
+
+```ruby
+    private_ip: '10.0.0.1'
+    instance_id: 'i-abc123de456bb'
+    name: 'PROD-PRIVATE-DASHBOARD-A'
+```
+
+## Testing
+This has been manually tested specifically to our AWS environment, and while this should work across other AWS environments I cannot guarantee this will be the case. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-aws-hosts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-aws-hosts.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/aws/hosts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-aws-hosts"
+  spec.version       = Capistrano::Aws::Hosts::VERSION
+  spec.authors       = ["Matthew Savage"]
+  spec.email         = ["matt@amasses.net"]
+
+  spec.summary       = %q{Provide access to AWS EC2 inventory for deploy host targets}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '>= 3.0'
+  spec.add_dependency 'aws-sdk-ec2', '~> 1'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/aws/hosts/version.rb

@@ -0,0 +1,7 @@
+module Capistrano
+  module Aws
+    module Hosts
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/capistrano/aws/hosts.rb

@@ -0,0 +1,41 @@
+require "capistrano/aws/hosts/version"
+require 'aws-sdk-ec2'
+module Capistrano
+  module Aws
+    module Hosts
+      # Fetches the hosts from AWS, filtering based on the tag 'Role' values (wildcarded)
+      #
+      # @return [Array<Struct(private_ip, instance_id, name>] array of instance records
+      def fetch_aws_hosts
+        role_name = fetch(:aws_hosts_filter)
+        profile = fetch(:aws_hosts_profile) || ENV['AWS_PROFILE']
+        region = fetch(:aws_region) || ENV['AWS_DEFAULT_REGION']
+        
+        raise 'Region is not specified - please set :aws_region or export AWS_DEFAULT_REGION as an environment variable' unless region.to_s != ''
+        # raise "Profile is not specified - please set :aws_region or export AWS_DEFAULT_REGION as an environment variable" unless region.present?
+        
+        client = ::Aws::EC2::Client.new(region: region, profile: profile)
+
+        instances = client.describe_instances(filters: [
+          {name: 'instance-state-name', values: ['running']},
+          {name: 'tag-key', values: ['Role']},
+          {name: 'tag-value', values: ["*#{role_name}*"]}
+        ])
+
+        instances = instances.first.reservations.first.instances
+        result = instances.each_with_object([]) do |item, arr|
+          arr << OpenStruct.new(
+            private_ip: item.private_ip_address,
+            instance_id: item.instance_id,
+            name: item.tags.select {|t| t.key == 'Name'}.first.value
+          )
+        end
+
+        print "Target hosts: #{result.map(&:name).join(', ')}\n"
+        result
+      end
+    end
+  end
+end
+
+include Capistrano::Aws::Hosts

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-aws-hosts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Savage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- matt@amasses.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-aws-hosts.gemspec
+- lib/capistrano/aws/hosts.rb
+- lib/capistrano/aws/hosts/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Provide access to AWS EC2 inventory for deploy host targets
+test_files: []