Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

puppetboard

Install and configure PuppetBoard
Project URLRSS FeedReport issues

878,302 downloads

3,208 latest version

4.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 10.0.0 (latest)
  • 9.0.0
  • 8.2.0
  • 8.1.0
  • 8.0.0
  • 7.0.2
  • 7.0.1
  • 7.0.0
  • 6.1.0
  • 6.0.0
  • 5.0.0
  • 4.1.0
  • 4.0.0
  • 3.0.0
  • 2.9.0
  • 2.8.2
  • 2.8.1
  • 2.7.3
  • 2.7.1
  • 2.7.0
released Nov 27th 2023
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0
  • , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-puppetboard', '10.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-puppetboard
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-puppetboard --version 10.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: puppetdb, puppetboard, voxpupuli

Documentation

puppet/puppetboard — version 10.0.0 Nov 27th 2023

puppetboard

License Build Status Puppet Forge Puppet Forge downloads Puppet Forge - endorsement Puppet Forge score

Table of Contents

  1. Overview
  2. Setup
  3. Usage
  4. Number of Reports
  5. Offline Mode
  6. Set Default Environment
  7. Disable SELinux Management
  8. Apache
  9. RedHat/CentOS 7 with Python 3
  10. Using SSL to the PuppetDB host
  11. Development

Overview

Puppet module for installing and managing Puppetboard.

Puppetboard is a web interface to PuppetDB aiming to replace the reporting functionality of Puppet Enterprise console (previously: Puppet Dashboard) for the open source Puppet.

Setup

Installation

puppet module install puppet-puppetboard

Dependencies

Note that this module no longer explicitly requires the puppetlabs apache module. If you want to use the apache functionality of this module you will have to specify that the apache module is installed with:

puppet module install puppetlabs-apache

In most cases the module requires the virtualenv package. This can be enabled in the module with the manage_virtualenv flag set to true:

class { 'puppetboard':
  manage_virtualenv => true,
  secret_key        => fqdn_rand_string(32),
}

If the virtualenv is managed by this module, the voxpupuli/python will be used. That module uses voxpupuli/epel on RHEL based platforms.

Usage

Declare the base puppetboard manifest with the below required parameter(s), set to the values you want to use:

class { 'puppetboard':
  python_version => '3.8',
  secret_key     => fqdn_rand_string(32),
}

This will install the latest stable version of the app from a PyPI package in a virtualenv created using the requested Python version and keep it up to date. This example secret key is fine if you have a single-node deployment of the app. If you have a multi-node deployment, you should generate a secret key and use the same one on all nodes.

Number of Reports

NOTE: In order to have reports present in the dashboard, report storage must be enabled on the Puppet master node. This is not the default behavior, so it must be enabled.

See https://puppet.com/docs/puppetdb/latest/connect_puppet_server.html#enabling-report-storage for instructions on report storage.

By default, puppetboard displays only 10 reports. This number can be controlled to set the number of reports to show.

class { 'puppetboard':
  python_version => '3.8',
  secret_key     => fqdn_rand_string(32),
  reports_count  => 40,
}

Offline Mode

If you are running puppetboard in an environment which does not have network access to public CDNs, puppet board can load static assets (jquery, semantic-ui, tablesorter, etc) from the local web server instead of a CDN:

class { 'puppetboard':
  python_version => '3.8',
  secret_key     => fqdn_rand_string(32),
  offline_mode   => true,
}

Set Default Environment

By default, puppetboard defaults to "production" environment. This can be set to default to a different environment.

class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  default_environment => 'customers',
}

or to default to "All environments":

class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  default_environment => '*',
}

Disable SELinux Management

class { 'puppetboard':
  python_version => '3.8',
  secret_key     => fqdn_rand_string(32),
  manage_selinux => false,
}

If manage_selinux is true, manage policies related to SELinux. If false, do nothing. By default, this module will try to determine if SELinux is enabled, and manage the policies if it is.

Apache

If you want puppetboard accessible through Apache and you're able to use the official puppetlabs/apache Puppet module, this module contains two classes to help configuration.

