consul-templaterb 1.27.2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67e2df58bcd5c322789984815ff60bd95e50fc047cb20c929a67ca29c07f553
-  data.tar.gz: c4df4357ae2852ad487eb90336a0d2d7d380767d51d05e02e7b452d29acda9c7
+  metadata.gz: 1d751a91e60648e8c967bd3401a6d1d595c01f95a4da6ca3537dad89247d2755
+  data.tar.gz: 662f076af6864fd541319e0e0ae4c41e6f09cbc96f578d700c403bd315df7420
 SHA512:
-  metadata.gz: 723beb9fca614d1675e50cc1516f37c4aad93815a1725abcdecb33c8bf0aa5e399449f8c3826a14eac8705aa8cb354aa1034796cf68b46304624f958c1b2ba90
-  data.tar.gz: 379cb1ca86d8edc44c68694f70b6bd7c1373b8b707f26bef3459379554f94fa12f27653354dc52647eadbd2cf5b0df7cec7f01bcb457e7ed159b7396709ce00d
+  metadata.gz: c58c6e86c13d2ca37bbb2d4a82aace1d39c27fe76fd4bbf43372d6131d2e14004cbe9d9b6205e40008ab4ad992a44417651aa3739709eb88881d904d3f4161ba
+  data.tar.gz: 9f0baecd48f648c0f04a49bc4366d8b85f2cf635d4bb9bd0d572dec9edf3e7fc0a3157f103ef31669cb2856827a4da4cbe73644d9071dcd4de5f3ad4d60451c6

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 ## (UNRELEASED)
 
