Puppet module for installing Uchiwa
Ruby Puppet HTML
Latest commit 8095b7c Dec 20, 2016 @solarkennedy solarkennedy committed on GitHub Merge pull request #78 from br0ch0n/support_usersoptions
Support the new UsersOptions hash



Tested with Travis CI

Build Status

Upgrade Note

Versions greater than 0.3.0 are incompatible with previous versions of the Yelp-Uchiwa module.


$ puppet module install yelp-uchiwa


  • One or more working Sensu installations


  • puppetlabs/apt
  • puppetlabs/stdlib

See Modulefile for details.


Simple Setup

By default the puppet module will connect to a single Sensu API endpoint on localhost:

node 'uchiwa-server.foo.com' {
  include ::uchiwa

API definitions will default to the following values:

name     => 'sensu'
host     => ''
ssl      => false
insecure => false
port     => 4567
user     => 'sensu'
pass     => 'sensu'
path     => ''
timeout  => 5

Simple Server Without the Repo

The module itself sets up the Sensu repo in order to download Uchiwa. Often this is also done by the Sensu puppet module too. To get around this duplication you can ask the Uchiwa module not to manage the repo:

class { '::uchiwa':
  install_repo => false,

Advanced Example Using Multiple APIs

This is an example of how to setup Uchiwa connecting to two different API endpoints. In this example there is one endpoint using mostly default parameters, and then a second endpoint using all the possible options:

node 'uchiwa-server.foo.com' {

  $uchiwa_api_config = [
      host  => '',
      host      => '',
      ssl       => true,
      insecure  => true,
      port      => 7654,
      user      => 'sensu',
      pass      => 'saBEnX8PQoyz2LG',
      path      => '/sensu',
      timeout   => 5
  class { 'uchiwa':
    sensu_api_endpoints => $uchiwa_api_config,


This is an example on how to use Uchiwa with HTTPS:


class { 'uchiwa':
  ssl = {
    'certfile' => '/path/to/certfile',
    'keyfile' => '/path/to/keyfile',

Simple YAML:

uchiwa::ssl: { 'certfile': '/opt/ssl/public.crt', 'keyfile': '/opt/ssl/private.key' }

Litle more advanced:

uchiwa::ssl: { 'certfile': '/opt/ssl/%{::hostname}.crt', 'keyfile': '/opt/ssl/%{::hostname}.key' }

Users Options

Example of declaring the UsersOptions hash as defined in https://docs.uchiwa.io/getting-started/configuration/#users-options:

Via hiera:

  disableNoExpiration: true
  requireSilencingReason: true
  defaultExpireOnResolve: true


See LICENSE file.