Puppet Enterprise installs several software components, configuration files, databases, services and users, and log files. It's useful to know the locations of these should you ever need to troubleshoot or manage your infrastructure.
Software components installed
PE installs several software components and dependencies. These tables show which version of each component is installed for releases dating back to the previous long term supported (LTS) release.
|PE Version||Puppet Agent||Puppet||Facter||Hiera||Resource API||MCollective||Ruby||OpenSSL|
|PE Version||Puppet Server||PuppetDB||r10k||Razor Server||Bolt Services||Agentless Catalog Executor (ACE) Services||PostgreSQL||Java||ActiveMQ||Nginx|
Executable binaries and symlinks installed
PE installs executable binaries and symlinks for interacting with tools and services.
On *nix nodes, all software is installed under
On Windows nodes, all
software is installed in
$PATH, manually add them to your profile or export the path:
To make essential Puppet tools available to all users, the installer
automatically creates symlinks in
/usr/local/bin for the
hiera binaries. Symlinks are created only if
/usr/local/bin is writeable. Users of AIX and Solaris versions 10 and 11 must add
/usr/local/bin to their default path.
For macOS agents, symlinks aren't created until the first successful run that applies the agents' catalogs.
manage_symlinkssetting in your default Hiera file:
Binaries provided by other software components, such as those for interacting with the PostgreSQL server, PuppetDB, or Ruby packages, do not have symlinks created.
Modules and plugins installed
PE installs modules and plugins for normal operations.
Modules included with the software
are installed on the master in
/opt/puppetlabs/puppet/modules. Don't modify anything in this
directory or add modules of your own. Instead, install non-default modules in
Configuration files installed
PE installs configuration files that you might need to interact with from time to time.
On *nix nodes, configuration files live at
On Windows nodes,
configuration files live at
<COMMON_APPDATA>\PuppetLabs. The location of this folder varies
by Windows version; in 2008 and
2012, its default location is
confdir is in the
puppet subdirectory. This
directory contains the
auth.conf, and the SSL
PE installs several suites of tools to help you work with the major components of the software.
- Puppet tools — Tools that control basic
functions of the software such as
- Client tools — The
pe-client-tools package collects a set of CLI tools that extend the ability for you
to access services from the master or a workstation. This package includes:
- Orchestrator — The
orchestrator is a set of interactive command line tools that provide the
interface to the orchestration service. Orchestrator also enables you to
enforce change on the environment level. Tools include
- Puppet Access — Users can generate tokens to authenticate their access to certain command line tools and API endpoints.
- Code Manager CLI — The
puppet-codecommand allows you to trigger Code Manager from the command line to deploy your environments.
- PuppetDB CLI — This a tool for working with PuppetDB, including building queries and handling exports.
- Orchestrator — The orchestrator is a set of interactive command line tools that provide the interface to the orchestration service. Orchestrator also enables you to enforce change on the environment level. Tools include
- Module tool — The module tool is used to access and create modules, which are reusable chunks of Puppet code users have written to automate configuration and deployment tasks. For more information, and to access modules, visit the Forge.
- Console — The console is the web user interface for PE. The console provides tools to view and edit resources on your nodes, view reports and activity graphs, and more.
PE installs several default databases, all of which use PostgreSQL as a database backend.
The PE PostgreSQL database includes these following databases.
|pe-activity||Activity data from the classifier, including who, what, and when.|
|pe-classifier||Classification data, all node group information.|
|pe-puppetdb||PuppetDB data, including exported resources, catalogs, facts, and reports.|
|pe-rbac||RBAC data, including users, permissions, and AD/LDAP info.|
|pe-orchestrator||Orchestrator data, including details about job runs.|
Use the native PostgreSQL tools to perform database exports and imports. At a minimum, you should perform backups to a remote system nightly, or as dictated by your company policy.
PE installs several services used to interact with the software during normal operations.
|pe-console-services||Manages and serves the console.|
|pe-puppetserver||Runs the master server, which manages the master component.|
|pe-nginx||Nginx, serves as a reverse-proxy to the console.|
|puppet||(on Enterprise Linux and Debian-based platforms) Runs the agent daemon on every agent node.|
|pe-puppetdb, pe-postgresql||Daemons that manage and serve the database components. The pe-postgresql service is created only if the software installs and manages PostgreSQL.|
|pxp-agent||Runs the Puppet Execution Protocol agent process.|
|pe-orchestration-services||Runs the orchestration process.|
User and group accounts installed
These are the user and group accounts installed.
|pe-puppet||Runs the master
processes spawned by
|pe-puppetdb||Has root access to the database.|
|pe-postgres||Has access to the
|pe-console-services||Runs the console process.|
|pe-orchestration-services||Runs the orchestration process.|
Log files installed
The software distributed with PE generates log files that you can collect for compliance or use for troubleshooting.
The master has these logs.
/var/log/puppetlabs/puppetserver/pcp-broker.log— The log file for Puppet Communications Protocol brokers on compilers.
/var/log/puppetlabs/puppetserver/puppetserver.log— The master application logs its activity, including compilation errors and deprecation warnings, here.
/var/log/puppetlabs/puppetserver/puppetserver-daemon.log— This is where fatal errors or crash reports can be found.
The locations of agent logs depend on the agent operating system.
On *nix nodes, the agent service logs its activity to the
syslog service. Your syslog configuration dictates where these messages are saved,
but the default location is
/var/log/messages on Linux,
/var/log/system.log on macOS, and
/var/adm/messages on Solaris.
On Windows nodes, the agent service logs its activity to the event log. You can view its logs by browsing the event viewer.
Console and console services logs
The console and pe-console-services has these logs.
/var/log/puppetlabs/console-services-daemon.log— This is where fatal errors or crash reports can be found.
/var/log/puppetlabs/nginx/error.log— Contains errors related to nginx. Console errors that aren't logged elsewhere can be found in this log.
The installer has these logs.
/var/log/puppetlabs/installer/http.log— Contains web requests sent to the installer. This log is present only on the machine from which a web-based installation was performed.
/var/log/puppetlabs/installer/install_log.lastrun.<hostname>.log— Contains the contents of the last installer run.
/var/log/puppetlabs/installer/installer-<timestamp>.log— Contains the operations performed and any errors that occurred during installation.
/var/log/puppetlabs/installer/<action_name>_<timestamp>_<run_description>.log— Contains details about high availability command execution. Each action triggers multiple Puppet runs, some on the master, some on the replica, so there might be multiple log files for each command.
The database has these logs.
The orchestration service and related components have these logs.
/var/log/puppetlabs/orchestration-services/pcp-broker.log— The log file for Puppet Communications Protocol brokers on the master.
/var/log/puppetlabs/orchestration-services/orchestration-services-daemon.log— This is where fatal errors or crash reports can be found.
/var/log/puppetlabs/pxp-agent/pxp-agent.log(on *nix) or
C:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log(on Windows) — Contains the Puppet Execution Protocol agent log file.
/var/log/puppetlabs/bolt-server/bolt-server.log- Log file for PE Bolt server.
/var/log/puppetlabs/orchestration-services/orchestration-services.log— Log file for the node inventory service.
During installation, the software generates and installs a number of SSL certificates so that agents and services can authenticate themselves.
These certs can be found at
A certificate with the same name as the agent that runs on the master is generated during installation. This certificate is used by PuppetDB and the console.
Services that run on the master — for example,
pe-console-services — use the agent certificate to
Secret key file installed
During installation, the software generates a secret key file that is used to encrypt and decrypt sensitive data stored in the inventory service.
The secret key is stored at: