consul-templaterb 1.18.1 → 1.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c712ffce37a55a53211be4109f089fa8d08a8bd7cab7a3f9afe14a0407f6274f
-  data.tar.gz: 564ead3a1e81267424e4d1d00df38a3752c6a23d7b0af6ef34ddb077c16d076f
+  metadata.gz: d79f747c0b0378a3526f63fd7a4638f2cfe432da043821749c89f8b302a6489a
+  data.tar.gz: 69f3d665fda37542cc4496daeb77f2d300514d9708afb0eef363aebf1a5a74ad
 SHA512:
-  metadata.gz: 58a722c9eb468a9e843dbd991841bb494e80e194fcd79c66773e36e792e897adf99db9cb11aaab4d125673cf474f4d61e741d4b226aee4577b68e911d34ed574
-  data.tar.gz: 90b2aad7e64e949da07a803e48e76d1cf45b27df81cf01d353b596c2583235298c9df43fd2961739fcb3f7fe1e2e3dfe9413a1ce2f6a8c72aca9fda67c7350ba
+  metadata.gz: e6e24033378a8bc9abd18c6e57da606e45aac7bf20ea8f295d33ea668f2d44b9abf4395099ecf0dbc804e50a0467426807f587ba2f07fc2149361b568ce5b791
+  data.tar.gz: 4a5c613be0aee5f4c7646286b699ab3d17cf4af3b26f6e227884f14c79648d6ea3086777d547de162bd5906e161877a1c3e5f7d19c2a5ecc8d1c94a072eebcb3

data/CHANGELOG.md

@@ -2,9 +2,25 @@
 
 ## (UNRELEASED)
 
+## 1.18.2 (August 28,  2019)
+
+BUGFIX:
+
+* In Consul UI, showing data from KV with markup was not properly handled
+
+NEW FEATURES:
+
+Support any request method for remote_resource.as_json (#41)
+
+ - support post and other request methods
+ - accept any 2xx result (instead of just 200). This is a semi-breaking
+   change.
+ - accept body passed for non GET requests
+ - allow to add headers (such as Authorization)
+
 ## 1.18.1 (July 27, 2019)
 
-BUFIX:
+BUGFIX:
 
 Fixed wrong lazy initialization in `remote_resource.as_json` that
 cause too many connections to be opened.

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:2.5
+
+WORKDIR /usr/src/app
+COPY . .
+
+RUN apt-get update -qq && apt-get install -y build-essential nginx-light
+
+RUN bundle install
+
+EXPOSE 80
+ENV LANG C.UTF-8
+ENV CONSUL_HTTP_ADDR http://consul-relay.service.consul.preprod.crto.in:8500
+
+ENTRYPOINT ["/usr/local/bin/bundle", "exec", "consul-templaterb"]
+CMD ["--template", "samples/consul-ui/consul-keys-ui.html.erb", "--template", "samples/consul-ui/consul-nodes-ui.html.erb", "--template", "samples/consul-ui/consul-services-ui.html.erb", "--template", "samples/consul-ui/consul-timeline-ui.html.erb", "--template", "samples/consul-ui/consul_keys.json.erb", "--template", "samples/consul-ui/consul_nodes.json.erb", "--template", "samples/consul-ui/consul_services.json.erb", "--template", "samples/consul-ui/timeline.json.erb", "--template", "samples/consul-ui/consul-services-ui.html.erb:samples/consul-ui/index.html:touch samples/consul-ui/ready", "--sig-reload=NONE", "--exec=nginx -c /usr/src/app/docker-nginx-conf/nginx.conf"]

data/README.md

@@ -117,6 +117,13 @@ https://github.com/oneclick/rubyinstaller2/issues/96#issuecomment-434619796
 gem install eventmachine consul-templaterb --platform ruby
 ```
 
+### Run it with Docker
+
+An Docker image is also available https://hub.docker.com/r/discoverycriteo/consul-templaterb
+and allows to quickly have a working
+[Consul-UI](https://github.com/criteo/consul-templaterb/blob/master/samples/consul-ui/README.md)
+that will server the UI to explore your Consul Cluster.
+
 ### Playing with the samples templates
 
 Samples are installed with the GEM, you can either

data/TemplateAPI.md

@@ -439,12 +439,23 @@ secret('secret/foo', [force_ttl: intInSecond])
 ### as_json(url, default_value, [refresh_delay_secs: intInSecond])
 
 Fetch json data from any url. This allows to create templates with consul/vault data mixed in with data coming from other services/api.
-Polling interval can be controlled with refresh_delay_secs.
+Polling interval can be controlled with `refresh_delay_secs` option.
+Request method (`GET`, `POST`, ...) can be controlled with `request_method` option.
 
 ```erb
 remote_resource.as_json('http://my-api.dev/fridge/list.json', [])
 ```
 
+Example with post (json_body will be applied `to_json` automatically):
+```erb
+remote_resource.as_json('http://my-api.dev/fridge', [], request_method: :post, json_body: {brand: 'any'})
+```
+
+Basic authentication can be done passing `headers` option.
+```erb
+remote_resource.as_json('http://my-api.dev/fridge/list.json', [], headers: { Authorization: [user, password]})
+```
+
 Full example: [samples/list_ruby_versions_from_rubygems.txt.erb](samples/list_ruby_versions_from_rubygems.txt.erb)
 
 ## template_info()

data/docker-nginx-conf/nginx.conf

@@ -0,0 +1,27 @@
+daemon            off;
+worker_processes  2;
+
+error_log         /usr/src/app/error.log info;
+
+events {
+    worker_connections  128;
+}
+
+http {
+    server_tokens off;
+    include       /etc/nginx/mime.types;
+    charset       utf-8;
+
+    access_log        /usr/src/app/access.log combined;
+
+    server {
+        server_name   localhost;
+        listen        0.0.0.0:80;
+        root          /usr/src/app/samples/consul-ui;
+        sendfile      on;
+
+        error_page    500 502 503 504  /50x.html;
+
+    }
+
+}

data/lib/consul/async/consul_template.rb

@@ -26,8 +26,8 @@ module Consul
         @endp_manager = endpoints_manager
       end
 
-      def as_json(url, default_value, refresh_delay_secs: 10)
-        conf = JSONConfiguration.new(url: url, min_duration: refresh_delay_secs, retry_on_non_diff: refresh_delay_secs)
+      def as_json(url, default_value, refresh_delay_secs: 10, **opts)
+        conf = JSONConfiguration.new(url: url, min_duration: refresh_delay_secs, retry_on_non_diff: refresh_delay_secs, **opts)
         @endp_manager.create_if_missing(url, {}) do
           if default_value.is_a?(Array)
             ConsulTemplateJSONArray.new(JSONEndpoint.new(conf, url, default_value))

data/lib/consul/async/json_endpoint.rb

@@ -7,12 +7,16 @@ module Consul
   module Async
     class JSONConfiguration
       attr_reader :url, :retry_duration, :min_duration, :retry_on_non_diff,
-                  :debug, :enable_gzip_compression
+                  :debug, :enable_gzip_compression, :request_method, :json_body,
+                  :headers
       def initialize(url:,
                      debug: { network: false },
                      retry_duration: 10,
                      min_duration: 10,
                      retry_on_non_diff: 10,
+                     request_method: :get,
+                     json_body: nil,
+                     headers: {},
                      enable_gzip_compression: true)
         @url = url
         @debug = debug
@@ -20,6 +24,9 @@ module Consul
         @retry_duration = retry_duration
         @min_duration = min_duration
         @retry_on_non_diff = retry_on_non_diff
+        @request_method = request_method
+        @json_body = json_body
+        @headers = headers
       end
 
       def create(_url)
@@ -135,7 +142,14 @@ module Consul
           keepalive: true,
           callback: method(:on_response)
         }
+        if conf.json_body
+          res[:body] = conf.json_body.to_json
+          res[:head]['Content-Type'] = 'application/json'
+        end
         res[:head]['accept-encoding'] = 'identity' unless conf.enable_gzip_compression
+        conf.headers.map do |k, v|
+          res[:head][k] = v
+        end
         @query_params.each_pair do |k, v|
           res[:query][k] = v
         end
@@ -167,9 +181,10 @@ module Consul
           conn: EventMachine::HttpRequest.new(conf.url, options)
         }
         cb = proc do
-          http = connection[:conn].get(build_request)
+          request_method = conf.request_method.to_sym
+          http = connection[:conn].send(request_method, build_request)
           http.callback do
-            if enforce_json_200 && http.response_header.status != 200 && http.response_header['Content-Type'] != 'application/json'
+            if enforce_json_200 && !(200..299).cover?(http.response_header.status) && http.response_header['Content-Type'] != 'application/json'
               _handle_error(http) do
                 warn "[RETRY][#{url}] (#{@consecutive_errors} errors)" if (@consecutive_errors % 10) == 1
               end

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.18.1'.freeze
+    VERSION = '1.18.2'.freeze
   end
 end

data/samples/consul-ui/README.md

@@ -12,6 +12,13 @@ meaning that it can be scaled horizontally without any troubles with Consul.
 * List all nodes
 * List datacenters
 
+## Quick install with Docker
+
+An Docker image is also available https://hub.docker.com/r/discoverycriteo/consul-templaterb
+and allows to quickly have a working
+[Consul-UI](https://github.com/criteo/consul-templaterb/blob/master/samples/consul-ui/README.md)
+that will server the UI to explore your Consul Cluster.
+
 ## Is it prod ready?
 
 This application is used for several months within Criteo to replace Consul native interface and

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

@@ -115,7 +115,7 @@ class ConsulKeys {
       var dataToDisplay = 'NO DATA';
     }
 
-    $("#kv-data").html(dataToDisplay);
+    $("#kv-data").text(dataToDisplay);
     $("#kv-data").removeClass();
 
     $('pre code').each(function(i, block) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.18.2
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -170,6 +170,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -177,6 +178,7 @@ files:
 - TemplateAPI.md
 - bin/consul-templaterb
 - consul-templaterb.gemspec
+- docker-nginx-conf/nginx.conf
 - docs/images/consul-ui_001.png
 - lib/consul/async/consul_endpoint.rb
 - lib/consul/async/consul_template.rb