+## 1.30.0 (Dec 18, 2020)
+
+IMPROVEMENTS:
+
+ * Allow customization to sort nodes in service view in Consul-UI ([#71](https://github.com/criteo/consul-templaterb/pull/71))
+
+NEW FEATURES:
+
+ * Auto-detection of rate-limit on Consul Side (introduced in Consul 1.6.2+), this feature
+   will work only Consul 1.9+ (see [Consul #7527](https://github.com/hashicorp/consul/issues/7527)). 
+
+## 1.29.0 (Oct 6, 2020)
+
+IMPROVEMENTS:
+
+ * When no template has been specified, stop early with an error message
+
+## 1.28.2 (Oct 5, 2020)
+
+NEW FEATURES:
+
+ * Added new decorator to compute node names in consul-ui ([#70](https://github.com/criteo/consul-templaterb/pull/70))
+
+## 1.28.1 (Sept 30, 2020)
+
+IMPROVEMENTS:
+
+ * Reduced size of GEM from 400k o 100k by removing not needed files
+
+## 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)
+
+BUG FIXES:
+
+ * 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:
@@ -12,7 +54,7 @@ IMPROVEMENTS:
 
 BUGIX:
 
- * Fix collision in JSON queries when using payload in requests #68
+ * Fix collision in JSON queries when using payload in requests [#68](https://github.com/criteo/consul-templaterb/pull/68)
 
 ## 1.27.0 (June 5, 2020)
 
@@ -25,15 +67,15 @@ NEW FEATURES:
 
 ## 1.26.3 (April 15, 2020)
 
-BUGFIX:
+BUG FIXES:
 
  * Removed all Criteo specific decorators from Consul-UI
 
 ## 1.26.2 (April 15, 2020)
 
-BUGFIX:
+BUG FIXES:
 
- * Fixed broken Dockerfile (was missing the new `decorator.js.erb` file). Fixes #61 (Thanks to @ simongareste)
+ * Fixed broken Dockerfile (was missing the new `decorator.js.erb` file). Fixes #61 (Thanks to [@simongareste](https://github.com/simongareste))
 
 NEW FEATURES:
 
@@ -41,7 +83,7 @@ NEW FEATURES:
 
 ## 1.26.1 (March 27, 2020)
 
-BUGFIX:
+BUG FIXES:
 
  * Using `agent: http://vault_or_consul_agent:port>` was not properly taken into account in some endpoints
 
@@ -59,7 +101,7 @@ NEW FEATURES:
 
 ## 1.25.2 (February 29, 2020)
 
-BUGFIX:
+BUG FIXES:
 
  * Update rake to 12.3.3 to fix [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8)
 
@@ -78,7 +120,7 @@ NEW FEATURES:
 
 ## 1.24.1 (February 19, 2020)
 
-BUGFIX:
+BUG FIXES:
 
  * Properly set service meta in node meta decorator
 
@@ -95,7 +137,7 @@ NEW FEATURES:
  * Implementation of #59 - implementation of `--retry` and `--vault-retry` new flags
    Those flags work in a similar way as in consul-template: stop program after X failures
    of consul or vault endpoints
- * Added --fail-fast that stop the programs immediately if vault or consul are not available
+ * Added `--fail-fast` that stop the programs immediately if vault or consul are not available
    at startup (also works with `--once`)
 
 ## 1.22.0 (January 17, 2020)
@@ -106,7 +148,7 @@ NEW FEATURES:
 
 ## 1.21.8 (January 2, 2020)
 
-BUGFIX:
+BUG FIXES:
 
  * Escape properly metadata containing double quotes in prometheus exporter
 
@@ -120,13 +162,13 @@ IMPROVEMENTS:
 
 IMPROVEMENTS:
 
- * Added node_meta_info for serviceInstanceDecorator and serviceMetaDecorator
+ * Added `node_meta_info` for `serviceInstanceDecorator` and `serviceMetaDecorator` in Consul-UI
 
 ## 1.21.5 (December 6, 2019)
 
 NEW FEATURES:
 
- * Added clean() method in nodes.js to allow nexw behaviors
+ * Added `clean()` method in nodes.js to allow new behaviors
 
 ## 1.21.4 (November 28, 2019)
 
@@ -157,7 +199,7 @@ IMPROVEMENTS:
 ## 1.21.0 (November 21, 2019)
 
 * added function `templates` to list all templates being rendered
-* added support for JS decorators in consul-ui (thanks to @Thib17)
+* added support for JS decorators in consul-ui (thanks to [@Thib17](https://github.com/Thib17))
 
 ## 1.20.0 (October 16, 2019)
 
@@ -176,7 +218,7 @@ NEW FEATURES:
 
 * Added new function `checks_for_node`
 
-BUGFIXs:
+BUG FIXES:
 
 * Avoid try publishing several times Gem on rubygems.org
 
@@ -198,13 +240,13 @@ IMPROVEMENTS:
 
 ## 1.18.3 (September 2, 2019)
 
-BUGFIX:
+BUG FIXES:
 
 * When vault receives at timeout, correctly reschedule it
 
 ## 1.18.2 (August 28,  2019)
 
-BUGFIX:
+BUG FIXES:
 
 * In Consul UI, showing data from KV with markup was not properly handled
 
@@ -220,7 +262,7 @@ Support any request method for remote_resource.as_json (#41)
 
 ## 1.18.1 (July 27, 2019)
 
-BUGFIX:
+BUG FIXES:
 
 Fixed wrong lazy initialization in `remote_resource.as_json` that
 cause too many connections to be opened.
@@ -229,13 +271,13 @@ cause too many connections to be opened.
 
 NEW FEATURES:
 
- * Support for `remote_resource` provided by @kamaradclimber
+ * Support for `remote_resource` provided by [@kamaradclimber](https://github.com/kamaradclimber)
  * Added support for `remote_resource.as_json` to fetch JSON remote resource from a web server
  * Added `samples/list_ruby_versions_from_rubygems.txt.erb` to demonstrate usage
 
 ## 1.17.3 (July 18, 2019)
 
-BUGFIX:
+BUG FIXES:
 
  * Added gem parallel as a dependency to allow `samples/prometheus_consul_coordinates.erb`
    to work properly
@@ -360,7 +402,7 @@ NEW FEATURES:
 
 ## 1.10.1 (February 28, 2019)
 
-BUGFIX:
+BUG FIXES:
 
  * Ensure that timeline sort properly events when healthchecks are removed (eg: maintenance)
 
@@ -383,7 +425,7 @@ IMPROVEMENTS:
 
 ## 1.9.8 (January 16, 2019)
 
-BUGFIX:
+BUG FIXES:
 
  * When default value was the same as real value, endpoints were always marked as
    dirty, thus rendering of templates did never succeed.
@@ -399,7 +441,7 @@ IMPROVEMENTS:
 
 ## 1.9.6 (January 15, 2019)
 
-BUGFIX:
+BUG FIXES:
 
  * Keep connections open properly as it increase timeouts on Consul servers on
    very large templates
@@ -410,7 +452,7 @@ IMPROVEMENTS:
 
 ## 1.9.5 (January 14, 2019)
 
-BUGFIX:
+BUG FIXES:
 
  * Ensure to always re-open Connection to Consul agent in case of network error
 
@@ -460,11 +502,11 @@ IMPROVEMENTS:
 
 OPTIMIZATIONS:
 
- * Better network issue because of X-Consul-Index parsing bug
+ * Better network usage because of X-Consul-Index parsing bug
 
-NEW FEATURES:
+BUG FIXES:
 
- * value.endpoint.x_consul_index now works as expected
+ * `value.endpoint.x_consul_index` now works as expected
 
 IMPROVEMENTS:
 
@@ -504,7 +546,7 @@ NEW FEATURES:
 
 ## 1.8.1 (December 12, 2018)
 
-BUGFIX:
+BUG FIXES:
 
  * Properly fill `template_info` strtucture when hot reload is performed so templates using
    `template_info()` new function can behave nicely.
@@ -613,8 +655,8 @@ IMPROVEMENTS:
  * [Prometheus template](samples/metrics.erb) to export easily Consul
    informations about nodes, datacenters and all services states
  * Code style cleanup + travis now enforces Rubocop
- * Remove criteo references in spec files thanks to @pierrecdn
- * Bitrate display more consistent thanks to @pierrecdn
+ * Remove criteo references in spec files thanks to [@pierrecdn](https://github.com/pierrecdn)
+ * Bitrate display more consistent thanks to [@pierrecdn](https://github.com/pierrecdn)
 
 ## 1.5.3 (September 24, 2018)
 

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/TemplateAPI.md

@@ -388,7 +388,7 @@ name or its ID. If DC is specified, will lookup for given node in another datace
 
 [Find all the checks](https://www.consul.io/api/health.html#list-checks-for-service) of a given service.
 
-## def checks_in_state(check_state, dc: nil, [agent: consul_agent_address])
+## checks_in_state(check_state, dc: nil, [agent: consul_agent_address])
 
 [Find all the checks in a given state](https://www.consul.io/api-docs/health#list-checks-in-state) in the whole cluster.
 

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
@@ -359,6 +375,11 @@ ARGV.each do |tpl|
   consul_engine.add_template(tpl, dest)
 end
 
+if consul_engine.templates.count.zero?
+  puts 'You must specify at least one template as arg or using -t'
+  exit 255
+end
+
 template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf, consul_engine.templates, options[:erb][:trim_mode])
 
 Signal.trap('USR1', 'IGNORE') unless Gem.win_platform?

data/lib/consul/async/consul_endpoint.rb

@@ -225,9 +225,34 @@ module Consul
         retry_in / 2 + Consul::Async::Utilities.random.rand(retry_in)
       end
 
+      # rubocop:disable Style/ClassVars
+      def _last_429
+        @@_last_429 ||= { count: 0 }
+      end
+      # rubocop:enable Style/ClassVars
+
       def _handle_error(http, consul_index)
         retry_in = _compute_retry_in([600, conf.retry_duration + 2**@consecutive_errors].min)
-        ::Consul::Async::Debug.puts_error "[#{path}] X-Consul-Index:#{consul_index} - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+        if http.response_header.status == 429
+          _last_429
+          retry_in = 60 + Consul::Async::Utilities.random.rand(180) if retry_in < 60
+          _last_429[:time] = Time.now.utc
+          _last_429[:count] += 1
+          if (_last_429[:count] % 10) == 1
+            if _last_429[:count] == 1
+              ::Consul::Async::Debug.puts_error "Rate limiting detected on Consul side (HTTP 429)!\n\n" \
+                                                "******************************* CONFIGURATION ISSUE DETECTED *******************************\n" \
+                                                "* Too many simultaneous connections for Consul agent #{conf.base_url}\n" \
+                                                "* You should tune 'limits.http_max_conns_per_client' to a higher value.\n" \
+                                                "* This program will behave badly until you change this.\n" \
+                                                "* See https://www.consul.io/docs/agent/options.html#http_max_conns_per_client for more info\n" \
+                                                "********************************************************************************************\n\n"
+            end
+            ::Consul::Async::Debug.puts_error "[#{path}] Too many conns to #{conf.base_url}, errors=#{_last_429[:count]} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+          end
+        else
+          ::Consul::Async::Debug.puts_error "[#{path}] X-Consul-Index:#{consul_index} - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+        end
         @consecutive_errors += 1
         http_result = HttpResponse.new(http)
         EventMachine.add_timer(retry_in) do

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