consul-templaterb 1.9.8 → 1.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7163a9f8ea72026dcc50a91da551a7e7ac27b4d276e3bcf4cbe71f14e2a9d4
-  data.tar.gz: e54468d856039191d377eced8706adae58c50a7c17b3a23c2a52ee2ae18a9481
+  metadata.gz: 1bc60bdb2bf31bd1da18ee4623f62fdf7a664daa5f31a273712168591612a666
+  data.tar.gz: 05dbb95ce7faba2da08b30cd6c7e8cdd96246d4e0bd4fd93996b279c9c2f6c61
 SHA512:
-  metadata.gz: 3a56201067ca649e23c8d53370d4134cfb413543400ac5c1cbf615b31d16d7e69b8b9b6578125c1eb0348f2960628aafa29058c690b66893d6ef30328c6f93b9
-  data.tar.gz: 7599a3b441da669a0e43800a2e345f4d7586232d9ea5abd78ab9f2269ba8ceae3f6e219b299fd71f910ed753d387774b487845feeb90bcf67344c96e91f685a3
+  metadata.gz: 11019612ceefc6258fe2d578bfedc836689c82c7e3118621298d7eaea21b22e65a48778422e378b50ac7799f733af8c4af1d3330356b8a0d0b10758f829725f4
+  data.tar.gz: aa338fff43589ddbc32b6d8bc20982cbd58bf0f2fd556cc18c46865014592fdffb8b9ccd7f34d54a352b3476474ceb4edfd53b12785fa1a2e76c0f9836851a4b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## (UNRELEASED)
 
+## 1.9.9 (January 18, 2019)
+
+IMPROVEMENTS:
+
+ * `EXCLUDE_SERVICES` now supports regexps to blacklist many services easily
+
 ## 1.9.8 (January 16, 2019)
 
 BUGFIX:

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at p.souchay@criteo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# How to contribute to Consul-Templaterb ?
+
+## Samples
+
+The [samples/](samples/) directory contains lots of useable templates that might help others using your new features.
+Keep them less specific as possible (for instance use environment variables to allow others to use it directly
+without relying on a specic path in KV).
+
+Read first [TemplateAPI.md](TemplateAPI.md) to ensure you are using the best functions for the job, the API is kept
+compact and powerful with many examples.
+
+All the samples are unit-tested, so launch rspec before commiting, a template not converging will not be merged.
+
+## Want new features/Found a bug?
+
+[Report it](https://github.com/criteo/consul-templaterb/issues), but read carefully [TemplateAPI.md](TemplateAPI.md) and
+[README.md](README.md)
+
+## Want to add features/fix a bug?
+
+Contributions in code are welcomed, create a fork and then a Pull Request, we will review it quickly.

data/README.md

@@ -303,9 +303,10 @@ Please consult [CHANGELOG.md](CHANGELOG.md) for fixed bugs.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/criteo/consul-templaterb.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidance: Bug reports and pull requests are welcome on GitHub at https://github.com/criteo/consul-templaterb.
+
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
-[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+[Contributor Covenant](http://contributor-covenant.org) code of conduct. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
 
 ## License
 

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.9.8'.freeze
+    VERSION = '1.9.9'.freeze
   end
 end

data/samples/consul-ui/README.md

@@ -65,6 +65,6 @@ This app supports the following environment variables:
 * `SERVICES_TAG_FILTER`: basic tag filter for service (default HTTP)
 * `INSTANCE_MUST_TAG`: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 * `INSTANCE_EXCLUDE_TAG`: Exclude instances having the given tag (default: canary)
-* `EXCLUDE_SERVICES`: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+* `EXCLUDE_SERVICES`: comma-separated services to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 * `CONSUL_TIMELINE_BUFFER`: number of entries to keep in the timeline. 1000 by default.
 * `CONSUL_TIMELINE_BLACKLIST`: regexp of services to hide from timeline

data/samples/consul-ui/consul_nodes.json.erb

@@ -4,17 +4,19 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated services of regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG']
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }  # Compute the health of a Service
+
   service_per_node = {}
   services.each do |service_name, tags|
-    if !services_blacklist.include? service_name
+    if ! services_blacklist.any? {|r| r.match(service_name)}
       service(service_name, tag: service_tag_filter).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
         node_info = service_per_node[snode['Node']['Node']] || {}
 

data/samples/consul-ui/consul_services.json.erb

@@ -4,14 +4,15 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated services regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG']
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
 
   def compute_attributes(snode)
     w = 100
@@ -30,7 +31,7 @@
   backends = {}
   tags_per_service = {}
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && (instance_must_tag.nil? || tags.include?(instance_must_tag))
+    if !services_blacklist.any? {|r| r.match(service_name)} && (instance_must_tag.nil? || tags.include?(instance_must_tag))
       tags_per_service[service_name] = tags.sort
       the_backends = []
       service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|

data/samples/consul-ui/timeline.json.erb

@@ -1,7 +1,8 @@
 <%
 require 'json'
 require 'set'
-services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }  # Compute the health of a Service
 timeline_blacklist = ENV['CONSUL_TIMELINE_BLACKLIST'] || '(lbl7-.*|netsvc-.*)'
 timeline_blacklist = Regexp.new(timeline_blacklist)
 
@@ -9,7 +10,7 @@ timeline_blacklist = Regexp.new(timeline_blacklist)
 @last_service_info = {}
 @newest_index = 0 unless @newest_index
 cur_state = services.map do |service_name, _tags|
-  next if services_blacklist.include?(service_name)
+  next if services_blacklist.any? {|r| r.match(service_name)}
   next if timeline_blacklist.match(service_name)
 
   snodes = service(service_name)

data/samples/consul_template.json.erb

@@ -4,14 +4,16 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated services regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || 'http'
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG'] || 'canary'
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }  # Compute the health of a Service
+
   # Compute the health of a Service
   def compute_attributes(snode)
     w = 100
@@ -29,7 +31,7 @@
   end
   backends = {}
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && tags.include?(instance_must_tag)
+    if !services_blacklist.any? {|r| r.match(service_name)} && tags.include?(instance_must_tag)
       the_backends = []
       service(service_name, tag:'http').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
         tags_of_instance = snode['Service']['Tags']

data/samples/consul_template_broken.txt.erb

@@ -0,0 +1,10 @@
+<%
+services.each do |service_name, tags|
+     if tags.include? 'marathon'
+       service(service_name, tag:'marathon').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
+         if (compute_state(snode)[0] == 'critical') && (snode['Service']['Tags'].include? 'marathon')
+%>wssh "<%= snode['Node']['Node'] %>" time curl -v -XPUT localhost:8500/v1/agent/service/deregister/<%= snode['Service']['ID'] %>
+<%       end
+       end
+     end
+   end %>

data/samples/criteo/haproxy.cfg.erb

@@ -4,7 +4,7 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated service regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 # Environment variables to configure HaProxy
 #   PORT0 : HaProxy main port (default to 8000)
 #   PORT1 : HaProxy admin port (default to 8001)
@@ -19,7 +19,8 @@
   optional_dns_suffix = ENV['DNS_SUFFIX'] || ''
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
 
   def compute_attributes(node)
     w = node.currrent_weight
@@ -38,7 +39,7 @@
   backends = {}
   all_kv = {}
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && tags.include?(instance_must_tag)
+    if !services_blacklist.any? {|r| r.match(service_name)} && tags.include?(instance_must_tag)
       the_backends = []
       kv_data = kv("#{kv_root}/#{service_name}/network-service").get_value_json
       all_kv[service_name] = kv_data if kv_data

data/samples/ha_proxy.cfg.erb

@@ -4,7 +4,7 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
-#   EXCLUDE_SERVICES: comma-separated services to exclude (default: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated services regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 # Environment variables to configure HaProxy
 #   PORT0 : HaProxy main port (default to 8000)
 #   PORT1 : HaProxy admin port (default to 8001)
@@ -17,7 +17,8 @@
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG'] || 'canary'
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
 
   def compute_attributes(snode)
     w = 100
@@ -35,7 +36,7 @@
   end
   backends = {}
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && tags.include?(instance_must_tag)
+    if !services_blacklist.any? {|r| r.match(service_name)} && tags.include?(instance_must_tag)
       the_backends = []
       service(service_name, tag:'http').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |node|
         tags_of_instance = node['Service']['Tags']

data/samples/metrics.erb

@@ -4,7 +4,7 @@
 #   SERVICES_TAG_FILTER: basic tag filter for service (default HTTP)
 #   INSTANCE_MUST_TAG: Second level of filtering (optional, default to SERVICES_TAG_FILTER)
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag
-#   EXCLUDE_SERVICES: comma-separated services to exclude (example: consul-agent-http,mesos-slave,mesos-agent-watcher)
+#   EXCLUDE_SERVICES: comma-separated services regexps to exclude (example: lbl7.*,netsvc-probe.*,consul-probed.*)
 <%
 
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
@@ -12,11 +12,13 @@
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG']
 
   # Services to hide
-  services_blacklist = (ENV['EXCLUDE_SERVICES'] || '').split(',')
+  services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+  services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
+
   backends = {}
   service_count = 0
   services(tag: service_tag_filter).each do |service_name, tags|
-    if !services_blacklist.include?(service_name) && (instance_must_tag.nil? || tags.include?(instance_must_tag))
+    if !services_blacklist.any? {|r| r.match(service_name)} && (instance_must_tag.nil? || tags.include?(instance_must_tag))
       service_count += 1
       res = {
         'passing'  => 0,

data/samples/nodes.html.erb

@@ -1,11 +1,12 @@
 <%= render_file('common/header.html.erb', title: 'Nodes') %><%
 service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
 # Services to hide
-services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
+services_blacklist_raw = (ENV['EXCLUDE_SERVICES'] || 'lbl7.*,netsvc-probe.*,consul-probed.*').split(',')
+services_blacklist = services_blacklist_raw.map { |v| Regexp.new(v) }
 
 service_per_node = {}
 services.each do |service_name, tags|
-  if !services_blacklist.include? service_name
+  if !services_blacklist.any? {|r| r.match(service_name)}
     service(service_name, tag: service_tag_filter).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
       node_services = service_per_node[snode['Node']['Node']] || []
       node_services.push(snode)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.9.8
+  version: 1.9.9
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -154,6 +154,8 @@ files:
 - ".ruby_app"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -199,6 +201,7 @@ files:
 - samples/consul_template.json.erb
 - samples/consul_template.txt.erb
 - 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
@@ -233,8 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Implementation of Consul template using Ruby and .erb templating language