Methods for configuring PE
Sections
After you've installed Puppet Enterprise (PE), optimize it for
your environment by configuring and tuning settings as needed. For example, you might want
to add your certificate to the allowlist, increase the max-threads setting for
http
and https
requests, or configure the number of
JRuby instances.
PE shares configuration settings used in open source Puppet and documented in the Configuration Reference, however PE defaults
for certain settings might differ from the Puppet
defaults. Some examples of settings that have different PE defaults include disable18n
, environment_timeout
, always_retry_plugins
,
and the Puppet Server
JRuby
max-active-instances
setting. To verify PE configuration defaults, check the puppet.conf
file after installation.
There are three main methods for configuring PE: using the
console, adding a key to Hiera, or editing
pe.conf
. Be consistent with the method you choose, unless the
situation calls for you to use a specific method over the others.
Configure settings using the console
The console allows you to use a graphical interface to configure Puppet Enterprise (PE).
Changes in the console override your Hiera
data and data in pe.conf
. It is usually best to use the console
when you want to:
- Change parameters in profile classes starting with
puppet_enterprise::profile
. - Add any parameters in PE-managed configuration files.
- Set parameters that configure at runtime.
There are two ways to change settings in the console: setting configuration data and editing parameters.
Set configuration data
Configuration data set in the console is used for automatic parameter lookup, the same way that Hiera data is used. Console configuration data takes precedence over Hiera data, but you can combine data from both sources to configure nodes.
- You want to override Hiera data. Data set in the console overrides Hiera data when configured as recommended.
- You want to give someone access to set or change data and they don’t have the skill set to do it in Hiera.
-
You simply prefer the console user interface.
Set parameters
Parameters are declared resource-style, which means they can be used to override other data; however, this override capability can introduce class conflicts and declaration errors that cause Puppet runs to fail.
Configure settings with Hiera
Hiera is a hierarchy-based method of configuration management that relies on a “defaults, with overrides” system. When you add a parameter or setting to your Hiera data, Hiera searches through the data in the order it was written to find the value you want to change. Once found, it overrides the default value with the new parameter or setting. You can use Hiera to manage your PE configuration settings.
pe.conf
, but not those set in the console. It's
best to use Hiera when you want to:- Change parameters in non-profile classes.
- Set parameters that are static and version controlled.
- Configure for high availability.
To configure a setting using Hiera:
Configure settings in pe.conf
Puppet Enterprise (PE)
configuration data includes any data set in
/etc/puppetlabs/enterprise/conf.d/
but
pe.conf
is the file used for most
configuration activities during
installation.
pe.conf
. Configure
settings using pe.conf
when you want to:
- Access settings during installation.
- Configure for high availability.
To configure settings using
pe.conf
: