Puppet Documentation

Commands

• puppet agent
• puppet apply
• puppet catalog
• puppet config
• puppet describe
• puppet device
• puppet doc
• puppet epp
• puppet facts
• puppet filebucket
• puppet generate
• puppet help
• puppet key
• puppet lookup
• puppet man
• puppet module
• puppet node
• puppet parser
• puppet plugin
• puppet report
• puppet resource
• puppet script
• puppet ssl
• puppet status

Functions

• abs
• alert
• all
• annotate
• any
• assert_type
• binary_file
• break
• call
• camelcase
• capitalize
• ceiling
• chomp
• chop
• compare
• contain
• convert_to
• create_resources
• crit
• debug
• defined
• dig
• digest
• downcase
• each
• emerg
• empty
• epp
• err
• eyaml_lookup_key
• fail
• file
• filter
• find_file
• flatten
• floor
• fqdn_rand
• generate
• get
• getvar
• group_by
• hiera
• hiera_array
• hiera_hash
• hiera_include
• hocon_data
• import
• include
• index
• info
• inline_epp
• inline_template
• join
• json_data
• keys
• length
• lest
• lookup
• lstrip
• map
• match
• max
• md5
• min
• module_directory
• new
• next
• notice
• partition
• realize
• reduce
• regsubst
• require
• return
• reverse_each
• round
• rstrip
• scanf
• sha1
• sha256
• shellquote
• size
• slice
• sort
• split
• sprintf
• step
• strftime
• strip
• tag
• tagged
• template
• then
• tree_each
• type
• unique
• unwrap
• upcase
• values
• versioncmp
• warning
• with
• yaml_data

Guides

• About Hiera
• About environments
• Abstract data types
• Adding file server mount points
• Advanced constructs
• Advanced plugin routing
• Agent-master HTTPS communications
• Arrays
• Autosigning certificate requests
• Basic certificate autosigning
• Beginner's guide to writing modules
• Bolt tasks
• Booleans
• CSR attributes and certificate extensions
• Cache directory (vardir)
• Catalog
• Catalog compilation
• Certificate authority and SSL
• Certificate extensions
• Checking the values of settings
• Classes
• Code and data directory (codedir)
• Code comments
• Conditional statements and expressions
• Config directory (confdir)
• Configuration Reference
• Configure merge behavior in Hiera data
• Configuring Hiera
• Configuring Puppet
• Containment of resources
• Contributing to Puppet modules
• Core Facts
• Core types cheat sheet
• Creating and editing data
• Creating environments
• Creating templates using Embedded Puppet
• Creating templates using Embedded Ruby
• Custom Puppet functions
• Custom facts
• Custom facts walkthrough
• Custom fileserver mount points
• Custom functions
• Custom resources
• Data type syntax
• Default
• Defined resource types
• Details of complex behaviors
• Develop types and providers with the Resource API
• Documenting modules
• Documenting modules with Puppet Strings
• Editing settings on the command line
• Environment isolation
• Environments
• Environments
• Experimental features
• Exported resources
• Expressions and operators
• External CA
• External facts
• Facter
• Facter release notes
• Facts and built-in variables
• File Bucket File
• File Content
• File Metadata
• Files and paths on Windows
• Function calls
• Get started managing a DNS nameserver file
• Get started managing an NTP service
• Get started managing firewall rules
• Get started managing sudo privileges
• Getting started with Hiera
• Glossary
• Hashes
• Hiera
• Important directories and files
• Installing Puppet
• Installing agents
• Installing and managing modules from the command line
• Installing and upgrading
• Iteration and loops
• Iterative functions
• Key configuration settings
• Lambdas
• Language visual index
• List of built-in functions
• Looking up data with Hiera
• Low-level method for developing types and providers
• Main manifest directory
• Managing essential configuration with Puppet
• Metaparameter Reference
• Module cheat sheet
• Module fundamentals
• Module metadata
• Msgpack support
• Namespaces and autoloading
• Network hardware access
• Node
• Node definitions
• Numbers
• Optional resource types for Windows
• Overview
• PSON
• Per-environment settings
• Plug-ins in modules
• Provider development
• Publishing modules
• Puppet Server CA commands
• Puppet Strings style guide
• Puppet agent on *nix systems
• Puppet agent on Windows
• Puppet apply
• Puppet architecture
• Puppet commands
• Puppet device
• Puppet known issues
• Puppet language and code
• Puppet packages and versions
• Puppet release notes
• Puppet services and tools
• Puppet settings
• Puppet's configuration files
• Puppet's internals
• PuppetDB server locations
• Refactoring legacy 3.x functions
• Regenerating certificates in a Puppet deployment
• Regular expressions
• Relationships and ordering
• Release notes
• Report
• Report format
• Report reference
• Reporting
• Reserved words and acceptable names
• Resource API reference
• Resource Type Reference
• Resource and class references
• Resource collectors
• Resource default statements
• Resource types
• Resource types
• Resources
• Ruby function signatures
• Run stages
• Running Puppet commands on Windows
• SSL directory (ssldir)
• Schemas (JSON)
• Scope
• Secrets store integrations and agent-side data retrieval
• Sensitive
• Short names for cert extension OIDs
• Static catalogs
• Status
• Strings
• System requirements
• Tags
• Templates
• The Puppet language
• The Puppet language style guide
• The main config file
• The modulepath
• Time-related data types
• Tracking Puppet activity with reports
• Type aliases
• Type development
• Undef
• Upgrading
• Upgrading to Hiera 5
• Using exec on Windows
• Using file on Windows
• Using package on Windows
• Using service
• Using special features in implementation methods
• Using the Puppet platform
• Using user and group on Windows
• Values and data types
• Variables
• Virtual resources
• Welcome to Puppet 6.10
• Welcome to Puppet modules
• Write a Puppet function to store secrets
• Writing custom functions
• Writing custom functions in Ruby
• Writing custom report processors
• Writing external node classifiers
• Writing new data backends

