synapse 0.14.3 → 0.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e3738f6460f35bc6577d1e4cae8c03fc140853d
-  data.tar.gz: e1f425aafbf4fabf61eb87951a062ac6dc948c7b
+  metadata.gz: b4276b34a00e100441c2183b1ed89f743bb4b262
+  data.tar.gz: d746a4b04cf9295c66d1616968511f8d5bca3c49
 SHA512:
-  metadata.gz: 0442cbebf0babfa619c09748e00192530ceff0f232e218d185ebe0faff2c502fe8b0c3b90da6ab0e2aba7ecbed12fb753583a72829fb7269f72ddd0b82dccb65
-  data.tar.gz: 449ae8b192445176f43d3d820d36cb68948d09b6ef6c60116732ff1a84e3cb8282d15b358fdb55b941d33ba85d893047a9507652c25339257d0c27531f6dbd39
+  metadata.gz: 0ec01cc2150af99b69d5e438d1da515224cdce9926b978b6b09665269240daed1828501f75b93f0cd92852cf7f55227207b897ff7082b07e9437704f2de574ce
+  data.tar.gz: b9676bc3d4bb7a6647b8502c8edf7d2e02cba979e304a329ec3c99714a5de0f7f01ce00743364864848fa7a51f132f2da5a7bcb26432163b5324967a78ee629f

data/README.md

@@ -163,6 +163,7 @@ level as well, e.g.:
   configuration for how to configure and interact with NGINX.
 
 <a name="services"/>
+
 ### Configuring a Service ###
 
 The `services` section is a hash, where the keys are the `name` of the service to be configured.
@@ -194,6 +195,7 @@ The services hash may contain the following additional keys:
 * `backend_port_override`: the port that discovered servers listen on; you should specify this if your discovery mechanism only discovers names or addresses (like the DNS watcher or the Ec2TagWatcher). If the discovery method discovers a port along with hostnames (like the zookeeper watcher) this option may be left out, but will be used in preference if given.
 
 <a name="discovery"/>
+
 #### Service Discovery ####
 
 We've included a number of `watchers` which provide service discovery.
@@ -292,6 +294,7 @@ It takes the following options:
 * `port_index`: Index of the backend port in the task's "ports" array. (default: 0)
 
 <a name="defaultservers"/>
+
 #### Listing Default Servers ####
 
 You may list a number of default servers providing a service.
@@ -312,6 +315,7 @@ disappear then the previous known backends will be used.  Disable this behavior
 by unsetting `use_previous_backends`.
 
 <a name="haproxysvc"/>
+
 #### The `haproxy` Section ####
 
 This section is its own hash, which should contain the following keys:
@@ -343,6 +347,7 @@ listen on 127.0.0.3:443) allows /etc/hosts entries to point to services.
 * `cookie_value_method`: optional: default value is `name`, it defines the way your backends receive a cookie value in http mode. If equal to `hash`, synapse hashes backend names on cookie value assignation of your discovered backends, useful when you want to use haproxy cookie feature but you do not want that your end users receive a Set-Cookie with your server name and ip readable in clear.
 
 <a name="haproxy"/>
+
 ### Configuring HAProxy ###
 
 The top level `haproxy` section of the config file has the following options:
@@ -376,6 +381,7 @@ Note that a non-default `bind_address` can be dangerous.
 If you configure an `address:port` combination that is already in use on the system, haproxy will fail to start.
 
 <a name="file"/>
+
 ### Configuring `file_output` ###
 
 This section controls whether or not synapse will write out service state