The first, puppetboard::apache::vhost, will use the apache::vhost defined-type to create a full virtual host. This is useful if you want puppetboard to be available under an address like http://pboard.example.com:

(The following is generic code used in our tests, it works on Debian 9 and 10, also on Ubuntu 16.04 and 18.04. It will talk to PuppetDB on localhost via http)

# Configure Apache on this server
class { 'apache':
  default_vhost => false,
}

# Configure Puppetboard
class { 'puppetboard':
  python_version    => '3.8',
  secret_key        => fqdn_rand_string(32),
  manage_virtualenv => true,
}

# Access Puppetboard through pboard.example.com
class { 'puppetboard::apache::vhost':
  vhost_name => 'pboard.example.com',
  port       => 80,
}

The second, puppetboard::apache::conf, will create an entry in /etc/apache2/conf.d (or /etc/httpd/conf.d, depending on your distribution). This is useful if you simply want puppetboard accessible from http://example.com/puppetboard:

# Configure Puppetboard
class { 'puppetboard':
  python_version => '3.8',
  secret_key     => fqdn_rand_string(32),
}

# Access Puppetboard from example.com/puppetboard
class { 'puppetboard::apache::conf': }

Apache (with Reverse Proxy)

You can also relocate puppetboard to a sub-URI of a Virtual Host. This is useful if you want to reverse-proxy puppetboard, but are not planning on dedicating a domain just for puppetboard:

class { 'puppetboard::apache::vhost':
  vhost_name => 'dashes.acme',
  wsgi_alias => '/pboard',
}

In this case puppetboard will be available (on the default) on http://dashes.acme:5000/pboard. You can then reverse-proxy to it like so:

Redirect /pboard /pboard/
ProxyPass /pboard/ http://dashes.acme:5000/pboard/
ProxyPassReverse /pboard/ http://dashes.acme:5000/pboard/

Using the puppetlabs/apache module:

apache::vhost { 'example.acme':
  port            => '80',
  docroot         => '/var/www/html',
  redirect_source => [ '/pboard' ],
  redirect_dest   => [ '/pboard/' ],
  proxy_pass      => [
    {
      'path' => '/pboard/',
      'url'  => 'http://dashes.acme:5000/pboard/',
    },
  ],
}

RedHat/CentOS 7 with Python 3

CentOS/RedHat 7 is pretty old. Python 3 got added after the initial release and a lot of packages are missing. For example python3.6 is available as a package, but no matching wsgi module for apache is available. Because of that, we don't test on CentOS 7 anymore. However, it's still possible to setup Puppetboard on CentOS with gunicorn as a webserver and nginx/apache forwarding to it.

Using SSL to the PuppetDB host

If you would like to use certificate auth into the PuppetDB service you must configure puppetboard to use a client certificate and private key.

You have two options for the source of the client certificate & key:

  1. Generate a new certificate, signed by the puppetmaster CA
  2. Use the existing puppet client certificate

If you choose option 1, generate the new certificates on the CA puppet master as follows:

sudo puppet cert generate puppetboard.example.com

Note: this name cannot conflict with an existing certificate name.

The new certificate and private key can be found in $certdir/.pem and $privatekeydir/.pem on the CA puppet master. If you are not running puppetboard on the CA puppet master you will need to copy the certificate and key to the node running puppetboard.

Here's an example, using new certificates:

$ssl_dir = '/var/lib/puppetboard/ssl'
$puppetboard_certname = 'puppetboard.example.com'
class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  manage_virtualenv   => true,
  puppetdb_host       => 'puppetdb.example.com',
  puppetdb_port       => 8081,
  puppetdb_key        => "${ssl_dir}/private_keys/${puppetboard_certname}.pem",
  puppetdb_ssl_verify => "${ssl_dir}/certs/ca.pem",
  puppetdb_cert       => "${ssl_dir}/certs/${puppetboard_certname}.pem",
}

If you are re-using the existing puppet client certificates, they will already exist on the node (assuming puppet has been run and the client cert signed by the puppet master). However, the puppetboaard user will not have permission to read the private key unless you add it to the puppet group.

Here's a complete example, re-using the puppet client certs:

