#puppet-consul

##Installation

##Compatibility

Any module release that is tagged with 0.4.* is compatible with the 0.4.x versions of consul. Anything tagged with 0.5.* is compatible with consul 0.5.x, etc.

So, if you are using consul 0.4.1, try to use the lastes tagged release on the 4 series. Do not pull from master.

###What This Module Affects

• Installs the consul daemon (via url or package)
• Optionally installs a user to run it under
• Installs a configuration file (/etc/consul/config.json)
• Manages the consul service via upstart, sysv, or systemd
• Optionally installs the Web UI

##Usage

class { 'consul':
  config_hash => {
      'datacenter' => 'east-aws',
      'data_dir'   => '/opt/consul',
      'log_level'  => 'INFO',
      'node_name'  => 'foobar',
      'server'     => true
  }
}

##Web UI

To install and run the Web UI, include ui_dir in the config_hash. You may also want to change the client_addr to 0.0.0.0 from the default 127.0.0.1, for example:

class { 'consul':
  config_hash => {
      'datacenter'  => 'east-aws',
      'data_dir'    => '/opt/consul',
      'ui_dir'      => '/opt/consul/ui',
      'client_addr' => '0.0.0.0',
      'log_level'   => 'INFO',
      'node_name'   => 'foobar',
      'server'      => true
  }
}

For more security options, consider leaving the client_addr set to 127.0.0.1 and use with a reverse proxy:

  $aliases = ['consul', 'consul.example.com']

  # Reverse proxy for Web interface
  include 'nginx'

  $server_names = [$::fqdn, $aliases]

  nginx::resource::vhost { $::fqdn:
    proxy       => 'http://localhost:8500',
    server_name => $server_names,
  }

Service Definition

To declare the availability of a service, you can use the service define. This will register the service through the local consul client agent and optionally configure a health check to monitor its availability.

consul::service { 'redis':
  tags           => ['master'],
  port           => 8000,
  check_script   => '/usr/local/bin/check_redis.py',
  check_interval => '10s',
}

Hiera usage example

# default agent config ('common.yaml')
consul::config_dir: '/etc/consul'
consul::install_method: 'package'
consul::config_hash:
  datacenter: 'datacentername'
  data_dir: '/var/lib/consul'
  retry_join: 
    - '10.0.0.1'
    - '10.0.0.2'
    - '10.0.0.3'

# master config override ('consul-master.yaml')
consul::config_hash:
  log_level: 'INFO'
  server: true
  bootstrap_expect: 3
  ui_dir: '/usr/share/consul/web-ui'
  client_addr: '0.0.0.0'

# service definitions ('some-service.yaml')
# Alternative 1
consul::service:
  'some-service':
    tags: [ 'tag-1' , 'tag-a' ]
    port: 9999
      
# Alternative 2
consul::config_hash:
  services:
    'servicename':
      tags: [ 'some' , 'tags' ]
      port: 2181

##Limitations

Depends on the JSON gem, or a modern ruby.

##Development Open an issue or fork and open a Pull Request