consul-templaterb 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03d2d0aa9f8c3d39ce100425d7b8a2907eea8e0362383a34e41917af4fc8e2b2
-  data.tar.gz: e1c0f7dd9bb50d8c10e5be073a00cc52e7de82b0541c8efb973929834b70c48a
+  metadata.gz: 4e668f5f7933ba2ec7c0ccad29248d7c2c18cb638931c13dbd4cbb63e55f5908
+  data.tar.gz: 61f3edd44ca479edad6c71226f6a2b827ae83f5387726a012f4e2d72d5606f3b
 SHA512:
-  metadata.gz: 2bf4ff3ce92344d9e79ba00035072753ec95d860bb143f39b0c858038119adf89014e8b3f7e294b4095158840fe43198252da1626a561f49dce796cd94f8549c
-  data.tar.gz: d53f88ea95908908aced0200a2afb98d30a156bc4a3f9c0ce66412c1ae6fc4f22f591137bce031fb85e840d7dc7b0116702f891d5a027f44f818e24631b7f116
+  metadata.gz: d7fe83b0f9c67abf720fb6a9f941c184c646a9ea5aa7dbeaf244840d9cea52bdbb41a81fb4b79b0a178dc24c3c48e5d75eecd8236731e22ad836262e9ec4d3b3
+  data.tar.gz: 878b453b28fb63c430604ae1335a23267f31a5e0dfcc2e1728d5bb919a8cfe907ac1c8458916b6682bb39b7bb51e09baadb5e4bfe97b9b8d6805ce534ab34497

data/.gitignore

