docker_boss 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a3b4b55a8a45eb94a4f4273cc1d7aa7aba31ac8
-  data.tar.gz: 642f6c1f450af4c0af50ffd5250ef1add388f5fe
+  metadata.gz: 989d68fca738c872db812e961eb3689e989aa25a
+  data.tar.gz: 965fa76de0e26be5dbf48058c2245823e6fbcf9c
 SHA512:
-  metadata.gz: 06e1efa8c82701c1f60a2108c481476866f949743ab8afd4a58030465b6bab57b99fd8feea5c2d306e92d8bcde5d0dbf71c7d3303c8bc47ae96be9d1c7d700be
-  data.tar.gz: 7cc522cecde379acd03a4b9f04bfec8551c263b4633ee346660bfbb05daa65aad102739dafef46979cb22a84cd9f375490791776645d3dee9f51c4c196e64f79
+  metadata.gz: 20942bbc9402ddffa2e9fccff0e8654092a09d38dc16b78148192366ce82adbd4102c6e18b78b5e29b05d982cd56fa99bbcb35af1001178763dd1c415fcd9c02
+  data.tar.gz: 15644b7957449c2f917d23cd5b89f155c53c2f844f1e41d796bd23c304280cd58c6a322eb44b54b9f68a0a798fdf1d94031534d5d3391e2e4dbe220fbb2e5aa3

data/README.md

@@ -10,6 +10,9 @@ DockerBoss has been built from the start to be completely pluggable. By default,
 
  - dns: The dns module has a very simple built-in DNS server. The DNS server's records get updated based on the container's addresses, names, environment variables, etc. The DNS server will pass through requests for zones that it is not the authoritative server for.
 
+The pluggable design of DockerBoss, alongside the flexibility offered by the default modules, makes it possible to adapt DockerBoss to a large number of different use cases and scenarios, without being tied down to one particular convention as others do.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -247,9 +250,9 @@ A very simple example template file could look as follows:
 
 The etcd module adds/updates/removes keys in etcd based on changes to the containers. This can be used to provide dynamic settings based on the containers to other tools interfacing with etcd, such as SkyDNS and confd.
 
-The `server` setting defines the host and port of the etcd server. SSL and basic HTTP auth are not yet supported.
+The `server` setting defines the host and port of the etcd server. SSL and basic HTTP auth are not yet supported. The `host` field is rendered as an ERB template, and has access to two helper functions, `interface_ipv4(some_intf)` and `interface_ipv6(some_intf)` which get the IPv4 or IPv6 address of a particular host interface.
 
-The `setup` setting is a template, each line of which can manipulate keys in etcd. These key manipulations are run once when the module/DockerBoss starts, and can be used to ensure a clean slate, free of any old keys from a previous run. Each line must follow one of the following formats:
+The `setup` setting is a template, each line of which can manipulate keys in etcd. These key manipulations are run once when the module/DockerBoss starts, and can be used to ensure a clean slate, free of any old keys from a previous run. The `setup` template can use the `interface_ipv4` and `interface_ipv6` helpers. Each line must follow one of the following formats:
 
  - `ensure <key> <value>` - sets a given key in etcd to the given value.
  - `absent <key>` - removes a given key in etcd.
@@ -259,19 +262,20 @@ The `sets` setting supports any number of children, each of which is an ERB temp
 
  - `ensure <key> <value>` - ensure a key exists in etcd with the given value.
 
