Docs: Puppet Documentation Index


Puppet Documentation Index

This is the documentation for Puppet, the industry-leading configuration management toolkit. Most of the content here applies equally to Puppet Enterprise and open source releases of Puppet.

Drive-Thru

Small documents for getting help fast.

Thumbnail preview of the core types cheat sheet. Thumbnail preview of the module cheat sheet.


Learning Puppet

Learn to use Puppet! New users: start here.


Reference Shelf

Puppet 3.6 Reference Manual

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

Puppet 3.5 Reference Manual

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

Puppet 3 Reference Manual

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

Puppet 2.7 Reference Manual

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

Miscellaneous References

Generated References

Complete and up-to-date references for Puppet’s resource types, functions, metaparameters, configuration options, indirection termini, and reports, served piping hot directly from the source code.

These references are automatically generated from the inline documentation in Puppet’s source code. References generated from each version of Puppet are archived here:


Puppet Guides

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

Components

Learn more about major working parts of the Puppet system.

Installing and Configuring

Get Puppet up and running at your site.

Building and Using Modules

Help With Writing Puppet Code

Using Optional Features

  • Environments — separate dev, stage, & production
  • 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

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