Language: Comments

Puppet 4.6 reference manual

Introduction
Quick start guides
- Quick start intro for *nix users
- Essential configuration tasks
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
- About deprecations in this version
- Web servers
- Operating systems
- Language features
- Extension points and APIs
- Settings
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
- 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
- Configuring environments
- Creating environments
- Assigning environments to nodes
- Suggestions for use
- Limitations of environments
- Environments and Puppet's HTTPS interface
Modules
- Fundamentals
- Plugins in modules
- Installing modules
- Publishing modules on the Puppet Forge
- Module metadata and metadata.json
- Documenting modules
- Module smoke testing
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
- 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
  - Known issues
  - SSL problems with load-balanced PuppetDB servers ("server certificate change" error)
- Administrative API
  - Environment cache
  - JRuby pool
- Puppet API
  - Environment classes
  - Static file content
- Status API
  - Services
- Developer info
  - Debugging
  - Running from source
  - Tracing code events
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
  - 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
Puppet lookup
- Quick reference for Hiera users
- Quick intro to module data
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
- About reporting
- Built-in report processors
- Writing custom report processors
- Puppet::Transaction::Report object format
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
- Environment isolation

Expand menu Collapse menu

Shell-style comments
C-style comments

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
*/