-The etcd will keep track of keys set during previous state updates, and if a key is no longer present, it will be removed from etcd.
+The etcd module will keep track of keys set during previous state updates, and if a key is no longer present, it will be removed from etcd.
 
 Example configuration:
 
 ```yaml
 etcd:
   server:
-    host: '127.0.0.1'
+    host: <%= interface_ipv4('docker0') %>
     port: 4001
 
   setup: |
     absent_recursive /skydns/docker
     absent_recursive /vhosts
+    ensure /skydns/docker/dockerhost/etcd <%= as_json(host: interface_ipv4('docker0'), port: '4001') %>
 
   sets:
     skydns: |
@@ -299,12 +303,14 @@ The DNS module starts a built-in DNS server based on `rubydns`. The DNS server c
 
 The `ttl` setting determines the `ttl` for each response, both positive and NXDOMAIN.
 
-The `listen` setting is an array of addresses/ports on which the DNS server should listen.
+The `listen` setting is an array of addresses/ports on which the DNS server should listen. As with the `server.host` key for the etcd module, the `host` key is a template with access to the `interface_ipv4` and `interface_ipv6` helpers.
 
 The `upstream` setting is an array of upstream DNS servers to which requests should be forwarded to if no record is available locally and the name is not within one of the local zones.
 
 The `zones` setting is an array of zones for which the DNS server is authoritative. The DNS server will not forward requests in these zones to upstream DNS servers, not even if no local record is found.
 
+The `setup` setting is a template, each line of which adds a new DNS record at setup time, independently of any containers. These records are added when the module/DockerBoss starts. Each line must follow the format of `some_host_name some_ip_address`. The `setup` template can use the `interface_ipv4` and `interface_ipv6` helpers.
+
 The `spec` setting is an ERB template which should render out all hostnames for a given container, each on a separate line. A container can have any number of host records, even none at all (by simply not rendering out any hostname).
 
 Example configuration:
@@ -313,7 +319,9 @@ Example configuration:
 dns:
   ttl: 5
   listen:
-    - host: 0.0.0.0
+    - host: <%= interface_ipv4('docker0') %>
+      port: 5300
+    - host: 127.0.0.1
       port: 5300
 
   upstream:
@@ -324,6 +332,9 @@ dns:
     - .local
     - .docker
 
+  setup: |
+    etcd.dockerhost.docker <%= interface_ipv4('docker0') %>
+
   spec: |
     <%= container['Config']['Env'].fetch('SERVICE_NAME', container['Name'][1..-1]) %>.docker
     <%= container['Config']['Hostname'] %>.docker
@@ -359,7 +370,7 @@ class DockerBoss::Module::Foo < DockerBoss::Module
   def trigger(containers, trigger_id)
     DockerBoss.logger.debug "foo: State change triggered by container_id=#{trigger_id}"
     containers.each do |c|
-      DockerBoss.logger.debug "foo: container: #{c['Id]}"
+      DockerBoss.logger.debug "foo: container: #{c['Id']}"
     end
   end
 end

data/example.cfg.yml

@@ -1,7 +1,7 @@
 dns:
   ttl: 5
   listen:
-    - host: 0.0.0.0
+    - host: <%= interface_ipv4('docker0') %>
       port: 5300
 
   upstream:
@@ -12,17 +12,21 @@ dns:
     - .local
     - .docker
 
+  setup: |
+    etcd.dockerhost.docker <%= interface_ipv4('docker0') %>
+
   spec: |
     <%= container['Config']['Env'].fetch('SERVICE_NAME', container['Name'][1..-1]) %>.docker
     <%= container['Config']['Hostname'] %>.docker
 
 etcd:
   server:
-    host: '127.0.0.1'
+    host: <%= interface_ipv4('docker0') %>
     port: 4001
 
   setup: |
     absent_recursive /skydns/docker
+    ensure /skydns/docker/dockerhost/etcd <%= as_json(host: interface_ipv4('docker0'), port: '4001') %>
 
   sets:
     skydns: |

data/lib/docker_boss/helpers.rb

@@ -7,6 +7,7 @@ module DockerBoss::Helpers
   def self.render_erb(template_str, data)
     tmpl = ERB.new(template_str)
     ns = OpenStruct.new(data)
+    ns.extend(TemplateHelpers)
     tmpl.result(ns.instance_eval { binding })
   end
 
@@ -41,5 +42,17 @@ module DockerBoss::Helpers
     def as_json(hash)
       hash.to_json
     end
+
+    def interface_ipv4(iface)
+      ipv4 = `ip addr show docker0 | grep -Po 'inet \\K[\\d.]+'`
+      raise ArgumentError, "Could not retrieve IPv4 address for interface `#{iface}`" unless $? == 0
+      ipv4.chomp
+    end
+
+    def interface_ipv6(iface)
+      ipv6 = `ip addr show docker0 | grep -Po 'inet6 \\K[\\da-f:]+'`
+      raise ArgumentError, "Could not retrieve IPv6 address for interface `#{iface}`" unless $? == 0
+      ipv6.chomp
+    end
   end
 end

data/lib/docker_boss/modules/dns.rb

@@ -9,26 +9,39 @@ class DockerBoss::Module::DNS < DockerBoss::Module
 
   def initialize(config)
     @records = {}
+    @setup_records = {}
     @config = config
     DockerBoss.logger.debug "dns: Set up"
+    setup
+  end
+
+  def setup
+    setup = DockerBoss::Helpers.render_erb(@config.fetch('setup', ''), {})
+    setup.lines.each do |line|
+      (name, ip) = line.lstrip.chomp.split(" ", 2)
+      @setup_records[name] = ip
+    end
   end
 
   def run
     listen = []
-    @config['listen'].each do |l|
-      listen << [:udp, l['host'], l['port'].to_i]
-      listen << [:tcp, l['host'], l['port'].to_i]
-    end
 
     DockerBoss.logger.debug "dns: Starting DNS server"
 
+    @config['listen'].each do |l|
+      host = DockerBoss::Helpers.render_erb(l['host'], {})
+      listen << [:udp, host, l['port'].to_i]
+      listen << [:tcp, host, l['port'].to_i]
+      DockerBoss.logger.debug "dns: Listening on #{host} (port: #{l['port']})"
+    end
+
     Thread.new do
       RubyDNS::run_server(:listen => listen, :ttl => @config['ttl'], :upstream_dns => @config['upstream'], :zones => @config['zones'], :supervisor_class => Server, :manager => self)
     end
   end
 
   def trigger(containers, trigger_id)
-    records = {}
+    records = @setup_records.clone
     containers.each do |c|
       names = DockerBoss::Helpers.render_erb(@config['spec'], :container => c)
       names.lines.each do |n|

data/lib/docker_boss/modules/etcd.rb

@@ -10,14 +10,16 @@ require 'etcd'
 class DockerBoss::Module::Etcd < DockerBoss::Module
   def initialize(config)
     @config = config
-    DockerBoss.logger.debug "etcd: Set up to connect to #{@config['server']['host']}, port #{@config['server']['port']}"
-    @client = ::Etcd.client(host: @config['server']['host'], port: @config['server']['port'])
+    @host = DockerBoss::Helpers.render_erb(@config['server']['host'], {})
+    DockerBoss.logger.debug "etcd: Set up to connect to #{@host}, port #{@config['server']['port']}"
+    @client = ::Etcd.client(host: @host, port: @config['server']['port'])
     @previous_keys = {}
     setup
   end
 
   def setup
-    @config.fetch('setup', '').lines.each do |line|
+    setup = DockerBoss::Helpers.render_erb(@config.fetch('setup', ''), {})
+    setup.lines.each do |line|
       (kw, k, v) = line.lstrip.chomp.split(" ", 3)
       case kw
       when 'absent'

data/lib/docker_boss/version.rb

@@ -1,3 +1,3 @@
 module DockerBoss
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker_boss
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex Hornung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api