consul-templaterb 1.27.2 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67e2df58bcd5c322789984815ff60bd95e50fc047cb20c929a67ca29c07f553
-  data.tar.gz: c4df4357ae2852ad487eb90336a0d2d7d380767d51d05e02e7b452d29acda9c7
+  metadata.gz: c15ee78520048d7d091882b9d3b1d43b4cc5f5658cf39d782f06e1dc617d8cd9
+  data.tar.gz: 6f77a9daab557420f2640a314a97f78af68e26fec91c1a66f3ee575d9bf150f8
 SHA512:
-  metadata.gz: 723beb9fca614d1675e50cc1516f37c4aad93815a1725abcdecb33c8bf0aa5e399449f8c3826a14eac8705aa8cb354aa1034796cf68b46304624f958c1b2ba90
-  data.tar.gz: 379cb1ca86d8edc44c68694f70b6bd7c1373b8b707f26bef3459379554f94fa12f27653354dc52647eadbd2cf5b0df7cec7f01bcb457e7ed159b7396709ce00d
+  metadata.gz: 8c2b374a9400061f3ffd673e418771bb5685ec3d13a631c3839660121d86575be1fbbd1cd99f7ee1a4ddedf850ec72fa984ca084575da587b7a239d2e4654b2e
+  data.tar.gz: '0933c0a2f1f58c617c184679ab68c1e90d55f1d9ab796e45336ddbbf49ae2fd73cf1aafbfea6e921254a520c8be3e5f0f380cfbdacd694ba2de6c5f8e4f5a074'

data/.rubocop.yml

@@ -10,7 +10,7 @@ Metrics/AbcSize:
   Max: 87
 
 Metrics/BlockLength:
-  Max: 182
+  Max: 188
 
 Metrics/BlockNesting:
   Max: 4

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## (UNRELEASED)
 
