path: root/man/man8/puppet.conf.8

.TH Configuration Reference  "" "" ""
.SH NAME
Configuration Reference \-

.\" Man page generated from reStructeredText.
This page is autogenerated; any changes will get overwritten
.I (last generated on Mon May 05 09:33:01 +1000 2008)



.\" topic: Contents
.\"
.\" Specifying Configuration Parameters
.\"
.\" Signals
.\"
.\" Configuration Parameter Reference

.SH Specifying Configuration Parameters

.SS On The Command\-Line
Every Puppet executable (with the exception of
.\" visit_literal
puppetdoc
.\" depart_literal
) accepts all of
the parameters below, but not all of the arguments make sense for every executable.
Each parameter has a section listed with it in parentheses; often, that section
will map to an executable (e.g.,
.\" visit_literal
puppetd
.\" depart_literal
), in which case it probably only
makes sense for that one executable.  If
.\" visit_literal
main
.\" depart_literal
 is listed as the section,
it is most likely an option that is valid for everyone.

I have tried to be as thorough as possible in the descriptions of the
arguments, so it should be obvious whether an argument is appropriate or not.

These parameters can be supplied to the executables either as command\-line
options or in the configuration file.  For instance, the command\-line
invocation below would set the configuration directory to
.\" visit_literal
/private/puppet
.\" depart_literal
:


.nf
$ puppetd \-\-confdir=/private/puppet
.fi
Note that boolean options are turned on and off with a slightly different
syntax on the command line:


.nf
$ puppetd \-\-storeconfigs

$ puppetd \-\-no\-storeconfigs
.fi
The invocations above will enable and disable, respectively, the storage of
the client configuration.


.SS Configuration Files
As mentioned above, the configuration parameters can also be stored in a
configuration file, located in the configuration directory.  As root, the
default configuration directory is
.\" visit_literal
/etc/puppet
.\" depart_literal
, and as a regular user, the
default configuration directory is
.\" visit_literal
~user/.puppet
.\" depart_literal
.  As of 0.23.0, all
executables look for
.\" visit_literal
puppet.conf
.\" depart_literal
 in their configuration directory
(although they previously looked for separate files).  For example,

.\" visit_literal
puppet.conf
.\" depart_literal
 is located at
.\" visit_literal
/etc/puppet/puppet.conf
.\" depart_literal
 as root and

.\" visit_literal
~user/.puppet/puppet.conf
.\" depart_literal
 as a regular user by default.

All executables will set any parameters set within the
.\" visit_literal
main
.\" depart_literal
 section,
while each executable will also look for a section named for the executable
and load those parameters.  For example,
.\" visit_literal
puppetd
.\" depart_literal
 will look for a
section named
.\" visit_literal
puppetd
.\" depart_literal
, and
.\" visit_literal
puppetmasterd
.\" depart_literal
 looks for a section
named
.\" visit_literal
puppetmasterd
.\" depart_literal
.  This allows you to use a single configuration file
to customize the settings for all of your executables.


.SS File Format
The file follows INI\-style formatting.  Here is an example of a very simple

.\" visit_literal
puppet.conf
.\" depart_literal
 file:


.nf
[main]
    confdir = /private/puppet
    storeconfigs = true
.fi
Note that boolean parameters must be explicitly specified as
.I true
 or

.I false
 as seen above.

If you need to change file parameters (e.g., reset the mode or owner), do
so within curly braces on the same line:


.nf
[main]
    myfile = /tmp/whatever {owner = root, mode = 644}
.fi
If you\'re starting out with a fresh configuration, you may wish to let
the executable generate a template configuration file for you by invoking
the executable in question with the
.I \-\-genconfig
 command.  The executable
will print a template configuration to standard output, which can be
redirected to a file like so:


.nf
$ puppetd \-\-genconfig > /etc/puppet/puppet.conf
.fi
Note that this invocation will replace the contents of any pre\-existing

.I puppet.conf
 file, so make a backup of your present config if it contains
valuable information.

