consul-templaterb 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665f6314688398c4384fcaf1759f438e3f48fe61e0308a4cd0d3bf72a45f5355
-  data.tar.gz: 24188ffb9e2e43bf3a4b2d879e50758b185897c2fd9bb3028f115fb9e0749899
+  metadata.gz: c585b885aba40b8fcb72ac48c82f4dfd90ea4cbb9949976aa33eecf8a6a109a3
+  data.tar.gz: 1a35639786fb7c3dad6f23bd890816763997f025299a99608291212cc8c07695
 SHA512:
-  metadata.gz: 7d8b2daa28c4e3d44206c1bc3790ea59f82521243de4cb650ad3ae054b6cec270e2c3bfdb8c5b09af79815485f2e840dc111fe9368e1c0a920d1098a54b6b3dc
-  data.tar.gz: ac954c31e366d638cb62777a6fe4da7d9e3970de32a3d220c3d7b3f85d744f07bed06dd2bef034b7409b0a74b97daa14ac6cc6f8a2db7fe28a751700c898ddf9
+  metadata.gz: 50afc5d1cdfb2aa269673be86561dc4c8fde3334f9de4b2a9361714f1e35b47a0235d828a17c93d6e50345873bbb396075bd0762f6ad7062fe97ba51eda1c1c3
+  data.tar.gz: 9286bd23cf9d41e01b0585521eb0e7c41bead41a82b571baa687e7f3734fdfd238cce67b7b45bcadbe2565111dc118b49d659061ec20a9deaa2d0dd6fa0bf016

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## (UNRELEASED)
+
+## 1.0.6 (March 16, 2018)
+
+IMPROVEMENTS:
+
+* 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
+* Fixed typos in README.md
+* Added CHANGELOG.md
+
+## 1.0.5 (March 12, 2018)
+
+BUG FIXES:
+
+* fixed default value for parameter -c to http://localhost:8500
+
+## 1.0.4 (March 12, 2018)
+
+BUG FIXES:
+
+* First auto-built by Travis CI and fully deployed version
+* Fixed String interpolation bug in help messages
+* Bump rubocop to version 0.49.0 due to CVE (Travis CI)
+
+IMPROVEMENTS:
+
+* Various README.md improvements
+
+## 1.0.0 -> 1.0.3 (March 12, 2018) First public release
+
+BUG FIXES:
+
+* Allow Travis to build properly using tags and publish to rubygems.org

data/README.md

@@ -2,13 +2,13 @@
 
 This GEM 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 babysitting processes
+erb templates. It also support launching programs and baby-sitting processes
 when rendering the files, thus notifying programs when data do change.
 
 It is intended for user accustomed to expressiveness or Ruby templating (ERB),
-allowing for more flexibility and than Go Templating.
+allowing for more flexibility and features than Go templates.
 
-It also allow to use all of ruby language, especially usefull for generating
+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.
 
@@ -16,7 +16,7 @@ It also focuses on good performance and lightweight usage of bandwidth,
 especially for very large clusters and watching lots of services.
 
 For complicated rendering of templates and large Consul Clusters, it usually
-render faster with a more predictible way the template than the original
+renders faster with a more predictable way the template than the original
 consul-template.
 
 ## Differences with HashiCorp's consul-template
@@ -31,12 +31,12 @@ has support for Hashicorp's Vault), but consul-templaterb focuses on getting
 more power with the generation of templates and more performance.
 
 Consul Template uses Go templates which is very limited in its set of
-features is quite limited: it is complicated to sort, apply real transformations
+features: it is complicated to sort, apply real transformations
 using code and even interact with the OS (ex: get the current date, format
 timestamps...).
 
-The sort feature for instances allow you to create predictible output (i.e: meaning
-that the order of nodes is predictible), thus it might offer better performance
+The sort feature for instances allow you to create predictable output (i.e: meaning
+that the order of nodes is predictable), thus it might offer better performance
 since the reload of processes if happening ONLY when the files are binary
 different. Thus, if using consul-templaterb, you will reload less your haproxy or
 load-balancer than you would do with consul-template.
@@ -44,19 +44,19 @@ load-balancer than you would do with consul-template.
 Compared to consul-template, consul-templaterb offers the following features:
 
 * Hot-Reload of template files
