consul-templaterb 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481677a9cb87417e3667a7a282186ad05e0580521a96b68f8c22370371e20abc
-  data.tar.gz: b70a75f66188749d2b0a0a38a51dcc8629b8fbc6554165b4241802a47864db40
+  metadata.gz: 60bb02ded0414b955e2ddf979bd02587fd352af8dbb07c162e1985a0173b5fa3
+  data.tar.gz: dd78711af97ad24c9b01a228cfaabc0376484ef24fdc6c86fd7e541cf8421a05
 SHA512:
-  metadata.gz: 3aeffc5f5fd88c284f8deeaa9b178151761a9b7e49bb79d1f352e2cd2d221b9cdb4011611009c0a24930afe190f285d25d9fc227384c33151cee8c29904fa578
-  data.tar.gz: d1831577b1359473dc0fb07702f438729c6e312c0bd29cf7f4fdcac369f896f9462ac9a7147324cf648a526615d491c219334f2bc0c1a8f52f9b3529e4e9bab1
+  metadata.gz: 32632e75b3742427a40373b36caeba46aab17eb634513a1c0d137be65adfb1ce02365c65024df651494bf635464268a2f2555dddd01baade3cad4ef03ccb1d4e
+  data.tar.gz: 129215ca52ccb173b31c0939c5438ad5bebb888b15733172ba333fca2f7a03016291a3ec542570679e38e9b64f5f3bb6a983129a461178fb3f8705cc57a3966b

data/CHANGELOG.md

@@ -2,8 +2,21 @@
 
 ## (UNRELEASED)
 
