Puppet Enterprise 2017.3

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.

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 Agent Puppet Facter Hiera MCollective RubyOpenSSL
2017.3.1 5.3.2 5.3.2 3.9.23.4.22.11.32.4.11.0.2k
2017.3.0 5.3.2 5.3.2 3.9.23.4.22.11.32.4.11.0.2k
2017.2.41.10.84.10.83.6.73.3.22.10.52.1.91.0.2k
2017.2.31.10.54.10.53.6.63.3.22.10.52.1.91.0.2k
2017.2.21.10.44.10.43.6.53.3.22.10.52.1.91.0.2k
2017.2.11.10.14.10.13.6.43.3.12.10.42.1.91.0.2k
2017.1.11.9.34.9.43.6.23.3.12.9.02.1.91.0.2j
2017.1.1 for Ubuntu on i3861.7.04.7.03.4.13.2.12.10.22.1.91.0.2h
2017.1.01.9.34.9.43.6.23.3.12.9.02.1.91.0.2j
2017.1.0 for Ubuntu on i3861.7.04.7.03.4.13.2.12.10.22.1.91.0.2h
This table shows components installed on server nodes:
PE Version Puppet Server PuppetDB r10k Razor Server Razor Libs PostgreSQL Java ActiveMQ Nginx
2017.3.1 5.1.3 5.1.1 2.5.51.6.03.1.29.6.51.8.05.14.31.12.1
2017.3.05.1.35.1.12.5.51.6.03.1.29.6.51.8.05.14.31.12.1
2017.2.42.8.04.4.22.5.51.6.03.1.29.4.141.8.05.14.31.12.1
2017.2.32.7.24.4.12.5.51.6.03.1.29.4.121.8.05.14.31.12.1
2017.2.22.7.24.4.12.5.51.6.03.1.29.4.121.8.05.14.31.10.2
2017.2.12.7.24.4.02.5.41.6.03.1.29.4.101.8.05.14.31.10.2
2017.1.12.7.24.3.22.5.11.5.03.1.29.4.101.8.05.14.31.10.2
2017.1.02.7.24.3.22.5.11.5.03.1.29.4.101.8.05.14.31.10.2

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 /etc/puppetlabs/code/environments/<environment>/modules.
  • MCollective plugins are installed in /opt/puppetlabs/mcollective/plugins/ on *nix and in <COMMON_APPDATA>``\PuppetLabs\mcollective\etc\plugins\mcollective on Windows. If you are adding new plugins to agent nodes, distribute them with Puppet.

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

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 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 master and puppet cert.
  • 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 job and puppet app.
    • 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.
  • MCollective tools — Tools used to invoke simultaneous actions across a number of nodes. These tools are built on the MCollective framework and are accessed via the mco command.
  • 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, you should 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.

ServiceDefinition
pe-activemqThe ActiveMQ message server, which passes messages to the MCollective servers on agent nodes. Runs on servers with the master component.
pe-console-servicesManages and serves the console.
pe-puppetserverRuns the master server, which manages the master component.
pe-nginxNginx, serves as a reverse-proxy to the console.
mcollectiveThe MCollective daemon, which listens for messages and invokes actions. Runs on every agent node.
puppet(on Enterprise Linux and Debian-based platforms) Runs the agent daemon on every agent node.
pe-puppetdb, pe-postgresqlDaemons that manage and serve the database components. The pe-postgresql service is created only if the software installs and manages PostgreSQL.
pxp-agentRuns the Puppet Execution Protocol agent process.
pe-orchestration-servicesRuns the orchestration process.

User and group accounts installed

These are the user and group accounts installed.

UserDefinition
peadminInvokes MCollective actions. The individual user account is the only user account intended for use in a login shell. This user exists on servers with the master component.
pe-puppetRuns the master processes spawned by pe-puppetserver.
pe-webserverRuns Nginx.
pe-activemqRuns the ActiveMQ message bus used by MCollective.
pe-puppetdbHas root access to the database.
pe-postgresHas access to the pe-postgreSQL instance. Created only if the software installs and manages PostgreSQL.
pe-console-servicesRuns the console process.
pe-orchestration-servicesRuns the orchestration process.

Log files installed

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

Master logs

The master has these logs.

  • /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.
  • /var/log/puppetlabs/puppetserver/pcp-broker.log — The log file for Puppet Communications Protocol brokers on compile masters.
  • /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/puppetserver-access.log
  • /var/log/puppetlabs/puppetserver/puppetserver.log
  • /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 Mac OS X, 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.

ActiveMQ logs

ActiveMQ has these logs.

  • /var/log/puppetlabs/activemq/wrapper.log
  • /var/log/puppetlabs/activemq/activemq.log
  • /var/log/puppetlabs/activemq/data/audit.log

MCollective logs

MCollective has these logs.

  • /var/log/puppetlabs/mcollective.log — Maintained by the MCollective service, which is installed on all nodes.
  • /var/log/puppetlabs/mcollective-audit.log — Exists on all nodes that have MCollective installed. Logs any MCollective actions run on the node, including information about the client that called the node

Console and console services logs

The console and pe-console-services has these logs.

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

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/installer-<timestamp>.log — Contains the operations performed and any errors that occurred during installation.
  • /var/log/puppetlabs/installer/install_log.lastrun.<hostname>.log — Contains the contents of the last installer run.

Database logs

The database has these logs.

  • /var/log/puppetlabs/puppetdb/puppetdb-access.log
  • /var/log/puppetlabs/puppetdb/puppetdb-status.log
  • /var/log/puppetlabs/puppetdb/puppetdb.log
  • /var/log/puppetlabs/postgresql/pgstartup.log
  • /var/log/puppetlabs/postgresql/postgresql-Fri.log
  • /var/log/puppetlabs/postgresql/postgresql-Mon.log
  • /var/log/puppetlabs/postgresql/postgresql-Sat.log
  • /var/log/puppetlabs/postgresql/postgresql-Sun.log
  • /var/log/puppetlabs/postgresql/postgresql-Thu.log
  • /var/log/puppetlabs/postgresql/postgresql-Tue.log
  • /var/log/puppetlabs/postgresql/postgresql-Wed.log

Orchestration logs

The orchestration service and related components have these logs.

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

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.

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

CertDefinition
<MASTER CERTNAME>Generated during install. In a monolithic install, this cert is used by PuppetDB and the console. This is the same value for the agent's certname that runs on the master. In a monolithic install, the agent on the console and PuppetDB share this certname. In a default monolithic or split install, this is also the CA certificate.
<CONSOLE CERTNAME>The certificate for the console, which is generated only if you have a split install. This is the same value for the agent's certname that runs on the console.
<PUPPETDB CERTNAME>The certificate for PuppetDB, which is generated only if you have a split install. This is the same value for the agent's certname that runs on PuppetDB.
pe-internal-mcollective-serversA certificate generated on the master and shared to all agent nodes.
pe-internal-peadmin-mcollective-clientThe certificate for the peadmin account on the master.
pe-internal-puppet-console-mcollective-clientThe MCollective certificate for the console.
Back to top