consul-templaterb 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60bb02ded0414b955e2ddf979bd02587fd352af8dbb07c162e1985a0173b5fa3
-  data.tar.gz: dd78711af97ad24c9b01a228cfaabc0376484ef24fdc6c86fd7e541cf8421a05
+  metadata.gz: fc502021c589486d5467570135c409154b48de0829358bc0f5a261c93cb4bf83
+  data.tar.gz: 77d2214c3b8d4db64d28911f76d7f4148f0e54aa00a504f116f0b06ed7d227fd
 SHA512:
-  metadata.gz: 32632e75b3742427a40373b36caeba46aab17eb634513a1c0d137be65adfb1ce02365c65024df651494bf635464268a2f2555dddd01baade3cad4ef03ccb1d4e
-  data.tar.gz: 129215ca52ccb173b31c0939c5438ad5bebb888b15733172ba333fca2f7a03016291a3ec542570679e38e9b64f5f3bb6a983129a461178fb3f8705cc57a3966b
+  metadata.gz: 730e29b4453d6e6b298bc2b1b3b5d57b39ccf6d88231b84ac60fe04998ca131a5294d450219f7432f7de80813de8ee32c279ed11d88547fe11a7926122136920
+  data.tar.gz: 9b8fe26cee53f5417418ce9574e076fc3ffc40a2a61f9f211cd516bfcb591d5fd146ec7b664fd86d8170fc6d25e6eef3c8c964e7e2fbe52ca1bc8468bd7a081b

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## (UNRELEASED)
 
+## 1.5.0 (August 17, 2018)
+
+IMPROVEMENTS:
+
+ * fixed small errors in documentation
+ * added `-T` flag to control ERB trim mode with default value of `-`
+
 ## 1.4.0 (July 23, 2018)
 
 IMPROVEMENTS:

data/README.md

@@ -28,6 +28,9 @@ consul-template.
 It provides a very [simple API](TemplateAPI.md) to write your own templates
 with fully [working examples](samples/).
 
+It also allow to display a very nice and hi-performance HTML5 UI for Consul,
+see [consul-ui](samples/consul-ui) for details.
+
 ## Differences with HashiCorp's consul-template
 
 [Hashicorp's Consul Template](https://github.com/hashicorp/consul-template)
@@ -141,6 +144,7 @@ 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
+    -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
     -e, --exec=<command>             Execute the following command
     -d, --debug-network-usage        Debug the network usage

data/TemplateAPI.md

@@ -279,6 +279,8 @@ consul-templaterb --template "source.html.erb:dest.html:reload_command:params.ya
 [...]
 ```
 
+See [samples/common/header.html.erb](samples/common/header.html.erb) for example of usage.
+
 ## secrets(prefix)
 
 It requires that a Vault token is given either in parameter or in environment variable
@@ -335,5 +337,3 @@ secret('secret/foo', [force_ttl: intInSecond])
 
 </div>
 </details>
-
-See [samples/common/header.html.erb](samples/common/header.html.erb) for example of usage.

data/bin/consul-templaterb

@@ -17,6 +17,9 @@ def compute_default_output(source)
 end
 
 options = {
+  erb: {
+    trim_mode: '-', # trim_mode for ERB
+  },
   vault: {
     debug: {
       network: false
@@ -138,6 +141,11 @@ optparse = OptionParser.new do |opts|
     cur_sig_term = compute_signal(sig, nil)
   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
+  end
+
   opts.on('-R', '--sig-reload=reload_signal', String,
           "Signal to send to next --exec command on reload (NONE supported), default=#{cur_sig_reload}") do |sig|
     cur_sig_reload = compute_signal(sig, 'NONE')
@@ -265,7 +273,7 @@ EM.epoll
 
 consul_conf = Consul::Async::ConsulConfiguration.new(options[:consul])
 vault_conf = Consul::Async::VaultConfiguration.new(options[:vault])
-template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf)
+template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf, options[:erb][:trim_mode])
 
 ARGV.each do |tpl|
   dest = compute_default_output(tpl)

data/lib/consul/async/consul_template.rb

@@ -21,9 +21,10 @@ module Consul
 
     class EndPointsManager
       attr_reader :consul_conf, :vault_conf, :net_info, :start_time
-      def initialize(consul_configuration, vault_configuration)
+      def initialize(consul_configuration, vault_configuration, trim_mode = nil)
         @consul_conf = consul_configuration
         @vault_conf = vault_configuration
+        @trim_mode = trim_mode
         @endpoints = {}
         @iteration = 1
         @start_time = Time.now.utc
@@ -169,7 +170,7 @@ module Consul
           current_erb_path: tpl_file_path,
           params: params
         }
-        result = ERB.new(tpl).result(binding)
+        result = ERB.new(tpl, nil, @trim_mode).result(binding)
         @context = old_value
         result
       rescue StandardError => e

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.4.0'.freeze
+    VERSION = '1.5.0'.freeze
   end
 end

data/samples/consul-ui/README.md

@@ -4,6 +4,23 @@ A simple HTML5 app that displays all services within Consul with AJAX requests.
 It supports fitering based on tags and does not rely on Consul to display pages,
 meaning that it can be scaled horizontally without any troubles with Consul.
 
+## Is it prod ready?
+
+This application is used for several months within Criteo to replace Consul native interface and
+is used daily by hundreds of users. At Criteo, consul-templaterb creates the static web, updates
+it continuously and all the static pages are served using nginx, but any web server might be used.
+
+Criteo has more than 20k Consul nodes on 8 datacenters, so it should work for most installations.
+
+It has far more performance than most Consul UIs, the only downside is that the whole application
+is Read-Only (but it would be possible to add RW support with CORS to modify values within
+Consul).
+
+You can watch a [video comparison](https://www.youtube.com/watch?v=o7VEox2FSEs) of this application
+with the new native Consul UI interface of Consul 1.2.x, performance gap is especially strong
+when using remote Datacenters (in the video around 01:10) where this app displays all information
+from datacenter in Tokyo from Paris.
+
 ## Usage
 
 ```shell
@@ -35,9 +52,9 @@ Will generate index.html and consul_template.json in your directory, so you migh
 
 ### Filtering services
 
-This app supports the following environement variables:
+This app supports the following environment variables:
 
 * SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 * INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 * INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-* EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+* EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request