Configuration Settings

A lock file to indicate that puppet agent runs have been administratively disabled. File contains a JSON object with state information.

• Default: $statedir/agent_disabled.lock

Whether to allow a new certificate request to overwrite an existing certificate.

• Default: false

Permit hyphens (-) in variable names and issue deprecation warnings about them. This setting should always be false; setting it to true will cause subtle and wide-ranging bugs. It will be removed in a future version. Hyphenated variables caused major problems in the language, but were allowed between Puppet 2.7.3 and 2.7.14. If you used them during this window, we apologize for the inconvenience --- you can temporarily set this to true in order to upgrade, and can rename your variables at your leisure. Please revert it to false after you have renamed all affected variables.

• Default: false

During an inspect run, the file bucket server to archive files to if archive_files is set.

• Default: $server

During an inspect run, whether to archive files whose contents are audited to a file bucket.

• Default: false

Whether to use a queueing system to provide asynchronous database integration. Requires that puppet queue be running.

• Default: false

Whether log files should always flush to disk.

• Default: true

Whether to enable autosign. Valid values are true (which autosigns any key request, and is a very bad idea), false (which never autosigns any key request), and the path to a file, which uses that configuration file to determine which keys to sign.

• Default: $confdir/autosign.conf

The address a listening server should bind to.

• Default: 0.0.0.0

Where FileBucket files are stored.

• Default: $vardir/bucket

Whether the master should function as a certificate authority.

• Default: true

The name to use the Certificate Authority certificate.

• Default: Puppet CA: $certname

The port to use for the certificate authority.

• Default: $masterport

The server to use for certificate authority requests. It´s a separate server because it cannot and does not need to horizontally scale.

• Default: $server

The default TTL for new certificates. If this setting is set, ca_days is ignored. Can be specified as a duration.

• Default: 5y

The CA certificate.

• Default: $cadir/ca_crt.pem

The certificate revocation list (CRL) for the CA. Will be used if present but otherwise ignored.

• Default: $cadir/ca_crl.pem

The root directory for the certificate authority.

• Default: $ssldir/ca

The CA private key.

• Default: $cadir/ca_key.pem

Where the CA stores the password for the private key

• Default: $caprivatedir/ca.pass

Where the CA stores private certificate information.

• Default: $cadir/private

The CA public key.

• Default: $cadir/ca_pub.pem

How to store cached catalogs. Valid values are ´json´ and ´yaml´. The agent application defaults to ´json´.

Default:

(Deprecated for ´preferred_serialization_format´) What format to use to dump the catalog. Only supports ´marshal´ and ´yaml´. Only matters on the client, since it asks the server for a specific format.

Where to get node catalogs. This is useful to change if, for instance, you´d like to pre-compile catalogs and store them in memcached or some other easily-accessed store.

• Default: compiler

A Complete listing of all certificates

• Default: $cadir/inventory.txt

The certificate directory.

• Default: $ssldir/certs

The certdnsnames setting is no longer functional, after CVE-2011-3872. We ignore the value completely. For your own certificate request you can set dns_alt_names in the configuration and it will apply locally. There is no configuration option to set DNS alt names, or any other subjectAltName value, for another nodes certificate. Alternately you can use the --dns_alt_names command line option to set the labels added while generating your own CSR.

The window of time leading up to a certificate´s expiration that a notification will be logged. This applies to CA, master, and agent certificates. Can be specified as a duration.

• Default: 60d

Whether certificate revocation should be supported by downloading a Certificate Revocation List (CRL) to all clients. If enabled, CA chaining will almost definitely not work.

• Default: true

The name to use when handling certificates. Defaults to the fully qualified domain name.

• Default: sirrus.puppetlabs.lan

The file in which puppet agent stores a list of the classes associated with the retrieved configuration. Can be loaded in the separate puppet executable using the --loadclasses option.

• Default: $statedir/classes.txt

The directory in which serialized data is stored on the client.

• Default: $vardir/client_data

Where FileBucket files are stored locally.

• Default: $vardir/clientbucket

