diplomat 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62862f6656ae4dd60092e29e884c722b22179b01
-  data.tar.gz: 6414b0363e8213a40d4b247b25a301fca3635de4
+  metadata.gz: 7ea44efec4bbbbd7dcea08226f4c1e85ee3d0c74
+  data.tar.gz: 686a774e0ff66b40516eb75f905a9ffb463e4317
 SHA512:
-  metadata.gz: d0b382b7644788c012d204e5c666efb53fe493b456234b3f42cc7bfeb72d004b2c54e4f16afc58b176d114278c50973c489fa2e0795608f7dbc8acf17a6cc342
-  data.tar.gz: f6230d83e8c5547eb20e173ceb43de5e6a42ecf6094c49898b51e3b5ada275dfee34f0dc9c671a9d1cec51f775acd3ae647ab18554e77681a962ad4f6b9f78b4
+  metadata.gz: 96a3c918192148440c80515a0e49cadd8422ead23a814c12d9e21e66907654c6d07a6dbf5e6b1a33864165644245442eb0b36ac8fb9ac8a9acbc87d10e52cfb6
+  data.tar.gz: 54a7dc66263f1dadb005e6ba4ef402551e5c5244d492d9f83e01d3dab27164384b865c98c451d4f25305a843542a23797b16bd32b3aea3b1cda1cb96099f79a1

data/README.md

@@ -100,6 +100,20 @@ nodes = Diplomat::Node.get_all
 # => [#<OpenStruct Address="10.1.10.12", Node="foo">, #<OpenStruct Address="10.1.10.13", Node="bar">]
 ```
 
+Register a node:
+
+```ruby
+Diplomat::Node.register({ :Node => "app1", :Address => "10.0.0.2" })
+# => true
+```
+
+De-register a node:
+
+```ruby
+Diplomat::Node.deregister({ :Node => "app1", :Address => "10.0.0.2" })
+# => true
+```
+
 ### Services
 
 #### Getting
@@ -227,6 +241,21 @@ end
 events.each{ |e| puts e }
 ```
 
+### Maintenance mode
+
+Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)
+
+```ruby
+Diplomat::Maintenance.enable(true, 'doing stuff', :dc => 'abc')
+```
+
+Determine if a host has maintenance mode enabled
+
+```ruby
+Diplomat::Maintenance.enabled('foobar')
+# => { :enabled => true, :reason => 'doing stuff' }
+```
+
 ### Custom configuration
 
 You can create a custom configuration using the following syntax:

data/lib/diplomat.rb

@@ -23,7 +23,7 @@ module Diplomat
 
   require_libs "configuration", "rest_client", "api_options", "kv", "datacenter",
     "service", "members", "node", "nodes", "check", "health", "session", "lock",
-    "error", "event", "acl"
+    "error", "event", "acl", "maintenance"
   self.configuration ||= Diplomat::Configuration.new
 
   class << self

data/lib/diplomat/event.rb

@@ -2,6 +2,9 @@ require 'faraday'
 
 module Diplomat
   class Event < Diplomat::RestClient
+  
+    include ApiOptions
+  
     @access_methods = [ :fire, :get_all, :get ]
 
     # Send an event
@@ -12,14 +15,14 @@ module Diplomat
     # @param tag [String] the target tag name, must only be used with service
     # @return [nil]
     def fire name, value=nil, service=nil, node=nil, tag=nil
-      @conn.put do |req|
-        url = [ "/v1/event/fire/#{name}" ]
-        url += use_named_parameter("service", service)
-        url += use_named_parameter("node", node)
-        url += use_named_parameter("tag", tag) if service
-        req.url concat_url url
-        req.body = value unless value.nil?
-      end
+      url = [ "/v1/event/fire/#{name}" ]
+      url += check_acl_token
+      url += use_named_parameter("service", service)
+      url += use_named_parameter("node", node)
+      url += use_named_parameter("tag", tag) if service
+      url = concat_url url
+
+      @conn.put(url, value)
       nil
     end
 
@@ -55,6 +58,7 @@ module Diplomat
     #   - W W - get the first or next value; wait until there is an update
     def get_all name=nil, not_found=:reject, found=:return
       url = ["/v1/event/list"]
+      url += check_acl_token
       url += use_named_parameter("name", name)
       url = concat_url url
 
@@ -104,6 +108,7 @@ module Diplomat
     #   events (while being sure that none are missed).
     def get name=nil, token=:last, not_found=:wait, found=:return
       url = ["/v1/event/list"]
+      url += check_acl_token
       url += use_named_parameter("name", name)
       url = concat_url url
       @raw = @conn.get url

data/lib/diplomat/maintenance.rb

