An overview of PE's platform documentation
Puppet Enterprise is built on the Puppet configuration management platform. This platform has several components, and the most important ones are:
This page describes the components of our platform, and links to the correct component docs for this PE version.
Puppet is the core of our configuration management platform. It consists of a special programming language for describing desired system states, an agent that can enforce desired states, and several other tools and services.
Right now, you’re reading the PE manual; the Puppet 4.8 reference manual is a separate section of our docs site. Once you’ve followed a link there, you can use the navigation sidebar to browse other sections of the manual.
Note: The Puppet manual has information about installing the open source release of Puppet. As a PE user, you should ignore those pages.
The following pages are good starting points for getting familiar with Puppet:
- An outline of how the Puppet language works.
- Resources, variables, conditional statements, and relationships and ordering are the fundamental pieces of the Puppet language.
- Classes and defined types are how you organize Puppet code into useful chunks.
- Classes are the main unit of Puppet code you’ll be interacting with on a daily basis! You can assign classes to nodes in the PE console.
- Facts and built-in variables explains the special variables you can use in your Puppet manifests.
- Most Puppet code should go in modules. We explain how modules work here.
- There are also guides to installing modules and publishing modules on the Puppet Forge.
- As a PE user, we recommend that you use PE’s code management features to control your modules instead of installing by hand. See Managing and deploying Puppet code (in the PE manual) for more details.
Services and commands
- An overview of Puppet’s architecture.
- A list of the main services and commands you’ll interact with.
- Notes on running Puppet’s commands on Windows.
Built-in resource types and functions
- The resource type reference has info about all of Puppet’s built-in resource types.
- The function reference does the same for the built-in functions.
Important directories and files
- Most of your Puppet content goes in environments. Find out more about environments here.
- The codedir contains code and data and the confdir contains config files. The modulepath and the main manifest both depend on the current environment.
- Puppet’s main config file is
/etc/puppetlabs/puppet/puppet.conf. Learn more about Puppet’s settings, and about puppet.conf itself.
- There are also a bunch of other config files used for special purposes. Go to the page about puppet.conf and check the navigation sidebar for a full list.
Puppet Server is the JVM application that provides Puppet’s core HTTPS services. Whenever Puppet agent checks in to request a configuration catalog for a node, it contacts Puppet Server.
For the most part, PE users don’t need to directly manage Puppet Server, and the Puppet reference manual (above) has all the important info about how Puppet Server evaluates the Puppet language and loads environments and modules. However, some users might need to access the environment cache and JRuby pool administrative APIs, and there’s lots of interesting background information in the rest of the Puppet Server docs.
Note: The Puppet Server manual has information about installing the open source release of Puppet Server. As a PE user, you should ignore those pages. Additionally, Puppet Server’s config files in PE are managed with a built-in Puppet module; to change most settings, you should set the appropriate class parameters in the PE console.
Facter is a system profiling tool. Puppet agent uses it to send important system info to Puppet Server, which can access that info when compiling that node’s catalog.
- For a list of variables you can use in your code, check out the core facts reference.
- You can also write your own custom facts. See the custom fact overview and the custom fact walkthrough.
Hiera is a hierarchical data lookup tool. You can use it to configure your Puppet classes.
Start with the overview and use the navigation sidebar to get around.
PuppetDB collects the data Puppet generates, and offers a powerful query API for analyzing that data. It’s the foundation of the PE console, and you can also use the API to build your own applications.
If you’re interacting with PuppetDB directly, you’ll mostly be using the query API.
- The query tutorial page walks you through the process of building and executing a query.
- The query structure page explains the fundamentals of using the query API.
- The cURL tips page has useful information about testing the API from the command line.
- You can use the navigation sidebar to browse the rest of the query API docs.
Note: The PuppetDB manual has information about installing the open source release of PuppetDB. As a PE user, you should ignore those pages.