consul-templaterb 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81fe8ace61e417a86ebcc40579f9d7601c624e1f
-  data.tar.gz: 743e935937d5b0a23a7e1f2586e89d98142311a9
+  metadata.gz: 4cf5c69b8bbbe9ee35642288ce1e5535e2faa3d0
+  data.tar.gz: e40f21f3950ee6276e68022c9e1480f06098850b
 SHA512:
-  metadata.gz: 7de540a1a265c175d71d9509425ccf1c4bc70f07d63dda83e31fe7046542d6ffbb877e674426d257754d95b00902697c91f4a77e72bb9cfdfdcdbd6762111bcd
-  data.tar.gz: 54a1adec053fd1da90a3de4f7bbdbc5654f7bc1f641c47d91a469e26d3bad6b749be661a3061516f734c9c30ccf2334a12589fdb3f4c94081eb446bac225df21
+  metadata.gz: 5e325f31bbc13002496602c82b1c58b661118443048ce43bf7cbd8520dce9afe024fdf5f6d3d43db6422521f3f80408d2cea94617d4f1ad91ca7fcd0ec3cfae8
+  data.tar.gz: 1d81cb3a0c852f95e501a3b6aec6a8db6c3baab3406f81389ed85830772906fea3bfb1e28b9efea1dfb0b88296b5ba98a3c0c2a35d7a8133d8953e6b440bc854

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  Max: 225
+  Max: 250
 
 Metrics/CyclomaticComplexity:
   Max: 20

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## (UNRELEASED)
 
+## 1.14.0 (May 6, 2019)
+
+NEW FEATURES:
+
+When `return nil` is performed in a template, consul-templaterb now considers the template is
+not ready and thus do not start any process. It is useful if you want to start a process ONLY
+when some conditions are met.
+
 ## 1.13.1 (April 12, 2019)
 
 IMPROVEMENTS:

data/README.md

@@ -216,6 +216,10 @@ 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).
 
+If any template does return nothing (aka use `return nil` in the code of a template),
+consul-templaterb does consider that the template is not ready and will not launch the executable
+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

data/lib/consul/async/consul_template.rb

@@ -222,10 +222,14 @@ module Consul
           end
           to_cleanup << endpoint_key if (@iteration - endpt.seen_at) > 60
         end
-        if not_ready.count.positive?
+        if not_ready.count.positive? || data.nil?
           if @iteration - @last_debug_time > 1
             @last_debug_time = @iteration
-            ::Consul::Async::Debug.print_info "Waiting for data from #{not_ready.count}/#{not_ready.count + ready} endpoints: #{not_ready[0..2]}...\r"
+            if data.nil?
+              ::Consul::Async::Debug.print_info "Waiting for Template #{tpl_file_path} to not return nil, consider it not ready...\r"
+            else
+              ::Consul::Async::Debug.print_info "Waiting for data from #{not_ready.count}/#{not_ready.count + ready} endpoints: #{not_ready[0..2]}...\r"
+            end
           end
           return [false, false, nil]
         end

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.13.1'.freeze
+    VERSION = '1.14.0'.freeze
   end
 end

data/samples/haproxy_dns.cfg.erb

@@ -0,0 +1,105 @@
+# HaProxy template with consul-templaterb adapted from
+# https://github.com/haproxytech/haproxy/blob/master/blog/integration_with_consul/haproxy.conf.tmpl
+#
+# You might read this article:
+# https://www.haproxy.com/blog/haproxy-and-consul-with-dns-for-service-discovery/
+#
+# This template is more powerful than initial implementation:
+# * It discovers by itself the services (by default, all having http tag)
+# * It allows having white/blacklists of services
+# * It handles nicely services having http/non http tag
+#  
+# Here is how to configure it with environment variables:
+#
+# 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)
+#   EXCLUDE_SERVICES: comma-separated services regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
+#   SERVICES_MATCHING: regexp to show only services matching the regexp, defaults to '.*'
+#
+# HaProxy specific:
+#   HAPROXY_DOMAIN_NAME the domain name to serve, eg: myservice => myservice.example.com
+#   CONSUL_DOMAIN_NAME_SUFFIX = suffix in consul configuration (default 'consul', so services are myservice.service.consul)
+#   HAPROXY_PREFIX_PATH = where you want HaProxy to reload config
+#   CONSUL_DNS_ADDR: Address of DNS resolver returning consul SRV records (defaults to 127.0.0.1:8600)
+#   PORT0: HaProxy port to use to serve (default: 8000)
+#   HAPROXY_STATS_BIND: bind stats on... (defaut: '127.0.0.1:1936', can use for instance '*:1936')
+#   HAPROXY_ADMIN_USER_PASSWORD: Password to access stats (defaults: none)
+#
+# USAGE examples:
+#
+#   Reverse HTTP Proxy for services with tag http and starting with 'web'
+# SERVICES_MATCHING='web.*' consul-templaterb samples/haproxy_dns.cfg.erb --sig-reload=HUP --exec 'haproxy -W -f samples/haproxy_dns.cfg'
+
+<%
+  consul_domain_name = ENV['CONSUL_DOMAIN_NAME_SUFFIX'] || 'consul'
+  ha_proxy_data_prefix = ENV['HAPROXY_PREFIX_PATH'] || File.absolute_path('.')
+  ha_proxy_data_prefix += '/' unless ha_proxy_data_prefix.end_with? '/'
+  services_tag_filter = ENV['SERVICES_TAG_FILTER'] || 'http'
+  services_matching = Regexp.new(ENV['SERVICES_MATCHING'] || '.*')
+
+  # Services to hide
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
+%>
+  global
+  # daemon
+  # debug
+  pidfile <%= ha_proxy_data_prefix %>haproxy.pid
+  stats socket <%= ha_proxy_data_prefix %>haproxy.sock level admin
+  # If you want to configure from KV, you might use:
+  # You might use instead: `kv("service/haproxy/maxconn").get_value_decoded() || 256`
+  maxconn 256 
+  log 127.0.0.01:514 local0 info
+  server-state-file <%= ha_proxy_data_prefix %>haproxy.serverstates
+  description HAProxy / consul demo
+
+resolvers consul
+  nameserver <%= consul_domain_name %> <%= ENV['CONSUL_DNS_ADDR'] || '127.0.0.1:8600' %>
+  accepted_payload_size 8192
+
+defaults
+  log global
+  option httplog
+  option socket-stats
+  load-server-state-from-file global
+  default-server init-addr none inter 1s rise 2 fall 2
+  mode http
+  timeout client 30s
+  timeout connect 4s
+  timeout http-keep-alive 10s
+  timeout http-request 5s
+  timeout server 30s
+
+frontend http-in
+  bind *:<%= ENV['PORT0'] || 8000 %>
+  maxconn 256
+  use_backend b_%[req.hdr(Host),lower,word(1,:)]
+
+<%
+services(tag: services_tag_filter).each do |service_name, tags|
+  if services_matching.match(service_name) && !services_blacklist.any? {|r| r.match(service_name)}
+%>
+backend b_<%= service_name %>.<%= ENV['HAPROXY_DOMAIN_NAME'] || 'example.com' %>
+  server-template <%= service_name %> 10 <%= services_tag_filter %>.<%= service_name %>.service.<%= consul_domain_name %> resolvers consul resolve-prefer ipv4 #check
+<%
+  end
+end
+%>
+
+frontend stats
+  bind <%= ENV['HAPROXY_STATS_BIND'] || '127.0.0.1:1936' %>
+  mode http
+  option forceclose
+  stats enable
+  stats uri /
+  stats show-legends
+  stats show-desc
+  stats show-node
+  stats refresh 60
+<%
+   user_password = ENV['HAPROXY_ADMIN_USER_PASSWORD']
+   if user_password
+%>
+  stats auth <%= user_password %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -204,10 +204,10 @@ files:
 - samples/consul_template.xml.erb
 - samples/consul_template_broken.txt.erb
 - samples/criteo/haproxy.cfg.erb
