Open source Puppet documentation
- Welcome to Puppet documentation
- Puppet 5 Platform
- Quick start guides
- 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
- About Puppet's settings
- Short list of important settings
- Config files
- puppet.conf: The main config file
- environment.conf: Per-environment settings
- auth.conf (LEGACY): HTTPS authorization
- fileserver.conf: Custom fileserver mount points
- puppetdb.conf: PuppetDB server locations
- hiera.yaml: Data lookup configuration
- autosign.conf: Basic certificate autosigning
- csr_attributes.yaml: Certificate extensions
- custom_trusted_oid_mapping.yaml: Short names for cert extension OIDs
- device.conf: Network hardware access
- routes.yaml: Advanced plugin routing
- Configuring Puppet Server
- Puppet Server's config files
- puppetserver.conf: Main config file
- auth.conf: Access control
- webserver.conf: Jetty web server config
- web-routes.conf: Mount points for component services
- global.conf: Trapperkeeper settings
- ca.conf: CA service access control (deprecated)
- master.conf: Authorization by HTTP header (deprecated)
- product.conf: Configuring Product-level Interactions (optional)
- logback.xml: Logging level and location
- Advanced logging configuration
- Bootstrap upgrade notes
- Checking values of settings
- Editing settings on the command line
- Complete list of settings (configuration reference)
- Settings that differ under Puppet Server
- 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
- Administrative API endpoints
- Server-specific Puppet API endpoints
- Status API endpoints
- Metrics API endpoints
- 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
- 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
- Hiera
- Facter
- Resource types
- All resource types (single-page reference)
- Core types cheat sheet
- Optional resource types for Windows
- augeas
- Augeas tips and examples
- computer
- cron
- exec
- Exec tips and examples for Windows
- file
- File tips and examples for Windows
- filebucket
- group
- User and group tips and examples for Windows
- host
- index
- interface
- k5login
- macauthorization
- mailalias
- maillist
- mcx
- mount
- nagios_command
- nagios_contact
- nagios_contactgroup
- nagios_host
- nagios_hostdependency
- nagios_hostescalation
- nagios_hostextinfo
- nagios_hostgroup
- nagios_service
- nagios_servicedependency
- nagios_serviceescalation
- nagios_serviceextinfo
- nagios_servicegroup
- nagios_timeperiod
- notify
- package
- Package tips and examples for Windows
- resources
- router
- schedule
- scheduled_task
- Scheduled task tips and examples
- selboolean
- selmodule
- service
- Service tips and examples
- ssh_authorized_key
- sshkey
- stage
- tidy
- user
- User and group tips and examples for Windows
- vlan
- yumrepo
- zfs
- zone
- zpool
- Reports: Tracking Puppet's activity
- Extensions for assigning classes to nodes
- Misc. references (settings, functions, etc.)
- Man pages
- Index
- Core tools
- Occasionally useful
- Niche
- HTTP API
- SSL and certificates
- Adding file server mount points
- Puppet's internals
- Experimental features
Open source Puppet ships puppet-agent packages for a variety of platforms, but some systems have been deprecated since we began shipping them, and we will no longer be providing packages for those systems.
The system requirements lists which platforms we currently publish packages for. Watch this space for upcoming deprecations in Puppet 5.