Puppet Man Pages

Open source Puppet 6.10

Welcome to Puppet 6.10
- Puppet architecture
- Puppet packages and versions
- Puppet language and code
- Glossary
Release notes
- Puppet release notes
- Puppet known issues
Getting started with Puppet
- Managing NTP
- Managing DNS
- Managing sudo
- Manage firewall rules
Installing and upgrading
- System requirements
- Using the Puppet platform
- Installing Puppet
- Installing agents
- Upgrading
Configuring Puppet
- Puppet settings
- Key configuration settings
- Puppet's configuration files
- Configuring Puppet Server
- Adding file server mount points
- Checking the values of settings
- Editing settings on the command line
- Configuration settings reference
- Settings that differ under Puppet Server
Important directories and files
- Code and data directory (codedir)
- Config directory (confdir)
- Main manifest directory
- The modulepath
- SSL directory (ssldir)
- Cache directory (vardir)
Environments
- About environments
- Creating environments
- Environment isolation
Modules
- Module fundamentals
- Plug-ins in modules
- Module cheat sheet
- Installing and managing modules from the command line
- Beginner's guide to writing modules
- Module metadata
- Documenting modules
- Documenting modules with Puppet Strings
- Puppet Strings style guide
- Publishing modules
- Contributing to Puppet modules
Puppet services and tools
- Puppet commands
- Running Puppet commands on Windows
- Puppet master
  - Puppet Server
- Puppet agent on *nix systems
- Puppet agent on Windows
- Puppet apply
- Puppet device
Puppet Server
- Index
- About Puppet Server
- Release Notes
- Deprecated features
- 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
- CA v1 API
- Server-specific Puppet API endpoints
- Status API endpoints
  - Status services
- Metrics API endpoints
  - v1 metrics
  - v2 (Jolokia) metrics
- Developer information
The Puppet language
- Language visual index
- The Puppet language style guide
- Files and paths on Windows
- Code comments
- Variables
- Resources
- Relationships and ordering
- Classes
- Defined resource types
- Bolt tasks
- Type aliases
- Expressions and operators
- Conditional statements and expressions
- Function calls
- Built-in functions
- Node definitions
- Facts and built-in variables
- Reserved words and acceptable names
- Custom resources
  - Develop types and providers with the Resource API
  - Resource API reference
  - Low-level method for developing types and providers
    - Type development
    - Provider development
- Values and data types
  - Strings
  - Numbers
  - Booleans
  - Arrays
  - Hashes
  - Regular expressions
  - Sensitive
  - Time-related data types
  - Undef
  - Default
  - Resource and class references
  - Resource types
  - Data type syntax
  - Abstract data types
- Templates
  - Creating templates using Embedded Puppet
  - Creating templates using Embedded Ruby
- Advanced constructs
  - Iteration and loops
  - Lambdas
  - Resource default statements
  - Resource collectors
  - Virtual resources
  - Exported resources
  - Tags
  - Run stages
- Details of complex behaviors
  - Containment of resources
  - Scope
  - Namespaces and autoloading
Writing custom functions
- Custom functions
- Custom Puppet functions
- Writing custom functions in Ruby
- Secrets store integrations and agent-side data retrieval
- Write a Puppet function to store secrets
Hiera
- About Hiera
- Getting started with Hiera
- Configuring Hiera
- Creating and editing data
- Looking up data with Hiera
- Writing new data backends
- Upgrading to Hiera 5
Facter
- Facter release notes
- Core facts
- Custom facts
- Custom facts walkthrough
- External facts
- Configuring Facter with facter.conf
Resource types
- All resource types
- Core types cheat sheet
- Optional resource types for Windows
- exec
- Using exec on Windows
- file
- Using file on Windows
- filebucket
- group
- Using user and group on Windows
- index
- notify
- package
- Using package on Windows
- resources
- schedule
- service
- Using service
- stage
- tidy
- user
Tracking Puppet activity with reports
- Reporting
- Report reference
- Writing custom report processors
- Report format
Writing external node classifiers
References (settings, functions, etc.)
- Configuration settings reference
- Functions
- Metaparameters
- Built-in report processors
- Ruby API for developing extensions
Man pages
- Index
- Core tools
- Occasionally useful
- Niche
HTTP API
- Puppet Server HTTP API
- PSON
- Puppet v4 API
  - Catalog
- Puppet v3 API
- CA v1 API
- Schemas (JSON)
Certificate authority and SSL
- Puppet Server CA commands
- Intermediate CA
- Autosigning certificate requests
- CSR attributes and certificate extensions
- Regenerating certificates in a Puppet deployment
- External CA
- External SSL termination with Puppet Server
Puppet's internals
- Agent-master HTTPS communications
- Catalog compilation
Experimental features
- Msgpack support

Expand menu Collapse menu

Core Tools
Secondary subcommands
Niche subcommands

Puppet’s command line tools consist of a single puppet binary with many subcommands. The following subcommands are available in this version of Puppet:

Core Tools

These subcommands form the core of Puppet’s tool set, and every user should understand what they do.

Note: The puppet cert command is available only in Puppet versions prior to 6.0. For 6.0 and later, use the puppetserver certcommand.

Secondary subcommands

Many or most users need to use these subcommands at some point, but they aren’t needed for daily use the way the core tools are.

Niche subcommands

Most users can ignore these subcommands. They’re only useful for certain niche workflows, and most of them are interfaces to Puppet’s internal subsystems.