-- samples/criteo_choregraphies.html.erb
 - samples/criteo_choregraphies.txt.erb
 - samples/debug/compare_connect_services.txt.erb
 - samples/ha_proxy.cfg.erb
+- samples/haproxy_dns.cfg.erb
 - samples/keys.html.erb
 - samples/kv_yaml_to_json.json.erb
 - samples/metrics.erb

data/samples/criteo_choregraphies.html.erb

@@ -1,99 +0,0 @@
-<% require 'base64'
-   require 'json'
-   require 'date'
-   @current_time = Time.now.utc
-%><%= 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>
-<%
-  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
-   ["<li class=\"list-group-item list-group-item-#{status}\">#{holder}: #{holder_date} : #{diff_txt} ago", status]
-  end
-%>
-
-<div id="accordion">
-<% kv('choregraphie', recurse:true).each do |tuple| %>
-  <!-- <%= tuple['Key'] %> -->
-  <%
-    key = tuple['Key'].gsub('/', '-')
-    if tuple['Value'].nil?
-      json = []
-      holders = []
-    %>
-    <div class="alert alert-warning" role="alert">
-      Invalid Choregraphie data: <%= tuple %>
-    </div>
-  <%
-    else
-      json = JSON.parse(Base64.decode64(tuple['Value']))
-      begin
-        holders = json['holders']
-      rescue StandardError => e
-%>
-        <h1>Failed to parse holders <%= e %> in <%= json %></h1>
-<%
-        holders = []
-      end
-    end
-  %>
-  <% if holders.count > 0 %>
-
-    <div class="card">
-      <div class="card-header" id="heading-<%= key %>">
-        <span class="badge badge-pill badge-primary float-right"><%= holders.count%>/<%= json['concurrency'] %></span>
-        <h5 class="mb-0">
-          <a href="#<%= key %>" class="btn btn-link collapsed" data-toggle="collapse" data-target="#collapse-<%= key %>" aria-expanded="true" aria-controls="collapse-<%= key %>">
-            <%= tuple['Key'] %>
-          </a>
-        </h5>
-      </div>
-      <%
-        text_result = ''
-        clazz = 'collapse'
-        holders.each_pair do |key,value|
-          if value.is_a?(Hash)
-            text_result+= "<li><u>#{key}:</u><ul class=\"list-group\">"
-            value.each_pair do |k, v|
-              res, status = display_holder(k, v)
-              clazz = 'collapse show' unless status == 'success'
-              text_result += res
-            end
-            text_result += '</ul></li>'
-          else
-            res, status = display_holder(key, value)
-            clazz = 'collapse show' unless status == 'success'
-            text_result << res
-          end
-        end
-      %>
-      <div id="collapse-<%= key %>" class="<%= clazz %>" aria-labelledby="heading-<%= key %>" data-parent="#accordion">
-        <div class="card-body">
-          <pre class="pre-scrollable"><code><%= JSON.pretty_generate(json) %></code></pre>
-          <ul class="list-group">
-            <%= text_result %>
-          </ul>
-        </div>
-      </div>
-    </div>
-  <% end %>
-<% end %>
-</div>
-</div>
-</main>
-<%= render_file 'common/footer.html.erb' %>