Parameters

• alias
• audit
• before
• consume
• export
• loglevel
• noop
• notify
• require
• schedule
• stage
• subscribe
• tag

Reports

• http
• log
• store

Settings

• Configuring Facter with facter.conf
• agent_catalog_run_lockfile
• agent_disabled_lockfile
• allow_duplicate_certs
• always_retry_plugins
• autoflush
• autosign
• basemodulepath
• binder_config
• bucketdir
• ca_fingerprint
• ca_name
• ca_port
• ca_server
• ca_ttl
• cacert
• cacrl
• cadir
• cakey
• capub
• catalog_cache_terminus
• catalog_terminus
• cert_inventory
• certdir
• certificate_revocation
• certname
• classfile
• client_datadir
• clientbucketdir
• clientyamldir
• code
• codedir
• color
• confdir
• config
• config_file_name
• config_version
• configprint
• crl_refresh_interval
• csr_attributes
• csrdir
• daemonize
• data_binding_terminus
• default_file_terminus
• default_manifest
• default_schedules
• deviceconfdir
• deviceconfig
• devicedir
• diff
• diff_args
• digest_algorithm
• disable_i18n
• disable_per_environment_manifest
• disable_warnings
• dns_alt_names
• document_all
• environment
• environment_data_provider
• environment_timeout
• environmentpath
• evaltrace
• external_nodes
• factpath
• facts_terminus
• fileserverconfig
• filetimeout
• forge_authorization
• freeze_main
• func3x_check
• future_features
• genconfig
• genmanifest
• graph
• graphdir
• group
• hiera_config
• hostcert
• hostcrl
• hostcsr
• hostprivkey
• hostpubkey
• http_connect_timeout
• http_debug
• http_keepalive_timeout
• http_proxy_host
• http_proxy_password
• http_proxy_port
• http_proxy_user
• http_read_timeout
• http_user_agent
• ignoremissingtypes
• ignoreschedules
• key_type
• keylength
• lastrunfile
• lastrunreport
• ldapattrs
• ldapbase
• ldapclassattrs
• ldapparentattr
• ldappassword
• ldapport
• ldapserver
• ldapssl
• ldapstackedattrs
• ldapstring
• ldaptls
• ldapuser
• libdir
• localcacert
• localedest
• localesource
• log_level
• logdest
• logdir
• manage_internal_file_permissions
• manifest
• masterport
• max_deprecations
• max_errors
• max_warnings
• maximum_uid
• maxwaitforcert
• mkusers
• module_groups
• module_repository
• module_working_dir
• modulepath
• name
• named_curve
• no_proxy
• node_cache_terminus
• node_name
• node_name_fact
• node_name_value
• node_terminus
• noop
• onetime
• passfile
• path
• pidfile
• plugindest
• pluginfactdest
• pluginfactsource
• pluginsignore
• pluginsource
• postrun_command
• preferred_serialization_format
• prerun_command
• preview_outputdir
• priority
• privatedir
• privatekeydir
• profile
• publickeydir
• puppetdlog
• report
• report_port
• report_server
• reportdir
• reports
• reporturl
• requestdir
• resourcefile
• rest_authconfig
• rich_data
• route_file
• rundir
• runinterval
• runtimeout
• serial
• server
• server_datadir
• server_list
• show_diff
• signeddir
• skip_tags
• sourceaddress
• splay
• splaylimit
• srv_domain
• ssl_client_ca_auth
• ssl_client_header
• ssl_client_verify_header
• ssl_lockfile
• ssl_server_ca_auth
• ssldir
• statedir
• statefile
• statettl
• static_catalogs
• storeconfigs
• storeconfigs_backend
• strict
• strict_environment_mode
• strict_hostname_checking
• strict_variables
• summarize
• supported_checksum_types
• syslogfacility
• tags
• tasks
• trace
• transactionstorefile
• trusted_oid_mapping_file
• use_cached_catalog
• use_srv_records
• usecacheonfailure
• user
• vardir
• vendormoduledir
• waitforcert
• yamldir

Types

• exec
• file
• group
• notify
• package
• resources
• schedule
• service
• stage
• tidy
• user