All parameters will be under a single section heading matching the name of
the process used to generate the configuraiton (\'puppetd\', in this case).

Like the
.I \-\-genconfig
 argument, the executables also accept a
.I \-\-genmanifest

argument, which will generate a manifest that can be used to manage all of
Puppet\'s directories and files and prints it to standard output.  This can
likewise be redirected to a file:


.nf
$ puppetd \-\-genmanifest > /etc/puppet/manifests/site.pp
.fi
Puppet can also create user and group accounts for itself (one
.I puppet
 group
and one
.I puppet
 user) if it is invoked as
.I root
 with the
.I \-\-mkusers
 argument:


.nf
$ puppetd \-\-mkusers
.fi

.SH Signals
The
.\" visit_literal
puppetd
.\" depart_literal
 and
.\" visit_literal
puppetmasterd
.\" depart_literal
 executables catch some signals for special
handling.  Both daemons catch (
.\" visit_literal
SIGHUP
.\" depart_literal
), which forces the server to restart
tself.  Predictably, interrupt and terminate (
.\" visit_literal
SIGINT
.\" depart_literal
 and
.\" visit_literal
SIGHUP
.\" depart_literal
) will shut
down the server, whether it be an instance of
.\" visit_literal
puppetd
.\" depart_literal
 or
.\" visit_literal
puppetmasterd
.\" depart_literal
.

Sending the
.\" visit_literal
SIGUSR1
.\" depart_literal
 signal to an instance of
.\" visit_literal
puppetd
.\" depart_literal
 will cause it to
immediately begin a new configuration transaction with the server.  This
signal has no effect on
.\" visit_literal
puppetmasterd
.\" depart_literal
.


.SH Configuration Parameter Reference
Below is a list of all documented parameters.  Not all of them are valid with all
Puppet executables, but the executables will ignore any inappropriate values.


.SS authconfig
The configuration file that defines the rights to the different namespaces and methods.  This can be used as a coarse\-grained authorization system for both
.\" visit_literal
puppetd
.\" depart_literal
 and
.\" visit_literal
puppetmasterd
.\" depart_literal
.


.TP 2
\(bu
Default: $confdir/namespaceauth.conf


.SS autoflush
Whether log files should always flush to disk.


.TP 2
\(bu
Default: false


.SS autosign
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.


.TP 2
\(bu
Default: $confdir/autosign.conf


.SS bindaddress
The address to bind to.  Mongrel servers default to 127.0.0.1 and WEBrick defaults to 0.0.0.0.


.SS bucketdir
Where FileBucket files are stored.


.TP 2
\(bu
Default: $vardir/bucket


.SS ca
Wether the master should function as a certificate authority.


.TP 2
\(bu
Default: true


.SS ca_days
How long a certificate should be valid.  This parameter is deprecated, use ca_ttl instead


.SS ca_md
The type of hash used in certificates.


.TP 2
\(bu
Default: md5


.SS ca_port
The port to use for the certificate authority.


.TP 2
\(bu
Default: $masterport


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


.TP 2
\(bu
Default: $server


.SS ca_ttl
The default TTL for new certificates; valid values  must be an integer, optionally followed by one of the units  \'y\' (years of 365 days), \'d\' (days), \'h\' (hours), or  \'s\' (seconds). The unit defaults to seconds. If this parameter is set, ca_days is ignored. Examples are \'3600\' (one hour)  and \'1825d\', which is the same as \'5y\' (5 years)


.TP 2
\(bu
Default: 5y


.SS cacert
The CA certificate.


.TP 2
\(bu
Default: $cadir/ca_crt.pem


.SS cacrl
The certificate revocation list (CRL) for the CA. Set this to \'false\' if you do not want to use a CRL.


.TP 2
\(bu
Default: $cadir/ca_crl.pem


.SS cadir
The root directory for the certificate authority.


.TP 2
\(bu
Default: $ssldir/ca


.SS cakey
The CA private key.


.TP 2
\(bu
Default: $cadir/ca_key.pem


.SS capass
Where the CA stores the password for the private key


.TP 2
\(bu
Default: $caprivatedir/ca.pass


.SS caprivatedir
Where the CA stores private certificate information.


.TP 2
\(bu
Default: $cadir/private


.SS capub
The CA public key.


.TP 2
\(bu
Default: $cadir/ca_pub.pem


.SS casesensitive
Whether matching in case statements and selectors should be case\-sensitive.  Case insensitivity is handled by downcasing all values before comparison.


.TP 2
\(bu
Default: false


.SS cert_inventory
A Complete listing of all certificates


.TP 2
\(bu
Default: $cadir/inventory.txt


.SS certdir
The certificate directory.


.TP 2
\(bu
Default: $ssldir/certs


.SS certdnsnames
The DNS names on the Server certificate as a colon\-separated list. If it\'s anything other than an empty string, it will be used as an alias in the created certificate.  By default, only the server gets an alias set up, and only for \'puppet\'.


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


.TP 2
\(bu
Default: absinthe.lovedthanlost.net


.SS classfile
The file in which puppetd stores a list of the classes associated with the retrieved configuration.  Can be loaded in the separate
.\" visit_literal
puppet
.\" depart_literal
 executable using the
.\" visit_literal
\-\-loadclasses
.\" depart_literal
 option.


.TP 2
\(bu
Default: $statedir/classes.txt


.SS clientbucketdir
Where FileBucket files are stored locally.


.TP 2
\(bu
Default: $vardir/clientbucket


.SS code
Code to parse directly.  This is essentially only used by
.\" visit_literal
puppet
.\" depart_literal
, and should only be set if you\'re writing your own Puppet executable


.SS color
Whether to use colors when logging to the console. Valid values are
.\" visit_literal
ansi
.\" depart_literal
 (equivalent to
.\" visit_literal
true
.\" depart_literal
),
.\" visit_literal
html
.\" depart_literal
 (mostly used during testing with TextMate), and
.\" visit_literal
false
.\" depart_literal
, which produces no color.


.TP 2
\(bu
Default: ansi


.SS confdir
The main Puppet configuration directory.  The default for this parameter is calculated based on the user.  If the process is runnig as root or the user that
.\" visit_literal
puppetmasterd
.\" depart_literal
 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
.\" visit_literal
~
.\" depart_literal
.


.TP 2
\(bu
Default: /etc/puppet


.SS config
The configuration file for puppetdoc.


.TP 2
\(bu
Default: $confdir/puppet.conf


.SS configprint
Print the value of a specific configuration parameter.  If a parameter is provided for this, then the value is printed and puppet exits.  Comma\-separate multiple values.  For a list of all values, specify \'all\'.  This feature is only available in Puppet versions higher than 0.18.4.


.SS configtimeout
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.


.TP 2
\(bu
Default: 120


.SS csrdir
Where the CA stores certificate requests


.TP 2
\(bu
Default: $cadir/requests


.SS daemonize
Send the process into the background.  This is the default.


.TP 2
\(bu
Default: true


.SS dbadapter
The type of database to use.


.TP 2
\(bu
Default: sqlite3


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


.TP 2
\(bu
Default: $statedir/clientconfigs.sqlite3


.SS dbmigrate
Whether to automatically migrate the database.


.TP 2
\(bu
Default: false


.SS dbname
The name of the database to use.


.TP 2
\(bu
Default: puppet


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


.TP 2
\(bu
Default: puppet


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


.TP 2
\(bu
Default: localhost


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


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


.TP 2
\(bu
Default: puppet


.SS diff
Which diff command to use when printing differences between files.


.TP 2
\(bu
Default: diff


.SS diff_args
Which arguments to pass to the diff command when printing differences between files.


.SS downcasefacts
Whether facts should be made all lowercase when sent to the server.


.TP 2
\(bu
Default: false


.SS dynamicfacts
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.


.TP 2
\(bu
Default: memorysize,memoryfree,swapsize,swapfree


.SS environment
The environment Puppet is running in.  For clients (e.g.,
.\" visit_literal
puppetd
.\" depart_literal
) this determines the environment itself, which is used to find modules and much more.  For servers (i.e.,
.\" visit_literal
puppetmasterd
.\" depart_literal
) this provides the default environment for nodes we know nothing about.


.TP 2
\(bu
Default: production


.SS environments
The valid environments for Puppet clients. This is more useful as a server\-side setting than client, but any environment chosen must be in this list.  Values should be separated by a comma.


.TP 2
\(bu
Default: production,development


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


.TP 2
\(bu
Default: false


.SS external_nodes
An external command that can produce node information.  The output must be a YAML dump of a hash, and that hash must have one or both of
.\" visit_literal
classes
.\" depart_literal
 and
.\" visit_literal
parameters
.\" depart_literal
, where
.\" visit_literal
classes
.\" depart_literal
 is an array and
.\" visit_literal
parameters
.\" depart_literal
 is a hash.  For unknown nodes, the commands 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.


.TP 2
\(bu
Default: none


.SS factdest
Where Puppet should store facts that it pulls down from the central server.


.TP 2
\(bu
Default: $vardir/facts


.SS factpath
Where Puppet should look for facts.  Multiple directories should be colon\-separated, like normal PATH variables.


.TP 2
\(bu
Default: $vardir/facts


.SS factsignore
What files to ignore when pulling down facts.


.TP 2
\(bu
Default: .svn CVS


.SS factsource
From where to retrieve facts.  The standard Puppet
.\" visit_literal
file
.\" depart_literal
 type is used for retrieval, so anything that is a valid file source can be used here.


.TP 2
\(bu
Default: puppet://$server/facts


.SS factsync
Whether facts should be synced with the central server.


.TP 2
\(bu
Default: false


.SS fileserverconfig
Where the fileserver configuration is stored.


.TP 2
\(bu
Default: $confdir/fileserver.conf


.SS filetimeout
The minimum time to wait (in seconds) 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.


.TP 2
\(bu
Default: 15


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


.TP 2
\(bu
Default: false


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


.TP 2
\(bu
Default: false


.SS graph
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).


.TP 2
\(bu
Default: false


.SS graphdir
Where to store dot\-outputted graphs.


.TP 2
\(bu
Default: $statedir/graphs


.SS group
The group puppetmasterd should run as.


.TP 2
\(bu
Default: puppet


.SS hostcert
Where individual hosts store and look for their certificates.


.TP 2
\(bu
Default: $certdir/$certname.pem


.SS hostcsr
Where individual hosts store and look for their certificates.


.TP 2
\(bu
Default: $ssldir/csr_$certname.pem


.SS hostprivkey
Where individual hosts store and look for their private key.


.TP 2
\(bu
Default: $privatekeydir/$certname.pem


.SS hostpubkey
Where individual hosts store and look for their public key.


.TP 2
\(bu
Default: $publickeydir/$certname.pem


.SS http_enable_post_connection_check
Boolean; wheter or not puppetd should validate the server SSL certificate against the request hostname.


.TP 2
\(bu
Default: true


.SS http_proxy_host
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.


.TP 2
\(bu
Default: none


.SS http_proxy_port
The HTTP proxy port to use for outgoing connections


.TP 2
\(bu
Default: 3128


.SS httplog
Where the puppetd web server logs.


.TP 2
\(bu
Default: $logdir/http.log


.SS ignorecache
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.


.TP 2
\(bu
Default: false


.SS ignoreimport
A parameter that can be used in commit hooks, since it enables you to parse\-check a single file rather than requiring that all files exist.


.TP 2
\(bu
Default: false


.SS ignoreschedules
Boolean; whether puppetd should ignore schedules.  This is useful for initial puppetd runs.


.TP 2
\(bu
Default: false


.SS keylength
The bit length of keys.


.TP 2
\(bu
Default: 1024


.SS ldapattrs
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.


.TP 2
\(bu
Default: all


.SS ldapbase
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.


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


.TP 2
\(bu
Default: puppetclass


.SS ldapnodes
Whether to search for node configurations in LDAP.  See http://reductivelabs.com/puppet/trac/wiki/LdapNodes/ for more information.


.TP 2
\(bu
Default: false


.SS ldapparentattr
The attribute to use to define the parent node.


.TP 2
\(bu
Default: parentnode


.SS ldappassword
The password to use to connect to LDAP.


.SS ldapport
The LDAP port.  Only used if
.\" visit_literal
ldapnodes
.\" depart_literal
 is enabled.


.TP 2
\(bu
Default: 389


.SS ldapserver
The LDAP server.  Only used if
.\" visit_literal
ldapnodes
.\" depart_literal
 is enabled.


.TP 2
\(bu
Default: ldap


.SS ldapssl
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.


.TP 2
\(bu
Default: false


.SS ldapstring
The search string used to find an LDAP node.


.TP 2
\(bu
Default: (&(objectclass=puppetClient)(cn=%s))


.SS ldaptls
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.


.TP 2
\(bu
Default: false


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


.SS lexical
Whether to use lexical scoping (vs. dynamic).


.TP 2
\(bu
Default: false


.SS libdir
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


.TP 2
\(bu
Default: $vardir/lib


.SS listen
Whether puppetd should listen for connections.  If this is true, then by default only the
.\" visit_literal
runner
.\" depart_literal
 server is started, which allows remote authorized and authenticated nodes to connect and trigger
.\" visit_literal
puppetd
.\" depart_literal
 runs.


.TP 2
\(bu
Default: false


.SS localcacert
Where each client stores the CA certificate.


.TP 2
\(bu
Default: $certdir/ca.pem


.SS localconfig
Where puppetd caches the local configuration.  An extension indicating the cache format is added automatically.


.TP 2
\(bu
Default: $statedir/localconfig


.SS logdir
The Puppet log directory.


.TP 2
\(bu
Default: $vardir/log


.SS manifest
The entry\-point manifest for puppetmasterd.


.TP 2
\(bu
Default: $manifestdir/site.pp


.SS manifestdir
Where puppetmasterd looks for its manifests.


.TP 2
\(bu
Default: $confdir/manifests


.SS masterhttplog
Where the puppetmasterd web server logs.


.TP 2
\(bu
Default: $logdir/masterhttp.log


.SS masterlog
Where puppetmasterd logs.  This is generally not used, since syslog is the default log destination.


.TP 2
\(bu
Default: $logdir/puppetmaster.log


.SS masterport
Which port puppetmasterd listens on.


.TP 2
\(bu
Default: 8140


.SS maximum_uid
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.


.TP 2
\(bu
Default: 4294967290


.SS mkusers
Whether to create the necessary user and group that puppetd will run as.


.TP 2
\(bu
Default: false


.SS modulepath
The search path for modules as a colon\-separated list of directories.


.TP 2
\(bu
Default: $confdir/modules:/usr/share/puppet/modules


.SS name
The name of the service, if we are running as one.  The default is essentially $0 without the path or
.\" visit_literal
.rb
.\" depart_literal
.


.TP 2
\(bu
Default: puppetdoc


.SS node_name
How the puppetmaster 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)


.TP 2
\(bu
Default: cert


.SS node_terminus
Where to find information about nodes.


.TP 2
\(bu
Default: plain


.SS noop
Whether puppetd should be run in noop mode.


.TP 2
\(bu
Default: false


.SS paramcheck
Whether to validate parameters during parsing.


.TP 2
\(bu
Default: true


.SS parseonly
Just check the syntax of the manifests.


.TP 2
\(bu
Default: false


.SS passfile
Where puppetd stores the password for its private key. Generally unused.


.TP 2
\(bu
Default: $privatedir/password


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


.TP 2
\(bu
Default: none


.SS pidfile
The pid file


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


.TP 2
\(bu
Default: $libdir


.SS pluginpath
Where Puppet should look for plugins.  Multiple directories should be colon\-separated, like normal PATH variables.  As of 0.23.1, this option is deprecated; download your custom libraries to the $libdir instead.


.TP 2
\(bu
Default: $vardir/plugins


.SS pluginsignore
What files to ignore when pulling down plugins.


.TP 2
\(bu
Default: .svn CVS


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


.TP 2
\(bu
Default: puppet://$server/plugins


.SS pluginsync
Whether plugins should be synced with the central server.


.TP 2
\(bu
Default: false


.SS privatedir
Where the client stores private certificate information.


.TP 2
\(bu
Default: $ssldir/private


.SS privatekeydir
The private key directory.


.TP 2
\(bu
Default: $ssldir/private_keys


.SS publickeydir
The public key directory.


.TP 2
\(bu
Default: $ssldir/public_keys


.SS puppetdlockfile
A lock file to temporarily stop puppetd from doing anything.


.TP 2
\(bu
Default: $statedir/puppetdlock


.SS puppetdlog
The log file for puppetd.  This is generally not used.


.TP 2
\(bu
Default: $logdir/puppetd.log


.SS puppetport
Which port puppetd listens on.


.TP 2
\(bu
Default: 8139


.SS rails_loglevel
The log level for Rails connections.  The value must be a valid log level within Rails.  Production environments normally use
.\" visit_literal
info
.\" depart_literal
 and other environments normally use
.\" visit_literal
debug
.\" depart_literal
.


.TP 2
\(bu
Default: info


.SS railslog
Where Rails\-specific logs are sent


.TP 2
\(bu
Default: $logdir/rails.log


.SS report
Whether to send reports after every transaction.


.TP 2
\(bu
Default: false


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


.TP 2
\(bu
Default: $vardir/reports


.SS reportfrom
The \'from\' email address for the reports.


.TP 2
\(bu
Default: report@absinthe.lovedthanlost.net


.SS reports
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).


.TP 2
\(bu
Default: store


.SS reportserver
The server to which to send transaction reports.


.TP 2
\(bu
Default: $server


.SS req_bits
The bit length of the certificates.


.TP 2
\(bu
Default: 2048


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


.TP 2
\(bu
Default: $vardir/rrd


.SS rrdgraph
Whether RRD information should be graphed.


.TP 2
\(bu
Default: false


.SS rrdinterval
How often RRD should expect data. This should match how often the hosts report back to the server.


.TP 2
\(bu
Default: $runinterval


.SS rundir
Where Puppet PID files are kept.


.TP 2
\(bu
Default: $vardir/run


.SS runinterval
How often puppetd applies the client configuration; in seconds.


.TP 2
\(bu
Default: 1800


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


.SS serial
Where the serial number for certificates is stored.


.TP 2
\(bu
Default: $cadir/serial


.SS server
The server to which server puppetd should connect


.TP 2
\(bu
Default: puppet


.SS servertype
The type of server to use.  Currently supported options are webrick and mongrel.  If you use mongrel, you will need a proxy in front of the process or processes, since Mongrel cannot speak SSL.


.TP 2
\(bu
Default: webrick


.SS show_diff
Whether to print a contextual diff when files are being replaced.  The diff is printed on stdout, so this option is meaningless unless you are running Puppet interactively. This feature currently requires the
.\" visit_literal
diff/lcs
.\" depart_literal
 Ruby library.


.TP 2
\(bu
Default: false


.SS signeddir
Where the CA stores signed certificates.


.TP 2
\(bu
Default: $cadir/signed


.SS smtpserver
The server through which to send email reports.


.TP 2
\(bu
Default: none


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


.TP 2
\(bu
Default: false


.SS splaylimit
The maximum time to delay before runs.  Defaults to being the same as the run interval.


.TP 2
\(bu
Default: $runinterval


.SS ssl_client_header
The header containing an authenticated client\'s SSL DN.  Only used with Mongrel.  This header must be set by the proxy to the authenticated client\'s SSL DN (e.g.,
.\" visit_literal
/CN=puppet.reductivelabs.com
.\" depart_literal
). See http://reductivelabs.com/puppet/trac/wiki/UsingMongrel for more information.


.TP 2
\(bu
Default: HTTP_X_CLIENT_DN


.SS ssl_client_verify_header
The header containing the status message of the client verification. Only used with Mongrel.  This header must be set by the proxy to \'SUCCESS\' if the client successfully authenticated, and anything else otherwise. See http://reductivelabs.com/puppet/trac/wiki/UsingMongrel for more information.


.TP 2
\(bu
Default: HTTP_X_CLIENT_VERIFY


.SS ssldir
Where SSL certificates are kept.


.TP 2
\(bu
Default: $confdir/ssl


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


.TP 2
\(bu
Default: $vardir/state


.SS statefile
Where puppetd and puppetmasterd store state associated with the running configuration.  In the case of puppetmasterd, this file reflects the state discovered through interacting with clients.


.TP 2
\(bu
Default: $statedir/state.yaml


.SS storeconfigs
Whether to store each client\'s configuration.  This requires ActiveRecord from Ruby on Rails.


.TP 2
\(bu
Default: false


.SS summarize
Whether to print a transaction summary.


.TP 2
\(bu
Default: false


.SS syslogfacility
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.


.TP 2
\(bu
Default: daemon


.SS tagmap
The mapping between reporting tags and email addresses.


.TP 2
\(bu
Default: $confdir/tagmail.conf


.SS tags
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.


.SS templatedir
Where Puppet looks for template files.


.TP 2
\(bu
Default: $vardir/templates


.SS trace
Whether to print stack traces on some errors


.TP 2
\(bu
Default: false


.SS typecheck
Whether to validate types during parsing.


.TP 2
\(bu
Default: true


.SS usecacheonfailure
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.


.TP 2
\(bu
Default: true


.SS user
The user puppetmasterd should run as.


.TP 2
\(bu
Default: puppet


.SS vardir
Where Puppet stores dynamic and growing data.  The default for this parameter is calculated specially, like confdir.


.TP 2
\(bu
Default: /var/puppet


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


.TP 2
\(bu
Default: $vardir/yaml


.sp
.ce
----

.ce 0
.sp

.I This page autogenerated on Mon May 05 09:33:01 +1000 2008



.\" Generated by docutils manpage writer on 2008-05-05 09:33.
.\"