-* Bandwith limitation per endpoint (will soon support dynamic bandwith limiter)
+* Bandwidth limitation per endpoint (will soon support dynamic bandwidth limiter)
 * Supports baby sitting of multiple processes
 * 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 babysitting of multiple processes with
-ability to send signals to those processes whenever the files do change.
+commands when files are modified and supervision of multiple processes with
+ability to send signals to those processes when the files do change.
 
 ## Installation
 
-You might either use the executable direcly OR use this GEM as a library by
-adding this line to your application's Gemfile:
+You might either use the executable directly OR use this GEM as a library by
+adding this line to your application's `Gemfile`:
 
 ```ruby
 gem 'consul-templaterb'
@@ -65,7 +65,7 @@ gem 'consul-templaterb'
 And then execute:
 
 ```shell
-    $ bundle
+$ bundle
 [...]
 ```
 
@@ -79,13 +79,34 @@ $ gem install consul-templaterb
 If you simply want to use the executable on your favorite linux distribution, you
 have to install first: ruby and ruby dev.
 
-### Quick install on Ubuntu
+### Quick install on Ubuntu-Linux
 
 ```shell
 sudo apt-get install ruby ruby-dev && sudo gem install consul-templaterb
 ```
 
-You can now use it directly using the binary `consul-templaterb` in your path
+You can now use it directly using the binary `consul-templaterb` in your path.
+
+### Playing with the samples templates
+
+Samples are installed with the GEM, you can either
+[download](https://github.com/criteo/consul-templaterb/tree/master/samples) them or
+simply use the ones installed with the gem. To figure out where the templates are
+installed:
+
+```shell
+$ gem contents consul-templaterb|grep samples
+```
+
+Will output the path where the samples are being installed, you can copy the directory
+somewhere and then issue the command:
+
+```shell
+$ consul-templaterb samples/*.html.erb
+```
+
+It will render a full web site you may browse to look in real time the status of your
+Consul Cluster.
 
 ## Usage of consul-templaterb
 
@@ -110,6 +131,14 @@ USAGE: bin/consul-templaterb [[options]]
         --once                       Do not run the process as a daemon
 ```
 
+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
+if the `--template my_file.ext.erb:myfile.ext` was used.
+
 ### Generate multiple templates
 
 In the same way as consul-template, consul-templaterb supports multiple templates and executing
@@ -132,7 +161,7 @@ $ consul-templaterb \\
 
 ### Process management and signalisation of configuration files
 
-With the --exec argument (can be specified multiple times), consul-templaterb will launch
+With the `--exec` argument (can be specified multiple times), consul-templaterb will launch
 the process specified when all templates have been generated and will send a reload signal
 if the content of any of the files do change (the signal will be sent atomically however,
 meaning that if 2 results of templates are modified at the same time, the signal will be
@@ -154,7 +183,7 @@ By design, the GEM supports limiting the number of requests per endpoints (see c
 `bin/consul-templaterb` file). It avoids using too much network to fetch data from Consul
 in large Consul Clusters (especially when watching lots of files).
 
-The limitation is currently static, but fair dynamic bandwidth allocation will allow to limit
+The limitation is static for now, but fair dynamic bandwidth allocation will allow to limit
 the bandwidth used to get information for all services by capping the global bandwidth used
 by consul-templaterb.
 
@@ -176,12 +205,12 @@ use (website updated automagically when values to change).
 
 Here are the various functions you might use in your templates.
 
-For each function, mandatory arguments are specified at the begining while optional ones are marked with `[]`.
+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 interactivelly. While developping, it is possible to use the switch `--hot-reload=keep`,
+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).
 
@@ -228,15 +257,16 @@ 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.
+[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.
+can also be raw text (if it is a valid template) and is resolved with a relative path regarding the file
+including it.
 
 Example:
 
@@ -250,16 +280,17 @@ We recommend using bundle using `bundle install`, you can now run `bundle exec b
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
 version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org/gems/consul-templaterb).
 
 ## Known bugs
 
 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
-  watches) at the same time. This bug is a race condition, probably in `em-http-request`. Only visible on very large
-  clusters.
-* [ ] render_file might create an infinite recusion if a template includes itself indirectly.
+  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.
 
 ## TODO
 
@@ -268,7 +299,7 @@ Here are the known bugs of the application:
 * [ ] 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
       up rendering by iterating with higher frequency until the first write of result has been performed.
-* [ ] Allow to tune bandwith using a simple config file (while it should not be necessary for 90% of use-cases)
+* [ ] Allow to tune bandwidth using a simple config file (while it should not be necessary for 90% of use-cases)
 
 ## Contributing
 
@@ -278,4 +309,4 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 
 ## License
 
-The gem is available as open source under the terms of the Apache v2 license. See LICENSE.txt file.
+The gem is available as open source under the terms of the Apache v2 license. See [LICENSE.txt](LICENSE.txt) file.

data/bin/consul-templaterb

@@ -212,6 +212,10 @@ def find_max_descriptors(max_descripors)
   max_size
 end
 
+unless options[:consul][:base_url].start_with? 'http'
+  options[:consul][:base_url] = "http://#{options[:consul][:base_url]}"
+end
+
 # Since we might be using a lots of descriptors, document this
 new_size = find_max_descriptors(65_536)
 STDERR.puts "Max number of descriptors set to #{new_size}" if options[:consul][:debug][:network]

data/consul-templaterb.gemspec

@@ -12,9 +12,13 @@ Gem::Specification.new do |spec|
   spec.email         = ['sre-core-services@criteo.com']
 
   spec.summary       = 'Implementation of Consul template using Ruby and .erb templating language'
-  spec.homepage      = 'https://github.com/criteo/consul-templaterb'
-  spec.description   = 'A ruby implementation of Consul Template with support of erb templating'
-
+  spec.homepage      = 'https://rubygems.org/gems/consul-templaterb'
+  spec.description   = 'A ruby implementation of Consul Template with support of erb templating ' \
+                       'with hi-performance on large clusters and advanced process management features.'
+  spec.metadata      = { 'bug_tracker_uri' => 'https://github.com/criteo/consul-templaterb/issues',
+                         'changelog_uri'   => 'https://github.com/criteo/consul-templaterb/blob/master/CHANGELOG.md',
+                         'homepage_uri'    => 'https://github.com/criteo/consul-templaterb',
+                         'source_code_uri' => 'https://github.com/criteo/consul-templaterb' }
   spec.license       = 'Apache v2'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.0.5'.freeze
+    VERSION = '1.0.6'.freeze
   end
 end

data/samples/services.html.erb

@@ -25,8 +25,6 @@
     <li><a href="#datacenters">DataCenters</a></li>
     <li><a href="#list_services">List of services</a></li>
     <li><a href="#services">Services with instances</a></li>
-    <li><a href="#nodes">All Nodes</a></li>
-    <li><a href="#kv">Key/Value Store</a></li>
   </ul>
 </nav>
 <h1 id="datacenters">List of all datacenters</h1>
@@ -71,19 +69,4 @@
 <% end%>
 </ul>
 <% end%>
-
-
-<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>
-<% end %>
-</ul>
-
-<h1 id="kv">KV of Current DC</h1>
-<ul>
-<% kv(keys:true).each do |key|
-%><li id="kv_#{key}"><%= key %></li>
-<% end %>
-</ul>
 <%= 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.5
+  version: 1.0.6
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -123,6 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: A ruby implementation of Consul Template with support of erb templating
+  with hi-performance on large clusters and advanced process management features.
 email:
 - sre-core-services@criteo.com
 executables:
@@ -136,6 +137,7 @@ files:
 - ".rubocop.yml"
 - ".ruby_app"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -162,10 +164,14 @@ files:
 - samples/keys.html.erb
 - samples/nodes.html.erb
 - samples/services.html.erb
-homepage: https://github.com/criteo/consul-templaterb
+homepage: https://rubygems.org/gems/consul-templaterb
 licenses:
 - Apache v2
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/criteo/consul-templaterb/issues
+  changelog_uri: https://github.com/criteo/consul-templaterb/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/criteo/consul-templaterb
+  source_code_uri: https://github.com/criteo/consul-templaterb
 post_install_message: 
 rdoc_options: []
 require_paths: