Docs / Puppet Documentation Index

Puppet Documentation Index

This is the documentation for Puppet, as well as several 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.

Current Versions

Older Versions

Other Reference Material


Puppet Guides

Learn about different areas of Puppet, fix problems, and design solutions.

Installing and Configuring

Get Puppet up and running at your site.

Looking Ahead to Puppet 4

Building and Using Modules

Help With Writing Puppet Code

Using Optional Features

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

Puppet on Windows

You can manage Windows nodes side by side with your *nix infrastructure, with Puppet 2.7 and higher (including Puppet Enterprise ≥ 2.5).

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: Using Puppet’s Data

  • Puppet Data Library: Overview — Puppet automatically gathers reams of data about your infrastructure. Learn where that data is, how to access it, and how to mine it for knowledge.
  • Inventory Service — use Puppet’s inventory of nodes at your site in your own custom applications
  • Reporting — learn what your nodes are up to

Hacking and Extending: APIs and Interfaces

  • HTTP Access Control — secure API access with auth.conf
  • 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

Developing Puppet

Historical Guides

Puppet has gone through some transitional periods, and we’ve occasionally written short guides to explain major changes in its behavior.

  • Scope and Puppet — understand and banish dynamic lookup warnings with Puppet 2.7
  • Scaling With Mongrel — Running production puppet master servers with pre-0.24.6 versions of Puppet

Other Resources

↑ Back to top