Puppet 4.6 reference manual
- Introduction
- Quick start guides
- Puppet 4.6 release notes
- Puppet agent release notes
- Puppet Server 2.6 release notes
- puppet-agent: What is it, what's in it?
- Where did everything go?
- Deprecated features
- Installing and upgrading
- Overview of Puppet's architecture
- System requirements
- Pre-install tasks
- Puppet Collection repositories
- Install: Puppet Server
- Install: Puppet agent
- Install: PuppetDB
- Upgrade: From Puppet 4.x
- Upgrade: From Puppet 3.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)
- 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's services and tools
- Puppet Server
- Index
- About Puppet Server
- Release notes
- Deprecated features
- Notable differences vs. the Apache/Passenger stack
- Installation
- 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)
- Differing behavior in puppet.conf
- Using Ruby gems
- Subcommands
- Backwards compatibility with Puppet 3 agents
- Using an external CA
- External SSL termination
- Tuning guide
- Restarting Puppet Server
- Known issues and workarounds
- Administrative API
- Puppet API
- Status API
- Developer info
- The Puppet language
- Updating 3.x manifests for Puppet 4.x
- Visual index
- Basics
- Handling file paths on Windows
- Variables
- Resources
- Resources (advanced)
- Relationships and ordering
- Classes
- Defined resource types
- Type aliases
- Custom types
- Provider development
- Expressions and operators
- Conditional statements and expressions
- Functions
- Node definitions
- Comments
- Facts and built-in variables
- Reserved words and acceptable names
- Writing functions in the Puppet language
- Values and data types
- Templates
- Advanced constructs
- Details of complex behaviors
- Puppet lookup
- Resource types
- All resource types (single-page reference)
- augeas
- computer
- cron
- exec
- file
- filebucket
- group
- 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
- resources
- router
- schedule
- scheduled_task
- selboolean
- selmodule
- service
- ssh_authorized_key
- sshkey
- stage
- tidy
- user
- vlan
- yumrepo
- zfs
- zone
- zpool
- Reports: Tracking Puppet's activity
- Misc. references (settings, functions, etc.)
- Man pages
- Index
- Core tools
- Occasionally useful
- Niche
- HTTP API
- SSL and certificates
- Adding file server mount points
- Details about Puppet's internals
- Experimental features
Puppet supports two kinds of comments:
Shell-style comments
Shell-style comments (also known as Ruby-style comments) begin with a hash symbol (#
) and continue to the end of a line. They can start at the beginning of a line or partway through a line that began with code.
# This is a comment
file {'/etc/ntp.conf': # This is another comment
ensure => file,
owner => root,
}
C-style comments
C-style comments are delimited by slashes with inner asterisks. They can span multiple lines. This comment style is less frequently used than shell-style.
/*
this is a comment
*/