The directory in which client-side YAML data is stored.

• Default: $vardir/client_yaml

Code to parse directly. This is essentially only used by puppet, and should only be set if you´re writing your own Puppet executable

Whether to use colors when logging to the console. Valid values are ansi (equivalent to true), html, and false, which produces no color. Defaults to false on Windows, as its console does not support ansi colors.

• Default: ansi

The main Puppet configuration directory. The default for this setting is calculated based on the user. If the process is running as root or the user that Puppet is supposed to run as, it defaults to a system directory, but if it´s running as any other user, it defaults to being in the user´s home directory.

• Default: /etc/puppet

The configuration file for the current puppet application

• Default: $confdir/${config_file_name}

The name of the puppet config file.

• Default: puppet.conf

How to determine the configuration version. By default, it will be the time that the configuration is parsed, but you can provide a shell script to override how the version is determined. The output of this script will be added to every log message in the reports, allowing you to correlate changes on your hosts to the source version on the server.

Print the value of a specific configuration setting. If the name of a setting is provided for this, then the value is printed and puppet exits. Comma-separate multiple values. For a list of all values, specify ´all´.

How long the client should wait for the configuration to be retrieved before considering it a failure. This can help reduce flapping if too many clients contact the server at one time. Can be specified as a duration.

• Default: 2m

The url where the puppet couchdb database will be created

• Default: http://127.0.0.1:5984/puppet

Where the CA stores certificate requests

• Default: $cadir/requests

Whether to send the process into the background. This defaults to true on POSIX systems, and to false on Windows (where Puppet currently cannot daemonize).

• Default: true

Where to retrive information about data.

• Default: hiera

The type of database to use.

• Default: sqlite3

The number of database connections for networked databases. Will be ignored unless the value is a positive integer.

The database cache for client configurations. Used for querying within the language.

• Default: $statedir/clientconfigs.sqlite3

Whether to automatically migrate the database.

• Default: false

The name of the database to use.

• Default: puppet

The database password for caching. Only used when networked databases are used.

• Default: puppet

The database password for caching. Only used when networked databases are used.

The database server for caching. Only used when networked databases are used.

• Default: localhost

The database socket location. Only used when networked databases are used. Will be ignored if the value is an empty string.

The database user for caching. Only used when networked databases are used.

• Default: puppet

The default source for files if no server is given in a uri, e.g. puppet:///file. The default of rest causes the file to be retrieved using the server setting. When running apply the default is file_server, causing requests to be filled locally.

• Default: rest

Path to the device config file for puppet device

• Default: $confdir/device.conf

The root directory of devices´ $vardir

• Default: $vardir/devices

Which diff command to use when printing differences between files. This setting has no default value on Windows, as standard diff is not available, but Puppet can use many third-party diff tools.

• Default: diff

Which arguments to pass to the diff command when printing differences between files. The command to use can be chosen with the diff setting.

• Default: -u

The comma-separated list of alternative DNS names to use for the local host. When the node generates a CSR for itself, these are added to the request as the desired subjectAltName in the certificate: additional DNS labels that the certificate is also valid answering as. This is generally required if you use a non-hostname certname, or if you want to use puppet kick or puppet resource -H and the primary certname does not match the DNS name you use to communicate with the host. This is unnecessary for agents, unless you intend to use them as a server for puppet kick or remote puppet resource management. It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names.

Document all resources

• Default: false

(Deprecated) Facts that are dynamic; these facts will be ignored when deciding whether changed facts should result in a recompile. Multiple facts should be comma-separated.

• Default: memorysize,memoryfree,swapsize,swapfree

The environment Puppet is running in. For clients (e.g., puppet agent) this determines the environment itself, which is used to find modules and much more. For servers (i.e., puppet master) this provides the default environment for nodes we know nothing about.

• Default: production

Whether each resource should log when it is being evaluated. This allows you to interactively see exactly what is being done.

• Default: false

