consul_syncer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84c90cae567535c20d3965ef9bf933ec3a6408e9
+  data.tar.gz: c757284962593f66d365345220e87f33d082cf65
+SHA512:
+  metadata.gz: 2456d0129b4ce655b3c8d829c20c18e77685e263c61f3c5919f20c360d5fa92316bfcdc4c64a4c46e74631e896d24fe3e9dd17bf689e20f9a49a4fb64945c492
+  data.tar.gz: 9320fb542f405a9f28701ad2983c6053ae1bf2d0885cf0bae710571acfd4cde8e8c85b89c9e6c5fabbe33914c907d29fa74929cf64073a590537ad9d3a059258

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Michael Grosser <michael@grosser.it>
+
+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/lib/consul_syncer.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'logger'
+require 'consul_syncer/endpoint'
+require 'consul_syncer/wrapper'
+
+# syncs a given list of endpoints into consul
+# - adds missing
+# - updates changed
+# - removes deprecated
+class ConsulSyncer
+  def initialize(url, logger: Logger.new(STDOUT))
+    @consul = Wrapper.new(Faraday.new(url))
+    @logger = logger
+  end
+
+  # changing tags means all previous services need to be removed manually since
+  # they can no longer be found
+  def sync(expected_definitions, tags)
+    raise ArgumentError, "Need at least 1 tag to reliably update endpoints" if tags.empty?
+
+    modified = 0
+
+    # ensure consistent tags to find the endpoints after adding
+    expected_definitions = expected_definitions.dup
+    expected_definitions.each do |d|
+      d[:tags] += tags
+      d[:tags].sort!
+    end
+
+    actual_definitions = consul_endpoints(tags).map do |consul_endpoint|
+      {
+        node: consul_endpoint.node,
+        address: consul_endpoint.ip,
+        service: consul_endpoint.name,
+        service_id: consul_endpoint.service_id,
+        tags: consul_endpoint.tags.sort,
+        port: consul_endpoint.port
+      }
+    end
+
+    identifying = [:node, :service]
+    interesting = [*identifying, :address, :tags, :port]
+
+    expected_definitions.each do |expected|
+      description = "#{expected.fetch(:service)} on #{expected.fetch(:node)} in Consul"
+
+      if remove_matching_service!(actual_definitions, expected, interesting)
+        @logger.info "Found #{description}"
+      elsif remove_matching_service!(actual_definitions, expected, identifying)
+        @logger.info "Updating #{description}"
+        modified += 1
+        register expected
+      else
+        @logger.info "Adding #{description}"
+        modified += 1
+        register expected
+      end
+    end
+
+    # all definitions that are left did not match any expected definitions and are no longer needed
+    actual_definitions.each do |actual|
+      @logger.info "Removing #{actual.fetch(:service)} on #{actual.fetch(:node)} in Consul"
+      modified += 1
+      deregister actual.fetch(:node), actual.fetch(:service_id)
+    end
+
+    modified
+  end
+
+  private
+
+  def consul_endpoints(requested_tags)
+    services = @consul.request(:get, "/v1/catalog/services?tag=#{requested_tags.first}")
+    services.each_with_object([]) do |(name, tags), all|
+      # cannot query for multiple tags via query, so handle multi-matching manually
+      next if (requested_tags - tags).any?
+
+      @logger.info "Getting service endpoints for #{name}"
+      # this also finds the 'external services' we define since they have no checks
+      endpoints = @consul.request(:get, "/v1/health/service/#{name}")
+      endpoints.each do |endpoint|
+        endpoint = Endpoint.new(endpoint)
+        next if (requested_tags - endpoint.tags).any?
+        all << endpoint
+      end
+    end
+  end
+
+  def remove_matching_service!(actuals, expected, keys)
+    return unless found = actuals.detect { |actual| actual.values_at(*keys) == expected.values_at(*keys) }
+    actuals.delete(found)
+  end
+
+  # creates or updates based on node and service
+  def register(node:, service:, address:, tags:, port:)
+    @consul.request(
+      :put,
+      '/v1/catalog/register',
+      Node: node,
+      Address: address,
+      Service: {
+        Service: service,
+        Tags: tags,
+        Port: port
+      }
+    )
+  end
+
+  def deregister(node, service_id)
+    @consul.request(
+      :put,
+      '/v1/catalog/deregister',
+      Node: node,
+      ServiceID: service_id
+    )
+  end
+end

data/lib/consul_syncer/endpoint.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+class ConsulSyncer
+  class Endpoint
+    def initialize(service_hash)
+      @hash = service_hash
+    end
+
+    def name
+      @hash.fetch('Service').fetch('Service')
+    end
+
+    def service_id
+      @hash.fetch('Service').fetch('ID')
+    end
+
+    def node
+      @hash.fetch('Node').fetch('Node')
+    end
+
+    def port
+      @hash.fetch('Service').fetch('Port')
+    end
+
+    def tags
+      @hash.fetch('Service').fetch('Tags', [])
+    end
+
+    def ip
+      @hash.fetch('Node').fetch('Address')
+    end
+  end
+end

data/lib/consul_syncer/version.rb

@@ -0,0 +1,3 @@
+class ConsulSyncer
+  VERSION = "0.1.0"
+end

data/lib/consul_syncer/wrapper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# - parses json responses
+# - fails with descriptive output when a request fails
+class ConsulSyncer
+  class Wrapper
+    BACKOFF = [0.1, 0.5, 1.0, 2.0].freeze
+
+    class ConsulError < StandardError
+    end
+
+    def initialize(consul)
+      @consul = consul
+    end
+
+    def request(method, path, payload = nil)
+      retry_on_error do
+        args = [path]
+        args << payload.to_json if payload
+        response = @consul.send(method, *args)
+        if response.status == 200
+          if method == :get
+            JSON.parse(response.body)
+          else
+            true
+          end
+        else
+          raise(
+            ConsulError,
+            "Failed to request #{response.env.method} #{response.env.url}: #{response.status} -- #{response.body}"
+          )
+        end
+      end
+    end
+
+    private
+
+    def retry_on_error
+      yield
+    rescue Faraday::Error, ConsulError
+      retried ||= 0
+      backoff = BACKOFF[retried]
+      raise unless backoff
+      retried += 1
+
+      warn "Consul request failed, retrying in #{backoff}s"
+      sleep backoff
+      retry
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: consul_syncer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/consul_syncer.rb
+- lib/consul_syncer/endpoint.rb
+- lib/consul_syncer/version.rb
+- lib/consul_syncer/wrapper.rb
+homepage: https://github.com/grosser/consul_syncer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Sync remote services into consul
+test_files: []