vagrant-aws-dns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d803e83fcf98591c15b47bdd3be2dcea27de8328
+  data.tar.gz: 7f37e731eb9d21d5f9cacb2ae55c5cfaec4e124c
+SHA512:
+  metadata.gz: 30953b9b2964fd51cdbd0868a551d5b74f89b928c9bc1161fbb9b89d84811001e5373b040b5fa5fd4e492370a4dc74c12f09e1ba95a9f760f8ac5880961b6193
+  data.tar.gz: a614aca6162713bbb1b35ebb4706b557346a8add91ac17877c6973505dce8fffe399f697f82ec35f1bead03063f065d110cd01d7ec81eea08fb4144026b3b16c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/~
+/.idea
+/.vagrant
+.DS_Store
+Vagrantfile
+dummy

data/.ruby-version

@@ -0,0 +1,2 @@
+2.3.0
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+
+group :plugins do
+  gemspec
+  gem 'vagrant-aws', '~> 0.6.0'
+  gem 'vagrant-aws-dns', path: '.'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nassim Kacha
+
+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,64 @@
+# vagrant-aws-dns
+
+`vagrant-aws-dns` is a Vagrant plugin that allows you to set up route53 records.
+
+## Behaviors
+
+* Set route53 records on machine up.
+* Remove associated route53 records on machine halt/destroy.
+ 
+## Installation
+
+    $ vagrant plugin install vagrant-aws-dns
+
+## Usage
+
+### Configuration example
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  config.vm.provider :aws do |aws, override|
+    aws.access_key_id = "YOUR KEY"
+    aws.secret_access_key = "YOUR SECRET KEY"
+    aws.session_token = "SESSION TOKEN"
+    aws.keypair_name = "KEYPAIR NAME"
+
+    aws.ami = "ami-7747d01e"
+
+    override.ssh.username = "ubuntu"
+    override.ssh.private_key_path = "PATH TO YOUR PRIVATE KEY"
+    
+    override.dns.hosted_zone_id = 'HOSTED ZONE ID'
+    override.dns.record_sets = [['subdomain1.domain.com', 'A', '4.3.2.1'], ['subdomain1.domain.com', 'A']]
+  end
+```
+
+### record_sets
+
+`record_sets` is an array of record set that are also represented as arrays. Below are some examples:
+
+* `['subdomain.domain.com', 'A']` - This will set a record of type `subdomain.domain.com. A <public_ip>`, the <public_ip> is auto detected.
+* `['subdomain.domain.com', 'A', '4.3.2.1']` - This will set a record of type `subdomain.domain.com. A 4.3.2.1`.
+* `['subdomain1.domain.com', 'CNAME', 'domain2.com']` - This will set a record of type `subdomain1.domain.com. CNAME domain2.com.`.
+
+## FAQ
+
+* Why this plugin is not named `vagrant-aws-route53` ?
+> Unfortunately, that name was already taken by another plugin of the same kind.
+* So why develop a new one?
+> There are several reasons for this: use of new AWS SDK, support of multiple records, support of deleting records on machine halt
+  or destory.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nasskach/vagrant-aws-dns.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Acknowledgments
+
+I want to thank my employer `atHome Group S.A - REA Group` for giving me the opportunity to share this work with the open source community.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/vagrant-aws-dns.rb

@@ -0,0 +1,7 @@
+require 'vagrant-aws-dns/plugin'
+
+
+module VagrantPlugins
+  module AwsDns
+  end
+end

data/lib/vagrant-aws-dns/action/add_record.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+
+module VagrantPlugins
+  module AwsDns
+    module Action
+      class AddRecord < Base
+
+        def call(env)
+          super env do |record, type, value|
+            @aws.add_record(@machine.config.dns.hosted_zone_id, record, type, value)
+            @machine.ui.info("Add dns record #{record} pointing to #{value}.")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-aws-dns/action/base.rb

@@ -0,0 +1,33 @@
+require 'aws-sdk'
+require_relative '../util/aws_util'
+
+
+module VagrantPlugins
+  module AwsDns
+    module Action
+      class Base
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+        end
+
+        def call(env)
+          return @app.call(env) if @machine.config.dns.hosted_zone_id.nil? && @machine.config.dns.record_sets.nil?
+
+          @aws = AwsDns::Util::AwsUtil.new(@machine.provider_config.access_key_id,
+                                          @machine.provider_config.secret_access_key)
+          public_ip = @aws.get_public_ip(@machine.id)
+
+          @machine.config.dns.record_sets.each do |record_set|
+            record, type, value = record_set
+            yield record, type, value || public_ip  if block_given?
+          end
+
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-aws-dns/action/remove_record.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+
+module VagrantPlugins
+  module AwsDns
+    module Action
+      class RemoveRecord < Base
+
+        def call(env)
+          super env do |record, type, value|
+            @aws.remove_record(@machine.config.dns.hosted_zone_id, record, type, value)
+            @machine.ui.info("Removing dns record #{record}.")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-aws-dns/config.rb

@@ -0,0 +1,31 @@
+require 'vagrant'
+
+
+module VagrantPlugins
+  module AwsDns
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :hosted_zone_id
+      attr_accessor :record_sets
+
+      def initialize
+        @hosted_zone_id = UNSET_VALUE
+        @record_sets     = UNSET_VALUE
+      end
+
+      def finalize!
+        @hosted_zone_id = nil if @hosted_zone_id == UNSET_VALUE
+        @record_sets = nil if @record_sets == UNSET_VALUE
+      end
+
+      def validate(machine)
+        finalize!
+
+        errors = _detected_errors
+        errors << 'hosted_zone_id is required' if @hosted_zone_id.nil? && !@record_sets.nil?
+        errors << 'record_sets is required' if @record_sets.nil? && !hosted_zone_id.nil?
+
+        { 'AwsDns' => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-aws-dns/plugin.rb

@@ -0,0 +1,38 @@
+require 'vagrant'
+
+
+module VagrantPlugins
+  module AwsDns
+    class Plugin < Vagrant.plugin('2')
+      name 'aws-dns'
+
+      description <<-DESC
+        A Vagrant plugin that allows you to setup route53 records.
+      DESC
+
+      config :dns do
+        require_relative 'config'
+        Config
+      end
+
+      action_hook :add_record, :machine_action_up do |hook|
+        require_relative 'action/add_record'
+        hook.after VagrantPlugins::AWS::Action::RunInstance,   VagrantPlugins::AwsDns::Action::AddRecord
+        hook.after VagrantPlugins::AWS::Action::StartInstance, VagrantPlugins::AwsDns::Action::AddRecord
+      end
+
+      action_hook :remove_record, :machine_action_halt do |hook|
+        require_relative 'action/remove_record'
+        hook.after VagrantPlugins::AWS::Action::StopInstance,      VagrantPlugins::AwsDns::Action::RemoveRecord
+        hook.after VagrantPlugins::AWS::Action::TerminateInstance, VagrantPlugins::AwsDns::Action::RemoveRecord
+      end
+
+      action_hook :remove_record, :machine_action_destroy do |hook|
+        require_relative 'action/remove_record'
+        hook.before VagrantPlugins::AWS::Action::StopInstance,      VagrantPlugins::AwsDns::Action::RemoveRecord
+        hook.before VagrantPlugins::AWS::Action::TerminateInstance, VagrantPlugins::AwsDns::Action::RemoveRecord
+      end
+
+    end
+  end
+end

data/lib/vagrant-aws-dns/util/aws_util.rb

@@ -0,0 +1,63 @@
+require 'aws-sdk'
+
+
+module VagrantPlugins
+  module AwsDns
+    module Util
+      class AwsUtil
+
+        attr_reader :ec2, :route53
+
+        def initialize(accesskey, secretkey)
+          credentials = Aws::Credentials.new(accesskey, secretkey)
+          @ec2 = Aws::EC2::Client.new(
+              region: 'eu-west-1',
+              credentials: credentials
+          )
+          @route53 = Aws::Route53::Client.new(
+              region: 'eu-west-1',
+              credentials: credentials
+          )
+        end
+
+        def get_public_ip(instance_id)
+          @ec2.describe_instances({instance_ids: [instance_id]}).reservations[0].instances[0].public_ip_address
+        end
+
+        def add_record(hosted_zone_id, record, type, value)
+          change_record(hosted_zone_id, record, type, value, 'UPSERT')
+        end
+
+        def remove_record(hosted_zone_id, record, type, value)
+          change_record(hosted_zone_id, record, type, value, 'DELETE')
+        end
+
+        private
+
+        def change_record(hosted_zone_id, record, type, value, action='CREATE')
+          @route53.change_resource_record_sets({
+            hosted_zone_id: hosted_zone_id, # required
+              change_batch: {
+                changes: [
+                  {
+                    action: action, # required, accepts CREATE, DELETE, UPSERT
+                    resource_record_set: {
+                      name: record, # required
+                      type: type, # required, accepts SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
+                      ttl: 1,
+                      resource_records: [
+                        {
+                          value: value # required
+                        }
+                      ]
+                    }
+                  }
+                ]
+              }
+          })
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-aws-dns/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module AwsDns
+    VERSION = "0.1.0"
+  end
+end

data/vagrant-aws-dns.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-aws-dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-aws-dns"
+  spec.version       = Vagrant::AwsDns::VERSION
+  spec.authors       = ["Nassim Kacha"]
+  spec.email         = ["nassim.kacha@rea-group.com"]
+
+  spec.summary       = %q{A Vagrant plugin that allows you to set up route53 records.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nasskach/vagrant-aws-dns"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'aws-sdk', '~> 2.2.8'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-aws-dns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nassim Kacha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: A Vagrant plugin that allows you to set up route53 records.
+email:
+- nassim.kacha@rea-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-aws-dns.rb
+- lib/vagrant-aws-dns/action/add_record.rb
+- lib/vagrant-aws-dns/action/base.rb
+- lib/vagrant-aws-dns/action/remove_record.rb
+- lib/vagrant-aws-dns/config.rb
+- lib/vagrant-aws-dns/plugin.rb
+- lib/vagrant-aws-dns/util/aws_util.rb
+- lib/vagrant-aws-dns/version.rb
+- vagrant-aws-dns.gemspec
+homepage: https://github.com/nasskach/vagrant-aws-dns
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Vagrant plugin that allows you to set up route53 records.
+test_files: []