+## 1.28.0 (Sept 25, 2020)
+
+NEW FEATURES:
+
+ * Added `-W` or `--wait-between-reload-signal` to avoid sending too many signals
+   to a process executed. This avoids for instance reloading too much a HAProxy configuration
+   without having to play with `-w` as described in [#69](https://github.com/criteo/consul-templaterb/issues/69)
+
+BUGFIX:
+
+ * Removed warnings at runtime with Ruby 2.7+
+ * Minor JS fix in Consul-UI (Added missing unused parameter to function `serviceTitleGenerator`)
+
 ## 1.27.2 (Sept 4, 2020)
 
 IMPROVEMENTS:

data/README.md

@@ -165,9 +165,19 @@ USAGE: consul-templaterb [[options]]
     -f, --[no-]fail-fast             If consul/vault endpoints fail at startup, fail immediately
     -g, --no-gzip-compression        Disable GZIP compression in HTTP requests
     -c, --consul-addr=<address>      Address of Consul, eg: http://localhost:8500
+        --consul-cert-chain=<path/to/cert_chain>
+                                     Path to Consul TLS client certificate chain to use
+        --consul-private-key=<path/to/private_key>
+                                     Path to Consul TLS client private key to use
+        --skip-consul-verify-tls     Skip verifying Consul TLS via certificate authority (DANGEROUS)
     -l, --log-level=<log_level>      Log level, default=info, any of none|error|info|debug
         --consul-token=<token>       Use a token to connect to Consul
     -V, --vault-addr=<address>       Address of Vault, eg: http://localhost:8200
+        --vault-cert-chain=<path/to/cert_chain>
+                                     Path to Vault TLS client certificate chain to use
+        --vault-private-key=<path/to/private_key>
+                                     Path to Vault TLS client private key to use
+        --skip-vault-verify-tls      Skip verifying Vault TLS via certificate authority (DANGEROUS)
         --vault-token=<token>        Token used to authenticate against vault.
         --[no-]vault-renew           Control auto-renewal of the Vault token. Default: activated
         --vault-retry, --vault-retry-attempts [RETRIES]
@@ -178,10 +188,11 @@ USAGE: consul-templaterb [[options]]
     -r, --retry-delay=<min_duration> Min Retry delay on Error/Missing Consul Index
     -k, --hot-reload=<behavior>      Control hot reload behaviour, one of :[die (kill daemon on hot reload failure), keep (on error, keep running), disable (hot reload disabled)]
     -K, --sig-term=kill_signal       Signal to send to next --exec command on kill, default=TERM
+    -M, --debug-memory-usage         Display messages when RAM grows
     -T, --trim-mode=trim_mode        ERB Trim mode to use (- by default)
     -R, --sig-reload=reload_signal   Signal to send to next --exec command on reload (NONE supported), default=HUP
-    -M, --debug-memory-usage         Display messages when RAM grows
-    -e, --exec=<command>             Execute the following command
+    -W, --wait-signal=min_duration   Wait at least n seconds before each reload signal being sent to next --exec process
+    -e, --exec=<command>             Execute the following command in as a subprocess when all templates are ready
     -d, --debug-network-usage        Debug the network usage
     -t erb_file:[output]:[command]:[params_file],
         --template                   Add a erb template, its output and optional reload command
@@ -235,7 +246,11 @@ nor write the file.
 Signals can be customized per process. Two signals are supported with options `--sig-reload` and
 `--sig-term`. When the option is added, the next `--exec` options to start a process will use the
 given signal. By default, HUP will be sent to reload events (you can use NONE to avoid sending any
-reload signal), TERM will be used when leaving consul-templaterb.
+reload signal), TERM will be used when leaving consul-templaterb. A minimum duration between reload
+signals can be specified for each sub process by prepending `--wait-signal=min_duration` to `--exec`
+command.
+In such case, the signal will be sent every `min_duration` as a maximum (very useful for templates
+changing a lot, but you don't want to trigger too many reloads, for instance for a load-balancer).
 
 ### Bandwidth limitation
 

data/bin/consul-templaterb

@@ -94,6 +94,7 @@ consul_engine = Consul::Async::ConsulTemplateEngine.new
 @programs = {}
 cur_sig_reload = 'HUP'.freeze
 cur_sig_term = 'TERM'.freeze
+cur_min_duration_between_signals = 1
 
 optparse = OptionParser.new do |opts|
   opts.banner = usage_text
@@ -215,6 +216,10 @@ optparse = OptionParser.new do |opts|
     cur_sig_term = compute_signal(sig, nil)
   end
 
+  opts.on('-M', '--debug-memory-usage', 'Display messages when RAM grows') do
+    consul_engine.debug_memory = true
+  end
+
   opts.on('-T', '--trim-mode=trim_mode', String,
           "ERB Trim mode to use (#{options[:erb][:trim_mode]} by default)") do |trim_mode|
     options[:erb][:trim_mode] = trim_mode
@@ -225,25 +230,36 @@ optparse = OptionParser.new do |opts|
     cur_sig_reload = compute_signal(sig, 'NONE')
   end
 
-  opts.on('-M', '--debug-memory-usage', 'Display messages when RAM grows') do
-    consul_engine.debug_memory = true
+  opts.on('-W', '--wait-signal=min_duration', Float, 'Wait at least n seconds before each reload signal being sent to next --exec process') do |min_duration|
+    raise "-wait-between-reload-signal=#{min_duration} must be greater than 0" unless min_duration.positive?
+
+    cur_min_duration_between_signals = min_duration
   end
 
-  opts.on('-e', '--exec=<command>', String, 'Execute the following command') do |cmd|
+  opts.on('-e', '--exec=<command>', String, 'Execute the following command in as a subprocess when all templates are ready') do |cmd|
     sig_reload = cur_sig_reload
     sig_term = cur_sig_term
+    sig_min_interval = cur_min_duration_between_signals
     consul_engine.add_template_callback do |all_ready, template_manager, results|
       if all_ready
         modified = results.any?(&:modified)
         if @programs[cmd].nil?
-          warn "[EXEC] Starting process: #{cmd}... on_reload=#{sig_reload || 'NONE'} on_term=#{sig_term}"
+          warn "[EXEC] Starting process: #{cmd}... on_reload=#{sig_reload || 'NONE'} on_term=#{sig_term}, delay between reloads=#{sig_min_interval}s"
           @programs[cmd] = Consul::Async::ProcessHandler.new(cmd, sig_reload: sig_reload, sig_term: sig_term)
           @programs[cmd].start
         else
+
           # At least one template has been modified
-          @programs[cmd].reload if modified
+          process_to_reload = @programs[cmd]
+          if modified && !process_to_reload.reload_scheduled
+            process_to_reload.reload_scheduled = true
+            now = Time.now
+            delay = sig_min_interval - (now - @programs[cmd].last_signal_sent)
+            delay = 0 if delay.negative?
+            EventMachine.add_timer(delay) { process_to_reload.reload }
+          end
           begin
-            @programs[cmd].process_status
+            process_to_reload.process_status
           rescue Consul::Async::ProcessDoesNotExist => e
             warn "[FATAL] The process is dead, aborting run: #{e.inspect}"
             template_manager.terminate

data/lib/consul/async/consul_template_render.rb

@@ -59,7 +59,7 @@ module Consul
         return false unless new_template != @template
 
         # We render to ensure the template is valid
-        render(new_template, current_template_info)
+        render(new_template, current_template_info: current_template_info)
         @template = new_template.freeze
         true
       end

data/lib/consul/async/process_handler.rb

@@ -7,7 +7,8 @@ module Consul
     # Handle the full lifecycle of a process and allows to forward
     # Posix signals to child process when needed.
     class ProcessHandler
-      attr_reader :command, :sig_reload, :sig_term, :pid, :exit_status
+      attr_reader :command, :sig_reload, :sig_term, :pid, :exit_status, :last_signal_sent, :reload_scheduled
+      attr_writer :reload_scheduled
       def initialize(command, sig_reload: 'HUP', sig_term: 'TERM')
         raise 'empty sig_term is not supported' unless sig_term
 
@@ -16,18 +17,23 @@ module Consul
         @sig_term = sig_term
         @pid = nil
         @exit_status = nil
+        @last_signal_sent = Time.now
+        @reload_scheduled = false
       end
 
       def start
         return pid unless pid.nil?
 
         @pid = Process.spawn(command)
+        @last_signal_sent = Time.now
       end
 
       def reload
         return if sig_reload.nil?
 
+        @last_signal_sent = Time.now
         warn "Sending SIG #{sig_reload} to #{pid}..."
+        @reload_scheduled = false
         begin
           Process.kill(sig_reload, pid)
         rescue Errno::ESRCH => e

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.27.2'.freeze
+    VERSION = '1.28.0'.freeze
   end
 end

data/samples/consul-ui/js/service.js

@@ -304,7 +304,7 @@ class ServiceMainSelector extends MainSelector {
         element.setAttribute("class", "list-group-item service-instance");
         var state = nodeState(instance.checks);
         element.appendChild(weightsGenerator(instance.weights, state));
-        element.appendChild(serviceTitleGenerator(instance));
+        element.appendChild(serviceTitleGenerator(instance, serviceName));
         var node_info = this.nodes[instance.name];
         if (node_info != null) {
             node_info = node_info.meta;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.27.2
+  version: 1.28.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request