tylerwalts / puppet-consul

A Puppet Module to Manage Consul

#puppet-consul

##Installation

###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,
  }

Join a cluster

To have the host automatically join a cluster after the service starts, pass in a URL or IP that you can safely assume will exist and be running consul.

class { 'consul':
  join_cluster => ‘my_leader.example.com’,
}

If you are bootstrapping a new cluster, it helps to also add a bootstrap_expect value to the config hash so that servers can elect a leader once quota is met.

class { 'consul':
  join_cluster => ‘my_neighbor.example.com’,
  config_hash => {
      ...
      'server'           => true,
      'bootstrap_expect' => 3
  }
}

##Limitations

Depends on the JSON gem, or a modern ruby.

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