nerve 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09be8c301fe459dcab4e5aa469f863ebb27c9f51
+  data.tar.gz: f458f7c7d2cbbd3e82f029d3a3488bcd5eff9088
+SHA512:
+  metadata.gz: bf15ca3c591c8bac19750d9c3e1ba96ef7af6096492dbd69f76c971563a22fb7948fa1322d11664b819e185f6d51b1e279ba54b08bba062433c6fb06b7b3be5b
+  data.tar.gz: b4b4b89e7eb356611b11aea64f9df687af5c1dc657864d791d799f7b80b2c7e63c16b7fccdc4e502593e03b7f42b6f6f425f2c67dddacaaa99bb0b4778ffd7cf

data/CONTRIBUTING.md

@@ -1,8 +1,22 @@
 # Contributing Guidelines #
 
 Thanks for contributing to SmartStack!
-If you're opening a new PR, please ask for a merge into our `pull_requests` branch -- *not* `master`.
-This will allow us avoid a back-and-forth by quickly accepting your PR and then making minor changes or doing testing before merging into `master`.
+
+If you are opening a new PR, please ask for a merge into the `master` branch.
+
+## Writing Reporters ##
+Nerve supports *pluggable* reporters, which means that you can easily add
+a reporter by making your own gem that contains your reporter available for
+require at ``nerve/reporter/#{name.downcase}``. If you do this please do
+submit a PR with a link to your gem/repo and we can reference it from the
+README.
+
+In general it is preferred to keep reporters that require specific dependencies
+out of nerve because that way you can select the version of dependencies that
+you need (for example if you have a particular version of the docker api or
+etcd). That being said, if your reporter has no external dependencies
+(e.g. files) or is extremely common (e.g. zookeeper, etcd), we may choose to
+support it in the repo itself.
 
 ## Writing Checks ##
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nerve (0.6.0)
+    nerve (0.7.0)
       bunny (= 1.1.0)
       etcd (~> 0.2.3)
       json

data/README.md

@@ -19,17 +19,27 @@ The information it reports can be used to take action from a centralized automat
 
 ## Installation ##
 
-Add this line to your application's Gemfile:
+To download and run the nerve binary, first install a version of ruby. Then,
+install nerve with:
 
-    gem 'nerve'
+```bash
+$ mkdir -p /opt/smartstack/nerve
 
-And then execute:
+# If you want to install specific versions of dependencies such as an older
+# version of the aws-sdk, the docker-api, etc, gem install that here *before*
+# gem installing nerve. This is also where you would gem install
+# custom reporters.
 
-    $ bundle
+# If you are on Ruby 2.X use --no-document instead of --no-ri --no-rdoc
+$ gem install nerve --install-dir /opt/smartstack/nerve --no-ri --no-rdoc
+```
 
-Or install it yourself as:
-
-    $ gem install nerve
+This will download nerve and its dependencies into /opt/smartstack/nerve. You
+might wish to omit the `--install-dir` flag to use your system's default gem
+path, however this will require you to run `gem install nerve` with root
+permissions. You can also install via bundler, but keep in mind you'll pick up
+Nerve's version of library dependencies and possibly not the ones you need
+for your infra/apps.
 
 ## Configuration ##
 
@@ -54,7 +64,9 @@ The configuration contains the following options:
 * `reporter_type`: the mechanism used to report up/down information; depending on the reporter you choose, additional parameters may be required. Defaults to `zookeeper`
 * `check_interval`: the frequency with which service checks will be initiated; defaults to `500ms`
 * `checks`: a list of checks that nerve will perform; if all of the pass, the service will be registered; otherwise, it will be un-registered
-* `weight`: a positive integer weight value which can be used to affect the haproxy backend weighting in synapse.
+* `weight` (optional): a positive integer weight value which can be used to affect the haproxy backend weighting in synapse.
+* `haproxy_server_options` (optional): a string containing any special haproxy server options for this service instance. For example if you wanted to set a service instance as a backup.
+* `labels` (optional): an object containing user-defined key-value pairs that describe this service instance. For example, you could label service instances with datacenter information.
 
 #### Zookeeper Reporter ####
 