@@ -476,18 +482,21 @@ please do contribute a [link](#plugins).
 5. Create new Pull Request
 
 <a name="createsw"/>
+
 ### Creating a Service Watcher ###
 
 See the Service Watcher [README](lib/synapse/service_watcher/README.md) for
 how to add new Service Watchers.
 
 <a name="createconfig"/>
+
 ### Creating a Config Generator ###
 
 See the Config Generator [README](lib/synapse/config_generator/README.md) for
 how to add new Config Generators
 
 <a name="plugins"/>
+
 ## Links to Synapse Plugins ##
 * [`synapse-nginx`](https://github.com/jolynch/synapse-nginx) Is a `config_generator`
   which allows Synapse to automatically configure and administer a local NGINX

data/lib/synapse/config_generator/README.md

@@ -7,6 +7,15 @@ when your generator has received an update from synapse via `update_config` it
 should sync the watcher state with the external configuration (e.g. HAProxy
 state)
 
+Note that you have access to the following **read only** methods on the
+watchers:
+
+* `config_for_generator[name]` -> Hash: A method for retrieving the watcher config
+ relevant to this particular config watcher.
+* `revision` -> int: A logical, monotonically increasing clock indicating which
+  revision of the watcher this is. You can use this to ignore config updates
+  from watchers that haven't changed
+
 ```ruby
 require "synapse/config_generator/base"
 

data/lib/synapse/config_generator/file_output.rb

@@ -21,6 +21,9 @@ class Synapse::ConfigGenerator
       rescue SystemCallError => err
         raise ArgumentError, "provided output directory #{opts['output_directory']} is not present or creatable"
       end
+
+      # For tracking backends that we don't need to update
+      @watcher_revisions = {}
     end
 
     def tick(watchers)
@@ -28,7 +31,12 @@ class Synapse::ConfigGenerator
 
     def update_config(watchers)
       watchers.each do |watcher|
-        write_backends_to_file(watcher.name, watcher.backends)
+        next if watcher.config_for_generator[name]['disabled']
+
+        unless @watcher_revisions[watcher.name] == watcher.revision
+          @watcher_revisions[watcher.name] = watcher.revision
+          write_backends_to_file(watcher.name, watcher.backends)
+        end
       end
       clean_old_watchers(watchers)
     end

data/lib/synapse/config_generator/haproxy.rb

@@ -837,6 +837,11 @@ class Synapse::ConfigGenerator
       # a place to store the parsed haproxy config from each watcher
       @watcher_configs = {}
 
+      # a place to store generated frontend and backend stanzas
+      @frontends_cache = {}
+      @backends_cache = {}
+      @watcher_revisions = {}
+
       @state_file_path = @opts['state_file_path']
       @state_file_ttl = @opts.fetch('state_file_ttl', DEFAULT_STATE_FILE_TTL).to_i
     end
@@ -897,8 +902,17 @@ class Synapse::ConfigGenerator
         watcher_config = watcher.config_for_generator[name]
         @watcher_configs[watcher.name] ||= parse_watcher_config(watcher)
         next if watcher_config['disabled']
-        new_config << generate_frontend_stanza(watcher, @watcher_configs[watcher.name]['frontend'])
-        new_config << generate_backend_stanza(watcher, @watcher_configs[watcher.name]['backend'])
+
+        regenerate = watcher.revision != @watcher_revisions[watcher.name] ||
+                     @frontends_cache[watcher.name].nil? ||
+                     @backends_cache[watcher.name].nil?
+        if regenerate
+          @frontends_cache[watcher.name] = generate_frontend_stanza(watcher, @watcher_configs[watcher.name]['frontend'])
+          @backends_cache[watcher.name] = generate_backend_stanza(watcher, @watcher_configs[watcher.name]['backend'])
+          @watcher_revisions[watcher.name] = watcher.revision
+        end
+        new_config << @frontends_cache[watcher.name] << @backends_cache[watcher.name]
+
         if watcher_config.include?('shared_frontend')
           if opts['shared_frontend'] == nil
             log.warn "synapse: service #{watcher.name} contains a shared frontend section but the base config does not! skipping."

data/lib/synapse/service_watcher/base.rb

@@ -7,12 +7,13 @@ class Synapse::ServiceWatcher
 
     LEADER_WARN_INTERVAL = 30
 
-    attr_reader :name, :config_for_generator
+    attr_reader :name, :config_for_generator, :revision
 
     def initialize(opts={}, synapse)
       super()
 
       @synapse = synapse
+      @revision = 0
 
       # set required service parameters
       %w{name discovery}.each do |req|
@@ -199,6 +200,7 @@ class Synapse::ServiceWatcher
     # Subclasses should not invoke this directly; it's only exposed so that it
     # can be overridden in subclasses.
     def reconfigure!
+      @revision += 1
       @synapse.reconfigure!
     end
   end

data/lib/synapse/version.rb

@@ -1,3 +1,3 @@
 module Synapse
-  VERSION = "0.14.3"
+  VERSION = "0.14.4"
 end

data/spec/lib/synapse/file_output_spec.rb

@@ -18,6 +18,10 @@ describe Synapse::ConfigGenerator::FileOutput do
     allow(mockWatcher).to receive(:name).and_return('example_service')
     backends = [{ 'host' => 'somehost', 'port' => 5555}]
     allow(mockWatcher).to receive(:backends).and_return(backends)
+    allow(mockWatcher).to receive(:config_for_generator).and_return(
+      {'file_output' => {}}
+    )
+    allow(mockWatcher).to receive(:revision).and_return(0)
     mockWatcher
   end
   let(:mockwatcher_2) do
@@ -25,6 +29,10 @@ describe Synapse::ConfigGenerator::FileOutput do
     allow(mockWatcher).to receive(:name).and_return('foobar_service')
     backends = [{ 'host' => 'somehost', 'port' => 1234}]
     allow(mockWatcher).to receive(:backends).and_return(backends)
+    allow(mockWatcher).to receive(:config_for_generator).and_return(
+      {'file_output' => {}}
+    )
+    allow(mockWatcher).to receive(:revision).and_return(0)
     mockWatcher
   end
 
@@ -33,6 +41,12 @@ describe Synapse::ConfigGenerator::FileOutput do
     subject.update_config([mockwatcher_1])
   end
 
+  it 'ignores repeat configs' do
+    expect(subject).to receive(:write_backends_to_file).once
+    subject.update_config([mockwatcher_1])
+    subject.update_config([mockwatcher_1])
+  end
+
   it 'manages correct files' do
     subject.update_config([mockwatcher_1, mockwatcher_2])
     FileUtils.cd(config['file_output']['output_directory']) do

data/spec/lib/synapse/haproxy_spec.rb

@@ -14,6 +14,7 @@ describe Synapse::ConfigGenerator::Haproxy do
     allow(mockWatcher).to receive(:config_for_generator).and_return({
       'haproxy' => {'server_options' => "check inter 2000 rise 3 fall 2"}
     })
+    allow(mockWatcher).to receive(:revision).and_return(1)
     mockWatcher
   end
 
@@ -86,6 +87,7 @@ describe Synapse::ConfigGenerator::Haproxy do
     allow(mockWatcher).to receive(:config_for_generator).and_return({
       'haproxy' => {'port' => 2200, 'disabled' => true}
     })
+    allow(mockWatcher).to receive(:revision).and_return(1)
     mockWatcher
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.4
 platform: ruby
 authors:
 - Martin Rhoads
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk