consul-template-generator 0.3.5 → 0.3.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2YzMmY3Y2Y5NzhlMzY2YjZiNjgxZWQ4ZWFiYzVkOGNlOGM0ODZlZA==
-  data.tar.gz: !binary |-
-    MjJjODFlNzRjM2EyNzk0MjM4ODViMWFjZGM5MGNmOTg0Mzc3YTUzMg==
+SHA256:
+  metadata.gz: f9b13454eb8a9ecbae979c7cd9e7ab7059ead09bccab88ad80717bf2cab3dc29
+  data.tar.gz: d6af9f9b003e2689c31773cf97545fcc1fc6f999951adc5866ccf1f8013f754f
 SHA512:
-  metadata.gz: !binary |-
-    YjMyZjZkYmMzNzRiOWYwMmU2MjQwZTZhYTgxMjJkYzdhZWExZjI1MzkxYTY5
-    Zjg3Y2EyNzhiNDMxNjRkMzY3NzEwMGRhYzdjYjU2ZDc3MDVlNWIwMjBmMjcw
-    NzliYTQyMmYxYTlmNjA1NjNiNDlmZmIxYTc2ODg1ODVlMGUzMjI=
-  data.tar.gz: !binary |-
-    YWVkYWEwN2ZkZDgwN2QyZTdkNzk5MzE2YjRmNjFjYWEwZjZkMTk4ZDI4ZjFh
-    MWNmYTBjZjkyNWVmNGMyODM5MjQyZWFiOTM4OGQ4MmMxOTYwNGJkN2FmMzQy
-    NWNkYzI0ZmMwMDQ3ODQ0YzgzZjQ4ZjRiY2UxMzk2ZjBhZWM0MjE=
+  metadata.gz: 6d304ceabef20b23b76d90b91b84892f46cfea5856a6f3f3deb5781b308f9a856a91f87eb3f80f5a400714baaaf0da582f617d1cbe4bc0cb36103725eef4c3ee
+  data.tar.gz: 743c1d4360e6924955a0c4d32694249506f267810aaaf4ae8f272792bcd5fcaa0dcb9884dbab2c5f1f04b8cf533d373c06cc4652bb921b5772f5b93d1e0aca5f

data/.travis.yml

@@ -1,7 +1,19 @@
 language: ruby
+dist: xenial
+
+branches:
+  only:
+    - master
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+before_install:
+  - gem install bundler
+
 bundler_args: --binstubs
+
 script: "bin/rspec --format doc"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consul-template-generator (0.3.4)
+    consul-template-generator (0.3.6)
       diffy (~> 3.0)
       diplomat (~> 0.13)
       popen4 (~> 0.1)
@@ -9,64 +9,71 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    Platform (0.4.0)
-    addressable (2.3.8)
-    colorize (0.7.7)
-    crack (0.4.2)
+    Platform (0.4.2)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    diffy (3.0.7)
-    diplomat (0.13.1)
+    diff-lcs (1.3)
+    diffy (3.3.0)
+    diplomat (0.19.0)
       faraday (~> 0.9)
-      json (~> 1.8)
-    docile (1.1.5)
-    faraday (0.9.2)
+      json
+    docile (1.3.1)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.9)
     hirb (0.7.3)
-    json (1.8.3)
+    json (2.2.0)
     multipart-post (2.0.0)
     open4 (1.3.4)
     popen4 (0.1.2)
       Platform (>= 0.4.0)
       open4 (>= 0.4.0)
-    rack (1.6.1)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.0)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.0)
+    public_suffix (3.0.3)
+    rack (2.0.7)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    safe_yaml (1.0.4)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-console (0.2.0)
-      colorize
+    simplecov-console (0.4.2)
+      ansi
       hirb
       simplecov
-    simplecov-html (0.10.0)
-    webmock (1.21.0)
+    simplecov-html (0.10.2)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler (~> 2.0)
   consul-template-generator!
-  rack (~> 1.6)
-  rake (~> 10.0)
+  rack (~> 2.0)
+  rake (~> 12.0)
   rspec (~> 3.3)
   simplecov (~> 0.10)
   simplecov-console (~> 0.2)
-  webmock (~> 1.21)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,3 +1,47 @@
 [![Build Status](https://travis-ci.org/socrata-platform/consul-template-generator.svg)](https://travis-ci.org/socrata-platform/consul-template-generator)
+[![Gem Version](https://badge.fury.io/rb/consul-template-generator.svg)](https://badge.fury.io/rb/consul-template-generator)
 
-# TODO
+# Consul Template Generator
+
+[Consul-Template](https://github.com/hashicorp/consul-template) is an immensely valuable tool
+for translating services registered with [Consul](https://github.com/hashicorp/consul) into
+system configurations. One potential pitfall with it, though, is the potential for large,
+distributed systems to [DDoS](https://github.com/hashicorp/consul-template/issues/205) their Consul
+cluster.  This work can be mitigated to some degree with carefully crafted templates, but can
+also be avoided by the use of `consul-template-generator`
+
+The function of `consul-template-generator` is to delegate template generation to a single process
+in a fault-tolerant fashion.  The `consul-template-generator` "master" takes a consul lock on a
+specified session K/V store key to allow redundant deployments of any given configuration to be
+active simultaneously.  A given `consul-template-generator` configuration can include an arbitrary
+number `ctmpl` files which will be evaluated using `consul-template`.  When updates to a `ctmpl`
+are found `consul-template-generator` will update specified keys in Consul's K/V store with the
+`consul-template` rendered templates.  This allows downstream instances of `consul-template` to
+watch a single key in Consul K/V instead of multiple Consul registered services, thus reducing
+the load on the underlying Consul cluster significantly.
+
+
+## Usage
+
+`consul-template-generator <command> [options]`
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| once | Run once and exit.  On success, the rendered template will be inserted into the KV store whether or not it has changed. |
+| run | Run continually, uploading the rendered template when a change is detected. |
+
+### Options
+| required | short flag         | long flag                       | Description |
+|----------|--------------------|---------------------------------|-------------|
+| No       | `-c HOSTNAME`      | `--consul HOSTNAME`             | Hostname/port used to connect to consul [default: 127.0.0.1:8500] |
+| Yes      | `-t TEMPLATES`     | `--templates TEMPLATES`         | (required) Comma separated list of consul-template `ctmpl` file and keys to monitor, `tmple.ctmpl:tmple-key,tmple2.ctmpl:templ-key2`. If `--graphite-host` is supplied, target graphite path must also be supplied, e.g. `tmple.ctmpl:tmple-key:consul.template.<HOSTNAME>.<template name>`. |
+| No       | `-s SESSION_KEY`   | `--session-key SESSION_KEY`     | Key used to lock template generation session [default: consul-template-generator] |
+| No       |                    | `--session-ttl SESSION_TTL`     | Set a TTL for consul sessions (sets an implicit ttl on locks created by consul-template-generator [default: 30s] |
+| No       |                    | `--unset-proxy`                 | Use if 'http_proxy' is set in your environment, but you don't want to use it... |
+| No       |                    | `--diff-changes`                | Log diff'ed template prior to upload |
+| No       | `-l`               | `--log-level LOG_LEVEL`         | Log level, options are 'debug', 'info', 'error' [default: info] |
+| No       |                    | `--cycle-sleep CYCLE_SLEEP`     | Sleep interval in seconds between each template rendering [default: 0.5] |
+| No       |                    | `--lock-sleep LOCK_SLEEP`       | Sleep interval in seconds between each attempt to obtain a session lock [default: 1.0] |
+| No       | `-g GRAPHITE_HOST` | `--graphite-host GRAPHITE_HOST` | Graphite host to post template update events to (optional) |

data/bin/consul-template-generator

@@ -51,19 +51,18 @@ EOC
           '--templates TEMPLATES',
           'Comma separated list of consul-template ctmpl file and keys to monitor, tmple.ctmpl:tmple-key,tmple2.ctmpl:templ-key2  (required)',
           'If \'--graphite-host\' is supplied, target graphite path must also be supplied, e.g.',
-          '    tmple.ctmpl:tmple-key:consul.template.HOSTNAME.<template name>,tmple2.ctmpl:tmple-key2:consul.template.HOSTNAME.<template name>',
-          'where \'HOSTNAME\' will be replaced as one might expect.') do |t|
+          '    tmple.ctmpl:tmple-key:consul.template.HOSTNAME.<template name>,tmple2.ctmpl:tmple-key2:consul.template.<HOSTNAME>.<template name>') do |t|
     options[:templates] = process_templates(t)
     options[:graphite_paths] = process_graphite_paths(t)
   end
 
   options[:session_key] = 'consul-template-generator'
-  opts.on('-s SESSION_KEY', '--session-key SESSION_KEY', 'Key used to lock template generation session [default: consul-template-generator') do |l|
+  opts.on('-s SESSION_KEY', '--session-key SESSION_KEY', 'Key used to lock template generation session [default: consul-template-generator]') do |l|
     options[:session_key] = l
   end
 
   options[:session_ttl] = 30
-  opts.on(nil, '--session-ttl SESSION_TTL', "Set a TTL for consul sessions (sets an implicit ttl on locks created by consul-template-generator [default: 30]") do |ttl|
+  opts.on(nil, '--session-ttl SESSION_TTL', "Set a TTL for consul sessions (sets an implicit ttl on locks created by consul-template-generator [default: 30s])") do |ttl|
     options[:session_ttl] = ttl.to_i
   end
 

data/consul-template-generator.gemspec

@@ -18,14 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'diffy', '~> 3.0'
+  spec.add_dependency 'diplomat', '~> 0.18.0'
+  spec.add_dependency 'popen4', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rack', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'simplecov', '~> 0.10'
   spec.add_development_dependency 'simplecov-console', '~> 0.2'
-  spec.add_development_dependency 'webmock', '~> 1.21'
-  spec.add_development_dependency 'rack', '~> 1.6'
-  spec.add_dependency 'diffy', '~> 3.0'
-  spec.add_dependency 'diplomat', '~> 0.13'
-  spec.add_dependency 'popen4', '~> 0.1'
+  spec.add_development_dependency 'webmock', '~> 3.5'
 end

data/lib/consul/template/generator/configuration.rb

@@ -54,10 +54,13 @@ module Consul
           @logger = Consul::Template::Generator::STDLogger
           @graphite_host = nil
           @diff_changes = false
+
+          STDOUT.sync = true
+          STDERR.sync = true
         end
 
         def lock_key(key)
-          "/lock/#{key.sub(/^\//, '')}"
+          "lock/#{key.sub(/^\//, '')}"
         end
 
         def session_lock_key

data/lib/consul/template/generator/version.rb

@@ -1,7 +1,7 @@
 module Consul
   module Template
     module Generator
-      VERSION = '0.3.5'
+      VERSION = '0.3.6'
     end
   end
 end

data/spec/key_value_spec.rb

@@ -10,7 +10,7 @@ include Consul::Template::Generator
 describe 'Consul::Template::Generator::CTRunner' '#acquire_lock' do
   before do
     Consul::Template::Generator.configure do |config|
-      config.templates = { 'test-template.ctmpl' => '/test-template' }
+      config.templates = { 'test-template.ctmpl' => 'test-template' }
       config.consul_host = '127.0.0.1:8500'
       config.consul_template_binary = 'consul-template'
       config.log_level = :off
@@ -40,7 +40,7 @@ end
 describe 'Consul::Template::Generator::CTRunner' '#acquire_session_lock' do
   before do
     Consul::Template::Generator.configure do |config|
-      config.templates = { 'test-template.ctmpl' => '/test-template' }
+      config.templates = { 'test-template.ctmpl' => 'test-template' }
       config.session_key = '/session/test-template'
       config.consul_host = '127.0.0.1:8500'
       config.consul_template_binary = 'consul-template'
@@ -71,7 +71,7 @@ describe 'Consul::Template::Generator::CTRunner' '#upload_template' do
   context 'uploads template' do
     before do
       Consul::Template::Generator.configure do |config|
-        config.templates = { 'test-template.ctmpl' => '/test-template' }
+        config.templates = { 'test-template.ctmpl' => 'test-template' }
         config.consul_host = '127.0.0.1:8500'
         config.consul_template_binary = 'consul-template'
         config.log_level = :off
@@ -90,7 +90,7 @@ describe 'Consul::Template::Generator::CTRunner' '#upload_template' do
   context 'handles template upload failure' do
     before do
       Consul::Template::Generator.configure do |config|
-        config.templates = { 'test-template.ctmpl' => '/test-template-failure' }
+        config.templates = { 'test-template.ctmpl' => 'test-template-failure' }
         config.consul_host = '127.0.0.1:8500'
         config.consul_template_binary = 'consul-template'
         config.log_level = :off

data/spec/spec_helper.rb

@@ -97,10 +97,7 @@ RSpec.configure do |config|
 
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::Console
-]
+SimpleCov.formatter = SimpleCov::Formatter::Console
 SimpleCov.minimum_coverage(80)
 SimpleCov.start
 

metadata

@@ -1,155 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: consul-template-generator
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Brian Oldfield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: diplomat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 0.18.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: popen4
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov-console
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: diffy
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '0.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: diplomat
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :runtime
+        version: '0.2'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: popen4
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '3.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3.5'
 description: When using complex consul-template templates or distributing them across
   many hosts, you run the risk of DoSing your consul cluster.  Using consul-template-generator
   you can instead delegate the watching/rendering of templates to a single host and
@@ -162,9 +162,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -195,17 +195,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Wrapper around consul template which uploads renterd templates to consul's