+## 1.4.0 (July 23, 2018)
+
+IMPROVEMENTS:
+
+ * minor fixes in samples
+ * consul-ui now supports `#service_<service_name>` anchors
+
+NEW FEATURES:
+
+ * Support for Hashicorp Vault improvements thanks to [@uepoch](https://github.com/uepoch)
+
 ## 1.3.1 (June 19, 2018)
 
+NEW FEATURES:
+
  * samples/consul-ui/ now displays Service Meta information (new in Consul 1.1)
 
 ## 1.3.0 (June 7, 2018)
@@ -12,7 +25,7 @@ IMPROVEMENTS:
 
  * samples/consul-ui/ now supports keys as well as nodes thanks to [@geobeau](https://github.com/geobeau)
 
-NEW FEATURES
+NEW FEATURES:
 
  * EXPERIMENTAL Vault support thanks to [@uepoch](https://github.com/uepoch)
 

data/TemplateAPI.md

@@ -279,8 +279,61 @@ consul-templaterb --template "source.html.erb:dest.html:reload_command:params.ya
 [...]
 ```
 
-In that case, it would load the content of params.yaml and inject it as params when evaluating
-template `source.html.erb`. Injection of params using 4th parameter of `--template` supports
-YAML as well as JSON format. Those parameter files are NOT automatically reloaded however.
+## secrets(prefix)
+
+It requires that a Vault token is given either in parameter or in environment variable
+The [policies](https://www.vaultproject.io/docs/concepts/policies.html) should be properly set.
+
+List the secrets in vault under a given prefix.
+
+<details><summary>Examples</summary>
+<div class="samples">
+
+### List all LDAP entities configured in Vault
+
+```erb
+<% ['users','groups'].each do |entity_type|
+%><%= entity_type.capitalize %>: <%
+    secrets("auth/ldap/#{entity_type}/").each do |entity|
+%> * <%=entity%>
+<% end %>
+<% end %>
+```
+
+Full example: [samples/vault-ldap.txt.erb](samples/vault-ldap.txt.erb)
+
+</div>
+</details>
+
+## secret(path, [data = nil])
+
+It requires that a Vault token is given either in parameter or in environment variable
+The [policies](https://www.vaultproject.io/docs/concepts/policies.html) should be properly set.
+
+Either read or write on a path in vault.
+
+Having a non-nil data Hash will change the behavior from read to update and apply the given data.
+
+Notice: For the moment the versionned KV abstration is not handled, if you want to access versioned KV, you have to hit the logical paths directly.
+
+<details><summary>Examples</summary>
+<div class="samples">
+
+### Read LDAP configuration
+
+```erb
+secret('auth/ldap/config')['data']
+```
+
+Full example: [samples/vault-ldap.txt.erb](samples/vault-ldap.txt.erb)
+
+
+### Read a path in non-versionned KV
+```erb
+secret('secret/foo', [force_ttl: intInSecond])
+```
+
+</div>
+</details>
 
 See [samples/common/header.html.erb](samples/common/header.html.erb) for example of usage.

data/lib/consul/async/consul_template.rb

@@ -139,10 +139,9 @@ module Consul
         create_if_missing(path, query_params) { ConsulTemplateVaultSecretList.new(VaultEndpoint.new(vault_conf, path, 'GET',true, query_params,JSON.generate(data: {keys: []}))) }
       end
 
-      def secret(path = '', post_data = nil )
-        puts post_data
-        raise "You need to provide a vault token to use 'secrets' keyword" if vault_conf.token.nil?
-        path = "/v1/#{path}"
+      def secret(path = '', post_data = nil)
+        raise "You need to provide a vault token to use 'secret' keyword" if vault_conf.token.nil?
+        path = "/v1/#{path}".gsub(/\/{2,}/, '/')
         query_params = {}
         method = post_data ? "POST" : "GET"
         create_if_missing(path, query_params) { ConsulTemplateVaultSecret.new(VaultEndpoint.new(vault_conf, path, method, true, query_params, JSON.generate(data: {}))) }

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.3.1'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end

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

@@ -31,6 +31,12 @@ class ConsulService {
     console.log('Data generated at: ' + data['generated_at']);
 
     var urlParam = new URL(location.href).searchParams.get('service');
+    if (urlParam === null) {
+      var servicePrefix = '#service_'
+      if (location.hash.startsWith(servicePrefix)) {
+        urlParam = location.hash.substr(servicePrefix.length)
+      }
+    }
     if (urlParam) {
       var nodes = document.getElementById('service-list').childNodes;
       for(var i in nodes) {

data/samples/consul_template.txt.erb

@@ -1,6 +1,6 @@
 + List of all datacenters
 -------------------------
-<% datacenters.  each do |dc| %>
+<% datacenters.each do |dc| %>
   * <%= dc %> with <%= services(dc:dc).keys.count %> services, <%= nodes(dc:dc).count %> nodes
 <% end %>
 

data/samples/vault-ldap.txt.erb

@@ -0,0 +1,17 @@
+<% ['users','groups'].each do |entity_type|
+%><%= entity_type.capitalize %>:
+<%
+    secrets("auth/ldap/#{entity_type}/").each do |entity|
+%> * <%=entity%>: <%= secret("auth/ldap/#{entity_type}/#{entity}")['data'].to_json %>
+<% end %>
+<% end %>
+
+<%# Example Output:
+Users:
+ * m.conraux: {"groups":"","policies":["operator"]}
+ * p.souchay: {"groups":"","policies":["duck_factory_rw"]}
+
+Groups:
+ * usr-aws-passwords: {"policies":["aws_passwords"]}
+ * gu-analytics: {"policies":["kibana", "hadoop"]}
+%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -194,7 +194,6 @@ files:
 - samples/consul_template.txt.erb
 - samples/consul_template.xml.erb
 - samples/criteo/haproxy.cfg.erb
-- samples/criteo/vault-test.erb
 - samples/criteo_choregraphies.html.erb
 - samples/criteo_choregraphies.txt.erb
 - samples/ha_proxy.cfg.erb
@@ -202,6 +201,7 @@ files:
 - samples/nodes.html.erb
 - samples/sample_keys.html.erb
 - samples/services.html.erb
+- samples/vault-ldap.txt.erb
 homepage: https://rubygems.org/gems/consul-templaterb
 licenses:
 - Apache v2

data/samples/criteo/vault-test.erb

@@ -1,6 +0,0 @@
-<% secrets("/teams/").each do |secretKey| %> * <%=secretKey%>
-<% end %>
-
-test/foo :<% secret("test/foo").each do |k, v| %>
-  <%=k%>: <%=v%><% end %>
-