nat-monitor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3665bd673f7f721528355cfacc695941a2f98063
+  data.tar.gz: aa462845fffc6a241368013dc1b90b609bb3b1bd
+SHA512:
+  metadata.gz: f6bd6266e6104e3f42baea9a2c408ec45b9a714511cfc1263ae7f2937b26fdbb87c856817edc214d5f0a0ade6307e65190a1ccc457d6897e63dc0d40d9f5346a
+  data.tar.gz: 3c86db404315f8e6dfc0aeae92fd0ac9969b3823b258791913f24e2110fe198ba053eb93bf78e45e0b3ddfb0fe4aac47e6c0261546efa34d11767eab3d076db4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nat-monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eric Herot
+
+MIT License
+
+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,55 @@
+# Nat::Monitor
+
+Monitors a quorum of NAT servers for an outage and reassigns the specified EC2 route table to point to a working server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nat-monitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nat-monitor
+
+## Usage
+
+Run it as a service after creating the configuration YAML file.
+
+E.g.:
+
+    $ nat-monitor [OPTIONAL CONF_FILE]
+
+By default it will check `/etc/nat_monitor.yml` for its configuration.
+
+## Example Configuration
+
+```yaml
+---
+route_table_id: rtb-00000001
+nodes:
+  i-00000001: 10.0.0.1
+  i-00000002: 10.0.1.1
+  i-00000003: 10.0.2.1
+```
+
+Optional properties include:
+```yaml
+pings: 3
+ping_timeout: 1
+heartbeat_interval: 10
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nat-monitor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/nat-monitor

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nat-monitor'
+
+EtTools::NatMonitor.new(ARGV[0]).run

data/lib/nat-monitor.rb

@@ -0,0 +1,121 @@
+module EtTools
+  class NatMonitor
+    require 'net/http'
+    require 'net/ping'
+    require 'fog'
+    require 'yaml'
+
+    def initialize(conf_file = nil)
+      @conf = YAML.load_file(conf_file || '/etc/nat_monitor.yml')
+      @conf = defaults.merge @conf
+    end
+
+    def run
+      validate!
+      output 'Starting NAT Monitor'
+      main_loop
+    end
+
+    def validate!
+      case
+      when !@conf['route_table_id']
+        output 'route_table_id not specified'
+        exit 1
+      when !route_exists?(@conf['route_table_id'])
+        output "Route #{@conf['route_table_id']} not found"
+        exit 2
+      when @conf['nodes'].count < 3
+        output '3 or more nodes are required to create a quorum'
+        exit 3
+      end
+    end
+
+    def output(message)
+      puts message
+    end
+
+    def defaults
+      { 'pings' => 3,
+        'ping_timeout' => 1,
+        'heartbeat_interval' => 10 }
+    end
+
+    def main_loop
+      loop do
+        heartbeat
+        sleep @conf['heartbeat_interval']
+      end
+    end
+
+    def heartbeat
+      return if am_i_master?
+      un = unreachable_nodes
+      return if (un.count == other_nodes.keys.count) || # Next if I'm unreachable...
+                !un.include?(current_master) # ...unless master is unreachable
+      steal_route
+    end
+
+    def steal_route
+      output 'Stealing route 0.0.0.0/0 on route table ' \
+             "#{@conf['route_table_id']}"
+      connection.replace_route(
+        @conf['route_table_id'],
+        '0.0.0.0/0',
+        my_instance_id
+      )
+    end
+
+    def unreachable_nodes
+      other_nodes.select { |_node, ip| !pingable?(ip) }
+    end
+
+    def other_nodes
+      @other_nodes ||= begin
+        nodes = @conf['nodes'].dup
+        nodes.delete my_instance_id
+        nodes
+      end
+    end
+
+    def pingable?(ip)
+      p = Net::Ping::External.new(ip)
+      p.timeout = @conf['ping_timeout']
+      p.ping?
+    end
+
+    def route_exists?(route_id)
+      connection.route_tables.map(&:id).include? route_id
+    end
+
+    def connection
+      @connection ||= begin
+        Fog::Compute::AWS.new(aws_access_key_id: 'AWS_ACCESS_KEY_ID',
+                              aws_secret_access_key: 'AWS_SECRET_ACCESS_KEY')
+      end
+    end
+
+    def current_master
+      default_r = connection.route_tables.get(route_table_id).routes.find do |r|
+        r['destinationCidrBlock'] == '0.0.0.0/0'
+      end
+      default_r['instanceId']
+    end
+
+    def my_instance_id
+      @my_instance_id ||= begin
+        Net::HTTP.get(
+          '169.254.169.254',
+          '/latest/meta-data/instance-id'
+        )
+      end
+    end
+
+    def am_i_master?
+      master_node? my_instance_id
+    end
+
+    def master_node?(node_id)
+      current_master == node_id
+    end
+  end
+end

data/lib/nat-monitor/version.rb

@@ -0,0 +1,5 @@
+module EtTools
+  class NatMonitor
+    VERSION = '1.0.0'
+  end
+end

data/nat-monitor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nat-monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nat-monitor'
+  spec.version       = EtTools::NatMonitor::VERSION
+  spec.authors       = ['Eric Herot']
+  spec.email         = ['eric.github@herot.com']
+  spec.summary       = 'A service for providing an HA NAT in EC2'
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'fog', '~> 1.23'
+end

data/spec/lib/nat-monitor_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+require 'byebug'
+require 'nat-monitor'
+
+describe EtTools::NatMonitor do
+  before(:each) do
+    @route_table_id = 'rtb-00000000'
+    @my_instance_id = 'i-00000001'
+
+    @other_nodes = { 'i-00000002' => '1.1.1.2',
+                     'i-00000003' => '1.1.1.3' }
+
+    @yaml_conf = { 'route_table_id' => @route_table_id,
+                   'nodes' => (
+                     { @my_instance_id => '1.1.1.1' }
+                   ).merge(@other_nodes) }
+
+    filepath = 'bogus_filename.yml'
+    allow(YAML).to receive(:load_file).with(filepath)
+      .and_return(@yaml_conf)
+
+    @nat_monitor = EtTools::NatMonitor.new(filepath)
+
+    @defaults = { 'pings' => 3,
+                  'ping_timeout' => 1,
+                  'heartbeat_interval' => 10 }
+
+    allow(@nat_monitor).to receive(:my_instance_id).and_return(@my_instance_id)
+    allow(@nat_monitor).to receive(:steal_route).and_return(true)
+  end
+
+  context 'fewer than 3 nodes are specified' do
+    before do
+      allow(YAML).to receive(:load_file).with(any_args)
+      @nat_monitor.instance_variable_set(
+        :@conf,
+        ({ 'route_table_id' => @route_table_id,
+           'nodes' => @other_nodes })
+      )
+      allow(@nat_monitor).to receive(:route_exists?).with(any_args)
+        .and_return true
+    end
+
+    it 'exits with status 3' do
+      expect(@nat_monitor).to receive(:exit).with(3)
+      @nat_monitor.validate!
+    end
+  end
+
+  context 'invalid route is specified' do
+    # connection.route_tables.map(&:id).include? route_id
+    before do
+      allow_any_instance_of(Fog::Compute::AWS).to receive(:route_tables)
+        .and_return [
+          double('route_tables',
+                 id: 'rtb-99999999')
+        ]
+    end
+
+    it 'exits with status 2' do
+      expect(@nat_monitor).to receive(:route_exists?).with(@route_table_id)
+        .and_return false
+      expect(@nat_monitor).to receive(:exit).with(2)
+      @nat_monitor.validate!
+    end
+  end
+
+  context 'no route is specified' do
+    before do
+      @nat_monitor.instance_variable_set(
+        :@conf,
+        'nodes' => ({ @my_instance_id => '1.1.1.1' }).merge(@other_nodes)
+      )
+    end
+
+    it 'exits with status 1' do
+      expect(@nat_monitor).to receive(:exit).with(1)
+      @nat_monitor.validate!
+    end
+  end
+
+  context 'local node is the master' do
+    before do
+      allow(@nat_monitor).to(
+        receive(:current_master).and_return(@my_instance_id)
+      )
+    end
+
+    it 'sets @conf correctly' do
+      expect(@nat_monitor.instance_variable_get(:@conf)).to eq(
+        @yaml_conf.merge(@defaults)
+      )
+    end
+
+    it 'and knows that it is master' do
+      expect(@nat_monitor).to receive(:am_i_master?).and_return(true)
+      @nat_monitor.heartbeat
+    end
+
+    it 'and does not check for unreachable nodes' do
+      expect(@nat_monitor).to_not receive(:unreachable_nodes)
+      @nat_monitor.heartbeat
+    end
+  end
+
+  context 'local node is not master' do
+    before do
+      allow(@nat_monitor).to(
+        receive(:current_master).and_return('i-00000002')
+      )
+    end
+
+    context 'and can ping everything' do
+      before do
+        allow(@nat_monitor).to receive(:pingable?).with(any_args)
+          .and_return true
+      end
+
+      it 'does not try to steal the route' do
+        expect(@nat_monitor).to_not receive(:steal_route)
+        @nat_monitor.heartbeat
+      end
+    end
+
+    context 'and can\'t ping anything' do
+      before do
+        allow(@nat_monitor).to receive(:pingable?).with(any_args)
+          .and_return false
+      end
+
+      it 'counts unreachable nodes correctly' do
+        allow(@nat_monitor).to receive(:other_nodes)
+          .and_return(@other_nodes)
+        expect(@nat_monitor).to receive(:unreachable_nodes)
+          .and_return(@other_nodes)
+        @nat_monitor.heartbeat
+      end
+
+      it 'does not try to steal the route' do
+        expect(@nat_monitor).to receive(:unreachable_nodes)
+          .and_return(@other_nodes)
+        expect(@nat_monitor).to_not receive(:steal_route)
+        @nat_monitor.heartbeat
+      end
+    end
+
+    context 'and can\'t ping the master' do
+      before do
+        allow(@nat_monitor).to receive(:pingable?).with('1.1.1.2')
+          .and_return false
+        allow(@nat_monitor).to receive(:pingable?).with('1.1.1.3')
+          .and_return true
+        allow_any_instance_of(Fog::Compute::AWS).to receive(:replace_route)
+          .with(@route_table_id, '0.0.0.0', @my_instance_id)
+          .and_return true
+      end
+
+      it 'computes the list of other nodes correctly' do
+        expect(@nat_monitor).to receive(:other_nodes)
+          .exactly(2).times.and_return(@other_nodes)
+        @nat_monitor.heartbeat
+      end
+
+      it 'finds i-00000002 unreachable' do
+        expect(@nat_monitor).to receive(:unreachable_nodes)
+          .and_return('i-00000002' => '1.1.1.2')
+        @nat_monitor.heartbeat
+      end
+
+      it 'tries to steal the route' do
+        allow(@nat_monitor).to receive(:other_nodes)
+          .and_return(@other_nodes)
+        expect(@nat_monitor).to receive(:steal_route)
+        @nat_monitor.heartbeat
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'simplecov'
+
+SimpleCov.start

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nat-monitor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Herot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+description: A service for providing an HA NAT in EC2
+email:
+- eric.github@herot.com
+executables:
+- nat-monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nat-monitor
+- lib/nat-monitor.rb
+- lib/nat-monitor/version.rb
+- nat-monitor.gemspec
+- spec/lib/nat-monitor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache 2.0
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A service for providing an HA NAT in EC2
+test_files:
+- spec/lib/nat-monitor_spec.rb
+- spec/spec_helper.rb