[Pkg-puppet-devel] [SCM] Puppet packaging for Debian branch, upstream, updated. 0.25.4-89-gcbbd363
James Turnbull
james at lovedthanlost.net
Tue May 18 09:03:38 UTC 2010
The following commit has been merged in the upstream branch:
commit efd0f76c3b40fb15528b3226687eb1ab454b0c42
Author: James Turnbull <james at lovedthanlost.net>
Date: Tue Feb 9 00:15:26 2010 +1100
Fixed #3128 - Updated man pages and moved puppet.conf.8 to puppet.conf.5
diff --git a/install.rb b/install.rb
index 49ca8b1..30f1d32 100755
--- a/install.rb
+++ b/install.rb
@@ -83,7 +83,7 @@ sbins = glob(%w{sbin/*})
bins = glob(%w{bin/*})
rdoc = glob(%w{bin/* sbin/* lib/**/*.rb README README-library CHANGELOG TODO Install}).reject { |e| e=~ /\.(bat|cmd)$/ }
ri = glob(%w(bin/*.rb sbin/* lib/**/*.rb)).reject { |e| e=~ /\.(bat|cmd)$/ }
-man = glob(%w{man/man8/*})
+man = glob(%w{man/man[0-9]/*})
libs = glob(%w{lib/**/*.rb lib/**/*.py})
tests = glob(%w{test/**/*.rb})
@@ -355,9 +355,9 @@ def build_man(bins)
# Locate rst2man
rst2man = %x{which rst2man.py}
rst2man.chomp!
- # Create puppet.conf.8 man page
+ # Create puppet.conf.5 man page
%x{bin/puppetdoc --reference configuration > ./puppet.conf.rst}
- %x{#{rst2man} ./puppet.conf.rst ./man/man8/puppet.conf.8}
+ %x{#{rst2man} ./puppet.conf.rst ./man/man5/puppet.conf.5}
File.unlink("./puppet.conf.rst")
# Create binary man pages
diff --git a/man/man8/puppet.conf.8 b/man/man5/puppet.conf.5
similarity index 73%
rename from man/man8/puppet.conf.8
rename to man/man5/puppet.conf.5
index 70d916c..2d73ccf 100644
--- a/man/man8/puppet.conf.8
+++ b/man/man5/puppet.conf.5
@@ -1,49 +1,56 @@
-.TH Configuration Reference "" "" ""
+.TH CONFIGURATION REFERENCE "" "" ""
.SH NAME
Configuration Reference \-
.\" Man page generated from reStructeredText.
-\fPThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Wed Dec 30 19:31:12 \-0500 2009)\fP
-
-
-.\" topic: Contents
-.\"
-.\" Specifying Configuration Parameters
-.\"
-.\" Signals
-.\"
-.\" Configuration Parameter Reference
-
-.SH Specifying Configuration Parameters
-
+.
+.sp
+\fBThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Mon Feb 08 23:57:07 +1100 2010)\fP
+.SS Contents
+.INDENT 0.0
+.IP \(bu 2
+.
+\fI\%Specifying Configuration Parameters\fP
+.IP \(bu 2
+.
+\fI\%Signals\fP
+.IP \(bu 2
+.
+\fI\%Configuration Parameter Reference\fP
+.UNINDENT
+.SH SPECIFYING CONFIGURATION PARAMETERS
.SS On The Command\-Line
+.sp
Every Puppet executable (with the exception of \fBpuppetdoc\fP) accepts all of
the parameters below, but not all of the arguments make sense for every executable.
-
+.sp
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.
-
+.sp
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 \fB/private/puppet\fP:
-
-
+.sp
.nf
+.ft C
$ puppetd \-\-confdir=/private/puppet
+.ft P
.fi
+.sp
Note that boolean options are turned on and off with a slightly different
syntax on the command line:
-
-
+.sp
.nf
+.ft C
$ puppetd \-\-storeconfigs
$ puppetd \-\-no\-storeconfigs
+.ft P
.fi
+.sp
The invocations above will enable and disable, respectively, the storage of
the client configuration.
-
-
.SS Configuration Files
+.sp
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 \fB/etc/puppet\fP, and as a regular user, the
@@ -52,1729 +59,1401 @@ executables look for \fBpuppet.conf\fP in their configuration directory
(although they previously looked for separate files). For example,
\fBpuppet.conf\fP is located at \fB/etc/puppet/puppet.conf\fP as root and
\fB~user/.puppet/puppet.conf\fP as a regular user by default.
-
+.sp
All executables will set any parameters set within the \fBmain\fP section,
while each executable will also look for a section named for the executable
and load those parameters. For example, \fBpuppetd\fP will look for a
section named \fBpuppetd\fP, and \fBpuppetmasterd\fP looks for a section
named \fBpuppetmasterd\fP. This allows you to use a single configuration file
to customize the settings for all of your executables.
-
-
.SS File Format
+.sp
The file follows INI\-style formatting. Here is an example of a very simple
\fBpuppet.conf\fP file:
-
-
+.sp
.nf
+.ft C
[main]
confdir = /private/puppet
storeconfigs = true
+.ft P
.fi
+.sp
Note that boolean parameters must be explicitly specified as \fItrue\fP or
\fIfalse\fP as seen above.
-
+.sp
If you need to change file parameters (e.g., reset the mode or owner), do
so within curly braces on the same line:
-
-
+.sp
.nf
+.ft C
[main]
myfile = /tmp/whatever {owner = root, mode = 644}
+.ft P
.fi
-If you\'re starting out with a fresh configuration, you may wish to let
+.sp
+If you\(aqre 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 \fI\-\-genconfig\fP command. The executable
will print a template configuration to standard output, which can be
redirected to a file like so:
-
-
+.sp
.nf
+.ft C
$ puppetd \-\-genconfig > /etc/puppet/puppet.conf
+.ft P
.fi
+.sp
Note that this invocation will replace the contents of any pre\-existing
\fIpuppet.conf\fP file, so make a backup of your present config if it contains
valuable information.
-
+.sp
Like the \fI\-\-genconfig\fP argument, the executables also accept a \fI\-\-genmanifest\fP
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
+Puppet\(aqs directories and files and prints it to standard output. This can
likewise be redirected to a file:
-
-
+.sp
.nf
+.ft C
$ puppetd \-\-genmanifest > /etc/puppet/manifests/site.pp
+.ft P
.fi
+.sp
Puppet can also create user and group accounts for itself (one \fIpuppet\fP group
and one \fIpuppet\fP user) if it is invoked as \fIroot\fP with the \fI\-\-mkusers\fP argument:
-
-
+.sp
.nf
+.ft C
$ puppetd \-\-mkusers
+.ft P
.fi
-
-.SH Signals
+.SH SIGNALS
+.sp
The \fBpuppetd\fP and \fBpuppetmasterd\fP executables catch some signals for special
handling. Both daemons catch (\fBSIGHUP\fP), which forces the server to restart
tself. Predictably, interrupt and terminate (\fBSIGINT\fP and \fBSIGTERM\fP) will shut
down the server, whether it be an instance of \fBpuppetd\fP or \fBpuppetmasterd\fP.
-
+.sp
Sending the \fBSIGUSR1\fP signal to an instance of \fBpuppetd\fP will cause it to
immediately begin a new configuration transaction with the server. This
signal has no effect on \fBpuppetmasterd\fP.
-
-
-.SH Configuration Parameter Reference
+.SH CONFIGURATION PARAMETER REFERENCE
+.sp
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 async_storeconfigs
-Whether to use a queueing system to provide asynchronous database integration. Requires that \fBpuppetqd\fP be running and that \'PSON\' support for ruby be installed.
-
+.sp
+Whether to use a queueing system to provide asynchronous database integration. Requires that \fBpuppetqd\fP be running and that \(aqPSON\(aq support for ruby be installed.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS authconfig
+.sp
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 \fBpuppetd\fP and \fBpuppetmasterd\fP.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/namespaceauth.conf
-
+.
+\fBDefault\fP: $confdir/namespaceauth.conf
.UNINDENT
-
.SS autoflush
+.sp
Whether log files should always flush to disk.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS autosign
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/autosign.conf
-
+.
+\fBDefault\fP: $confdir/autosign.conf
.UNINDENT
-
.SS bindaddress
+.sp
The address a listening server should bind to. Mongrel servers default to 127.0.0.1 and WEBrick defaults to 0.0.0.0.
-
-
.SS bucketdir
+.sp
Where FileBucket files are stored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/bucket
-
+.
+\fBDefault\fP: $vardir/bucket
.UNINDENT
-
.SS ca
+.sp
Wether the master should function as a certificate authority.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS ca_days
+.sp
How long a certificate should be valid. This parameter is deprecated, use ca_ttl instead
-
-
.SS ca_md
+.sp
The type of hash used in certificates.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: md5
-
+.
+\fBDefault\fP: md5
.UNINDENT
-
.SS ca_port
+.sp
The port to use for the certificate authority.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $masterport
-
+.
+\fBDefault\fP: $masterport
.UNINDENT
-
.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.
-
+.sp
+The server to use for certificate authority requests. It\(aqs a separate server because it cannot and does not need to horizontally scale.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $server
-
+.
+\fBDefault\fP: $server
.UNINDENT
-
.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)
-
+.sp
+The default TTL for new certificates; valid values must be an integer, optionally followed by one of the units \(aqy\(aq (years of 365 days), \(aqd\(aq (days), \(aqh\(aq (hours), or \(aqs\(aq (seconds). The unit defaults to seconds. If this parameter is set, ca_days is ignored. Examples are \(aq3600\(aq (one hour) and \(aq1825d\(aq, which is the same as \(aq5y\(aq (5 years)
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 5y
-
+.
+\fBDefault\fP: 5y
.UNINDENT
-
.SS cacert
+.sp
The CA certificate.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/ca_crt.pem
-
+.
+\fBDefault\fP: $cadir/ca_crt.pem
.UNINDENT
-
.SS cacrl
+.sp
The certificate revocation list (CRL) for the CA. Will be used if present but otherwise ignored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/ca_crl.pem
-
+.
+\fBDefault\fP: $cadir/ca_crl.pem
.UNINDENT
-
.SS cadir
+.sp
The root directory for the certificate authority.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/ca
-
+.
+\fBDefault\fP: $ssldir/ca
.UNINDENT
-
.SS cakey
+.sp
The CA private key.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/ca_key.pem
-
+.
+\fBDefault\fP: $cadir/ca_key.pem
.UNINDENT
-
.SS capass
+.sp
Where the CA stores the password for the private key
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $caprivatedir/ca.pass
-
+.
+\fBDefault\fP: $caprivatedir/ca.pass
.UNINDENT
-
.SS caprivatedir
+.sp
Where the CA stores private certificate information.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/private
-
+.
+\fBDefault\fP: $cadir/private
.UNINDENT
-
.SS capub
+.sp
The CA public key.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/ca_pub.pem
-
+.
+\fBDefault\fP: $cadir/ca_pub.pem
.UNINDENT
-
.SS casesensitive
+.sp
Whether matching in case statements and selectors should be case\-sensitive. Case insensitivity is handled by downcasing all values before comparison.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS catalog_format
-(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.
-
-
+.sp
+(Deprecated for \(aqpreferred_serialization_format\(aq) What format to use to dump the catalog. Only supports \(aqmarshal\(aq and \(aqyaml\(aq. Only matters on the client, since it asks the server for a specific format.
.SS cert_inventory
+.sp
A Complete listing of all certificates
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/inventory.txt
-
+.
+\fBDefault\fP: $cadir/inventory.txt
.UNINDENT
-
.SS certdir
+.sp
The certificate directory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/certs
-
+.
+\fBDefault\fP: $ssldir/certs
.UNINDENT
-
.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\'.
-
-
+.sp
+The DNS names on the Server certificate as a colon\-separated list. If it\(aqs 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 \(aqpuppet\(aq.
.SS certname
+.sp
The name to use when handling certificates. Defaults to the fully qualified domain name.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: pelin.lovedthanlost.net
-
+.
+\fBDefault\fP: absinthe.lovedthanlost.net
.UNINDENT
-
.SS classfile
+.sp
The file in which puppetd stores a list of the classes associated with the retrieved configuration. Can be loaded in the separate \fBpuppet\fP executable using the \fB\-\-loadclasses\fP option.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/classes.txt
-
+.
+\fBDefault\fP: $statedir/classes.txt
.UNINDENT
-
.SS clientbucketdir
+.sp
Where FileBucket files are stored locally.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/clientbucket
-
+.
+\fBDefault\fP: $vardir/clientbucket
.UNINDENT
-
.SS clientyamldir
+.sp
The directory in which client\-side YAML data is stored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/client_yaml
-
+.
+\fBDefault\fP: $vardir/client_yaml
.UNINDENT
-
.SS code
-Code to parse directly. This is essentially only used by \fBpuppet\fP, and should only be set if you\'re writing your own Puppet executable
-
-
+.sp
+Code to parse directly. This is essentially only used by \fBpuppet\fP, and should only be set if you\(aqre writing your own Puppet executable
.SS color
+.sp
Whether to use colors when logging to the console. Valid values are \fBansi\fP (equivalent to \fBtrue\fP), \fBhtml\fP (mostly used during testing with TextMate), and \fBfalse\fP, which produces no color.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: ansi
-
+.
+\fBDefault\fP: ansi
.UNINDENT
-
.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 \fBpuppetmasterd\fP 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 \fB~\fP.
-
+.sp
+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 \fBpuppetmasterd\fP is supposed to run as, it defaults to a system directory, but if it\(aqs running as any other user, it defaults to being in \fB~\fP.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: /etc/puppet
-
+.
+\fBDefault\fP: /etc/puppet
.UNINDENT
-
.SS config
+.sp
The configuration file for puppetdoc.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/puppet.conf
-
+.
+\fBDefault\fP: $confdir/puppet.conf
.UNINDENT
-
.SS config_version
+.sp
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.
-
-
.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.
-
-
+.sp
+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 \(aqall\(aq. This feature is only available in Puppet versions higher than 0.18.4.
.SS configtimeout
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 120
-
+.
+\fBDefault\fP: 120
.UNINDENT
-
.SS csrdir
+.sp
Where the CA stores certificate requests
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/requests
-
+.
+\fBDefault\fP: $cadir/requests
.UNINDENT
-
.SS daemonize
+.sp
Send the process into the background. This is the default.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS dbadapter
+.sp
The type of database to use.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: sqlite3
-
+.
+\fBDefault\fP: sqlite3
.UNINDENT
-
.SS dblocation
+.sp
The database cache for client configurations. Used for querying within the language.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/clientconfigs.sqlite3
-
+.
+\fBDefault\fP: $statedir/clientconfigs.sqlite3
.UNINDENT
-
.SS dbmigrate
+.sp
Whether to automatically migrate the database.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS dbname
+.sp
The name of the database to use.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS dbpassword
+.sp
The database password for Client caching. Only used when networked databases are used.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS dbserver
+.sp
The database server for Client caching. Only used when networked databases are used.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: localhost
-
+.
+\fBDefault\fP: localhost
.UNINDENT
-
.SS dbsocket
+.sp
The database socket location. Only used when networked databases are used. Will be ignored if the value is an empty string.
-
-
.SS dbuser
+.sp
The database user for Client caching. Only used when networked databases are used.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS diff
+.sp
Which diff command to use when printing differences between files.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: diff
-
+.
+\fBDefault\fP: diff
.UNINDENT
-
.SS diff_args
+.sp
Which arguments to pass to the diff command when printing differences between files.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: \-u
-
+.
+\fBDefault\fP: \-u
.UNINDENT
-
.SS downcasefacts
+.sp
Whether facts should be made all lowercase when sent to the server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS dynamicfacts
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: memorysize,memoryfree,swapsize,swapfree
-
+.
+\fBDefault\fP: memorysize,memoryfree,swapsize,swapfree
.UNINDENT
-
.SS environment
+.sp
The environment Puppet is running in. For clients (e.g., \fBpuppetd\fP) this determines the environment itself, which is used to find modules and much more. For servers (i.e., \fBpuppetmasterd\fP) this provides the default environment for nodes we know nothing about.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: production
-
+.
+\fBDefault\fP: production
.UNINDENT
-
.SS evaltrace
+.sp
Whether each resource should log when it is being evaluated. This allows you to interactively see exactly what is being done.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS external_nodes
+.sp
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 \fBclasses\fP and \fBparameters\fP, where \fBclasses\fP is an array and \fBparameters\fP 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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: none
-
+.
+\fBDefault\fP: none
.UNINDENT
-
.SS factdest
+.sp
Where Puppet should store facts that it pulls down from the central server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/facts/
-
+.
+\fBDefault\fP: $vardir/facts/
.UNINDENT
-
.SS factpath
+.sp
Where Puppet should look for facts. Multiple directories should be colon\-separated, like normal PATH variables.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/facts/
-
+.
+\fBDefault\fP: $vardir/facts/
.UNINDENT
-
.SS factsignore
+.sp
What files to ignore when pulling down facts.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: .svn CVS
-
+.
+\fBDefault\fP: .svn CVS
.UNINDENT
-
.SS factsource
+.sp
From where to retrieve facts. The standard Puppet \fBfile\fP type is used for retrieval, so anything that is a valid file source can be used here.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet://$server/facts/
-
+.
+\fBDefault\fP: puppet://$server/facts/
.UNINDENT
-
.SS factsync
+.sp
Whether facts should be synced with the central server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS fileserverconfig
+.sp
Where the fileserver configuration is stored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/fileserver.conf
-
+.
+\fBDefault\fP: $confdir/fileserver.conf
.UNINDENT
-
.SS filetimeout
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 15
-
+.
+\fBDefault\fP: 15
.UNINDENT
-
.SS genconfig
+.sp
Whether to just print a configuration to stdout and exit. Only makes sense when used interactively. Takes into account arguments specified on the CLI.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS genmanifest
+.sp
Whether to just print a manifest to stdout and exit. Only makes sense when used interactively. Takes into account arguments specified on the CLI.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS graph
+.sp
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).
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS graphdir
+.sp
Where to store dot\-outputted graphs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/graphs
-
+.
+\fBDefault\fP: $statedir/graphs
.UNINDENT
-
.SS group
+.sp
The group puppetmasterd should run as.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS hostcert
+.sp
Where individual hosts store and look for their certificates.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $certdir/$certname.pem
-
+.
+\fBDefault\fP: $certdir/$certname.pem
.UNINDENT
-
.SS hostcrl
-Where the host\'s certificate revocation list can be found. This is distinct from the certificate authority\'s CRL.
-
+.sp
+Where the host\(aqs certificate revocation list can be found. This is distinct from the certificate authority\(aqs CRL.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/crl.pem
-
+.
+\fBDefault\fP: $ssldir/crl.pem
.UNINDENT
-
.SS hostcsr
+.sp
Where individual hosts store and look for their certificate requests.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/csr_$certname.pem
-
+.
+\fBDefault\fP: $ssldir/csr_$certname.pem
.UNINDENT
-
.SS hostprivkey
+.sp
Where individual hosts store and look for their private key.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $privatekeydir/$certname.pem
-
+.
+\fBDefault\fP: $privatekeydir/$certname.pem
.UNINDENT
-
.SS hostpubkey
+.sp
Where individual hosts store and look for their public key.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $publickeydir/$certname.pem
-
+.
+\fBDefault\fP: $publickeydir/$certname.pem
.UNINDENT
-
-.SS http_enable_post_connection_check
-Boolean; wheter or not puppetd should validate the server SSL certificate against the request hostname.
-
-.INDENT 0.0
-
-.IP \(bu 2
-\fPDefault\fP: true
-
-.UNINDENT
-
.SS http_proxy_host
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: none
-
+.
+\fBDefault\fP: none
.UNINDENT
-
.SS http_proxy_port
+.sp
The HTTP proxy port to use for outgoing connections
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 3128
-
+.
+\fBDefault\fP: 3128
.UNINDENT
-
.SS httplog
+.sp
Where the puppetd web server logs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $logdir/http.log
-
+.
+\fBDefault\fP: $logdir/http.log
.UNINDENT
-
.SS ignorecache
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS ignoreimport
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS ignoreschedules
+.sp
Boolean; whether puppetd should ignore schedules. This is useful for initial puppetd runs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS keylength
+.sp
The bit length of keys.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 1024
-
+.
+\fBDefault\fP: 1024
.UNINDENT
-
.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.
-
+.sp
+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 \(aqall\(aq returns all attributes.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: all
-
+.
+\fBDefault\fP: all
.UNINDENT
-
.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.
-
-
+.sp
+The search base for LDAP searches. It\(aqs impossible to provide a meaningful default here, although the LDAP libraries might have one already set. Generally, it should be the \(aqou=Hosts\(aq branch under your main directory.
.SS ldapclassattrs
+.sp
The LDAP attributes to use to define Puppet classes. Values should be comma\-separated.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppetclass
-
+.
+\fBDefault\fP: puppetclass
.UNINDENT
-
.SS ldapnodes
+.sp
Whether to search for node configurations in LDAP. See \fI\%http://reductivelabs.com/trac/puppet/wiki/LDAPNodes\fP for more information.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS ldapparentattr
+.sp
The attribute to use to define the parent node.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: parentnode
-
+.
+\fBDefault\fP: parentnode
.UNINDENT
-
.SS ldappassword
+.sp
The password to use to connect to LDAP.
-
-
.SS ldapport
+.sp
The LDAP port. Only used if \fBldapnodes\fP is enabled.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 389
-
+.
+\fBDefault\fP: 389
.UNINDENT
-
.SS ldapserver
+.sp
The LDAP server. Only used if \fBldapnodes\fP is enabled.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: ldap
-
+.
+\fBDefault\fP: ldap
.UNINDENT
-
.SS ldapssl
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS ldapstackedattrs
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppetvar
-
+.
+\fBDefault\fP: puppetvar
.UNINDENT
-
.SS ldapstring
+.sp
The search string used to find an LDAP node.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: (&(objectclass=puppetClient)(cn=%s))
-
+.
+\fBDefault\fP: (&(objectclass=puppetClient)(cn=%s))
.UNINDENT
-
.SS ldaptls
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS ldapuser
+.sp
The user to use to connect to LDAP. Must be specified as a full DN.
-
-
.SS lexical
+.sp
Whether to use lexical scoping (vs. dynamic).
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.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
-
+.sp
+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\(aqs search path
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/lib
-
+.
+\fBDefault\fP: $vardir/lib
.UNINDENT
-
.SS listen
+.sp
Whether puppetd should listen for connections. If this is true, then by default only the \fBrunner\fP server is started, which allows remote authorized and authenticated nodes to connect and trigger \fBpuppetd\fP runs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS localcacert
+.sp
Where each client stores the CA certificate.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $certdir/ca.pem
-
+.
+\fBDefault\fP: $certdir/ca.pem
.UNINDENT
-
.SS localconfig
+.sp
Where puppetd caches the local configuration. An extension indicating the cache format is added automatically.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/localconfig
-
+.
+\fBDefault\fP: $statedir/localconfig
.UNINDENT
-
.SS logdir
+.sp
The Puppet log directory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/log
-
+.
+\fBDefault\fP: $vardir/log
.UNINDENT
-
.SS manage_internal_file_permissions
+.sp
Whether Puppet should manage the owner, group, and mode of files it uses internally
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS manifest
+.sp
The entry\-point manifest for puppetmasterd.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $manifestdir/site.pp
-
+.
+\fBDefault\fP: $manifestdir/site.pp
.UNINDENT
-
.SS manifestdir
+.sp
Where puppetmasterd looks for its manifests.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/manifests
-
+.
+\fBDefault\fP: $confdir/manifests
.UNINDENT
-
.SS masterhttplog
+.sp
Where the puppetmasterd web server logs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $logdir/masterhttp.log
-
+.
+\fBDefault\fP: $logdir/masterhttp.log
.UNINDENT
-
.SS masterlog
+.sp
Where puppetmasterd logs. This is generally not used, since syslog is the default log destination.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $logdir/puppetmaster.log
-
+.
+\fBDefault\fP: $logdir/puppetmaster.log
.UNINDENT
-
.SS masterport
+.sp
Which port puppetmasterd listens on.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 8140
-
+.
+\fBDefault\fP: 8140
.UNINDENT
-
.SS maximum_uid
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 4294967290
-
+.
+\fBDefault\fP: 4294967290
.UNINDENT
-
.SS mkusers
+.sp
Whether to create the necessary user and group that puppetd will run as.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS modulepath
+.sp
The search path for modules as a colon\-separated list of directories.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/modules:/usr/share/puppet/modules
-
+.
+\fBDefault\fP: $confdir/modules:/usr/share/puppet/modules
.UNINDENT
-
.SS name
+.sp
The name of the service, if we are running as one. The default is essentially $0 without the path or \fB.rb\fP.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppetdoc
-
+.
+\fBDefault\fP: puppetdoc
.UNINDENT
-
.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)
-
+.sp
+How the puppetmaster determines the client\(aqs identity and sets the \(aqhostname\(aq, \(aqfqdn\(aq and \(aqdomain\(aq facts for use in the manifest, in particular for determining which \(aqnode\(aq statement applies to the client. Possible values are \(aqcert\(aq (use the subject\(aqs CN in the client\(aqs certificate) and \(aqfacter\(aq (use the hostname that the client reported in its facts)
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: cert
-
+.
+\fBDefault\fP: cert
.UNINDENT
-
.SS node_terminus
+.sp
Where to find information about nodes.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: plain
-
+.
+\fBDefault\fP: plain
.UNINDENT
-
.SS noop
+.sp
Whether puppetd should be run in noop mode.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS paramcheck
+.sp
Whether to validate parameters during parsing.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS parseonly
+.sp
Just check the syntax of the manifests.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS passfile
+.sp
Where puppetd stores the password for its private key. Generally unused.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $privatedir/password
-
+.
+\fBDefault\fP: $privatedir/password
.UNINDENT
-
.SS path
+.sp
The shell search path. Defaults to whatever is inherited from the parent process.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: none
-
+.
+\fBDefault\fP: none
.UNINDENT
-
.SS pidfile
+.sp
The pid file
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $rundir/$name.pid
-
+.
+\fBDefault\fP: $rundir/$name.pid
.UNINDENT
-
.SS plugindest
+.sp
Where Puppet should store plugins that it pulls down from the central server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $libdir
-
+.
+\fBDefault\fP: $libdir
.UNINDENT
-
.SS pluginsignore
+.sp
What files to ignore when pulling down plugins.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: .svn CVS .git
-
+.
+\fBDefault\fP: .svn CVS .git
.UNINDENT
-
.SS pluginsource
+.sp
From where to retrieve plugins. The standard Puppet \fBfile\fP type is used for retrieval, so anything that is a valid file source can be used here.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet://$server/plugins
-
+.
+\fBDefault\fP: puppet://$server/plugins
.UNINDENT
-
.SS pluginsync
+.sp
Whether plugins should be synced with the central server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
+.SS postrun_command
+.sp
+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.
.SS preferred_serialization_format
-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.
-
+.sp
+The preferred means of serializing ruby instances for passing over the wire. This won\(aqt 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.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: pson
-
+.
+\fBDefault\fP: pson
.UNINDENT
-
+.SS prerun_command
+.sp
+A command to run before every agent run. If this command returns a non\-zero return code, the entire Puppet run will fail.
.SS privatedir
+.sp
Where the client stores private certificate information.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/private
-
+.
+\fBDefault\fP: $ssldir/private
.UNINDENT
-
.SS privatekeydir
+.sp
The private key directory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/private_keys
-
+.
+\fBDefault\fP: $ssldir/private_keys
.UNINDENT
-
.SS publickeydir
+.sp
The public key directory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/public_keys
-
+.
+\fBDefault\fP: $ssldir/public_keys
.UNINDENT
-
.SS puppetdlockfile
+.sp
A lock file to temporarily stop puppetd from doing anything.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/puppetdlock
-
+.
+\fBDefault\fP: $statedir/puppetdlock
.UNINDENT
-
.SS puppetdlog
+.sp
The log file for puppetd. This is generally not used.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $logdir/puppetd.log
-
+.
+\fBDefault\fP: $logdir/puppetd.log
.UNINDENT
-
.SS puppetport
+.sp
Which port puppetd listens on.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 8139
-
+.
+\fBDefault\fP: 8139
.UNINDENT
-
.SS queue_source
+.sp
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
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: stomp://localhost:61613/
-
+.
+\fBDefault\fP: stomp://localhost:61613/
.UNINDENT
-
.SS queue_type
+.sp
Which type of queue to use for asynchronous processing.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: stomp
-
+.
+\fBDefault\fP: stomp
.UNINDENT
-
.SS rails_loglevel
+.sp
The log level for Rails connections. The value must be a valid log level within Rails. Production environments normally use \fBinfo\fP and other environments normally use \fBdebug\fP.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: info
-
+.
+\fBDefault\fP: info
.UNINDENT
-
.SS railslog
+.sp
Where Rails\-specific logs are sent
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $logdir/rails.log
-
+.
+\fBDefault\fP: $logdir/rails.log
.UNINDENT
-
.SS report
+.sp
Whether to send reports after every transaction.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS report_port
+.sp
The port to communicate with the report_server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $masterport
-
+.
+\fBDefault\fP: $masterport
.UNINDENT
-
.SS report_server
+.sp
The server to which to send transaction reports.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $server
-
+.
+\fBDefault\fP: $server
.UNINDENT
-
.SS reportdir
+.sp
The directory in which to store reports received from the client. Each client gets a separate subdirectory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/reports
-
+.
+\fBDefault\fP: $vardir/reports
.UNINDENT
-
.SS reportfrom
-The \'from\' email address for the reports.
-
+.sp
+The \(aqfrom\(aq email address for the reports.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: \fI\%report at pelin.lovedthanlost.net\fP
-
+.
+\fBDefault\fP: \fI\%report at absinthe.lovedthanlost.net\fP
.UNINDENT
-
.SS reports
+.sp
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).
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: store
-
+.
+\fBDefault\fP: store
.UNINDENT
-
.SS reportserver
-(Deprecated for \'report_server\') The server to which to send transaction reports.
-
+.sp
+(Deprecated for \(aqreport_server\(aq) The server to which to send transaction reports.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $server
-
+.
+\fBDefault\fP: $server
.UNINDENT
-
.SS req_bits
+.sp
The bit length of the certificates.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 2048
-
+.
+\fBDefault\fP: 2048
.UNINDENT
-
.SS requestdir
+.sp
Where host certificate requests are stored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $ssldir/certificate_requests
-
+.
+\fBDefault\fP: $ssldir/certificate_requests
.UNINDENT
-
.SS rest_authconfig
+.sp
The configuration file that defines the rights to the different rest indirections. This can be used as a fine\-grained authorization system for \fBpuppetmasterd\fP.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/auth.conf
-
+.
+\fBDefault\fP: $confdir/auth.conf
.UNINDENT
-
.SS rrddir
+.sp
The directory where RRD database files are stored. Directories for each reporting host will be created under this directory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/rrd
-
+.
+\fBDefault\fP: $vardir/rrd
.UNINDENT
-
.SS rrdinterval
+.sp
How often RRD should expect data. This should match how often the hosts report back to the server.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $runinterval
-
+.
+\fBDefault\fP: $runinterval
.UNINDENT
-
.SS rundir
+.sp
Where Puppet PID files are kept.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/run
-
+.
+\fBDefault\fP: $vardir/run
.UNINDENT
-
.SS runinterval
+.sp
How often puppetd applies the client configuration; in seconds.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: 1800
-
+.
+\fBDefault\fP: 1800
.UNINDENT
-
.SS sendmail
+.sp
Where to find the sendmail binary with which to send email.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: /usr/sbin/sendmail
-
+.
+\fBDefault\fP: /usr/sbin/sendmail
.UNINDENT
-
.SS serial
+.sp
Where the serial number for certificates is stored.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/serial
-
+.
+\fBDefault\fP: $cadir/serial
.UNINDENT
-
.SS server
+.sp
The server to which server puppetd should connect
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS servertype
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: webrick
-
+.
+\fBDefault\fP: webrick
.UNINDENT
-
.SS show_diff
+.sp
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 \fBdiff/lcs\fP Ruby library.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS signeddir
+.sp
Where the CA stores signed certificates.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $cadir/signed
-
+.
+\fBDefault\fP: $cadir/signed
.UNINDENT
-
.SS smtpserver
+.sp
The server through which to send email reports.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: none
-
+.
+\fBDefault\fP: none
.UNINDENT
-
.SS splay
+.sp
Whether to sleep for a pseudo\-random (but consistent) amount of time before a run.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS splaylimit
+.sp
The maximum time to delay before runs. Defaults to being the same as the run interval.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $runinterval
-
+.
+\fBDefault\fP: $runinterval
.UNINDENT
-
.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., \fB/CN=puppet.reductivelabs.com\fP). See \fI\%http://reductivelabs.com/puppet/trac/wiki/UsingMongrel\fP for more information.
-
+.sp
+The header containing an authenticated client\(aqs SSL DN. Only used with Mongrel. This header must be set by the proxy to the authenticated client\(aqs SSL DN (e.g., \fB/CN=puppet.reductivelabs.com\fP). See \fI\%http://reductivelabs.com/puppet/trac/wiki/UsingMongrel\fP for more information.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: HTTP_X_CLIENT_DN
-
+.
+\fBDefault\fP: HTTP_X_CLIENT_DN
.UNINDENT
-
.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 \fI\%http://reductivelabs.com/puppet/trac/wiki/UsingMongrel\fP for more information.
-
+.sp
+The header containing the status message of the client verification. Only used with Mongrel. This header must be set by the proxy to \(aqSUCCESS\(aq if the client successfully authenticated, and anything else otherwise. See \fI\%http://reductivelabs.com/puppet/trac/wiki/UsingMongrel\fP for more information.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: HTTP_X_CLIENT_VERIFY
-
+.
+\fBDefault\fP: HTTP_X_CLIENT_VERIFY
.UNINDENT
-
.SS ssldir
+.sp
Where SSL certificates are kept.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/ssl
-
+.
+\fBDefault\fP: $confdir/ssl
.UNINDENT
-
.SS statedir
+.sp
The directory where Puppet state is stored. Generally, this directory can be removed without causing harm (although it might result in spurious service restarts).
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/state
-
+.
+\fBDefault\fP: $vardir/state
.UNINDENT
-
.SS statefile
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $statedir/state.yaml
-
+.
+\fBDefault\fP: $statedir/state.yaml
.UNINDENT
-
.SS storeconfigs
-Whether to store each client\'s configuration. This requires ActiveRecord from Ruby on Rails.
-
+.sp
+Whether to store each client\(aqs configuration. This requires ActiveRecord from Ruby on Rails.
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS strict_hostname_checking
+.sp
Whether to only search for the complete hostname as it is in the certificate when searching for node information in the catalogs.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS summarize
+.sp
Whether to print a transaction summary.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS syslogfacility
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: daemon
-
+.
+\fBDefault\fP: daemon
.UNINDENT
-
.SS tagmap
+.sp
The mapping between reporting tags and email addresses.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $confdir/tagmail.conf
-
+.
+\fBDefault\fP: $confdir/tagmail.conf
.UNINDENT
-
.SS tags
+.sp
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
+.sp
Where Puppet looks for template files. Can be a list of colon\-seperated directories.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/templates
-
+.
+\fBDefault\fP: $vardir/templates
.UNINDENT
-
.SS thin_storeconfigs
+.sp
Boolean; wether storeconfigs store in the database only the facts and exported resources. If true, then storeconfigs performance will be higher and still allow exported/collected resources, but other usage external to Puppet might not work
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS trace
+.sp
Whether to print stack traces on some errors
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: false
-
+.
+\fBDefault\fP: false
.UNINDENT
-
.SS typecheck
+.sp
Whether to validate types during parsing.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS usecacheonfailure
+.sp
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.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
-
.SS user
+.sp
The user puppetmasterd should run as.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: puppet
-
+.
+\fBDefault\fP: puppet
.UNINDENT
-
.SS vardir
+.sp
Where Puppet stores dynamic and growing data. The default for this parameter is calculated specially, like \fI\%confdir\fP.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: /var/puppet
-
+.
+\fBDefault\fP: /var/puppet
.UNINDENT
-
.SS yamldir
+.sp
The directory in which YAML data is stored, usually in a subdirectory.
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: $vardir/yaml
-
+.
+\fBDefault\fP: $vardir/yaml
.UNINDENT
-
.SS zlib
+.sp
Boolean; whether to use the zlib library
-
.INDENT 0.0
-
.IP \(bu 2
-\fPDefault\fP: true
-
+.
+\fBDefault\fP: true
.UNINDENT
.sp
@@ -1783,8 +1462,8 @@ Boolean; whether to use the zlib library
.ce 0
.sp
-\fIThis page autogenerated on Wed Dec 30 19:31:12 \-0500 2009\fP
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:31.
+.sp
+\fIThis page autogenerated on Mon Feb 08 23:57:07 +1100 2010\fP
+.\" Generated by docutils manpage writer.
.\"
+.
diff --git a/man/man8/filebucket.8 b/man/man8/filebucket.8
index 3d4d159..de2dee7 100644
--- a/man/man8/filebucket.8
+++ b/man/man8/filebucket.8
@@ -2,120 +2,106 @@
.SH NAME
\-
.\" Man page generated from reStructeredText.
-
+.
.SH SYNOPSIS
+.sp
A stand\-alone Puppet filebucket client.
-
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
-
.TP
.B filebucket [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose]
+.
[\-l|\-\-local] [\-r|\-\-remote]
[\-s|\-\-server <server>] [\-b|\-\-bucket <directory>] <file> <file> ...
-
.UNINDENT
.UNINDENT
.UNINDENT
-
.SH DESCRIPTION
+.sp
This is a stand\-alone filebucket client for sending files to a local or
central filebucket.
-
-
.SH USAGE
+.sp
This client can operate in three modes, with only one mode per call:
-
.INDENT 0.0
-
.TP
.B backup: Send one or more files to the specified file bucket. Each sent
+.
file is printed with its resulting md5 sum.
-
-
.TP
.B get: Return the text associated with an md5 sum. The text is printed
+.
to stdout, and only one file can be retrieved at a time.
-
-
.TP
.B restore: Given a file path and an md5 sum, store the content associated
+.
with the sum into the specified file path. You can specify an
entirely new path to this argument; you are not restricted to
restoring the content to its original location.
-
.UNINDENT
+.sp
Note that +filebucket+ defaults to using a network\-based filebucket
-available on the server named +puppet+. To use this, you\'ll have to be
+available on the server named +puppet+. To use this, you\(aqll have to be
running as a user with valid Puppet certificates. Alternatively, you can
use your local file bucket by specifying +\-\-local+.
-
-
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
+.sp
$ filebucket backup /etc/passwd
/etc/passwd: 429b225650b912a2ee067b0a4cf1e949
$ filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
$
-
.UNINDENT
.UNINDENT
-
.SH OPTIONS
-Note that any configuration parameter that\'s valid in the configuration
-file is also a valid long argument. For example, \'ssldir\' is a valid
-configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
+.sp
+Note that any configuration parameter that\(aqs valid in the configuration
+file is also a valid long argument. For example, \(aqssldir\(aq is a valid
+configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an
argument.
-
+.sp
See the configuration file documentation at
\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
-\'\-\-genconfig\'.
-
+\(aq\-\-genconfig\(aq.
+.sp
debug: Enable full debugging.
-
+.sp
help: Print this help message
-
.INDENT 0.0
-
.TP
.B local: Use the local filebucket. This will use the default
+.
configuration information.
-
-
.TP
.B remote: Use a remote filebucket. This will use the default
+.
configuration information.
-
.UNINDENT
+.sp
server: The server to send the file to, instead of locally.
-
+.sp
verbose: Print extra information.
-
+.sp
version: Print version information.
-
-
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
+.sp
filebucket \-b /tmp/filebucket /my/file
-
.UNINDENT
.UNINDENT
-
.SH AUTHOR
+.sp
Luke Kanies
-
-
.SH COPYRIGHT
+.sp
Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
.\"
+.
diff --git a/man/man8/pi.8 b/man/man8/pi.8
index 582c70e..519be2c 100644
--- a/man/man8/pi.8
+++ b/man/man8/pi.8
@@ -2,55 +2,49 @@
.SH NAME
\-
.\" Man page generated from reStructeredText.
-
+.
.SH SYNOPSIS
-Print help about puppet types on the console. Run with \'\-h\' to get
+.sp
+Print help about puppet types on the console. Run with \(aq\-h\(aq to get
detailed help.
-
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
+.sp
pi [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
-
.UNINDENT
.UNINDENT
-
.SH DESCRIPTION
+.sp
Prints details of Puppet types, providers and metaparameters on the
console.
-
-
.SH OPTIONS
+.sp
help: Print this help text
-
+.sp
providers: Describe providers in detail for each type
-
+.sp
list: List all types
-
+.sp
meta: List all metaparameters
-
+.sp
short: List only parameters without detail
-
-
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
+.sp
pi \-\-list
pi file \-\-providers
pi user \-s \-m
-
.UNINDENT
.UNINDENT
-
.SH AUTHOR
+.sp
David Lutterkort
-
-
.SH COPYRIGHT
+.sp
Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
.\"
+.
diff --git a/man/man8/puppet.8 b/man/man8/puppet.8
index 629fc99..02176ce 100644
--- a/man/man8/puppet.8
+++ b/man/man8/puppet.8
@@ -2,91 +2,81 @@
.SH NAME
\-
.\" Man page generated from reStructeredText.
-
+.
.SH SYNOPSIS
+.sp
Run a stand\-alone +puppet+ manifest.
-
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
-
.TP
.B puppet [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute]
+.
[\-\-detailed\-exitcodes] [\-l|\-\-logdest <file>] <file>
-
.UNINDENT
.UNINDENT
.UNINDENT
-
.SH DESCRIPTION
+.sp
This is the standalone puppet execution tool; use it to execute
individual manifests that you write. If you need to execute site\-wide
manifests, use +puppetd+ and +puppetmasterd+.
-
-
.SH OPTIONS
-Note that any configuration parameter that\'s valid in the configuration
-file is also a valid long argument. For example, \'ssldir\' is a valid
-configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
+.sp
+Note that any configuration parameter that\(aqs valid in the configuration
+file is also a valid long argument. For example, \(aqssldir\(aq is a valid
+configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an
argument.
-
+.sp
See the configuration file documentation at
\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
-\'\-\-genconfig\'.
-
+\(aq\-\-genconfig\(aq.
+.sp
debug: Enable full debugging.
-
.INDENT 0.0
-
.TP
.B detailed\-exitcodes: Provide transaction information via exit codes. If
-this is enabled, an exit code of \'2\' means there
-were changes, and an exit code of \'4\' means that
+.
+this is enabled, an exit code of \(aq2\(aq means there
+were changes, and an exit code of \(aq4\(aq means that
there were failures during the transaction.
-
.UNINDENT
+.sp
help: Print this help message
-
.INDENT 0.0
-
.TP
.B loadclasses: Load any stored classes. +puppetd+ caches configured
+.
classes (usually at /etc/puppet/classes.txt), and
setting this option causes all of those classes to
be set in your +puppet+ manifest.
-
-
.TP
.B logdest: Where to send messages. Choose between syslog, the
+.
console, and a log file. Defaults to sending
messages to the console.
-
.UNINDENT
+.sp
execute: Execute a specific piece of Puppet code
-
+.sp
verbose: Print extra information.
-
-
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
+.sp
puppet \-l /tmp/manifest.log manifest.pp
-
.UNINDENT
.UNINDENT
-
.SH AUTHOR
+.sp
Luke Kanies
-
-
.SH COPYRIGHT
+.sp
Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
.\"
+.
diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8
index e6b6a33..5cf7269 100644
--- a/man/man8/puppetdoc.8
+++ b/man/man8/puppetdoc.8
@@ -2,114 +2,103 @@
.SH NAME
\-
.\" Man page generated from reStructeredText.
-
+.
.SH SYNOPSIS
+.sp
Generate a reference for all Puppet types. Largely meant for internal
Reductive Labs use.
-
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
-
.TP
.B puppetdoc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir <rdoc outputdir>] [\-m|\-\-mode <text|pdf|markdown|trac|rdoc>]
+.
[\-r|\-\-reference <[type]|configuration|..>] [manifest\-file]
-
.UNINDENT
.UNINDENT
.UNINDENT
-
.SH DESCRIPTION
-If mode is not \'rdoc\', then this command generates a restructured\-text
+.sp
+If mode is not \(aqrdoc\(aq, then this command generates a restructured\-text
document describing all installed Puppet types or all allowable
arguments to puppet executables. It is largely meant for internal use
and is used to generate the reference document available on the
Reductive Labs web site.
-
-In \'rdoc\' mode, this command generates an html RDoc hierarchy describing
-the manifests that are in \'manifestdir\' and \'modulepath\' configuration
+.sp
+In \(aqrdoc\(aq mode, this command generates an html RDoc hierarchy describing
+the manifests that are in \(aqmanifestdir\(aq and \(aqmodulepath\(aq configuration
directives. The generated documentation directory is doc by default but
-can be changed with the \'outputdir\' option.
-
-If the command is started with \'manifest\-file\' command\-line arguments,
+can be changed with the \(aqoutputdir\(aq option.
+.sp
+If the command is started with \(aqmanifest\-file\(aq command\-line arguments,
puppetdoc generate a single manifest documentation that is output on
stdout.
-
-
.SH OPTIONS
.INDENT 0.0
-
.TP
-.B all: Output the docs for all of the reference types. In \'rdoc\'
+.B all: Output the docs for all of the reference types. In \(aqrdoc\(aq
+.
modes, this also outputs documentation for all resources
-
.UNINDENT
+.sp
help: Print this help message
-
.INDENT 0.0
-
.TP
.B outputdir: Specifies the directory where to output the rdoc
-documentation in \'rdoc\' mode.
-
-
+.
+documentation in \(aqrdoc\(aq mode.
.TP
-.B mode: Determine the output mode. Valid modes are \'text\', \'trac\',
-\'pdf\', \'markdown\' and \'rdoc\'. The \'pdf\' and \'markdown\' modes
+.B mode: Determine the output mode. Valid modes are \(aqtext\(aq, \(aqtrac\(aq,
+.
+\(aqpdf\(aq, \(aqmarkdown\(aq and \(aqrdoc\(aq. The \(aqpdf\(aq and \(aqmarkdown\(aq modes
create PDF or Markdown formatted files in the /tmp directory.
-Note that \'trac\' mode only works on Reductive Labs servers.
-The default mode is \'text\'. In \'rdoc\' mode you must provide
-\'manifests\-path\'
-
-
+Note that \(aqtrac\(aq mode only works on Reductive Labs servers.
+The default mode is \(aqtext\(aq. In \(aqrdoc\(aq mode you must provide
+\(aqmanifests\-path\(aq
.TP
.B reference: Build a particular reference. Get a list of references by
+.
running +puppetdoc \-\-list+.
-
.UNINDENT
-
.SH EXAMPLE
.INDENT 0.0
.INDENT 3.5
+.sp
$ puppetdoc \-r type > /tmp/type_reference.rst
-
.UNINDENT
.UNINDENT
+.sp
or
-
.INDENT 0.0
.INDENT 3.5
+.sp
$ puppetdoc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
-
.UNINDENT
.UNINDENT
+.sp
or
-
.INDENT 0.0
.INDENT 3.5
+.sp
$ puppetdoc /etc/puppet/manifests/site.pp
-
.UNINDENT
.UNINDENT
+.sp
or
-
.INDENT 0.0
.INDENT 3.5
+.sp
$ puppetdoc \-m markdown \-r configuration
-
.UNINDENT
.UNINDENT
-
.SH AUTHOR
+.sp
Luke Kanies
-
-
.SH COPYRIGHT
+.sp
Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
Public License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
.\"
+.
diff --git a/man/man8/ralsh.8 b/man/man8/ralsh.8
index 875f4e1..98892e0 100644
--- a/man/man8/ralsh.8
+++ b/man/man8/ralsh.8
@@ -2,127 +2,122 @@
.SH NAME
\-
.\" Man page generated from reStructeredText.
+.
+.sp
vim: softtabstop=4 shiftwidth=4 expandtab
-
-
.SH SYNOPSIS
+.sp
Use the Puppet RAL to directly interact with the system.
-
-
.SH USAGE
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
-
.TP
.B ralsh [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-H|\-\-host <host>]
+.
[\-p|\-\-param <param>] [\-t|\-\-types] type <name>
-
.UNINDENT
.UNINDENT
.UNINDENT
-
.SH DESCRIPTION
+.sp
This command provides simple facilities for converting current system
state into Puppet code, along with some ability to use Puppet to affect
the current state.
-
+.sp
By default, you must at least provide a type to list, which case ralsh
will tell you everything it knows about all instances of that type. You
can optionally specify an instance name, and ralsh will only describe
that single instance.
-
+.sp
You can also add +\-\-edit+ as an argument, and ralsh will write its
output to a file, open that file in an editor, and then apply the file
as a Puppet transaction. You can easily use this to use Puppet to make
simple changes to a system.
-
-
.SH OPTIONS
-Note that any configuration parameter that\'s valid in the configuration
-file is also a valid long argument. For example, \'ssldir\' is a valid
-configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
+.sp
+Note that any configuration parameter that\(aqs valid in the configuration
+file is also a valid long argument. For example, \(aqssldir\(aq is a valid
+configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an
argument.
-
+.sp
See the configuration file documentation at
\fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the
full list of acceptable parameters. A commented list of all
configuration options can also be generated by running puppet with
-\'\-\-genconfig\'.
-
+\(aq\-\-genconfig\(aq.
+.sp
debug: Enable full debugging.
-
+.sp
edit:
-
.INDENT 0.0
.INDENT 3.5
+.sp
Write the results of the query to a file, open the file in an editor,
and read the file back in as an executable Puppet manifest.
-
.UNINDENT
.UNINDENT
+.sp
host:
-
.INDENT 0.0
.INDENT 3.5
+.sp
When specified, connect to the resource server on the named host
and retrieve the list of resouces of the type specified.
-
.UNINDENT
.UNINDENT
+.sp
help:
-
.INDENT 0.0
.INDENT 3.5
+.sp
Print this help message.
-
.UNINDENT
.UNINDENT
+.sp
param:
-
.INDENT 0.0
.INDENT 3.5
+.sp
Add more parameters to be outputted from queries.
-
.UNINDENT
.UNINDENT
+.sp
types:
-
.INDENT 0.0
.INDENT 3.5
+.sp
List all available types.
-
.UNINDENT
.UNINDENT
+.sp
verbose: Print extra information.
-
-
.SH EXAMPLE
+.sp
This example uses \fBralsh\fP to return Puppet configuration for the user
\fBluke\fP:
-
-
+.sp
.nf
+.ft C
$ ralsh user luke
-user { \'luke\':
- home => \'/home/luke\',
- uid => \'100\',
- ensure => \'present\',
- comment => \'Luke Kanies,,,\',
- gid => \'1000\',
- shell => \'/bin/bash\',
- groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\']
+user { \(aqluke\(aq:
+ home => \(aq/home/luke\(aq,
+ uid => \(aq100\(aq,
+ ensure => \(aqpresent\(aq,
+ comment => \(aqLuke Kanies,,,\(aq,
+ gid => \(aq1000\(aq,
+ shell => \(aq/bin/bash\(aq,
+ groups => [\(aqsysadmin\(aq,\(aqaudio\(aq,\(aqvideo\(aq,\(aqpuppet\(aq]
}
+.ft P
.fi
-
.SH AUTHOR
+.sp
Luke Kanies
-
-
.SH COPYRIGHT
+.sp
Copyright (c) 2005\-2007 Reductive Labs, LLC Licensed under the GNU
Public License
-
-
-.\" Generated by docutils manpage writer on 2009-12-30 19:24.
+.\" Generated by docutils manpage writer.
.\"
+.
--
Puppet packaging for Debian
More information about the Pkg-puppet-devel
mailing list