An external command that can produce node information. The command´s output must be a YAML dump of a hash, and that hash must have a classes key and/or a parameters key, where classes is an array or hash and parameters is a hash. For unknown nodes, the command should exit with a non-zero exit code. This command makes it straightforward to store your node mapping information in other data sources like databases.

• Default: none

Where Puppet should look for facts. Multiple directories should be separated by the system path separator character. (The POSIX path separator is ´:´, and the Windows path separator is ´;´.)

• Default: $vardir/lib/facter:$vardir/facts

The node facts terminus.

• Default: facter

Where the fileserver configuration is stored.

• Default: $confdir/fileserver.conf

The minimum time to wait between checking for updates in configuration files. This timeout determines how quickly Puppet checks whether a file (such as manifests or templates) has changed on disk. Can be specified as a duration.

• Default: 15s

Freezes the ´main´ class, disallowing any code to be added to it. This essentially means that you can´t have any code outside of a node, class, or definition other than in the site manifest.

• Default: false

Whether to just print a configuration to stdout and exit. Only makes sense when used interactively. Takes into account arguments specified on the CLI.

• Default: false

Whether to just print a manifest to stdout and exit. Only makes sense when used interactively. Takes into account arguments specified on the CLI.

• Default: false

Whether to create dot graph files for the different configuration graphs. These dot files can be interpreted by tools like OmniGraffle or dot (which is part of ImageMagick).

• Default: false

Where to store dot-outputted graphs.

• Default: $statedir/graphs

The group puppet master should run as.

• Default: puppet

The hiera configuration file

• Default: $confdir/hiera.yaml

Where individual hosts store and look for their certificates.

• Default: $certdir/$certname.pem

Where the host´s certificate revocation list can be found. This is distinct from the certificate authority´s CRL.

• Default: $ssldir/crl.pem

Where individual hosts store and look for their certificate requests.

• Default: $ssldir/csr_$certname.pem

Where individual hosts store and look for their private key.

• Default: $privatekeydir/$certname.pem

Where individual hosts store and look for their public key.

• Default: $publickeydir/$certname.pem

Allow http compression in REST communication with the master. This setting might improve performance for agent -> master communications over slow WANs. Your puppet master needs to support compression (usually by activating some settings in a reverse-proxy in front of the puppet master, which rules out webrick). It is harmless to activate this settings if your master doesn´t support compression, but if it supports it, this setting might reduce performance on high-speed LANs.

• Default: false

The HTTP proxy host to use for outgoing connections. Note: You may need to use a FQDN for the server hostname when using a proxy.

• Default: none

The HTTP proxy port to use for outgoing connections

• Default: 3128

Where the puppet agent web server logs.

• Default: $logdir/http.log

Ignore cache and always recompile the configuration. This is useful for testing new configurations, where the local cache may in fact be stale even if the timestamps are up to date - if the facts change or if the server changes.

• Default: false

If true, allows the parser to continue without requiring all files referenced with import statements to exist. This setting was primarily designed for use with commit hooks for parse-checking.

• Default: false

Boolean; whether puppet agent should ignore schedules. This is useful for initial puppet agent runs.

• Default: false

The port to communicate with the inventory_server.

• Default: $masterport

The server to send facts to.

• Default: $server

Should usually be the same as the facts terminus

• Default: $facts_terminus

The bit length of keys.

• Default: 4096

Where puppet agent stores the last run report summary in yaml format.

• Default: $statedir/last_run_summary.yaml

Where puppet agent stores the last run report in yaml format.

• Default: $statedir/last_run_report.yaml

The LDAP attributes to include when querying LDAP for nodes. All returned attributes are set as variables in the top-level scope. Multiple values should be comma-separated. The value ´all´ returns all attributes.

• Default: all

The search base for LDAP searches. It´s impossible to provide a meaningful default here, although the LDAP libraries might have one already set. Generally, it should be the ´ou=Hosts´ branch under your main directory.

The LDAP attributes to use to define Puppet classes. Values should be comma-separated.

• Default: puppetclass

The attribute to use to define the parent node.

• Default: parentnode

