What gets installed and where?

On *nix nodes, all software is installed under /opt/puppetlabs.

On Windows nodes, all software is installed in Program Files at Puppet Labs\Puppet.

export PATH=$PATH:/opt/puppetlabs/binCopied!

To make essential Puppet tools available to all users, the installer automatically creates symlinks in /usr/local/bin for the facter, puppet, pe-man, r10k, and 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.

puppet_enterprise::manage_symlinks: falseCopied!

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 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.

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.

• 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.

The PE PostgreSQL database includes these following databases.

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.

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.

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.