data/lib/nerve/reporter/base.rb

@@ -26,14 +26,27 @@ class Nerve::Reporter
       %w{instance_id host port}.each do |required|
         raise ArgumentError, "missing required argument #{required} for new service watcher" unless service[required]
       end
-      d = {'host' => service['host'], 'port' => service['port'], 'name' => service['instance_id']}
-      return d unless service.has_key?('weight')
+      d = {
+        'host' => service['host'],
+        'port' => service['port'],
+        'name' => service['instance_id']
+      }
 
       # Weight is optional, but it should be well formed if supplied
-      if service['weight'].to_i >= 0 and "#{service['weight']}".match /^\d+$/
-        d['weight'] = service['weight'].to_i
-      else
-        raise ArgumentError, "invalid 'weight' argument in service data: #{service.inspect}"
+      if service.has_key?('weight')
+        if service['weight'].to_i >= 0 and "#{service['weight']}".match /^\d+$/
+          d['weight'] = service['weight'].to_i
+        else
+          raise ArgumentError, "invalid 'weight' argument in service data: #{service.inspect}"
+        end
+      end
+
+      if service.has_key?('haproxy_server_options')
+        d['haproxy_server_options'] = service['haproxy_server_options']
+      end
+
+      if service.has_key?('labels')
+        d['labels'] = service['labels']
       end
       d
     end

data/lib/nerve/service_watcher/http.rb

@@ -36,7 +36,9 @@ module Nerve
         code = response.code.to_i
         body = response.body
 
-        if code >= 200 and code < 300 and (@expect == nil || body.include?(@expect))
+        # Any 2xx or 3xx code should be considered healthy. This is standard
+        # practice in HAProxy, nginx, etc ...
+        if code >= 200 and code < 400 and (@expect == nil || body.include?(@expect))
           log.debug "nerve: check #{@name} got response code #{code} with body \"#{body}\""
           return true
         else

data/lib/nerve/version.rb

@@ -1,3 +1,3 @@
 module Nerve
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/example_services_spec.rb

@@ -23,6 +23,11 @@ describe "example services are valid" do
       it 'saves the weight data' do
         expect(JSON.parse(Nerve::Reporter.new_from_service(service_data).data)['weight']).to eql(2)
       end
+      it 'saves the labels data' do
+        labels = {'az' => 'us-west-1'}
+        service_data['labels'] = labels
+        expect(JSON.parse(Nerve::Reporter.new_from_service(service_data).data)['labels']).to eq(labels)
+      end
     end
 
     context "when #{item} can be initialized as a valid service watcher" do

data/spec/lib/nerve/reporter_spec.rb

@@ -67,6 +67,20 @@ describe Nerve::Reporter::Test do
     it 'works if the weight is a string' do
       expect(subject.get_service_data({'host' => '127.0.0.1', 'port' => 6666, 'instance_id' => 'foobar', 'weight' => '3'})['weight']).to eql(3)
     end
+
+    it 'correctly passes haproxy_server_options' do
+      expect(subject.get_service_data({
+        'host' => '127.0.0.1', 'port' => 6666, 'instance_id' => 'foobar',
+        'haproxy_server_options' => 'backup'
+      })['haproxy_server_options']).to eql('backup')
+    end
+    it 'correctly passes labels' do
+      labels = {'az' => 'us-west-1', 'custom_key' => 'custom_value'}
+      expect(subject.get_service_data({
+        'host' => '127.0.0.1', 'port' => 6666, 'instance_id' => 'foobar',
+        'labels' => labels
+      })['labels']).to eql(labels)
+    end
   end
 end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nerve
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors:
 - Martin Rhoads
@@ -11,44 +10,39 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: zk
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.2
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -64,81 +57,71 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: etcd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Nerve is a service registration daemon. It performs health checks on
@@ -153,10 +136,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .mailmap
-- .nerve.rc
-- .travis.yml
+- ".gitignore"
+- ".mailmap"
+- ".nerve.rc"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
@@ -194,27 +177,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/airbnb/nerve
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A service registration daemon
 test_files:
 - spec/.gitkeep