What gets installed and where?

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.

The functional components of the software are separated between those packaged with the agent and those packaged on the server side (which also includes the agent).
Note: PE also installs other dependencies, as documented in the system requirements.
This table shows the components installed on all agent nodes.
Note: Hiera 5 is a backwards-compatible evolution of Hiera, which is built into Puppet 4.9.0 and higher. To provide some backwards-compatible features, it uses the classic Hiera 3.x.x codebase version listed in this table.
PE Version Puppet and the Puppet agent Facter Hiera Ruby OpenSSL
2021.4 7.12.1 4.2.5 3.7.0 2.7.3 1.1.1l
2021.3 7.9.0 4.2.2 3.7.0 2.7.3 1.1.1k
2021.2 7.8.0 4.2.1 3.7.0 2.7.3 1.1.1k
2021.1 7.6.1 4.1.1 3.6.0 2.7.3 1.1.1i
2021.0 7.4.1 4.0.51 3.6.0 2.7.2 1.1.1i
2019.8.9 (LTS) 6.25.1 3.14.21 3.7.0 2.5.9 1.1.1l
2019.8.8 6.24.0 3.14.19 3.7.0 2.5.9 1.1.1k
2019.8.7 6.23.0 3.14.18 3.7.0 2.5.9 1.1.1k
2019.8.6 6.22.1 3.14.17 3.6.0 2.5.9 1.1.1g
2019.8.5 6.21.1 3.14.16 3.6.0 2.5.8 1.1.1i
2019.8.4 6.19.1 3.14.14 3.6.0 2.5.8 1.1.1g
2019.8.3 6.19.1 3.14.14 3.6.0 2.5.8 1.1.1g
2019.8.1 6.17.0 3.14.12 3.6.0 2.5.8 1.1.1g
2019.8 6.16.0 3.14.11 3.6.0 2.5.8 1.1.1g
This table shows components installed on server nodes.
PE Version Puppet Server PuppetDB r10k Bolt Services Agentless Catalog Executor (ACE) Services PostgreSQL Java Nginx
2021.4 7.4.2 7.7.1 3.13.0 3.20.0 1.2.4 11.13 11.0 1.21.0
2021.3 7.2.1 7.5.2 3.10.0 3.13.0 1.2.4 11.13 11.0 1.21.0
2021.2 7.2.0 7.4.1 3.9.2 3.10.0 1.2.4 11.11 11.0 1.21.0
2021.1 7.1.2 7.3.1 3.9.0 3.7.1 1.2.4 11.11 11.0 1.19.6
2021.0 7.0.3 7.1.0 3.8.0 3.0.0 1.2.2 11.10 11.0 1.19.6
2019.8.9 (LTS) 6.17.1 6.19.1 3.13.0 3.20.0 1.2.4 11.13 11.0 1.21.0
2019.8.8 6.16.1 6.18.2 3.10.0 3.13.0 1.2.4 11.13 11.0 1.17.0
2019.8.7 6.16.0 6.17.0 3.9.2 3.10.0 1.2.4 11.11 11.0 1.21.0
2019.8.6 6.15.3 6.16.1 3.9.0 3.7.1 1.2.4 11.11 11.0 1.19.6
2019.8.5 6.15.1 6.14.0 3.8.0 3.0.0 1.2.2 11.10 11.0 1.19.6
2019.8.4 6.14.1 6.13.1 3.6.0 2.32.0 1.2.1 11.10 11.0 1.17.10
2019.8.3 6.14.1 6.13.1 3.6.0 2.32.0 1.2.1 11.9 11.0 1.17.10
2019.8.1 6.12.1 6.11.3 3.5.2 2.16.0 1.2.0 11.8 11.0 1.17.10
2019.8 6.12.0 6.11.1 3.5.1 2.11.1 1.2.0 11.8 11.0 1.17.10

Modules and plugins installed

PE installs modules and plugins for normal operations.

Modules included with the software are installed on the primary server in /opt/puppetlabs/puppet/modules. Don't modify anything in this directory or add modules of your own. Instead, install non-default modules in /etc/puppetlabs/code/environments/<environment>/modules.

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 /etc/puppetlabs.

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 C:\ProgramData\PuppetLabs\puppet\etc.

The agent software's confdir is in the puppet subdirectory. This directory contains the puppet.conf file, auth.conf, and the SSL directory.

Tools installed

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 puppet agent and puppet ssl.
  • Puppet Server tools — The primary server contains a tool to manage and interact with the provided certificate authority, puppetserver ca.
  • Client tools — The pe-client-tools package collects a set of CLI tools that extend the ability for you to access services from the primary server 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 job and puppet task.
    • Puppet Access — Users can generate tokens to authenticate their access to certain command line tools and API endpoints.
    • Code Manager CLI — The puppet-code command 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.
  • 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.

