consul-templaterb 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de191ca431027f8633f4e50b3fe479ca6a4db001ce40b1d28460498d9d9a9987
-  data.tar.gz: 0a996fa6e6c69e108ea0c5adb335954496d57b3755fd68e5a95c025f9370147c
+  metadata.gz: 74b7cce156473c1c3cba5d028f352aef6a9463fc24b328f51585cd80c2b42e0d
+  data.tar.gz: 6fb08ec94eddac3b5e051359039ce1ec0a87593ecb32a91ab8b3b38fbf5f687f
 SHA512:
-  metadata.gz: 9b2f17384a48bc613a3e8a9088c4e68035e49a6ba0d25881cf1b1653d123c3e73ff8bbf45abbae877079a4d0b8333f69abab0dd003ef4162490125bebef17362
-  data.tar.gz: d8223b6902df1790ab897631d95ec5556c0cda6fa0b2168865ed0ad461d255ee0168b84531a39a24405bf5af36be3d2cef3a197d003e52a4238347fba2fe4b23
+  metadata.gz: 8a0ce21b647df4eaf71b3d1a6b5c791213cc5b9e0e224719aa27c49522e8a462f1a2ebfdc714af9ebd5d0d134d30662d1893c9dd7dd109a4fb1cabbde630a039
+  data.tar.gz: cad4a025f9df51b3f4544efd1a560d64b226f334056e5015e4aea5c9b38eb87d9a1265a5a755dacd1f902a338ef27a3441b472e68d672da29ea641b0ad81c2ee

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 IMPROVEMENTS:
 
+## 1.2.0 (May 17, 2018)
+
+IMPROVEMENTS:
+
+ * Added snode.service_address to get the IP address of a service easily
+   without any logic in ERB files
+ * Improved consul-ui, added a [README.md](samples/consul-ui/README.md)
+
 ## 1.1.3 (May 17, 2018)
 
 IMPROVEMENTS:

data/TemplateAPI.md

@@ -97,6 +97,9 @@ Full example: [samples/consul_template.txt.erb](samples/consul_template.txt.erb)
 optional tag. If no tag is specified, will return all instances of service. By default, it will return all the
 services that are passing or not. An optional argument passing might be used to retrieve only passing instances.
 
+This object also contains a Helper to get easily the correct Address by using `service_address` which returns
+the optional `['Service']['Address']` if found or `['Node']['Address']` otherwise.
+
 <details><summary>Examples</summary>
 <div class="samples">
 

data/lib/consul/async/consul_template.rb

@@ -269,9 +269,34 @@ module Consul
       end
     end
 
+    class ServiceInstance < Hash
+      def initialize(obj)
+        merge!(obj)
+      end
+
+      # Return ['Service']['Address'] if defined, the address of node otherwise
+      def service_address
+        val = self['Service']['Address']
+        val = self['Node']['Address'] unless !val.nil? && val != ''
+        val
+      end
+    end
+
     class ConsulTemplateService < ConsulTemplateAbstractMap
       def initialize(consul_endpoint)
         super(consul_endpoint)
+        @cached_result = []
+        @cached_json = nil
+      end
+
+      def result_delegate
+        return @cached_result if @cached_json == result.json
+        new_res = []
+        result.json.each do |v|
+          new_res << ServiceInstance.new(v)
+        end
+        @cached_result = new_res
+        new_res
       end
     end
 

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.1.3'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/samples/consul-ui/README.md

@@ -0,0 +1,43 @@
+# consul-ui
+
+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.
+
+## Usage
+
+```shell
+consul-templaterb -c http://localhost:8500 samples/consul-ui/*.erb
+```
+
+Where `http://localhost:8500` is the address of the Consul agent you want to use to
+perform requests.
+
+The content is statically created, so you can serve it using any HTTP server very easily.
+
+For development, you might use `python -m SimpleHTTPServer` in order to server the result
+on your browser.
+
+### Generating index.html
+
+By default, the command `consul-templaterb -c http://localhost:8500 samples/consul-ui/*.erb``
+will generate sample/consul-ui/consul-services-ui.html file. If you want to use index.html instead
+you might use the `--template samples/consul-ui/consul-services-ui.html:samples/consul-ui/index.html`
+instead. Example:
+
+```shell
+consul-templaterb -c http://localhost:8500 \
+  --template samples/consul-ui/consul-services-ui.html:samples/consul-ui/index.html \
+  samples/consul-ui/consul_template.json.erb
+```
+
+Will generate index.html and consul_template.json in your directory, so you might serve it directly.
+
+### Filtering services
+
+This app supports the following environement 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)

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

@@ -77,14 +77,15 @@
         check['notes'] = ncheck['Notes']
         checks.push(check)
       end
+      meta = snode['Service']['Meta']
       server = { frontend_id: "backend_http__#{service_name}",
-                 id:     snode['Service']['ID'],
-                 name:   snode['Node']['Node'],
-                 sMeta:  snode['Service']['Meta'],
-                 addr:   snode['Node']['Address'],
-                 port:   snode['Service']['Port'],
-                 tags:   snode['Service']['Tags'],
-                 checks: checks,
+                 id:      snode['Service']['ID'],
+                 name:    snode['Node']['Node'],
+                 sMeta:   meta ? meta : [],
+                 addr:    snode.service_address,
+                 port:    snode['Service']['Port'],
+                 tags:    snode['Service']['Tags'],
+                 checks:  checks,
       }
       service[:instances] << server
     end

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

@@ -218,7 +218,7 @@ function serviceTitleGenerator(instance) {
 
   var instanceLink = document.createElement('a');
   if (protocol != null) {
-    instanceLink.setAttribute('href',  protocol + instance.name + ':' + instance.port);
+    instanceLink.setAttribute('href',  protocol + instance.addr + ':' + instance.port);
     instanceLink.setAttribute('target',  '_blank');
   }
   instanceLink.appendChild(document.createTextNode(instance.name + ':' + instance.port));

data/samples/consul_template.html.erb

@@ -54,7 +54,7 @@
 <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']
+  addr = snode.service_address
   port_num = snode['Service']['Port'].to_i
   port = port_num && port_num > 0 ? ":#{port_num}" : ''
   url = if tags.include? 'https'

data/samples/consul_template.json.erb

@@ -66,7 +66,7 @@
     nodes.each do |snode|
       server = { frontend_id: "backend_http__#{service_name}",
                  id:     snode['Service']['ID'],
-                 addr:   snode['Node']['Address'],
+                 addr:   snode.service_address,
                  port:   snode['Service']['Port'],
                  tags:   snode['Service']['Tags'],
       }

data/samples/consul_template.xml.erb

@@ -34,7 +34,7 @@
       service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
         xnode = REXML::Element.new 'service-instance'
         xnode.add_attribute 'id', snode['Node']['ID'] if snode['Node']['ID']
-        xnode.add_attribute 'address', snode['Node']['Address']
+        xnode.add_attribute 'address', snode.service_address
         xnode.add_attribute 'name', snode['Node']['Name']
         xnode.add_attribute 'port', snode['Service']['Port'].to_i
         xnode.add_attribute 'tags', snode['Service']['Tags'].sort.join(',')

data/samples/criteo/haproxy.cfg.erb

@@ -157,7 +157,7 @@ backend be_<%= service_name %>
   mode http
   balance leastconn
 <%   nodes.each_with_index do |node, idx|
-  %>  server srv<%= idx %> <%= node['Node']['Address']%>:<%= node['Service']['Port'] %><%= compute_attributes(node) %>
+  %>  server srv<%= idx %> <%= node.service_address%>:<%= node['Service']['Port'] %><%= compute_attributes(node) %>
 <%   end
    end
 %>

data/samples/criteo_choregraphies.txt.erb

@@ -0,0 +1,49 @@
+<%
+  require 'base64'
+  require 'json'
+  require 'date'
+  @current_time = Time.now.utc
+  def display_holder(holder, value)
+    begin
+      holder_date = Time.parse(value)
+      status = 'success'
+      diff = (@current_time - holder_date).round(0)
+      status = 'warning' if diff > 3600
+      status = 'danger' if diff > 7200
+      diff_txt = "#{diff % 3600} seconds"
+      diff_txt = "#{(diff % 86400) / 3600} hours, #{diff_txt}" if diff > 3600
+      diff_txt = "#{diff / 86400} days, #{diff_txt}" if diff > 86400
+    rescue StandardError => e
+      status = 'info'
+      holder_date = "Cannot parse date: #{e}"
+      diff_txt = "Error Parsing date #{value}"
+    end
+   [holder, holder_date, "#{diff_txt} ago", status]
+  end
+
+datacenters.each do |dc|
+  kv('choregraphie', dc:dc, recurse:true).each do |tuple|
+    ckey = tuple['Key'].gsub('/', '-')
+    if tuple['Value'].nil?
+      json = []
+      holders = []
+    else
+      json = JSON.parse(Base64.decode64(tuple['Value']))
+      holders = json['holders']
+    end
+    if holders.count > 0
+      holders.each_pair do |key,value|
+        if value.is_a?(Hash)
+          value.each_pair do |k, v|
+            host, holder_date, diff_txt, status = display_holder(k, v)
+          end
+        else
+          host, holder_date, diff_txt, status = display_holder(key, value)
+        end
+        %><%= "#{host} ; #{dc} ; #{holder_date} ; #{status} ; #{ckey} ; #{diff_txt}" %>
+<%
+      end
+    end
+  end
+end
+%>

data/samples/ha_proxy.cfg.erb

@@ -88,7 +88,7 @@ backend backend_http__<%= service_name %>
   mode http
   balance leastconn
 <%   nodes.each do |node|
-  %>  server <%= node['Node']['Node']%>_<%= node['Service']['Port'] %> <%= node['Node']['Address']%>:<%= node['Service']['Port'] %><%= compute_attributes(node) %>
+  %>  server <%= node['Node']['Node']%>_<%= node['Service']['Port'] %> <%= node.service_address%>:<%= node['Service']['Port'] %><%= compute_attributes(node) %>
 <%   end
    end
 %>

data/samples/nodes.html.erb

@@ -28,7 +28,7 @@ end %>
   if service_per_node.key?(snode['Node'])
     service_per_node[snode['Node']].each do |service|
       tags = service['Service']['Tags'].sort
-      addr = service['Node']['Address']
+      addr = service.service_address
       port_num = service['Service']['Port'].to_i
       port = port_num && port_num > 0 ? ":#{port_num}" : ''
       url = if tags.include? 'https'

data/samples/services.html.erb

@@ -101,7 +101,7 @@ require 'date'
         <div class="list-group">
         <% nodes_sorted.each do |snode|
           tags = snode['Service']['Tags'].sort
-          addr = snode['Node']['Address']
+          addr = snode.service_address
           port_num = snode['Service']['Port'].to_i
           port = port_num && port_num > 0 ? ":#{port_num}" : ''
           url = if tags.include? 'https'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -171,6 +171,7 @@ files:
 - samples/checks.html.erb
 - samples/common/footer.html.erb
 - samples/common/header.html.erb
+- samples/consul-ui/README.md
 - samples/consul-ui/common/header.html.erb
 - samples/consul-ui/consul-services-ui.html.erb
 - samples/consul-ui/consul_template.json.erb
@@ -182,6 +183,7 @@ files:
 - samples/consul_template.xml.erb
 - samples/criteo/haproxy.cfg.erb
 - samples/criteo_choregraphies.html.erb
+- samples/criteo_choregraphies.txt.erb
 - samples/ha_proxy.cfg.erb
 - samples/keys.html.erb
 - samples/nodes.html.erb
@@ -211,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Implementation of Consul template using Ruby and .erb templating language