consul-templaterb 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dff2b22aa59dd10c76e17b02ad83bc2d3f5d0b6e2e2502ad94c2436c9c93f074
-  data.tar.gz: f41245cc9d75fd2c326fa573643e6dee67eb2e9743c9862da2710e41114fba3f
+  metadata.gz: 49568fc4a6f043e390484820ea383914a31d35c99149669a4b77772bfeed0504
+  data.tar.gz: f56e6cd3882cb1154219c3c56da2ae9b484e9c6196c685980c296e713c6f9650
 SHA512:
-  metadata.gz: 6a2cc201720dd43f08ac085e7df34bafaa63379a3eabd801e188f587a2ff5448ec2c657e7984c47dddc516a0fc6d8ce61c5ab4cb426ff76101e671f0c523855e
-  data.tar.gz: 7dea5e8d25aade2cfb621faa461f496183dcdfa77a8b3862fd2e030d042c05722692517bdaf8de382566946948eaa6aaeb3b91596c7bda08c1ef17690cc1f8dc
+  metadata.gz: 7e241be76b837635ef83dff4ec76191bba016cdb7e040b4c17325458465d6b10ae5a8430527484be30a2b0bf05d0a86350e970742b570766d14578a621f817fb
+  data.tar.gz: 9f4ccd3d0222a28abf6bcb89b46e101c627d736c73b6451a39f9bb4507e68713b1a88abfaf66d4e5a152de09d84b55ac486af2f2a692967a26762bb62129fd84

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  Max: 160
+  Max: 180
 
 Metrics/CyclomaticComplexity:
   Max: 15

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## (UNRELEASED)
 
+## 1.0.8 (March 18, 2018)
+
+IMPROVEMENTS:
+
+* More clever behaviour regarding processes on First completed rendering phase
+* All samples/*.html.erb templates are w3c compatibles without errors
+* Look and features improvements for samples/*.html.erb
+* Added optional parameters to sub-template in `render_file`
+* Added `param(name, default_value)` to retrieve parameter from sub-template
+* Use `CONSUL_HTTP_TOKEN` if present in environment variables to get the token
+* Added [TemplateAPI.md](TemplateAPI.md] for documenting functions
+
 ## 1.0.7 (March 16, 2018)
 
 BUG FIXES:
@@ -14,7 +26,7 @@ IMPROVEMENTS:
 
 IMPROVEMENTS:
 
-* Adds http:// to Consul URL if missing since `$CONSUL_HTTP_ADDR` environment
+* Adds `http://` to Consul URL if missing since `$CONSUL_HTTP_ADDR` environment
   variable might not have it
 * Updated gem description with more accurate information
 * samples: removed KV/nodes from services.html.erb

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in consul-templaterb.gemspec
 gemspec
-gem 'bootstrap', '~> 4.0.0.alpha6'
+gem 'bootstrap', '~> 4.0.0'

data/README.md

@@ -1,6 +1,7 @@
-# Consul::Templaterb [![Build Status](https://api.travis-ci.org/criteo/consul-templaterb.svg?branch=master)](https://travis-ci.org/criteo/consul-templaterb)
+# consul-templaterb [![Build Status](https://api.travis-ci.org/criteo/consul-templaterb.svg?branch=master)](https://travis-ci.org/criteo/consul-templaterb)
 
-This GEM is both a library and an executable that allows to generate files
+The ruby GEM [consul-templaterb](https://rubygems.org/gems/consul-templaterb)
+is both a library and an executable that allows to generate files
 using data from Consul (Discovery and Key/Value Store) easily using ruby's
 erb templates. It also support launching programs and baby-sitting processes
 when rendering the files, thus notifying programs when data do change.
@@ -9,8 +10,9 @@ It is intended for user accustomed to expressiveness or Ruby templating (ERB),
 allowing for more flexibility and features than Go templates.
 
 It also allows to use all of ruby language, especially useful for generating
-files in several formats (JSON, XML) where text substitutions are hard to get
-right.
+files in several formats ([JSON](samples/consul_template.json.erb),
+[XML](samples/consul_template.xml.erb)) for which text substitutions are hard
+to get right (escaping, attributes encoding...).
 
 It also focuses on good performance and lightweight usage of bandwidth,
 especially for very large clusters and watching lots of services.
@@ -19,6 +21,9 @@ For complicated rendering of templates and large Consul Clusters, it usually
 renders faster with a more predictable way the template than the original
 consul-template.
 
+It provides a very [simple API](TemplateAPI.md) to write your own templates
+with fully [working examples](samples/).
+
 ## Differences with HashiCorp's consul-template
 
 [Hashicorp's Consul Template](https://github.com/hashicorp/consul-template)
@@ -45,13 +50,16 @@ Compared to consul-template, consul-templaterb offers the following features:
 
 * Hot-Reload of template files
 * Bandwidth limitation per endpoint (will soon support dynamic bandwidth limiter)
-* Supports baby sitting of multiple processes
+* Supports launch and supervision of multiple child processes
+* Supports launching commands when files do change on disk (reload commands...)
 * Supports all Ruby features (ex: base64, real JSON/XML generation...)
 * Information about bandwidth
 
-The executable supports close semantics to Consul template, it also supports
-commands when files are modified and supervision of multiple processes with
-ability to send signals to those processes when the files do change.
+The executable supports semantics and command line flags and options similar to
+HashiCorp's Consul-template, so many flags you might use in consul-template will
+work in a similar way. It also supports the same environment variable
+`CONSUL_HTTP_ADDR` to find the Consul Agent to query and 'CONSUL_HTTP_TOKEN' to
+get the token.
 
 ## Installation
 
@@ -96,6 +104,7 @@ installed:
 
 ```shell
 $ gem contents consul-templaterb|grep samples
+[...]
 ```
 
 Will output the path where the samples are being installed, you can copy the directory
@@ -103,11 +112,16 @@ somewhere and then issue the command:
 
 ```shell
 $ consul-templaterb samples/*.html.erb
+Using samples/checks.html output for samples/checks.html.erb
+[...]
 ```
 
 It will render a full web site you may browse to look in real time the status of your
 Consul Cluster.
 
+You can now have a look to the [API Documentation](TemplateAPI.md) to modify existing
+templates or write your owns, it is very easy!
+
 ## Usage of consul-templaterb
 
 ### Show help
@@ -168,8 +182,8 @@ meaning that if 2 results of templates are modified at the same time, the signal
 sent only once (it is helpful for instance if your app is using several configurations
 files that must be consistent all together).
 
-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
+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.
 
@@ -189,90 +203,36 @@ by consul-templaterb.
 
 ### Samples
 
-Have a look into the [samples/](samples/) directory to browse example files.
+Have a look into the [samples/](samples/) directory to browse example files which contains those
+examples:
+
+1. [List all nodes on Cluster](samples/nodes.html.erb)
+2. [Show all services in Cluster](samples/services.html.erb)
+3. [Show all Service Checks and their output](samples/checks.html.erb)
+4. [Show all Key/Values nicely](samples/keys.html.erb)
+5. [Show Choregraphies  - work on content of K/V with JSON](samples/criteo_choregraphies.html.erb)
+6. [Services in XML](samples/consul_template.xml.erb)
+7. [Services in JSON](samples/consul_template.json.erb)
+8. [Generate HaProxy Configuration](samples/ha_proxy.cfg.erb)
 
 If you want to test it quickly, you might try with (assuming you consul agent is listening on
-http://localhost:8500):
+`http://localhost:8500`):
 
-```
+```shell
 $ be bin/consul-templaterb -c 'http://localhost:8500' samples/*.html.erb
+[...]
 ```
 
 It will generate a full website in samples/ directory with lots of Consul information ready to
 use (website updated automagically when values to change).
 
-## Template development
-
-Here are the various functions you might use in your templates.
-
-For each function, mandatory arguments are specified at the beginning while optional ones are marked with `[]`.
-Most of them support the optional dc attribute to access data from another datacenter. If the `dc`
-attribute is not specified, the function will output data from the current datacenter.
-
-To ease template development, `consul-templaterb` supports HOT reload of templates, thus it is possible to
-develop the templates interactively. While developing, it is possible to use the switch `--hot-reload=keep`,
-thus the application will display a warning if the template is invalid and won't stop
-(`--hot-reload=die` is the default, thus if the hot-reloaded template has issue, the application will die).
-
-### datacenters()
-
-[Get the list of datacenters as string array](https://www.consul.io/api/catalog.html#list-datacenters).
-
-### services([dc: datacenter], [tag: tagToFilterWith])
-
-[List the services matching the optional tag filter](https://www.consul.io/api/catalog.html#list-services),
-if tag is not specified, will match all the services. Note that this endpoint performs client side tag
-filtering for services to ease templates development since this feature is not available on Consul's endpoint.
-
-### service(serviceName, [dc: datacenter], [tag: tagToFilterWith], [passing: true])
-
-[List the instances](https://www.consul.io/api/health.html#list-nodes-for-service) of a service having the given
-optional tag. If no tag is specified, will return all instances of service. By default, it will return all the
-well services that are passing or not. An optional argument passing might be used to retrieve only passing instances.
+All templates are validated using the Travis CI, so all should be working for your Consul
+Configuration.
 
-### nodes([dc: datacenter])
-
-[List all the nodes of selected datacenter](https://www.consul.io/api/catalog.html#list-nodes). No filtering is
-applied.
-
-### node(nodeNameOrId, [dc: datacenter])
-
-[List all the services of a given Node](https://www.consul.io/api/catalog.html#list-services-for-node) using its
-name or its ID. If DC is specified, will lookup for given node in another datacenter.
-
-### checks_for_service(name, dc: nil, passing: false, tag: nil)
-
-[Find all the checks](https://www.consul.io/api/health.html#list-checks-for-service) of a given service.
-
-### kv(name = nil, dc: nil, keys: nil, recurse: false)
-
-[Read keys from KV Store](https://www.consul.io/api/kv.html#read-key). It can be used for both listing the keys and
-getting the values. See the file in samples [keys.html.erb](samples/keys.html.erb) for a working example.
-
-### agent_metrics()
-
-[Get the metrics of Consul Agent](https://www.consul.io/api/agent.html#view-metrics). Since this endpoint does
-not support blocking queries, data will be refreshed every few seconds, but will not use blocking queries
-mechanism.
-
-### agent_self()
-
-[Get the configuration of Consul Agent](https://www.consul.io/api/agent.html#read-configuration).
-Since this endpoint does not support blocking queries, data will be refreshed every few seconds,
-but will not use blocking queries mechanism.
-
-### render_file RELATIVE_PATH_TO_ERB_FILE
-
-This allow to include a template file into another one. Beware, it does not check for infinite recursion!
-The template can be either a static file either another template. The file has to be a valid template, but
-can also be raw text (if it is a valid template) and is resolved with a relative path regarding the file
-including it.
-
-Example:
+## Template development
 
-```erb
-<%= render_file 'header.html.erb' %>
-```
+Please look at [the template API](TemplateAPI.md) to have a list of all functions you might use for your
+templates. Also have a look to [samples/](samples/) directory to have full working examples.
 
 ## Development
 
@@ -292,6 +252,8 @@ Here are the known bugs of the application:
   on very large clusters or when watching thousands of individual KV keys.
 * [ ] render_file might create an infinite recursion if a template includes itself indirectly.
 
+Please consult [CHANGELOG.md](CHANGELOG.md) for fixed bugs.
+
 ## TODO
 
 * [ ] Hashi's Vault support

data/TemplateAPI.md

@@ -0,0 +1,84 @@
+# Template API for writting templates
+
+Here are the various functions you might use in your templates.
+
+For each function, mandatory arguments are specified at the beginning while optional ones are marked with `[]`.
+Most of them support the optional dc attribute to access data from another datacenter. If the `dc`
+attribute is not specified, the function will output data from the current datacenter.
+
+To ease template development, `consul-templaterb` supports HOT reload of templates, thus it is possible to
+develop the templates interactively. While developing, it is possible to use the switch `--hot-reload=keep`,
+thus the application will display a warning if the template is invalid and won't stop
+(`--hot-reload=die` is the default, thus if the hot-reloaded template has issue, the application will die).
+
+Have a look to [samples/](samples/) directory to start writing your own templates.
+
+## datacenters()
+
+[Get the list of datacenters as string array](https://www.consul.io/api/catalog.html#list-datacenters).
+
+## services([dc: datacenter], [tag: tagToFilterWith])
+
+[List the services matching the optional tag filter](https://www.consul.io/api/catalog.html#list-services),
+if tag is not specified, will match all the services. Note that this endpoint performs client side tag
+filtering for services to ease templates development since this feature is not available on Consul's endpoint.
+
+## service(serviceName, [dc: datacenter], [tag: tagToFilterWith], [passing: true])
+
+[List the instances](https://www.consul.io/api/health.html#list-nodes-for-service) of a service having the given
+optional tag. If no tag is specified, will return all instances of service. By default, it will return all the
+well services that are passing or not. An optional argument passing might be used to retrieve only passing instances.
+
+## nodes([dc: datacenter])
+
+[List all the nodes of selected datacenter](https://www.consul.io/api/catalog.html#list-nodes). No filtering is
+applied.
+
+## node(nodeNameOrId, [dc: datacenter])
+
+[List all the services of a given Node](https://www.consul.io/api/catalog.html#list-services-for-node) using its
+name or its ID. If DC is specified, will lookup for given node in another datacenter.
+
+## checks_for_service(name, dc: nil, passing: false, tag: nil)
+
+[Find all the checks](https://www.consul.io/api/health.html#list-checks-for-service) of a given service.
+
+## kv(name = nil, dc: nil, keys: nil, recurse: false)
+
+[Read keys from KV Store](https://www.consul.io/api/kv.html#read-key). It can be used for both listing the keys and
+getting the values. See the file in samples [keys.html.erb](samples/keys.html.erb) for a working example.
+
+## agent_metrics()
+
+[Get the metrics of Consul Agent](https://www.consul.io/api/agent.html#view-metrics). Since this endpoint does
+not support blocking queries, data will be refreshed every few seconds, but will not use blocking queries
+mechanism.
+
+## agent_self()
+
+[Get the configuration of Consul Agent](https://www.consul.io/api/agent.html#read-configuration).
+Since this endpoint does not support blocking queries, data will be refreshed every few seconds,
+but will not use blocking queries mechanism.
+
+## render_file(relative_path_to_erb_file, [params={}])
+
+This allow to include a template file into another one. Beware, it does not check for infinite recursion!
+The template can be either a static file either another template. The file has to be a valid template, but
+can also be raw text (if it is a valid template) and is resolved with a relative path regarding the file
+including it.
+
+Example:
+
+```erb
+<%= render_file('common/header.html.erb', title: 'My Title') %>
+```
+
+Will render header.html.erb with parameter title = 'My Title'. `title` can then be accessed within
+the template using `param('title', 'My default Value')` in the `header.html.erb` file.
+
+## param(parameter_name, [default_value: nil])
+
+Can be used within a template to access a parameter. Parameters can be specified with `render_file`
+directive. Optional value `default_value` allow to get a value if parameter has not been set.
+
+See [samples/common/header.html.erb](samples/common/header.html.erb) for example of usage.

data/bin/consul-templaterb

@@ -22,7 +22,7 @@ options = {
       network: false
     },
     base_url: ENV['CONSUL_HTTP_ADDR'] || 'http://localhost:8500',
-    token: nil,
+    token: ENV['CONSUL_HTTP_TOKEN'] || nil,
     retry_duration: 10,      # On error, retry after n seconds
     min_duration: 5,         # On sucess and when differences are found
     retry_on_non_diff: 3,    # On success but when there are not differences
@@ -113,16 +113,14 @@ optparse = OptionParser.new do |opts|
     sig_term = cur_sig_term
     consul_engine.add_template_callback do |all_ready, template_manager, results|
       if all_ready
-        modified = results.reduce(false) { |a, e| a || (e.ready? && e.modified) }
-        if modified
-          if @programs[cmd].nil?
-            STDERR.puts "[EXEC] Starting process: #{cmd}... on_reload=#{sig_reload ? sig_reload : 'NONE'} on_term=#{sig_term}"
-            @programs[cmd] = Consul::Async::ProcessHandler.new(cmd, sig_reload: sig_reload, sig_term: sig_term)
-            @programs[cmd].start
-          else
-            @programs[cmd].reload
-          end
-        elsif !@programs[cmd].nil?
+        modified = results.reduce(false) { |a, e| a || e.modified }
+        if @programs[cmd].nil?
+          STDERR.puts "[EXEC] Starting process: #{cmd}... on_reload=#{sig_reload ? sig_reload : 'NONE'} on_term=#{sig_term}"
+          @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
           begin
             @programs[cmd].process_status
           rescue Consul::Async::ProcessDoesNotExist => e

data/consul-templaterb.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.extra_rdoc_files = ['README.md', 'TemplateAPI.md']
   spec.require_paths = ['lib']
 
   spec.require_paths = ['lib']

data/lib/consul/async/consul_template.rb

@@ -24,6 +24,10 @@ module Consul
           errors: 0,
           bytes_read: 0
         }
+        @context = {
+          current_erb_path: nil,
+          params: {}
+        }
       end
 
       # https://www.consul.io/api/health.html#list-nodes-for-service
@@ -79,6 +83,14 @@ module Consul
         create_if_missing(path, query_params) { ConsulAgentMetrics.new(ConsulEndpoint.new(conf, path, true, query_params, default_value)) }
       end
 
+      # Return a param of template
+      def param(key, default_value = nil)
+        v = @context[:params][key]
+        v = @context[:params][key.to_sym] unless v
+        v = default_value unless v
+        v
+      end
+
       # https://www.consul.io/api/catalog.html#list-services
       def services(dc: nil, tag: nil)
         path = '/v1/catalog/services'
@@ -107,18 +119,22 @@ module Consul
         create_if_missing(path, query_params) { ConsulTemplateKV.new(ConsulEndpoint.new(conf, path, true, query_params, default_value), name) }
       end
 
-      def render_file(path)
-        new_path = File.expand_path(path, File.dirname(@current_erb_path))
+      # render a relative file with the given params accessible from template
+      def render_file(path, params = {})
+        new_path = File.expand_path(path, File.dirname(@context[:current_erb_path]))
         raise "render_file ERROR: #{path} is resolved as #{new_path}, but the file does not exists" unless File.exist? new_path
-        render(File.read(new_path), new_path)
+        render(File.read(new_path), new_path, params)
       end
 
-      def render(tpl, tpl_file_path)
+      def render(tpl, tpl_file_path, params = {})
         # Ugly, but allow to use render_file well to support stack of calls
-        old_value = @current_erb_path
-        @current_erb_path = tpl_file_path
+        old_value = @context
+        @context = {
+          current_erb_path: tpl_file_path,
+          params: params
+        }
         result = ERB.new(tpl).result(binding)
-        @current_erb_path = old_value
+        @context = old_value
         result
       rescue StandardError => e
         e2 = InvalidTemplateException.new e
@@ -141,7 +157,7 @@ module Consul
         end
         if not_ready.count.positive?
           STDERR.print "[INFO] Waiting for data from #{not_ready.count}/#{not_ready.count + ready} endpoints: #{not_ready[0..2]}..."
-          return [false, false, '']
+          return [false, false, nil]
         end
         if to_cleanup.count > 1
           STDERR.puts "[INFO] Cleaned up #{to_cleanup.count} endpoints: #{to_cleanup}"

data/lib/consul/async/consul_template_engine.rb

@@ -14,6 +14,7 @@ module Consul
         @templates = []
         @template_callbacks = []
         @hot_reload_failure = 'die'
+        @all_templates_rendered = false
       end
 
       def add_template_callback(&block)
@@ -36,12 +37,16 @@ module Consul
             begin
               results = template_renders.map(&:run)
               all_ready = results.reduce(true) { |a, e| a && e.ready? }
+              if !@all_templates_rendered && all_ready
+                @all_templates_rendered = true
+                STDERR.puts "[INFO] First rendering of #{results.count} templates completed"
+              end
               begin
                 @template_callbacks.each do |c|
                   c.call([all_ready, template_manager, results])
                 end
               rescue StandardError => cbk_error
-                STDERR.puts "Error in callback: #{cbk_error.inspect}"
+                STDERR.puts "[ERROR] callback error: #{cbk_error.inspect}"
                 raise cbk_error
               end
             rescue StandardError => e

data/lib/consul/async/consul_template_render.rb

@@ -58,7 +58,8 @@ module Consul
       end
 
       def write
-        success, modified, @last_result = @template_manager.write(@output_file, @template, @last_result, template_file)
+        success, modified, last_res = @template_manager.write(@output_file, @template, @last_result, template_file)
+        @last_result = last_res if last_res
         [success, modified, @last_result]
       end
 

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.0.7'.freeze
+    VERSION = '1.0.8'.freeze
   end
 end

data/samples/checks.html.erb

@@ -1,3 +1,4 @@
+<%= render_file('common/header.html.erb', title: 'Consul Checks') %>
 <%
 # This template can be configure the following way with environment variables
 # Environment variables to filter services/instances
@@ -14,13 +15,13 @@
       'info'
     end
   end
-  %><%= render_file 'common/header.html.erb' %>
-<style type="text/css">
+  %>
+<style>
 .check {
   transition: opacity 1s ease-out;
 }
 </style>
-<script type="text/javascript">
+<script>//<!--
   function updateStates() {
     states = ['passing', 'warning', 'critical']
     stylesheet = document.getElementById('css-states');
@@ -30,15 +31,16 @@
       is_checked = document.getElementById('show_'+s).checked
       var to_append = "." + s + " { ";
       if (is_checked) {
-        to_append += "opacity: 1; height: auto;"
+        to_append += "display: block"
       } else {
-        to_append += "opacity: 0; height: 0; overflow: hidden;"
+        to_append += "display:none"
       }
       to_append += " }\r\n"
       txt +=  to_append;
     }
     stylesheet.textContent = txt;
   }
+//->
 </script>
 <div class="container-fluid">
   <div class="row">
@@ -48,33 +50,66 @@
           all_services = services(tag: services_tag_filter)
           all_services.each do |service_name, tags|
         %>
-        <li><a href="#service_<%= service_name %>"><%= service_name %></a></li>
+        <li><a title="<%= tags.sort.join(', ') %>" href="#service_<%= service_name %>"><%= service_name %></a></li>
         <% end %>
       </ul>
     </nav>
     <main class="col-10">
       <div class="float-right">
-        <div class="state-selector">
+        <span class="state-selector">
           <input id="show_passing" type="checkbox" class="checks-visibility" value="passing" checked="checked" onchange="updateStates()"/>
           <label for="show_passing"><span class="badge badge-success">Passing</span></label>
-        </div>
-        <div class="state-selector">
+        </span>
+        <span class="state-selector">
           <input id="show_warning" type="checkbox" class="checks-visibility" value="warning" checked="checked" onchange="updateStates()"/>
           <label for="show_warning"><span class="badge badge-warning">Warning</span></label>
-        </div>
-        <div class="state-selector">
+        </span>
+        <span class="state-selector">
           <input id="show_critical" type="checkbox" class="checks-visibility" value="critical" checked="checked" onchange="updateStates()"/>
           <label for="show_critical"><span class="badge badge-danger">Critical</span></label>
-        </div>
-    </div>
+        </span>
+      </div>
 
       <h1 id="services">Services <%= services_tag_filter ? " tag: #{services_tag_filter}" : 'No filtering' %></h1>
-      <% all_services.each do |service_name, tags| %>
-      <div class="service" id="service_<%= service_name %>">
-        <h2>Service <%= service_name %></h2>
+      <% all_services.each do |service_name, tags|
+        passing = 0
+        warning = 0
+        critical = 0
+        service_state = 'passing'
+        sum = 0
+        checks_for_service(service_name).each do |check|
+          st = check['Status']
+          sum += 1
+          case st
+          when 'warning'
+            warning += 1
+          when 'passing'
+            passing += 1
+          else
+            critical += 1
+          end
+        end
+        service_state = 'warning' if warning > 0
+        service_state = 'critical' if critical > 0
+      %>
+      <div class="service <%= service_state %>" id="service_<%= service_name %>">
+        <h2 class="service-name text-<%= status_to_class(service_state) %>">Service <%= service_name %>
+          <span class="float-right">
+            <span class="badge badge-pill badge-success"><%= passing > 0 ? passing : nil %></span>
+            <span class="badge badge-pill badge-warning"><%= warning > 0 ? warning : nil %></span>
+            <span class="badge badge-pill badge-danger"><%= critical > 0 ? critical : nil %></span>
+          </span>
+        </h2>
+        <% if sum > 0
+        %><div class="progress">
+            <div title="<%= "#{passing} / #{sum}" %>" class="progress-bar bg-success" role="progressbar" style="width:<%= (100.0 * passing / sum).round(2) %>%" aria-valuenow="<%= passing %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+            <div title="<%= "#{warning} / #{sum}" %>" class="progress-bar bg-warning" role="progressbar" style="width:<%= (100.0 * warning / sum).round(2) %>%" aria-valuenow="<%= warning %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+            <div title="<%= "#{critical} / #{sum}" %>" class="progress-bar bg-danger" role="progressbar" style="width:<%= (100.0 * critical / sum).round(2) %>%" aria-valuenow="<%= critical %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+          </div>
+        <% end %>
         <div class="list-group">
           <% checks_for_service(service_name).each do |check| %>
-          <div class="list-group-item check <%= check['Status'] %>" id="<%= check['CheckID'] %>">
+          <div class="list-group-item check <%= check['Status'] %>" id="<%= check['Node'] + check['CheckID'] %>">
             <div class="d-flex align-items-center justify-content-between">
               <h5>
                 <%= check['Name'] %> / <%= check['Node'] %>
@@ -91,5 +126,5 @@
     </main>
   </div>
 </div>
-<script type="text/javascript">updateStates();</script>
-<%= render_file 'common/footer.html.erb' %>
+<script>updateStates();</script>
+<%= render_file('common/footer.html.erb') %>

data/samples/common/footer.html.erb

@@ -1,5 +1,3 @@
-    </div>
-    </main>
     <!-- Bootstrap core JavaScript
     ================================================== -->
     <!-- Latest compiled and minified JavaScript -->

data/samples/common/header.html.erb

@@ -9,35 +9,30 @@
 %><!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <meta name="description" content="Display Consul information">
-    <meta name="author" content="Criteo">
-    <meta http-equiv="refresh" content="<%= ENV['REFRESH'] || '600' %>"/>
-
-    <title><%= ENV['TITLE'] || 'Consul Real Time information'%></title>
-
+    <meta charset="utf-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"/>
+    <meta name="description" content="Display Consul information"/>
+    <meta name="author" content="Criteo"/>
+    <meta http-equiv="refresh" content="<%= param('refresh', ENV['REFRESH'] || '600') %>"/>
+    <title><%= param('title', 'Consul Real Time information') %></title>
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
-    <style type="text/css">
+    <style>
       body {
-      padding-top: 5rem;
+        padding-top: 5rem;
       }
       .check {
         transition: opacity 1s ease-out;
       }
     </style>
-    <style type="text/css" id="css-states">
+    <style id="css-states">
     </style>
   </head>
-
   <body>
-
     <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
       <a class="navbar-brand" href="#">Consul</a>
       <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
         <span class="navbar-toggler-icon"></span>
       </button>
-
       <div class="collapse navbar-collapse" id="navbarsExampleDefault">
         <ul class="navbar-nav mr-auto">
           <% tools.each do |tool| %>

data/samples/consul_template.html.erb

@@ -1,10 +1,10 @@
 <!doctype html>
-<html lang="fr">
+<html lang="en">
   <head>
     <meta charset="UTF-8"/>
     <meta http-equiv="refresh" content="300"/>
     <title>Consul Full Info</title>
-    <style type="text/css">
+    <style>
 .passing {
   color:green;
 }
@@ -50,7 +50,7 @@
 
 <h1 id="services">List all services instances sorted by node name</h1>
 <% services.each do |service_name, tags|
-%><h2 id="service_<%= service_name %>" title="<%= tags %>"><%= service_name %> <a class="qlink" href="#service_<%= service_name %>">&#128279;</a></h2>
+%><h2 id="service_<%= service_name %>" title="<%= tags.join(', ') %>"><%= service_name %> <a class="qlink" href="#service_<%= service_name %>">&#128279;</a></h2>
 <ul>
 <%     service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
   tags = snode['Service']['Tags'].sort
@@ -68,7 +68,7 @@
         end
 %><li><a <%= url ? "href=\"#{url}\"" : nil %>><%=
   snode['Node']['Node'] %><%= port %></a>
-  <span class="tags"><%= snode['Service']['Tags'].sort %></tag>
+  <span class="tags"><%= snode['Service']['Tags'].sort %></span>
   <span class="statuses"><%
   snode['Checks'].each do |c| %> <span title="<%= c['Name']%>" class="<%= c['Status'] %>"><%= c['Status']
   %></span><% end if snode['Checks'] %></span></li>
@@ -80,14 +80,14 @@
 <h1 id="nodes">List all nodes for DC, sorted by name</h1>
 <ul>
 <% nodes.sort {|a,b| a['Node'] <=> b['Node'] }.each do |snode|
-%> <li id="node_#{snode['ID']"><%= snode['Address'].ljust(16) %> <%= snode['Node'] %></li>
+%> <li id="node_<%= snode['ID'] %>"><%= snode['Address'].ljust(16) %> <%= snode['Node'] %></li>
 <% end %>
 </ul>
 
 <h1 id="kv">KV of Current DC</h1>
 <ul>
 <% kv(keys:true).each do |key|
-%><li id="kv_#{key}"><%= key %></li>
+%><li id="kv_<%= key %>"><%= key %></li>
 <% end %>
 </ul>
 </body>

data/samples/criteo_choregraphies.html.erb

@@ -2,8 +2,8 @@
    require 'json'
    require 'date'
    @current_time = Time.now.utc
-%><%= render_file 'common/header.html.erb' %>
-<main role="main" class="container">
+%><%= render_file('common/header.html.erb', title: 'Choregraphies', refresh: 30) %>
+<main class="container">
   <div>
   <h1>Show all choregraphie information</h1>
   <div>This page only show choregraphie when at least one holder exists.</div>
@@ -87,4 +87,6 @@
   <% end %>
 <% end %>
 </div>
+</div>
+</main>
 <%= render_file 'common/footer.html.erb' %>

data/samples/keys.html.erb

@@ -1,12 +1,12 @@
-<%= render_file 'common/header.html.erb' %>
-<% path = ENV['kv_path'] || 'services-data' %>
+<%= render_file('common/header.html.erb', title: 'Keys') %>
+<% path = ENV['kv_path'] || '' %>
 <% require 'base64'
    require 'json'
    require 'date'
 %>
-<main role="main" class="container">
+<main class="container">
 <div>
-<h1>Show all keys under hierarchy <%= path %></h1>
+<h1>Show all keys <%= path == '' ? '' : "under hierarchy #{path}" %></h1>
 <div id="accordion">
 <% kv(path, recurse:true).each do |tuple|
      key = tuple['Key']
@@ -28,11 +28,13 @@
       </h5>
       <div id="collapse-<%= key %>" class="collapse" aria-labelledby="heading-<%= key %>" data-parent="#accordion">
         <div class="card-body">
-          <pre class="pre-scrollable"><%= val %></pre>
+          <pre class="pre-scrollable"><%= ERB::Util.html_escape(val) %></pre>
         </div>
       </div>
      </div>
     </div>
 <% end %>
 </div>
+</div>
+</main>
 <%= render_file 'common/footer.html.erb' %>

data/samples/nodes.html.erb

@@ -1,17 +1,14 @@
-<%= render_file 'common/header.html.erb' %>
+<%= render_file('common/header.html.erb', title: 'Nodes') %>
 <h1 id="nodes">List all nodes for DC, sorted by name</h1>
 <ul>
 <% nodes.sort {|a,b| a['Node'] <=> b['Node'] }.each do |snode|
-%> <li id="node_#{snode['ID']"><a href="ssh://<%= snode['Address']%>"><%= snode['Address'].ljust(16) %></a> <%= snode['Node'] %><%
+%><li id="node_<%= snode['ID'] %>"><a href="ssh://<%= snode['Address']%>"><%= snode['Address'] %></a> <%= snode['Node'] %><%
   snode['Meta'].each do |k,v|
     if v && !v.empty?
-%>
-   <span class="badge badge-pill badge-primary float-right"><%= k %>:&nbsp;<%= v%></span>
-<%
+%><span class="badge badge-pill badge-primary float-right"><%= k %>:&nbsp;<%= v%></span><%
     end
   end if snode['Meta']
-%>
-</li>
+%></li>
 <% end %>
 </ul>
 <%= render_file 'common/footer.html.erb' %>

data/samples/services.html.erb

@@ -2,6 +2,10 @@
 # This template can be configure the following way with environment variables
 # Environment variables to filter services/instances
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
+require 'base64'
+require 'json'
+require 'date'
+
   services_tag_filter = ENV['SERVICES_TAG_FILTER']
   def status_to_class(status)
     if status == 'passing'
@@ -14,11 +18,41 @@
       'info'
     end
   end
-  %><%= render_file 'common/header.html.erb' %>
-<% require 'base64'
-   require 'json'
-   require 'date'
-%>
+
+  def compute_node_status(snode)
+    state = 'passing'
+    return state unless snode['Checks']
+    snode['Checks'].each do |c|
+      case c['Status']
+      when 'critical'
+        return 'critical'
+      when 'warning'
+        state = 'warning'
+      end
+    end
+    state
+  end
+
+  def compute_service_status(snodes)
+    passing = 0
+    warning = 0
+    critical = 0
+    sum = 0
+    snodes.each do |snode|
+      st = compute_node_status(snode)
+      sum += 1
+      case st
+      when 'passing'
+        passing += 1
+      when 'warning'
+        warning += 1
+      else
+        critical += 1
+      end
+    end
+    [passing, warning, critical, sum]
+  end
+  %><%= render_file('common/header.html.erb', title: 'Services') %>
 <nav>
   <ul>
     <li><a href="#datacenters">DataCenters</a></li>
@@ -26,46 +60,75 @@
     <li><a href="#services">Services with instances</a></li>
   </ul>
 </nav>
-<h1 id="datacenters">List of all datacenters</h1>
-<ul>
-<% datacenters.each do |dc| %>
-  <li id="dc_<%=dc %>%"><%= dc %> with <%= services(dc:dc).keys.count %> services, <%= nodes(dc:dc).count %> nodes</li>
-<% end %>
-</ul>
-
-<h1 id="list_services">List of all services in current DC</h1>
-<ul>
-<% services.each do |service_name, tags|
- %>
-  <li><a href="#service_<%= service_name %>"><%= service_name %></a> <%= tags.sort %></li>
-<% end %>
-</ul>
 
-<h1 id="services">List all services instances sorted by node name</h1>
-<% services.each do |service_name, tags|
-%><h2 id="service_<%= service_name %>" title="<%= tags %>"><%= service_name %> <a class="qlink" href="#service_<%= service_name %>">&#128279;</a></h2>
-<ul>
-<%     service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
-  tags = snode['Service']['Tags'].sort
-  addr = snode['Node']['Address']
-  port_num = snode['Service']['Port'].to_i
-  port = port_num && port_num > 0 ? ":#{port_num}" : ''
-  url = if tags.include? 'https'
-          "https://#{addr}#{port}"
-        elsif tags.include? 'http'
-          "http://#{addr}#{port}"
-        elsif tags.include? 'ftp'
-          "ftp://#{addr}#{port}"
-        else
-          nil
-        end
-%><li><a <%= url ? "href=\"#{url}\"" : nil %>><%=
-  snode['Node']['Node'] %><%= port %></a>
-  <span class="tags"><%= snode['Service']['Tags'].sort %></tag>
-  <span class="statuses"><%
-  snode['Checks'].each do |c| %> <span title="<%= c['Name']%>" class="<%= c['Status'] %>"><%= c['Status']
-  %></span><% end if snode['Checks'] %></span></li>
-<% end%>
-</ul>
-<% end%>
+<div class="container-fluid">
+  <div class="row">
+    <nav id="list_services" class="col-2">
+      <ul>
+        <%
+          all_services = services(tag: services_tag_filter)
+          all_services.each do |service_name, tags|
+        %>
+        <li><a title="<%= tags.sort.join(', ') %>" href="#service_<%= service_name %>"><%= service_name %></a></li>
+        <% end %>
+      </ul>
+    </nav>
+    <main class="col-10">
+      <h1 id="datacenters">List of all datacenters</h1>
+        <ul>
+        <% datacenters.each do |dc| %>
+          <li id="dc_<%=dc %>%"><%= dc %> with <%= services(dc:dc).keys.count %> services, <%= nodes(dc:dc).count %> nodes</li>
+        <% end %>
+        </ul>
+      <h1 id="services">List all services instances sorted by node name</h1>
+      <% services.each do |service_name, tags|
+          service_group = service(service_name)
+          nodes_sorted = service_group.sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }
+          passing, warning, critical, sum = compute_service_status(nodes_sorted)
+          service_state = 'passing'
+          service_state = 'warning' if warning > 0
+          service_state = 'critical' if critical > 0
+      %>
+      <div class="service <%= service_state %>" id="service_<%= service_name %>">
+        <h2 class="text-<%= status_to_class(service_state) %>" title="<%= tags.join(', ') %>"><%= service_name %><a class="qlink" href="#service_<%= service_name %>">&#128279;</a></h2>
+        <% if sum > 0
+        %><div class="progress">
+            <div title="<%= "#{passing} / #{sum}" %>" class="progress-bar bg-success" role="progressbar" style="width:<%= (100.0 * passing / sum).round(2) %>%" aria-valuenow="<%= passing %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+            <div title="<%= "#{warning} / #{sum}" %>" class="progress-bar bg-warning" role="progressbar" style="width:<%= (100.0 * warning / sum).round(2) %>%" aria-valuenow="<%= warning %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+            <div title="<%= "#{critical} / #{sum}" %>" class="progress-bar bg-danger" role="progressbar" style="width:<%= (100.0 * critical / sum).round(2) %>%" aria-valuenow="<%= critical %>" aria-valuemin="0" aria-valuemax="<%= sum %>"></div>
+          </div>
+        <% end %>
+        <div class="list-group">
+        <% nodes_sorted.each do |snode|
+          tags = snode['Service']['Tags'].sort
+          addr = snode['Node']['Address']
+          port_num = snode['Service']['Port'].to_i
+          port = port_num && port_num > 0 ? ":#{port_num}" : ''
+          url = if tags.include? 'https'
+                  "https://#{addr}#{port}"
+                elsif tags.include? 'http'
+                  "http://#{addr}#{port}"
+                elsif tags.include? 'ftp'
+                  "ftp://#{addr}#{port}"
+                else
+                  nil
+                end
+        %><div class="list-group-item check"><a <%= url ? "href=\"#{url}\"" : nil %>><%=
+          snode['Node']['Node'] %><%= port %></a>
+            <span class="tags"><%
+              snode['Service']['Tags'].sort.each do |t|
+              %><span class="badge badge-pill"><%= t %></span><%
+              end
+            %></span>
+            <span class="float-right statuses"><%
+          snode['Checks'].each do |c| %> <span title="<%= c['Name']%>" class="badge badge-pill badge-<%= status_to_class(c['Status']) %>"><%= c['Status']
+          %></span><% end if snode['Checks'] %></span></div>
+        <% end %>
+        </div>
+      </div>
+      <% end 
+      %>
+    </main>
+  </div>
+</div>
 <%= render_file 'common/footer.html.erb' %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -129,7 +129,9 @@ email:
 executables:
 - consul-templaterb
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- TemplateAPI.md
 files:
 - ".gitignore"
 - ".gitreview"
@@ -142,6 +144,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TemplateAPI.md
 - bin/consul-templaterb
 - consul-templaterb.gemspec
 - lib/consul/async/consul_endpoint.rb