Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

A Puppet module to manage the config and jobs of Consul Template from Hashicorp

License

Notifications You must be signed in to change notification settings

nytm/puppet-consul_template

This branch is 122 commits behind claranet/puppet-consul_template:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4cddf41 · May 23, 2016
Jan 23, 2015
Jan 30, 2015
May 20, 2016
Oct 22, 2015
Jan 20, 2016
Jan 30, 2015
Feb 25, 2015
Jan 30, 2015
Jan 30, 2015
May 11, 2016
Jan 30, 2015
Jul 3, 2015
Jan 30, 2015
Jan 30, 2015
Jan 30, 2015
Jan 23, 2015
May 11, 2016
Jan 30, 2015
May 11, 2016

Repository files navigation

#consul_template for Puppet

##Installation

###What This Module Affects

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

##Parameters

  • purge_config_dir Default: true. If enabled, removes config files no longer managed by Puppet.
  • config_mode Default: 0660. Mode set on config files and directories.
  • bin_dir Default: /usr/local/bin. Path to the consul-template binaries
  • arch Default: Read from facter. System architecture to use (amd64, x86_64, i386)
  • version Default: 0.11.0. Version of consul-template to install
  • install_method Default: url. When set to 'url', consul-template is downloaded and installed from source. If set to 'package', its installed using the system package manager.
  • os Default: Read from facter.
  • download_url Default: undef. URL to download consul-template from (when install_method is set to 'url')
  • download_url_base Default: https://github.com/hashicorp/consul-template/releases/download/ Base URL to download consul-template from (when install_method is set to 'url')
  • download_extension Default: zip. File extension of consul-template binary to be downloaded (when install_method is set to 'url')
  • package_name Default: consul-template. Name of package to install
  • package_ensure Default: latest.
  • config_dir Default: /etc/consul-template. Path to store the consul-template configuration
  • extra_options Default: ''. Extra options to be bassed to the consul-template agent. See https://github.com/hashicorp/consul-template#options
  • service_enable Default: true.
  • service_ensure Default: running.
  • user Default: root. This used to be a default of consul-template and this caused much out-of-box pain for people.
  • group Default: root.
  • manage_user Default: false. Module handles creating the user.
  • manage_group Default: false. Module handles creating the group.
  • consul_host Default: localhost. Hostanme of consul agent to query
  • consul_port Default: 8500. Port number the API is running on
  • consul_token Default: ''. ACL token to use when querying consul
  • consul_retry Default: 10s. Time in seconds to wait before retrying consul requests
  • consul_wait Default: undef. Min:Max time to wait before consul-template renders a new template to disk and triggers refresh. Specified in the format min:max according to Go time duration format
  • consul_max_stale Default: undef. The maximum staleness of a query. If specified, Consul will distribute work among all servers instead of just the leader.
  • init_style Init style to use for consul-template service.
  • log_level Default: info. Logging level to use for consul-template service. Can be 'debug', 'warn', 'err', 'info'

##Usage

The simplest way to use this module is:

include consul_template

Or to specify parameters:

class { 'consul_template':
    service_enable   => false
    log_level        => 'debug',
    init_style       => 'upstart',
    consul_wait      => '5s:30s',
    consul_max_stale => '1s'
}

Watch files

To declare a file that you wish to populate from Consul key-values, you use the watch define. This requires a source .ctmpl file and the file on-disk that you want to update.

consul_template::watch { 'common':
    template      => 'data/common.json.ctmpl.erb',
    template_vars => {
        'var1' => 'foo',
        'var2' => 'bar',
    },
    destination   => '/tmp/common.json',
    command       => 'true',
}

##Limitations

Depends on the JSON gem, or a modern ruby.

##Development See the contributing guide

Open an issue or fork and open a Pull Request

About

A Puppet module to manage the config and jobs of Consul Template from Hashicorp

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Puppet 42.0%
  • Ruby 35.1%
  • Shell 19.5%
  • HTML 3.4%