@@ -0,0 +1,47 @@
+require 'base64'
+require 'faraday'
+
+module Diplomat
+  class Maintenance < Diplomat::RestClient
+    @access_methods = [ :enabled, :enable]
+
+    # Get the maintenance state of a host
+    # @param n [String] the node
+    # @param options [Hash] :dc string for dc specific query
+    # @return [Hash] { :enabled => true, :reason => 'foo' }
+    def enabled n, options=nil
+      health = Diplomat::Health.new(@conn)
+      result = health.node(n, options).
+        select { |check| check['CheckID'] == '_node_maintenance' }
+
+      if result.size > 0
+        { :enabled => true, :reason => result.first['Notes'] }
+      else
+        { :enabled => false, :reason => nil }
+      end
+    end
+
+    # Enable or disable maintenance mode.  This endpoint only works
+    # on the local agent.
+    # @param enable enable or disable maintenance mode
+    # @param reason [String] the reason for enabling maintenance mode
+    # @param options [Hash] :dc string for dc specific query
+    # @return true if call is successful
+    def enable enable=true, reason=nil, options=nil
+      raw = @conn.put do |req|
+        url = ["/v1/agent/maintenance"]
+        url << use_named_parameter('enable', enable.to_s)
+        url << use_named_parameter('reason', reason) unless reason.nil?
+        url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
+        req.url concat_url url
+      end
+
+      if raw.status == 200
+        @raw = raw
+        return true
+      else
+        raise Diplomat::UnknownStatus, "status #{raw.status}"
+      end
+    end
+  end
+end

data/lib/diplomat/node.rb

@@ -4,7 +4,9 @@ require 'faraday'
 module Diplomat
   class Node < Diplomat::RestClient
 
-    @access_methods = [ :get, :get_all ]
+    include ApiOptions
+
+    @access_methods = [ :get, :get_all, :register, :deregister ]
 
     # Get a node by it's key
     # @param key [String] the key
@@ -13,6 +15,7 @@ module Diplomat
     def get key, options=nil
 
       url = ["/v1/catalog/node/#{key}"]
+      url += check_acl_token
       url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
 
       # If the request fails, it's probably due to a bad path
@@ -37,5 +40,23 @@ module Diplomat
 
       return JSON.parse(ret.body).map { |service| OpenStruct.new service }
     end
+
+    # Register a node
+    # @param definition [Hash] Hash containing definition of a node to register
+    # @return [Boolean]
+    def register(definition, path='/v1/catalog/register')
+      register = @conn.put path, JSON.dump(definition)
+
+      return register.status == 200
+    end
+
+    # De-register a node (and all associated services and checks)
+    # @param definition [Hash] Hash containing definition of a node to de-register
+    # @return [Boolean]
+    def deregister(definition, path="/v1/catalog/deregister")
+      deregister = @conn.put path, JSON.dump(definition)
+
+      return deregister.status == 200
+    end
   end
 end

data/lib/diplomat/service.rb

@@ -4,7 +4,9 @@ require 'faraday'
 module Diplomat
   class Service < Diplomat::RestClient
 
-    @access_methods = [ :get, :get_all, :register, :deregister ]
+    include ApiOptions
+
+    @access_methods = [ :get, :get_all, :register, :deregister, :register_external, :deregister_external ]
 
     # Get a service by it's key
     # @param key [String] the key
@@ -15,6 +17,7 @@ module Diplomat
     def get key, scope=:first, options=nil, meta=nil
 
       url = ["/v1/catalog/service/#{key}"]
+      url += check_acl_token
       url << use_named_parameter('wait', options[:wait]) if options and options[:wait]
       url << use_named_parameter('index', options[:index]) if options and options[:index]
       url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
@@ -46,6 +49,7 @@ module Diplomat
     # @return [OpenStruct] the list of all services
     def get_all options=nil
       url = ["/v1/catalog/services"]
+      url += check_acl_token
       url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
       begin
         ret = @conn.get concat_url url
@@ -59,9 +63,9 @@ module Diplomat
     # Register a service
     # @param definition [Hash] Hash containing definition of service
     # @return [Boolean]
-    def register(definition)
+    def register(definition, path='/v1/agent/service/register')
       json_definition = JSON.dump(definition)
-      register = @conn.put '/v1/agent/service/register', json_definition
+      register = @conn.put path, json_definition
       return register.status == 200
     end
 
@@ -72,5 +76,21 @@ module Diplomat
       deregister = @conn.get "/v1/agent/service/deregister/#{service_name}"
       return deregister.status == 200
     end
+
+    # Register an external service
+    # @param definition [Hash] Hash containing definition of service
+    # @return [Boolean]
+    def register_external(definition)
+      register(definition, '/v1/catalog/register')
+    end
+
+    # Deregister an external service
+    # @param definition [Hash] Hash containing definition of service
+    # @return [Boolean]
+    def deregister_external(definition)
+      json_definition = JSON.dump(definition)
+      deregister = @conn.put '/v1/catalog/deregister', json_definition
+      return deregister.status == 200
+    end
   end
 end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - John Hamelink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,6 +187,7 @@ files:
 - lib/diplomat/health.rb
 - lib/diplomat/kv.rb
 - lib/diplomat/lock.rb
+- lib/diplomat/maintenance.rb
 - lib/diplomat/members.rb
 - lib/diplomat/node.rb
 - lib/diplomat/nodes.rb