The password to use to connect to LDAP.

The LDAP port. Only used if node_terminus is set to ldap.

• Default: 389

The LDAP server. Only used if node_terminus is set to ldap.

• Default: ldap

Whether SSL should be used when searching for nodes. Defaults to false because SSL usually requires certificates to be set up on the client side.

• Default: false

The LDAP attributes that should be stacked to arrays by adding the values in all hierarchy elements of the tree. Values should be comma-separated.

• Default: puppetvar

The search string used to find an LDAP node.

• Default: (&(objectclass=puppetClient)(cn=%s))

Whether TLS should be used when searching for nodes. Defaults to false because TLS usually requires certificates to be set up on the client side.

• Default: false

The user to use to connect to LDAP. Must be specified as a full DN.

An extra search path for Puppet. This is only useful for those files that Puppet will load on demand, and is only guaranteed to work for those cases. In fact, the autoload mechanism is responsible for making sure this directory is in Ruby´s search path

• Default: $vardir/lib

Whether puppet agent should listen for connections. If this is true, then puppet agent will accept incoming REST API requests, subject to the default ACLs and the ACLs set in the rest_authconfig file. Puppet agent can respond usefully to requests on the run, facts, certificate, and resource endpoints.

• Default: false

Where each client stores the CA certificate.

• Default: $certdir/ca.pem

Where puppet agent caches the local configuration. An extension indicating the cache format is added automatically.

• Default: $statedir/localconfig

The directory in which to store log files

Default:

Whether Puppet should manage the owner, group, and mode of files it uses internally

• Default: true

The entry-point manifest for puppet master.

• Default: $manifestdir/site.pp

Where puppet master looks for its manifests.

• Default: $confdir/manifests

Where the puppet master web server logs.

• Default: $logdir/masterhttp.log

Where puppet master logs. This is generally not used, since syslog is the default log destination.

• Default: $logdir/puppetmaster.log

Which port puppet master listens on.

• Default: 8140

The maximum allowed UID. Some platforms use negative UIDs but then ship with tools that do not know how to handle signed ints, so the UIDs show up as huge numbers that can then not be fed back into the system. This is a hackish way to fail in a slightly more useful way when that happens.

• Default: 4294967290

Whether to create the necessary user and group that puppet agent will run as.

• Default: false

The module repository

• Default: https://forge.puppetlabs.com

The directory into which module tool data is stored

• Default: $vardir/puppet-module

The search path for modules, as a list of directories separated by the system path separator character. (The POSIX path separator is ´:´, and the Windows path separator is ´;´.)

• Default: $confdir/modules:/usr/share/puppet/modules

The name of the application, if we are running as one. The default is essentially $0 without the path or .rb.

Default:

How to store cached nodes. Valid values are (none), ´json´, ´yaml´ or write only yaml (´write_only_yaml´). The master application defaults to ´write_only_yaml´, all others to none.

Default:

How the puppet master determines the client´s identity and sets the ´hostname´, ´fqdn´ and ´domain´ facts for use in the manifest, in particular for determining which ´node´ statement applies to the client. Possible values are ´cert´ (use the subject´s CN in the client´s certificate) and ´facter´ (use the hostname that the client reported in its facts)

• Default: cert

The fact name used to determine the node name used for all requests the agent makes to the master. WARNING: This setting is mutually exclusive with node_name_value. Changing this setting also requires changes to the default auth.conf configuration on the Puppet Master. Please see http://links.puppetlabs.com/node_name_fact for more information.

The explicit value used for the node name for all requests the agent makes to the master. WARNING: This setting is mutually exclusive with node_name_fact. Changing this setting also requires changes to the default auth.conf configuration on the Puppet Master. Please see http://links.puppetlabs.com/node_name_value for more information.

• Default: $certname

Where to find information about nodes.

• Default: plain

Whether puppet agent should be run in noop mode.

• Default: false

Run the configuration once, rather than as a long-running daemon. This is useful for interactively running puppetd.

• Default: false

Where puppet agent stores the password for its private key. Generally unused.

