Puppet.com
Forge
Compass
Try Puppet

Products
Puppet Enterprise
Open Source Puppet
Bolt
Puppet Development Kit
Puppet DB
Puppet Remediate
Puppet Plugin for VMware

Get
Technical Support Plans
Support Lifecycle Policy
New Puppet Enterprise Customer?

About Puppet
TBD...
TBD...
Community
Puppet Champions
Puppet Test Pilots
Community Office Hours
Slack Channel

PRODUCT AND VERSION

Welcome to Puppet documentation

Puppet 5 Platform

Quick start guides
- Essential configuration tasks

Deprecated features

Installing and upgrading
- Overview of Puppet's architecture
- Pre-install tasks
- Puppet Platform repositories
- Install: Puppet Server
- Install: Puppet agent
- Install: PuppetDB
- Major upgrade from Puppet 3.8.x
- Minor upgrades: From Puppet 4 and within Puppet 5.x

Configuration

Important directories and files

Environments

Modules

Puppet services and tools

Puppet Server
- Index
- About Puppet Server
- Release notes
- Deprecated features
- Notable differences vs. the Apache/Passenger stack
- Compatibility with Puppet agent
- Installing Puppet Server
- Configuring Puppet Server
- Differing behavior in puppet.conf
- Using and extending Puppet Server
- Known issues and workarounds
  - Known issues
  - SSL problems with load-balanced PuppetDB servers (“Server Certificate Change” error)
- Administrative API endpoints
  - Environment cache
  - JRuby pool
- Server-specific Puppet API endpoints
- Status API endpoints
  - Status services
- Metrics API endpoints
  - v1 metrics
  - v2 (Jolokia) metrics
- Developer information

The Puppet language
- Visual index
- Basics
- The Puppet language style guide
- Handling file paths on Windows
- Variables
- Resources
- Resources (advanced)
- Relationships and ordering
- Classes
- Defined resource types
- Bolt tasks
- Type aliases
- Expressions and operators
- Conditional statements and expressions
- Function calls
- Docs for built-in functions
- Node definitions
- Comments
- Facts and built-in variables
- Reserved words and acceptable names
- Writing functions (Puppet language)
- Custom types
- Provider development
- Values and data types
- Templates
- Advanced constructs
- Details of complex behaviors

Writing custom functions
- Introduction to writing functions
- Writing functions (Puppet language)
- Writing functions (modern Ruby API)
- Writing functions (legacy Ruby API — avoid)

Hiera

Facter

Resource types

Reports: Tracking Puppet's activity

Extensions for assigning classes to nodes
- External node classifiers
- The LDAP node classifier

Misc. references (settings, functions, etc.)

Man Pages

HTTP API
- Index
- PSON
- Puppet v3 API
  - Catalog
  - Node
  - File bucket file
  - File content
  - File metadata
  - Report
  - Environments
  - Status
- CA v1 API
- Schemas (JSON)

SSL and certificates

Adding file server mount points

Puppet's internals
- Agent-master HTTPS communications
- Catalog compilation

Experimental features
- Overview
- Msgpack support

Deprecated settings

These Puppet settings are deprecated in this version of Puppet:

To send us feedback or let us know about a docs error, open a ticket (you need a Jira account) or leave a comment.

Send feedback to the Docs team:

Email Address:

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

Puppet automates the delivery and operation of the software that powers some of the biggest brands in the world.

Legal
Privacy Policy
Terms of Use
Security

Sitemap © 2021
Puppet