Databases installed

PE installs several default databases, all of which use PostgreSQL as a database backend.

The PE PostgreSQL database includes these following databases.

Database Description
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, perform backups to a remote system nightly, or as dictated by your company policy.

Services installed

PE installs several services used to interact with the software during normal operations.

Service Definition
pe-console-services Manages and serves the console.
pe-puppetserver Runs the primary server.
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.
pe-ace-server Runs the ace server.
pe-bolt-server Runs the Bolt server.

User and group accounts installed

These are the user and group accounts installed.

User Definition
pe-puppet Runs the primary server processes spawned by pe-puppetserver.
pe-webserver Runs Nginx.
pe-puppetdb Has root access to the database.
pe-postgres Has access to the pe-postgreSQL instance. Created only if the software installs and manages PostgreSQL.
pe-console-services Runs the console process.
pe-orchestration-services Runs the orchestration process.
pe-ace-server Runs the ace server.
pe-bolt-server Runs the Bolt server.

Log files installed

The software distributed with PE generates log files that you can collect for compliance or use for troubleshooting.

Primary server logs

The primary server has these logs.

  • /var/log/puppetlabs/puppetserver/code-manager-access.log
  • /var/log/puppetlabs/puppetserver/file-sync-access.log
  • /var/log/puppetlabs/puppetserver/masterhttp.log
  • /var/log/puppetlabs/puppetserver/pcp-broker.log — The log file for Puppet Communications Protocol brokers on compilers.
  • /var/log/puppetlabs/puppetserver/puppetserver.log — The primary server logs its activity, including compilation errors and deprecation warnings, here.
  • /var/log/puppetlabs/puppetserver/puppetserver-access.log
  • /var/log/puppetlabs/puppetserver/puppetserver-daemon.log — This is where fatal errors or crash reports can be found.
  • /var/log/puppetlabs/puppetserver/puppetserver-status.log

Agent logs

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/console-services.log
  • /var/log/puppetlabs/console-services/console-services-api-access.log
  • /var/log/puppetlabs/console-services-access.log
  • /var/log/puppetlabs/console-services-daemon.log — This is where fatal errors or crash reports can be found.
  • /var/log/puppetlabs/nginx/access.log
  • /var/log/puppetlabs/nginx/error.log — Contains errors related to nginx. Console errors that aren't logged elsewhere can be found in this log.

Installer logs

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/orchestrator_info.log — Contains run details about puppet infrastructure commands that use the orchestrator, including the commands to provision and upgrade compilers, convert legacy compilers, and regenerate agent and compiler certificates.
  • /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 disaster recovery command execution. Each action triggers multiple Puppet runs, some on the primary server, some on the replica, so there might be multiple log files for each command.

Database logs

The database has these logs.

  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/pgstartup.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Mon.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Tue.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Wed.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Thu.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Fri.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Sat.log
  • /var/log/puppetlabs/postgresql/<POSTGRESQL VERSION NUMBER>/postgresql-Sun.log
  • /var/log/puppetlabs/puppetdb/puppetdb.log
  • /var/log/puppetlabs/puppetdb/puppetdb-access.log
  • /var/log/puppetlabs/puppetdb/puppetdb-status.log

Orchestration logs

The orchestration service and related components have these logs.

  • /var/log/puppetlabs/orchestration-services/aggregate-node-count.log
  • /var/log/puppetlabs/orchestration-services/pcp-broker.log — The log file for Puppet Communications Protocol brokers on the primary server.
  • /var/log/puppetlabs/orchestration-services/pcp-broker-access.log
  • /var/log/puppetlabs/orchestration-services/orchestration-services.log
  • /var/log/puppetlabs/orchestration-services/orchestration-services-access.log
  • /var/log/puppetlabs/orchestration-services/orchestration-services-daemon.log — This is where fatal errors or crash reports can be found.
  • /var/log/puppetlabs/orchestration-services/orchestration-services-status.log
  • /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.

Certificates installed

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 /etc/puppetlabs/puppet/ssl/certs.

A certificate with the same name as the agent that runs on the primary server is generated during installation. This certificate is used by PuppetDB and the console.

Services that run on the primary server — for example, pe-orchestration-services and pe-console-services — use the agent certificate to authenticate.

The certificate authority, if active, stores its certificate information at /etc/puppetlabs/puppetserver/ca.

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: /etc/puppetlabs/orchestration-services/conf.d/secrets/keys.json