• Default: $privatedir/password

The shell search path. Defaults to whatever is inherited from the parent process.

• Default: none

The file containing the PID of a running process. This file is intended to be used by service management frameworks and monitoring systems to determine if a puppet process is still in the process table.

• Default: $rundir/${run_mode}.pid

Where Puppet should store plugins that it pulls down from the central server.

• Default: $libdir

What files to ignore when pulling down plugins.

• Default: .svn CVS .git

From where to retrieve plugins. The standard Puppet file type is used for retrieval, so anything that is a valid file source can be used here.

• Default: puppet://$server/plugins

Whether plugins should be synced with the central server.

• Default: true

A command to run after every agent run. If this command returns a non-zero return code, the entire Puppet run will be considered to have failed, even though it might have performed work during the normal run.

The preferred means of serializing ruby instances for passing over the wire. This won´t guarantee that all instances will be serialized using this method, since not all classes can be guaranteed to support this format, but it will be used for all classes that support it.

• Default: pson

A command to run before every agent run. If this command returns a non-zero return code, the entire Puppet run will fail.

Where the client stores private certificate information.

• Default: $ssldir/private

The private key directory.

• Default: $ssldir/private_keys

The public key directory.

• Default: $ssldir/public_keys

The log file for puppet agent. This is generally not used.

• Default: $logdir/puppetd.log

Which port puppet agent listens on.

• Default: 8139

Which type of queue to use for asynchronous processing. If your stomp server requires authentication, you can include it in the URI as long as your stomp client library is at least 1.1.1

• Default: stomp://localhost:61613/

Which type of queue to use for asynchronous processing.

• Default: stomp

The log level for Rails connections. The value must be a valid log level within Rails. Production environments normally use info and other environments normally use debug.

• Default: info

Where Rails-specific logs are sent

• Default: $logdir/rails.log

Whether to send reports after every transaction.

• Default: true

The port to communicate with the report_server.

• Default: $masterport

The server to send transaction reports to.

• Default: $server

The directory in which to store reports received from the client. Each client gets a separate subdirectory.

• Default: $vardir/reports

The ´from´ email address for the reports.

• Default: report@sirrus.puppetlabs.lan

The list of reports to generate. All reports are looked for in puppet/reports/name.rb, and multiple report names should be comma-separated (whitespace is okay).

• Default: store

The URL used by the http reports processor to send reports

• Default: http://localhost:3000/reports/upload

The bit length of the certificates.

• Default: 4096

Where host certificate requests are stored.

• Default: $ssldir/certificate_requests

The file in which puppet agent stores a list of the resources associated with the retrieved configuration.

• Default: $statedir/resources.txt

The configuration file that defines the rights to the different rest indirections. This can be used as a fine-grained authorization system for puppet master.

• Default: $confdir/auth.conf

The YAML file containing indirector route configuration.

• Default: $confdir/routes.yaml

The directory where RRD database files are stored. Directories for each reporting host will be created under this directory.

• Default: $vardir/rrd

How often RRD should expect data. This should match how often the hosts report back to the server. Can be specified as a duration.

• Default: $runinterval

Where Puppet PID files are kept.

Default:

How often puppet agent applies the client configuration; in seconds. Note that a runinterval of 0 means "run continuously" rather than "never run." If you want puppet agent to never run, you should start it with the --no-client option. Can be specified as a duration.

• Default: 30m

Where to find the sendmail binary with which to send email.

• Default: /usr/sbin/sendmail

Where the serial number for certificates is stored.

• Default: $cadir/serial

The server to which the puppet agent should connect

• Default: puppet

The directory in which serialized data is stored, usually in a subdirectory.

• Default: $vardir/server_data

Whether to log and report a contextual diff when files are being replaced. This causes partial file contents to pass through Puppet´s normal logging and reporting system, so this setting should be used with caution if you are sending Puppet´s reports to an insecure destination. This feature currently requires the diff/lcs Ruby library.

• Default: false

Where the CA stores signed certificates.

• Default: $cadir/signed

