Puppet Server: Index

Puppet Platform reference manual

Introduction
Puppet 5 Platform
- Puppet 5.0 release notes
- Puppet known issues
- System requirements
- Component versions in puppet-agent
- Puppet agent release notes
- Puppet Server 5.0 release notes
- Facter release notes
Quick start guides
- Essential configuration tasks
Deprecated features
- About deprecations in this version
- Web servers
- Upcoming operating system deprecations
- Language features
- Extension points and APIs
- Settings
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
- Configuring Puppet Server
- 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
- Code and data directory (codedir)
- Config directory (confdir)
- The main manifest(s)
- The modulepath
- The SSLdir
- Cache directory (vardir)
Environments
- About environments
- Creating environments
- Environment isolation
Modules
- Fundamentals
- Beginner’s guide to writing modules
- Plugins in modules
- Installing modules
- Publishing modules on the Puppet Forge
- Module metadata and metadata.json
- Documenting modules
- Smoke testing modules
- Module cheat sheet
Puppet’s services and tools
- Puppet’s commands
- Running Puppet commands on Windows
- Puppet master
- Puppet agent on *nix
- Puppet agent on Windows
- Puppet apply
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
- 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
  - About values and data types
  - Strings
  - Numbers
  - Booleans
  - Arrays
  - Hashes
  - Regular expressions
  - Sensitive
  - Undef
  - Resource references
  - Resource types
  - Default
  - Data type syntax
  - Abstract data types
- Templates
  - Using templates
  - Embedded Puppet (EPP) template syntax
  - Embedded Ruby (ERB) template syntax
- Advanced constructs
  - Iteration and loops
  - Lambdas (code blocks)
  - Resource defaults
  - Resource collectors
  - Virtual resources
  - Exported resources
  - Tags
  - Run stages
- Details of complex behaviors
  - Containment of resources
  - Scope
  - Namespaces and autoloading
Writing custom functions
- Introduction to writing functions
- Writing functions (Puppet language)
- Writing functions (modern Ruby API)
- Writing functions (legacy Ruby API — avoid)
Hiera: using configuration data
- What is Hiera?
- Quick start guide
- How hierarchies work
- How the three config layers work
- Upgrading to Hiera 5
- Configuring Hiera (the hiera.yaml file)
- Looking up data
- Creating and editing data
  - Merging data from multiple sources
  - Interpolating variables and functions
- Writing new data backends
Facter
- Facter release notes
- Core facts
- Custom fact overview/reference
- Custom fact walkthrough
- External facts
- Configuring Facter with facter.conf
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
- About reporting
- Built-in report processors
- Writing custom report processors
- Puppet::Transaction::Report object format
Extensions for assigning classes to nodes
- External node classifiers
- The LDAP node classifier
Misc. references (settings, functions, etc.)
- Settings (configuration reference)
- Functions
- Metaparameters
- Built-in report processors
- Indirections and termini
- Ruby API for developing extensions
Man pages
- Index
- Core tools
- Occasionally useful
- Niche
HTTP API
- Index
- PSON
- Puppet v3 API
- CA v1 API
- Schemas (JSON files)
SSL and certificates
- Using an external CA
- Using an external CA with Puppet Server
- External SSL termination with Puppet Server
- Configuring autosigning
- CSR attributes and certificate extensions
- Regenerating all certificates in a deployment
Adding file server mount points
Details about Puppet’s internals
- Agent/master HTTPS communications
- Catalog compilation
Experimental features
- Overview
- Msgpack support

Expand menu Collapse menu

Puppet Server is the next-generation application for managing Puppet agents.

Note: For information about configuring and tuning settings specific to Puppet Enterprise, see its documentation.

About Puppet Server
Installing Puppet Server
Configuring Puppet Server
- global.conf
- webserver.conf
- web-routes.conf
- puppetserver.conf
- auth.conf
  - Migrating deprecated authentication rules
- metrics.conf
- logback.xml
  - Advanced logging configuration
- master.conf (deprecated)
- ca.conf (deprecated)
- 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