@@ -13,6 +13,8 @@
 /samples/*.html
 /samples/*.txt
 /samples/*.cfg
+samples/consul-ui/*.html
+samples/consul-ui/*.json
 /samples/criteo/haproxy.cfg
 /samples/consul_template
 /samples/find_blocked_choregraphies

data/CHANGELOG.md

@@ -4,7 +4,25 @@
 
 IMPROVEMENTS:
 
-# 1.0.10
+## 1.0.11 (May 11, 2018)
+
+BUG FIXES:
+
+ * Fix for Mac OS X fixed in `1.2-stable` branch of
+   [event-machine](https://github.com/eventmachine/eventmachine/), see
+   https://github.com/igrigorik/em-http-request/issues/315 for more
+   details
+ * fixed bug in samples/sample_keys.html.erb
+ * Unit tests now catches all `*.erb` files in subdirectories
+
+IMPROVEMENTS:
+
+ * Improved new samples/consul-ui/
+ * Documentation typos
+ * Help typos fixed
+ * Various improvements in [samples/](samples/]
+
+# 1.0.10 (May 4, 2018)
 
 IMPROVEMENTS:
 

data/README.md

@@ -88,7 +88,7 @@ $ gem install consul-templaterb
 [...]
 ```
 
-If you simply want to use the executable on your favorite linux distribution, you
+If you simply want to use the executable on your preferred Linux distribution, you
 have to install first: ruby and ruby dev.
 
 ### Quick install on Ubuntu-Linux
@@ -140,8 +140,8 @@ USAGE: consul-templaterb [[options]]
     -w, --wait=<min_duration>        Wait at least n seconds before each template generation
     -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 sent to next --exec command on kill, default=TERM
-    -R, --sig-reload=reload_signal   Signal to sent to next --exec command on reload (NONE supported), default=HUP
+    -K, --sig-term=kill_signal       Signal to send to next --exec command on kill, default=TERM
+    -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
     -t erb_file:[output]:[command]:[params_file],
@@ -153,8 +153,8 @@ When launched with file arguments ending with .erb, the executable will assume
 the file is a template and will render the corresponding file without the
 `.erb` extension.
 
-It means that you can call consul-templaterb with *.erb arguments, the shell
-will then substitute all files and render it by removing the .erb extension as
+It means that you can call consul-templaterb with `*.erb` arguments, the shell
+will then substitute all files and render it by removing the `.erb` extension as
 if the `--template my_file.ext.erb:myfile.ext` was used.
 
 ### Generate multiple templates
@@ -222,7 +222,7 @@ examples:
 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
+If you want to test it quickly, you might try with (assuming your consul agent is listening on
 `http://localhost:8500`):
 
 ```shell
@@ -253,11 +253,11 @@ push git commits and tags, and push the `.gem` file to [rubygems.org](https://ru
 
 Here are the known bugs of the application:
 
-* [ ] On Mac OS X, with many services, consul-templaterb sometimes crashes when watching lots of changes (more than 2k
+* [x] On Mac OS X, with many services, consul-templaterb sometimes crashes when watching lots of changes (more than 2k
   watches) at the same time. This bug is
   [probably a race condition in `em-http-request`](https://github.com/igrigorik/em-http-request/issues/315). Only visible
   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.
+* [ ] `render_file` might create an infinite recursion if a template includes itself indirectly.
 
 Please consult [CHANGELOG.md](CHANGELOG.md) for fixed bugs.
 
@@ -266,9 +266,9 @@ Please consult [CHANGELOG.md](CHANGELOG.md) for fixed bugs.
 * [ ] Hashi's Vault support
 * [ ] Implement automatic dynamic rate limit
 * [ ] More samples: apache, nginx, full website displaying consul information...
-* [ ] Optimize rendering speed at startup: an iteration is done very second by default, but it would be possible to speed
+* [ ] Optimize rendering speed at start-up: an iteration is done very second by default, but it would be possible to speed
       up rendering by iterating with higher frequency until the first write of result has been performed.
-* [ ] Allow to tune bandwidth using a simple config file (while it should not be necessary for 90% of use-cases)
+* [ ] Allow to tune bandwidth using a simple configuration file (while it should not be necessary for 90% of use-cases)
 
 ## Contributing
 

data/TemplateAPI.md

@@ -95,7 +95,7 @@ Full example: [samples/consul_template.txt.erb](samples/consul_template.txt.erb)
 
 [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.
+services that are passing or not. An optional argument passing might be used to retrieve only passing instances.
 
 <details><summary>Examples</summary>
 <div class="samples">

data/bin/consul-templaterb

@@ -92,19 +92,19 @@ optparse = OptionParser.new do |opts|
 
   def compute_signal(val, none_value)
     valid_signals = Signal.list.keys
-    raise "Please #{val} specifiy a signal: #{valid_signals.inspect}" unless val
+    raise "Please specify a signal, use any of: #{valid_signals.inspect}" unless val
     return nil if val == none_value
-    raise "Invalid signal, valid signals: #{valid_signals.inspect}" unless valid_signals.include? val
+    raise "Invalid signal #{val}, valid signals: #{valid_signals.inspect}" unless valid_signals.include? val
     val
   end
 
   opts.on('-K', '--sig-term=kill_signal', String,
-          "Signal to sent to next --exec command on kill, default=#{cur_sig_term}") do |sig|
+          "Signal to send to next --exec command on kill, default=#{cur_sig_term}") do |sig|
     cur_sig_term = compute_signal(sig, nil)
   end
 
   opts.on('-R', '--sig-reload=reload_signal', String,
-          "Signal to sent to next --exec command on reload (NONE supported), default=#{cur_sig_reload}") do |sig|
+          "Signal to send to next --exec command on reload (NONE supported), default=#{cur_sig_reload}") do |sig|
     cur_sig_reload = compute_signal(sig, 'NONE')
   end
 

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.0.10'.freeze
+    VERSION = '1.0.11'.freeze
   end
 end

data/samples/consul-ui/common/header.html.erb

@@ -4,8 +4,12 @@
   # CONSUL_TOOLS_PREFIX: prefix for the address of consul tools
   # CONSUL_TOOLS: comma sperated list of consul tools
   tools = (ENV['CONSUL_TOOLS'] || 'services').split(",")
-  suffix = ENV['CONSUL_TOOLS_PREFIX'] || '-ui.html'
-  prefix = ENV['CONSUL_TOOLS_SUFFIX'] || 'consul-'
+  tools_suffix = ENV['CONSUL_TOOLS_PREFIX'] || '-ui.html'
+  tools_prefix = ENV['CONSUL_TOOLS_SUFFIX'] || 'consul-'
+
+  dc_suffix = ENV['CONSUL_DC_SUFFIX'] || ''
+  dc_prefix = ENV['CONSUL_DC_PREFIX'] || '#'
+
 %><!DOCTYPE html>
 <html lang="en">
   <head>
@@ -13,24 +17,28 @@
     <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">
-    <!-- <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet"> -->
     <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.11/css/all.css" integrity="sha384-p2jx59pefphTFIpeqCcISO9MdVfIm4pNnsL08A6v5vaQc4owkQqxMV8kg4Yvhaw/" crossorigin="anonymous">
     <link rel="stylesheet" href="css/style.css">
   </head>
   <body>
     <nav class="navbar navbar-expand-md navbar-dark bg-secondary">
-      <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-brand">Consul</span>
-      </button>
-      <div class="collapse navbar-collapse" id="navbarsExampleDefault">
+      <div class="collapse navbar-collapse">
         <ul class="navbar-nav mr-auto">
+          <li class="nav-item dropdown">
+            <a class="navbar-brand dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+              Consul
+            </a>
+            <div class="dropdown-menu" aria-labelledby="navbarDropdown">
+              <% datacenters.each do |dc| %>
+              <a class="dropdown-item" href="<%= dc_prefix + dc + dc_suffix %>"><%= dc %></a>
+              <% end %>
+            </div>
+          </li>
           <% tools.each do |tool| %>
           <li class="nav-item">
-            <a class="nav-link" href="<%= prefix + tool + suffix %>"><%= tool.gsub('_', ' ').capitalize %></a>
+            <a class="nav-link" href="<%= tools_prefix + tool + tools_suffix %>"><%= tool.gsub('_', ' ').capitalize %></a>
           </li>
           <% end %>
         </ul>

data/samples/consul-ui/consul-services-ui.html.erb

@@ -1,4 +1,7 @@
-<% datasource = ENV['SERVICE_DATASOURCE'] || 'consul-template.json' %>
+<% datasource = ENV['SERVICE_DATASOURCE'] || 'consul-template.json'
+   # Time to wait before reloading configuration again in seconds (0 = never)
+   refresh = ENV['REFRESH'] || '600' %>
+
 <%= render_file('common/header.html.erb', title: 'Services') %>
     <div class="main">
       <div class="row mx-0">
@@ -13,6 +16,11 @@
         </div>
         <div class="col-8 col-m-9">
           <h2 class="text-center" id="service-title"></h2>
+          <div class="progress">
+            <div id="service-progress-passing" status="passing" onclick="consulService.onClickFilter(this)" class="progress-status progress-bar bg-success" role="progressbar" style="width: 100%">passing</div>
+            <div id="service-progress-warning" status="warning" onclick="consulService.onClickFilter(this)" class="progress-status progress-bar bg-warning" role="progressbar" style="width: 0%">warning</div>
+            <div id="service-progress-critical" status="critical" onclick="consulService.onClickFilter(this)" class="progress-status progress-bar bg-danger" role="progressbar" style="width: 0%">critical</div>
+          </div>
           <div id="instances-wrapper">
             <div id="instances-list" class="list-group"></div>
           </div>
@@ -25,7 +33,7 @@
   <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
   <script src="js/service.js"></script>
   <script type="text/javascript">
-    consulService = new ConsulService('<%= datasource %>');
+    consulService = new ConsulService('<%= datasource %>','<%= refresh %>');
   </script>
   </body>
 </html>

data/samples/consul-ui/consul_template.json.erb

@@ -6,9 +6,9 @@
 #   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)
 
-  service_tag_filter = ENV['SERVICES_TAG_FILTER'] || 'http'
+  service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
-  instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG'] || 'canary'
+  instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG']
 
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
@@ -42,11 +42,11 @@
   end
   backends = {}
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && tags.include?(instance_must_tag)
+    if !services_blacklist.include?(service_name) && (instance_must_tag.nil? || tags.include?(instance_must_tag))
       the_backends = []
       service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
         tags_of_instance = snode['Service']['Tags']
-        if tags_of_instance.include?(instance_must_tag) && !tags_of_instance.include?(instance_exclude_tag)
+        if (instance_must_tag.nil? || tags_of_instance.include?(instance_must_tag)) && !tags_of_instance.include?(instance_exclude_tag)
           the_backends << snode if snode['Service']['Port']
         end
       end
@@ -85,5 +85,6 @@
       service[:instances] << server
     end
   end
-  json = { services: json_backends}
+  json_datacenters = datacenters
+  json = { services: json_backends, datacenters: json_datacenters, generated_at: Time.now}
 %><%= JSON.pretty_generate(json) %>

data/samples/consul-ui/css/style.css

@@ -38,7 +38,7 @@ h2 .fas {
   cursor: pointer;
   color: rgba( 0, 0, 0, 0.5);
   font-size: 1.5rem;
-  transition: color .16s linear
+  transition: color .16s linear;
 }
 
 h2 .fas:hover {
@@ -55,3 +55,17 @@ h2 .fas:hover {
   padding: 5px;
   padding-left: 10px;
 }
+
+.progress {
+  border-radius: 0px;
+}
+
+.progress-status {
+  transition: background-color .16s linear;
+  cursor: pointer;
+}
+
+.progress-deactivated {
+  background-color: #a5a5a5 !important;
+  color: #f1f1f1 !important;
+}

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

@@ -1,27 +1,27 @@
 class ConsulService {
-  constructor(ressourceURL) {
+  constructor(ressourceURL, refresh) {
     this.ressourceURL = ressourceURL;
     this.fetchRessource();
     this.serviceList = $("#service-list");
     this.serviceFilter = $("#service-filter");
-    this.serviceFilter.keyup(this.filterService)
+    this.serviceFilter.keyup(this.filterService);
+    this.refresh = parseInt(refresh);
+    this.filterStatus = null;
   }
 
   fetchRessource() {
     $.ajax({url: "consul_template.json", cache: false, dataType: "json", sourceObject: this, success: function(result){
-      if(this.sourceObject.data) {
-        // For autoupdate
-      } else {
-        this.sourceObject.initRessource(result);
-      }
+      consulService.initRessource(result);
     }});
   }
 
   initRessource(data) {
     this.data = data;
     this.reloadServiceList();
-    var urlParam = new URL(location.href).searchParams.get('service')
-    if(urlParam) {
+    console.log('Data generated at: ' + data['generated_at']);
+
+    var urlParam = new URL(location.href).searchParams.get('service');
+    if (urlParam) {
       var nodes = document.getElementById('service-list').childNodes;
       for(var i in nodes) {
         if($(nodes[i]).html() == urlParam) {
@@ -32,6 +32,10 @@ class ConsulService {
     } else {
       this.selectService(document.getElementById('service-list').firstElementChild);
     }
+
+    if(this.refresh > 0) {
+      setTimeout(this.fetchRessource, this.refresh * 1000);
+    }
   }
 
   reloadServiceList() {
@@ -62,6 +66,38 @@ class ConsulService {
     this.updateURL();
   }
 
+  onClickFilter(source) {
+    var status = $(source).attr('status');
+    this.filterStatus = (this.filterStatus == status) ? null : status;
+    this.filterInstances();
+  }
+
+  filterInstances() {
+    $('.progress-status').each(function() {
+      var status = $(this).attr('status');
+      if (consulService.filterStatus == null) {
+        $(this).removeClass('progress-deactivated');
+      } else if(consulService.filterStatus == status) {
+        $(this).removeClass('progress-deactivated');
+      } else {
+        $(this).addClass('progress-deactivated');
+      }
+    })
+    $('#instances-list').children('div').each(function() {
+      var status = $(this).attr('status');
+      if (consulService.filterStatus == null) {
+        $(this).removeClass('d-none');
+        $(this).addClass('d-block');
+      } else if (consulService.filterStatus == status) {
+        $(this).removeClass('d-none');
+        $(this).addClass('d-block');
+      } else {
+        $(this).removeClass('d-block');
+        $(this).addClass('d-none');
+      }
+    })
+  }
+
   updateURL() {
     var newUrl = window.location.protocol + "//" + window.location.host + window.location.pathname;
     newUrl += '?service=' + $(this.selectedService).html();
@@ -82,7 +118,9 @@ class ConsulService {
 
   displayService(service) {
     $("#service-title").html(service['name']);
-    $("#instances-list").html("")
+    $("#instances-list").html("");
+
+    var serviceStatus = {};
 
     for (var key in service['instances']) {
       var instance = service['instances'][key];
@@ -92,26 +130,54 @@ class ConsulService {
       serviceHtml.appendChild(serviceTitleGenerator(instance));
       serviceHtml.appendChild(tagsGenerator(instance));
       serviceHtml.appendChild(checksStatusGenerator(instance));
+      var state = nodeState(instance);
+      serviceHtml.setAttribute('status', state);
+      serviceStatus[state] = (serviceStatus[state] || 0) + 1;
+      serviceStatus['total'] = (serviceStatus['total'] || 0) + 1;
 
       $("#instances-list").append(serviceHtml);
     }
 
+    $('#service-progress-passing').css('width', (serviceStatus['passing'] || 0) / serviceStatus['total'] * 100 + '%')
+    $('#service-progress-warning').css('width', (serviceStatus['warning'] || 0) / serviceStatus['total'] * 100 + '%')
+    $('#service-progress-critical').css('width', (serviceStatus['critical'] || 0) / serviceStatus['total'] * 100 + '%')
+
     resizeWrapper('instances-wrapper', 'instances-list');
     $('#instances-list .list-group-item').resize(resizeAll);
   }
 }
 
+function nodeState(instance) {
+  status='passing';
+  for (var checkKey in instance.checks) {
+    switch(instance.checks[checkKey]['status']) {
+      case 'passing': break;
+      case 'warning': status='warning'; break;
+      case 'critical': return 'critical'; break;
+    }
+  }
+  return status;
+}
+
+supported_protocols = ['https', 'http', 'sftp', 'ftp', 'ssh', 'telnet']
+
 function serviceTitleGenerator(instance) {
-  var protocol = 'http://';
-  if(instance.tags.includes('https')) {
-    protocol = 'https://';
+  var protocol = null;
+  for (i in supported_protocols) {
+    var protoc = supported_protocols[i]
+    if (instance.tags.includes(protoc)) {
+      protocol = protoc + '://';
+      break;
+    }
   }
 
   var htmlTitle = document.createElement('h5');
 
   var instanceLink = document.createElement('a');
-  instanceLink.setAttribute('href',  protocol + instance.name + ':' + instance.port);
-  instanceLink.setAttribute('target',  '_blank');
+  if (protocol != null) {
+    instanceLink.setAttribute('href',  protocol + instance.name + ':' + instance.port);
+    instanceLink.setAttribute('target',  '_blank');
+  }
   instanceLink.appendChild(document.createTextNode(instance.name + ':' + instance.port));
   htmlTitle.appendChild(instanceLink);
 
@@ -177,7 +243,17 @@ function checksStatusGenerator(instance) {
       var td2 = document.createElement('td');
       var fieldName = dataToDisplay[index].replace(/\b\w/g, l => l.toUpperCase());
       td1.appendChild(document.createTextNode(fieldName + ': '));
-      td2.appendChild(document.createTextNode(instance.checks[checkKey][dataToDisplay[index]]));
+      var target = td2
+      if (index != 1) {
+        target = document.createElement('div');
+        target.setAttribute("class", "check-notes")
+      } else {
+        // Notes are rendered as plain text
+        target = document.createElement('pre');
+        target.setAttribute("class", "check-output")
+      }
+      target.appendChild(document.createTextNode(instance.checks[checkKey][dataToDisplay[index]]));
+      td2.appendChild(target)
       tr.appendChild(td1);
       tr.appendChild(td2);
       notes.appendChild(tr);

data/samples/sample_keys.html.erb

@@ -57,7 +57,7 @@ if key_to_display
     <code><% 
   # catch_errors: true will return nil if data cannot be converted to JSON
   json = kv(key_to_display).get_value_json(catch_errors: true)
-  %><%= (json ? jERB::Util.html_escape(json) : 'No Valid JSON Data') %></code>
+  %><%= (json ? ERB::Util.html_escape(json) : 'No Valid JSON Data') %></code>
   </div>
 <%
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -135,7 +135,6 @@ extra_rdoc_files:
 - TemplateAPI.md
 files:
 - ".gitignore"
-- ".gitreview"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby_app"

data/.gitreview

@@ -1,5 +0,0 @@
-[gerrit]
-host=review.criteois.lan
-port=29418
-project=ruby-gems/consul-templaterb
-defaultbranch=master