The server through which to send email reports.

• Default: none

Whether to sleep for a pseudo-random (but consistent) amount of time before a run.

• Default: false

The maximum time to delay before runs. Defaults to being the same as the run interval. Can be specified as a duration.

• Default: $runinterval

The domain which will be queried to find the SRV records of servers to use.

• Default: puppetlabs.lan

Certificate authorities who issue server certificates. SSL servers will not be considered authentic unless they posses a certificate issued by an authority listed in this file. If this setting has no value then the Puppet master´s CA certificate (localcacert) will be used.

Default:

The header containing an authenticated client´s SSL DN. This header must be set by the proxy to the authenticated client´s SSL DN (e.g., /CN=puppet.puppetlabs.com).

• Default: HTTP_X_CLIENT_DN

The header containing the status message of the client verification. This header must be set by the proxy to ´SUCCESS´ if the client successfully authenticated, and anything else otherwise.

• Default: HTTP_X_CLIENT_VERIFY

Certificate authorities who issue client certificates. SSL clients will not be considered authentic unless they posses a certificate issued by an authority listed in this file. If this setting has no value then the Puppet master´s CA certificate (localcacert) will be used.

Default:

Where SSL certificates are kept.

• Default: $confdir/ssl

The directory where Puppet state is stored. Generally, this directory can be removed without causing harm (although it might result in spurious service restarts).

• Default: $vardir/state

Where puppet agent and puppet master store state associated with the running configuration. In the case of puppet master, this file reflects the state discovered through interacting with clients.

• Default: $statedir/state.yaml

Whether to store each client´s configuration, including catalogs, facts, and related data. This also enables the import and export of resources in the Puppet language - a mechanism for exchange resources between nodes. By default this uses ActiveRecord and an SQL database to store and query the data; this, in turn, will depend on Rails being available. You can adjust the backend using the storeconfigs_backend setting.

• Default: false

Configure the backend terminus used for StoreConfigs. By default, this uses the ActiveRecord store, which directly talks to the database from within the Puppet Master process.

• Default: active_record

Whether to only search for the complete hostname as it is in the certificate when searching for node information in the catalogs.

• Default: false

Whether to print a transaction summary.

• Default: false

What syslog facility to use when logging to syslog. Syslog has a fixed list of valid facilities, and you must choose one of those; you cannot just make one up.

• Default: daemon

The mapping between reporting tags and email addresses.

• Default: $confdir/tagmail.conf

Tags to use to find resources. If this is set, then only resources tagged with the specified tags will be applied. Values must be comma-separated.

Where Puppet looks for template files. Can be a list of colon-separated directories.

• Default: $vardir/templates

Boolean; whether Puppet should store only facts and exported resources in the storeconfigs database. This will improve the performance of exported resources with the older active_record backend, but will disable external tools that search the storeconfigs database. Thinning catalogs is generally unnecessary when using PuppetDB to store catalogs.

• Default: false

Whether to print stack traces on some errors

• Default: false

Whether to only use the cached catalog rather than compiling a new catalog on every run. Puppet can be run with this enabled by default and then selectively disabled when a recompile is desired.

• Default: false

Whether the server will search for SRV records in DNS for the current domain.

• Default: false

Whether to use the cached configuration when the remote configuration will not compile. This option is useful for testing new configurations, where you want to fix the broken configuration rather than reverting to a known-good one.

• Default: true

The user puppet master should run as.

• Default: puppet

Where Puppet stores dynamic and growing data. The default for this setting is calculated specially, like confdir_.

• Default: /var/lib/puppet

The time interval ´puppet agent´ should connect to the server and ask it to sign a certificate request. This is useful for the initial setup of a puppet client. You can turn off waiting for certificates by specifying a time of 0. Can be specified as a duration.

• Default: 2m

The directory in which YAML data is stored, usually in a subdirectory.

• Default: $vardir/yaml

Boolean; whether to use the zlib library

• Default: true

This page autogenerated on Tue Jan 15 12:33:09 -0800 2013