Puppet documentation index

This is the documentation for Puppet, and its related tools and applications.

Most of the content here applies equally to Puppet Enterprise and open source releases of Puppet, but make sure you’re using the right docs version for your Puppet Enterprise version. If you get lost, check the version note in red text at the top of each page.

Main docs

Practically speaking, Puppet is a collection of several projects. Here’s the documentation for all of the major components that make up a Puppet deployment:

Component Latest Other versions
Puppet Latest Other versions
Puppet Server Latest Other versions
Facter Latest Other versions
Hiera Latest Other versions
PuppetDB Latest Other versions

Cheat sheets and glossary

Small documents for getting help fast.

Puppet reference manuals

A concise reference to Puppet’s usage and internals. Use the left sidebar of any reference manual page to navigate between pages.

Note: The “Puppet 3” manual covers versions 3.0 through 3.4.

Other reference material

Puppet guides

Learn about different areas of Puppet, problem fixes, and design solutions.

Installing and configuring

Get the latest version of Puppet up and running.

Previous install guides

Building and using modules

Help with writing Puppet code

  • Style guide — Puppet Language community conventions.

Using optional features

  • Puppet file serving — Files in modules are automatically served; this explains how to configure additional custom mount points for serving large files that shouldn’t be kept in modules.

Puppet on Windows

With a *nix based Puppet master, you can manage Windows nodes side by side with your *nix infrastructure or run Puppet masterless on Windows.

Tuning and scaling

Puppet’s default configuration is meant for prototyping and designing a site. Once you’re ready for production deployment, learn how to adjust Puppet for peak performance.

Hacking and extending: APIs and interfaces

  • External Nodes — Specify what your machines do using external data sources.
    • LDAP Nodes — A special-case tool for keeping node information in your LDAP directory.

Hacking and extending: Ruby plugins

Other resources

↑ Back to top