Forge Home


Install and configure puppetserver 5.x


5,314 latest version

5.0 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

  • 1.0.3 (latest)
  • 1.0.2
  • 1.0.1
released Jul 6th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'vinzent-puppetserver5', '1.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add vinzent-puppetserver5
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install vinzent-puppetserver5 --version 1.0.3

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.



vinzent/puppetserver5 — version 1.0.3 Jul 6th 2018


Install & configure puppetserver 5.

This module really only manages what puppetserver package provides. All other things should be done at the profile level (if using the roles/profiles pattern).


Setup Requirements

What this module doesn't do and you need to ensure yourself before including it:

  • It doesn't configure the puppet package repository
  • It doesn't manage puppet.conf settings

Beginning with puppetserver5

Most of the params are optional. If you don't pass a value, then the module won't try to manage the setting at all.

If you pass the string 'ABSENT' to settings params then the setting will be removed.

Simple example:

include puppetserver5

Complex example:

class { 'puppetserver5':
  init_java_args     => '-Xmx8g -Xms8g -XX:+UseG1GC -XX:ReservedCodeCacheSize=512m -Djruby.logger.class=com.puppetlabs.jruby_utils.jruby.Slf4jLogger',
  init_jruby_jar                         => '/opt/puppetlabs/server/apps/puppetserver/jruby-9k.jar',
  service_ca_disable                     => true,
  auth_allow_header_cert_info            => true,
  jruby_puppet_max_active_instances      => 6,
  jruby_puppet_max_requests_per_instance => 10000,
  webserver_host                         => '',
  webserver_port                         => 18140,
  webserver_ssl_host                     => 'ABSENT',
  webserver_ssl_port                     => 'ABSENT',
  product_check_for_updates              => false,

If you wan't to manage auth.conf rules with puppetlabs/puppet_authorization you'll need to ensure it only gets manage after the package is installed and that it sends a notify to the service reload class.


-> puppet_authorization { 'xyz': ... }

~> Class['puppetserver5::service::reload']

See for the puppet strings generated documentation.