$ssl_dir = $::settings::ssldir
$puppetboard_certname = $::certname
class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  manage_virtualenv   => true,
  groups              => 'puppet',
  puppetdb_host       => 'puppetdb.example.com',
  puppetdb_port       => 8081,
  puppetdb_key        => "${ssl_dir}/private_keys/${puppetboard_certname}.pem",
  puppetdb_ssl_verify => "${ssl_dir}/certs/ca.pem",
  puppetdb_cert       => "${ssl_dir}/certs/${puppetboard_certname}.pem",
}

Note that both the above approaches only work if you have the Puppet CA root certificate added to the root certificate authority file used by your operating system. If you want to specify the location to the Puppet CA file ( you probably do) you have to use the syntax below. Currently this is a bit of a gross hack, but it's an open issue to resolve it in the Puppet module:

$ssl_dir = $::settings::ssldir
$puppetboard_certname = $::certname
class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  manage_virtualenv   => true,
  groups              => 'puppet',
  puppetdb_host       => 'puppetdb.example.com',
  puppetdb_port       => 8081,
  puppetdb_key        => "${ssl_dir}/private_keys/${puppetboard_certname}.pem",
  puppetdb_ssl_verify => "${ssl_dir}/certs/ca.pem",
  puppetdb_cert       => "${ssl_dir}/certs/${puppetboard_certname}.pem",
}

Using SSL to PuppetDB >= 6.9.1

As of PuppetDB 6.9.1 the /metrics/v2 API is only accessible on the loopback/localhost interface of the PuppetDB server. This requires you to run puppetboard locally on that host and configure puppetdb_host to 127.0.0.1:


$ssl_dir = $::settings::ssldir
$puppetboard_certname = $::certname
class { 'puppetboard':
  python_version      => '3.8',
  secret_key          => fqdn_rand_string(32),
  manage_virtualenv   => true,
  groups              => 'puppet',
  puppetdb_host       => '127.0.0.1',
  puppetdb_port       => 8081,
  puppetdb_key        => "${ssl_dir}/private_keys/${puppetboard_certname}.pem",
  puppetdb_ssl_verify => "${ssl_dir}/certs/ca.pem",
  puppetdb_cert       => "${ssl_dir}/certs/${puppetboard_certname}.pem",
}

NOTE In order for SSL to verify properly in this setup, you'll need your Puppet SSL certificate to have an IP Subject Alternative Name setup for 127.0.0.1, otherwise the certificate verification will fail. You can set this up in your puppet.conf with the dns_alt_names configuration option, documented here.

[main]
dns_alt_names = puppetdb,puppetdb.domain.tld,puppetboard,puppetboard.domain.tld,IP:127.0.0.1

NOTE If you need to regenerate your existing cert to add DNS Alt Names follow the documentation here:

# remove the existing agent certs
puppetserver ca clean --certname <CERTNAME_OF_YOUR_PUPPETDB>
puppet ssl clean

# stop our services
puppet resource service puppetserver ensure=stopped
puppet resource service puppetdb ensure=stopped

# regenerate our cert
puppetserver ca generate --certname <CERTNAME> --subject-alt-names puppetdb,puppetdb.domain.tld,puppetboard,puppetboard.domain.tld,IP:127.0.0.1 --ca-client
# copy the cert into the PuppetDB directory
cp /etc/puppetlabs/puppet/ssl/certs/<CERTNAME>.pem /etc/puppetlabs/puppetdb/ssl/public.pem
cp /etc/puppetlabs/puppet/ssl/private_keys/<CERTNAME>.pem /etc/puppetlabs/puppetdb/ssl/private.pem

# restart our services
puppet resource service puppetdb ensure=running
puppet resource service puppetserver ensure=running

Development

This module is maintained by Vox Pupuli. Vox Pupuli welcomes new contributions to this module, especially those that include documentation and rspec tests. We are happy to provide guidance if necessary.

Please see CONTRIBUTING for more details.

Please log tickets and issues on github.

Authors

  • Spencer Krum krum.spencer@gmail.com
  • Vox Pupuli Team
  • The core of this module was based on Hunter Haugen's puppetboard-vagrant repo.