diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5 index 2a5b1b192..1e4e70457 100644 --- a/man/man5/puppet.conf.5 +++ b/man/man5/puppet.conf.5 @@ -1,1490 +1,1557 @@ .TH CONFIGURATION REFERENCE "" "" "" .SH NAME Configuration Reference \- .\" Man page generated from reStructeredText. . .sp -\fBThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Sun Apr 11 17:57:48 \-0400 2010)\fP +\fBThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Wed Jul 14 14:33:09 \-0700 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 +$ puppet agent \-\-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 +$ puppet agent \-\-storeconfigs -$ puppetd \-\-no\-storeconfigs +$ puppet agent \-\-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 default configuration directory is \fB~user/.puppet\fP. As of 0.23.0, all 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. +and each executable will also use one of the \fBmaster\fP, \fBagent\fP, or +\fBuser\fP sections. .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 + 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} + myfile = /tmp/whatever {owner = root, mode = 644} .ft P .fi .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 +$ puppet agent \-\-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\(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 +$ puppet agent \-\-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 +$ puppet agent \-\-mkusers .ft P .fi .SH SIGNALS .sp -The \fBpuppetd\fP and \fBpuppetmasterd\fP executables catch some signals for special +The \fBpuppet agent\fP and \fBpuppet master\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. +down the server, whether it be an instance of \fBpuppet agent\fP or \fBpuppet master\fP. .sp -Sending the \fBSIGUSR1\fP signal to an instance of \fBpuppetd\fP will cause it to +Sending the \fBSIGUSR1\fP signal to an instance of \fBpuppet agent\fP will cause it to immediately begin a new configuration transaction with the server. This -signal has no effect on \fBpuppetmasterd\fP. +signal has no effect on \fBpuppet master\fP. .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 .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 . \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. +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 \fBpuppet agent\fP and \fBpuppet master\fP. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $confdir/namespaceauth.conf .UNINDENT .SS autoflush .sp Whether log files should always flush to disk. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: $vardir/bucket .UNINDENT .SS ca .sp Wether the master should function as a certificate authority. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: md5 .UNINDENT +.SS ca_name +.sp +The name to use the Certificate Authority certificate. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: $certname +.UNINDENT .SS ca_port .sp The port to use for the certificate authority. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $masterport .UNINDENT .SS ca_server .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 . \fBDefault\fP: $server .UNINDENT .SS ca_ttl .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 . \fBDefault\fP: 5y .UNINDENT .SS cacert .sp The CA certificate. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: $cadir/ca_crl.pem .UNINDENT .SS cadir .sp The root directory for the certificate authority. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $ssldir/ca .UNINDENT .SS cakey .sp The CA private key. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: $caprivatedir/ca.pass .UNINDENT .SS caprivatedir .sp Where the CA stores private certificate information. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $cadir/private .UNINDENT .SS capub .sp The CA public key. .INDENT 0.0 .IP \(bu 2 . \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 -. -\fBDefault\fP: false -.UNINDENT .SS catalog_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 catalog_terminus .sp Where to get node catalogs. This is useful to change if, for instance, you\(aqd like to pre\-compile catalogs and store them in memcached or some other easily\-accessed store. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: compiler .UNINDENT .SS cert_inventory .sp A Complete listing of all certificates .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $cadir/inventory.txt .UNINDENT .SS certdir .sp The certificate directory. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $ssldir/certs .UNINDENT .SS certdnsnames .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 certificate_revocation +.sp +Whether certificate revocation should be supported by downloading a Certificate Revocation List (CRL) to all clients. If enabled, CA chaining will almost definitely not work. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: true +.UNINDENT .SS certname .sp The name to use when handling certificates. Defaults to the fully qualified domain name. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: pelin.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. +The file in which puppet agent 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 . \fBDefault\fP: $statedir/classes.txt .UNINDENT +.SS client_datadir +.sp +The directory in which serialized data is stored on the client. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: $vardir/client_data +.UNINDENT .SS clientbucketdir .sp Where FileBucket files are stored locally. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $vardir/clientbucket .UNINDENT .SS clientyamldir .sp The directory in which client\-side YAML data is stored. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $vardir/client_yaml .UNINDENT .SS code .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 . \fBDefault\fP: ansi .UNINDENT .SS confdir .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. +The main Puppet configuration directory. The default for this parameter is calculated based on the user. If the process is running as root or the user that \fBpuppet master\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 . \fBDefault\fP: /etc/puppet .UNINDENT .SS config .sp -The configuration file for puppetdoc. +The configuration file for doc. .INDENT 0.0 .IP \(bu 2 . \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 .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 . \fBDefault\fP: 120 .UNINDENT +.SS couchdb_url +.sp +The url where the puppet couchdb database will be created +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: \fI\%http://127.0.0.1:5984/puppet\fP +.UNINDENT .SS csrdir .sp Where the CA stores certificate requests .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $cadir/requests .UNINDENT .SS daemonize .sp Send the process into the background. This is the default. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: true .UNINDENT .SS dbadapter .sp The type of database to use. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: sqlite3 .UNINDENT - .SS dbconnections +.sp The number of database connections. Only used when networked databases are used. Will be ignored if the value is an empty string or is less than 1. - - +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: 0 +.UNINDENT .SS dblocation .sp The database cache for client configurations. Used for querying within the language. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $statedir/clientconfigs.sqlite3 .UNINDENT .SS dbmigrate .sp Whether to automatically migrate the database. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS dbname .sp The name of the database to use. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: puppet .UNINDENT .SS dbpassword .sp -The database password for Client caching. Only used when networked databases are used. +The database password for caching. Only used when networked databases are used. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: puppet .UNINDENT +.SS dbport +.sp +The database password for caching. Only used when networked databases are used. .SS dbserver .sp -The database server for Client caching. Only used when networked databases are used. +The database server for caching. Only used when networked databases are used. .INDENT 0.0 .IP \(bu 2 . \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. +The database user for caching. Only used when networked databases are used. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: puppet .UNINDENT .SS diff .sp Which diff command to use when printing differences between files. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \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 . \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. +The environment Puppet is running in. For clients (e.g., \fBpuppet agent\fP) this determines the environment itself, which is used to find modules and much more. For servers (i.e., \fBpuppet master\fP) this provides the default environment for nodes we know nothing about. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \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 . \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 . -\fBDefault\fP: $vardir/facts/ +\fBDefault\fP: $vardir/lib/facter/${\fI\%File::PATH_SEPARATOR\fP}$vardir/facts +.UNINDENT +.SS facts_terminus +.sp +Where to get node facts. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: facter .UNINDENT .SS factsignore .sp What files to ignore when pulling down facts. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: puppet://$server/facts/ .UNINDENT .SS factsync .sp Whether facts should be synced with the central server. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS fileserverconfig .sp Where the fileserver configuration is stored. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: 15 .UNINDENT +.SS freeze_main +.sp +Freezes the \(aqmain\(aq class, disallowing any code to be added to it. This essentially means that you can\(aqt have any code outside of a node, class, or definition other than in the site manifest. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: false +.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 . \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 . \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 . \fBDefault\fP: false .UNINDENT .SS graphdir .sp Where to store dot\-outputted graphs. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $statedir/graphs .UNINDENT .SS group .sp -The group puppetmasterd should run as. +The group puppet master should run as. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: puppet .UNINDENT .SS hostcert .sp Where individual hosts store and look for their certificates. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $certdir/$certname.pem .UNINDENT .SS hostcrl .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 . \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 . \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 . \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 . \fBDefault\fP: $publickeydir/$certname.pem .UNINDENT +.SS http_compression +.sp +Allow http compression in REST communication with the master. This setting might improve performance for agent \-> master communications over slow WANs. Your puppetmaster needs to support compression (usually by activating some settings in a reverse\-proxy in front of the puppetmaster, which rules out webrick). It is harmless to activate this settings if your master doesn\(aqt support compression, but if it supports it, this setting might reduce performance on high\-speed LANs. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: false +.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 . \fBDefault\fP: none .UNINDENT .SS http_proxy_port .sp The HTTP proxy port to use for outgoing connections .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: 3128 .UNINDENT .SS httplog .sp -Where the puppetd web server logs. +Where the puppet agent web server logs. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: false .UNINDENT .SS ignoreschedules .sp -Boolean; whether puppetd should ignore schedules. This is useful for initial puppetd runs. +Boolean; whether puppet agent should ignore schedules. This is useful for initial puppet agent runs. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS keylength .sp The bit length of keys. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: 1024 .UNINDENT .SS ldapattrs .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 . \fBDefault\fP: all .UNINDENT .SS ldapbase .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 . \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. +Whether to search for node configurations in LDAP. See \fI\%http://projects.puppetlabs.com/projects/puppet/wiki/LDAP_Nodes\fP for more information. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS ldapparentattr .sp The attribute to use to define the parent node. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: 389 .UNINDENT .SS ldapserver .sp The LDAP server. Only used if \fBldapnodes\fP is enabled. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: puppetvar .UNINDENT .SS ldapstring .sp The search string used to find an LDAP node. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: false .UNINDENT .SS libdir .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 . \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. +Whether puppet agent 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 \fBpuppet agent\fP runs. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS localcacert .sp Where each client stores the CA certificate. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $certdir/ca.pem .UNINDENT .SS localconfig .sp -Where puppetd caches the local configuration. An extension indicating the cache format is added automatically. +Where puppet agent caches the local configuration. An extension indicating the cache format is added automatically. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $statedir/localconfig .UNINDENT .SS logdir .sp The Puppet log directory. .INDENT 0.0 .IP \(bu 2 . \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 +Whether Puppet should manage the owner, group, and mode of files it uses internally .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: true .UNINDENT .SS manifest .sp -The entry\-point manifest for puppetmasterd. +The entry\-point manifest for puppet master. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $manifestdir/site.pp .UNINDENT .SS manifestdir .sp -Where puppetmasterd looks for its manifests. +Where puppet master looks for its manifests. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $confdir/manifests .UNINDENT .SS masterhttplog .sp -Where the puppetmasterd web server logs. +Where the puppet master web server logs. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $logdir/masterhttp.log .UNINDENT .SS masterlog .sp -Where puppetmasterd logs. This is generally not used, since syslog is the default log destination. +Where puppet master logs. This is generally not used, since syslog is the default log destination. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $logdir/puppetmaster.log .UNINDENT .SS masterport .sp -Which port puppetmasterd listens on. +Which port puppet master listens on. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: 4294967290 .UNINDENT .SS mkusers .sp -Whether to create the necessary user and group that puppetd will run as. +Whether to create the necessary user and group that puppet agent will run as. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT +.SS mode +.sp +The effective \(aqrun mode\(aq of the application: master, agent, or user. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: master +.UNINDENT .SS modulepath .sp The search path for modules as a colon\-separated list of directories. .INDENT 0.0 .IP \(bu 2 . \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. +The name of the application, if we are running as one. The default is essentially $0 without the path or \fB.rb\fP. .INDENT 0.0 .IP \(bu 2 . -\fBDefault\fP: puppetdoc +\fBDefault\fP: doc .UNINDENT .SS node_name .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 . \fBDefault\fP: cert .UNINDENT .SS node_terminus .sp Where to find information about nodes. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: plain .UNINDENT .SS noop .sp -Whether puppetd should be run in noop mode. +Whether puppet agent should be run in noop mode. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT -.SS paramcheck +.SS onetime .sp -Whether to validate parameters during parsing. +Run the configuration once, rather than as a long\-running daemon. This is useful for interactively running puppetd. .INDENT 0.0 .IP \(bu 2 . -\fBDefault\fP: true +\fBDefault\fP: false .UNINDENT .SS parseonly .sp Just check the syntax of the manifests. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS passfile .sp -Where puppetd stores the password for its private key. Generally unused. +Where puppet agent stores the password for its private key. Generally unused. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: none .UNINDENT .SS pidfile .sp The pid file .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: $libdir .UNINDENT .SS pluginsignore .sp What files to ignore when pulling down plugins. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: puppet://$server/plugins .UNINDENT .SS pluginsync .sp Whether plugins should be synced with the central server. .INDENT 0.0 .IP \(bu 2 . \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 .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 . \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 . \fBDefault\fP: $ssldir/private .UNINDENT .SS privatekeydir .sp The private key directory. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $ssldir/private_keys .UNINDENT .SS publickeydir .sp The public key directory. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $ssldir/public_keys .UNINDENT .SS puppetdlockfile .sp -A lock file to temporarily stop puppetd from doing anything. +A lock file to temporarily stop puppet agent from doing anything. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $statedir/puppetdlock .UNINDENT .SS puppetdlog .sp -The log file for puppetd. This is generally not used. +The log file for puppet agent. This is generally not used. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $logdir/puppetd.log .UNINDENT .SS puppetport .sp -Which port puppetd listens on. +Which port puppet agent listens on. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \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 . \fBDefault\fP: info .UNINDENT .SS railslog .sp Where Rails\-specific logs are sent .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $logdir/rails.log .UNINDENT .SS report .sp Whether to send reports after every transaction. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT .SS report_port .sp The port to communicate with the report_server. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $masterport .UNINDENT .SS report_server .sp The server to which to send transaction reports. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: $vardir/reports .UNINDENT .SS reportfrom .sp The \(aqfrom\(aq email address for the reports. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: \fI\%report@pelin.lovedthanlost.net\fP .UNINDENT .SS reports .sp -The list of reports to generate. All reports are looked for in puppet/reports/.rb, and multiple report names should be comma\-separated (whitespace is okay). +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 . \fBDefault\fP: store .UNINDENT .SS reportserver .sp (Deprecated for \(aqreport_server\(aq) The server to which to send transaction reports. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $server .UNINDENT +.SS reporturl +.sp +The URL used by the http reports processor to send reports +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: \fI\%http://localhost:3000/reports\fP +.UNINDENT .SS req_bits .sp The bit length of the certificates. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: 2048 .UNINDENT .SS requestdir .sp Where host certificate requests are stored. .INDENT 0.0 .IP \(bu 2 . \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. +The configuration file that defines the rights to the different rest indirections. This can be used as a fine\-grained authorization system for \fBpuppet master\fP. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: $runinterval .UNINDENT .SS rundir .sp Where Puppet PID files are kept. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $vardir/run .UNINDENT .SS runinterval .sp -How often puppetd applies the client configuration; in seconds. +How often puppet agent applies the client configuration; in seconds. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: 1800 .UNINDENT .SS sendmail .sp Where to find the sendmail binary with which to send email. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: /usr/sbin/sendmail .UNINDENT .SS serial .sp Where the serial number for certificates is stored. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $cadir/serial .UNINDENT .SS server .sp -The server to which server puppetd should connect +The server to which server puppet agent should connect .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: puppet .UNINDENT +.SS server_datadir +.sp +The directory in which serialized data is stored, usually in a subdirectory. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: $vardir/server_data +.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 . \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 . \fBDefault\fP: false .UNINDENT .SS signeddir .sp Where the CA stores signed certificates. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $cadir/signed .UNINDENT .SS smtpserver .sp The server through which to send email reports. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: $runinterval .UNINDENT .SS ssl_client_header .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. +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.puppetlabs.com\fP). See \fI\%http://projects.puppetlabs.com/projects/puppet/wiki/Using_Mongrel\fP for more information. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: HTTP_X_CLIENT_DN .UNINDENT .SS ssl_client_verify_header .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. +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://projects.puppetlabs.com/projects/puppet/wiki/Using_Mongrel\fP for more information. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: HTTP_X_CLIENT_VERIFY .UNINDENT .SS ssldir .sp Where SSL certificates are kept. .INDENT 0.0 .IP \(bu 2 . \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 . \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. +Where puppet agent and puppet master store state associated with the running configuration. In the case of puppet master, this file reflects the state discovered through interacting with clients. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $statedir/state.yaml .UNINDENT .SS storeconfigs .sp Whether to store each client\(aqs configuration. This requires ActiveRecord from Ruby on Rails. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: false .UNINDENT .SS summarize .sp Whether to print a transaction summary. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: daemon .UNINDENT .SS tagmap .sp The mapping between reporting tags and email addresses. .INDENT 0.0 .IP \(bu 2 . \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 . \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 . \fBDefault\fP: false .UNINDENT .SS trace .sp Whether to print stack traces on some errors .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .UNINDENT -.SS typecheck -.sp -Whether to validate types during parsing. -.INDENT 0.0 -.IP \(bu 2 -. -\fBDefault\fP: true -.UNINDENT .SS use_cached_catalog .sp Whether to only use the cached catalog rather than compiling a new catalog on every run. Puppet can be run with this enabled by default and then selectively disabled when a recompile is desired. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: false .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 . \fBDefault\fP: true .UNINDENT .SS user .sp -The user puppetmasterd should run as. +The user puppet master should run as. .INDENT 0.0 .IP \(bu 2 . \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 . \fBDefault\fP: /var/lib/puppet .UNINDENT .SS yamldir .sp The directory in which YAML data is stored, usually in a subdirectory. .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: $vardir/yaml .UNINDENT .SS zlib .sp Boolean; whether to use the zlib library .INDENT 0.0 .IP \(bu 2 . \fBDefault\fP: true .UNINDENT .sp .ce ---- .ce 0 .sp .sp -\fIThis page autogenerated on Sun Apr 11 17:57:48 \-0400 2010\fP +\fIThis page autogenerated on Wed Jul 14 14:33:09 \-0700 2010\fP .\" Generated by docutils manpage writer. .\" . diff --git a/man/man8/filebucket.8 b/man/man8/filebucket.8 index 2cfc82cea..dc2d60e63 100644 --- a/man/man8/filebucket.8 +++ b/man/man8/filebucket.8 @@ -1,107 +1,107 @@ .TH "" "" "" .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] +.B puppet filebucket [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] . [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server ] [\-b|\-\-bucket ] ... .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\(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 +$ puppet filebucket backup /etc/passwd /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 -$ filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 +$ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 $ .UNINDENT .UNINDENT .SH OPTIONS .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 \(aq as an argument. .sp See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the +\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with \(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 +puppet 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. .\" . diff --git a/man/man8/pi.8 b/man/man8/pi.8 index 519be2ca9..3e25485fc 100644 --- a/man/man8/pi.8 +++ b/man/man8/pi.8 @@ -1,50 +1,50 @@ .TH "" "" "" .SH NAME \- .\" Man page generated from reStructeredText. . .SH SYNOPSIS .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] +puppet describe [\-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 +puppet describe \-\-list +puppet describe file \-\-providers +puppet describe 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. .\" . diff --git a/man/man8/puppet.8 b/man/man8/puppet.8 index d34711bb2..7fa2a05c2 100644 --- a/man/man8/puppet.8 +++ b/man/man8/puppet.8 @@ -1,82 +1,11 @@ .TH "" "" "" .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 ] -.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 -.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 \(aq as an -argument. -.sp -See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the -full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppet with -\(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 \(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 +Usage: puppet command +Available commands are: agent, apply, cert, describe, doc, filebucket, kick, master, pi, puppet, puppetca, puppetd, puppetdoc, puppetmasterd, puppetqd, puppetrun, queue, ralsh, resource .\" Generated by docutils manpage writer. .\" . diff --git a/man/man8/puppetca.8 b/man/man8/puppetca.8 index 92e9de1b1..ec1f5045c 100644 --- a/man/man8/puppetca.8 +++ b/man/man8/puppetca.8 @@ -1,115 +1,130 @@ .TH "" "" "" .SH NAME \- .\" Man page generated from reStructeredText. . .SH SYNOPSIS .sp Stand\-alone certificate authority. Capable of generating certificates but mostly meant for signing certificate requests from puppet clients. .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP -.B puppetca [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] +.B puppet cert [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] . [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] -[\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [host] +[\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [\-\-digest DIGEST] +[\-\-fingerprint] [host] .UNINDENT .UNINDENT .UNINDENT .SH DESCRIPTION .sp Because the puppetmasterd daemon defaults to not signing client certificate requests, this script is available for signing outstanding requests. It can be used to list outstanding requests and then either sign them individually or sign all of them. .SH OPTIONS .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 \(aq as an argument. .sp See the configuration file documentation at \fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for the full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppetca with +configuration options can also be generated by running puppet cert with \(aq\-\-genconfig\(aq. .INDENT 0.0 .TP -.B all: Operate on all items. Currently only makes sense with +.B all: Operate on all items. Currently only makes sense with . \(aq\-\-sign\(aq, \(aq\-\-clean\(aq, or \(aq\-\-list\(aq. .TP -.B clean: Remove all files related to a host from puppetca\(aqs storage. +.B digest: Set the digest for fingerprinting (defaults to md5). Valid . -This is useful when rebuilding hosts, since new certificate -signing requests will only be honored if puppetca does not -have a copy of a signed certificate for that host. The -certificate of the host remains valid. If \(aq\-\-all\(aq is specified -then all host certificates, both signed and unsigned, will be -removed. +values depends on your openssl and openssl ruby extension +version, but should contain at least md5, sha1, md2, +sha256. +.TP +.B clean: Remove all files related to a host from puppet cert\(aqs +. +storage. This is useful when rebuilding hosts, since new +certificate signing requests will only be honored if puppet +cert does not have a copy of a signed certificate for that +host. The certificate of the host remains valid. If \(aq\-\-all\(aq +is specified then all host certificates, both signed and +unsigned, will be removed. .UNINDENT .sp -debug: Enable full debugging. +debug: Enable full debugging. .INDENT 0.0 .TP -.B generate: Generate a certificate for a named client. A +.B generate: Generate a certificate for a named client. A . -certificate/keypair will be generated for each client named on -the command line. +certificate/keypair will be generated for each client named +on the command line. .UNINDENT .sp -help: Print this help message +help: Print this help message .INDENT 0.0 .TP -.B list: List outstanding certificate requests. If \(aq\-\-all\(aq is +.B list: List outstanding certificate requests. If \(aq\-\-all\(aq is . specified, signed certificates are also listed, prefixed by -\(aq+\(aq, and revoked or invalid certificates are prefixed by \(aq\-\(aq -(the verification outcome is printed in parenthesis). +\(aq+\(aq, and revoked or invalid certificates are prefixed by +\(aq\-\(aq (the verification outcome is printed in parenthesis). .UNINDENT .sp -print: Print the full\-text version of a host\(aqs certificate. +print: Print the full\-text version of a host\(aqs certificate. .INDENT 0.0 .TP -.B revoke: Revoke the certificate of a client. The certificate can be +.B fingerprint: Print the DIGEST (defaults to md5) fingerprint of a host\(aqs +. +certificate. +.TP +.B revoke: Revoke the certificate of a client. The certificate can be . specified either by its serial number, given as a decimal number or a hexadecimal number prefixed by \(aq0x\(aq, or by its hostname. The certificate is revoked by adding it to the Certificate Revocation List given by the \(aqcacrl\(aq config -parameter. Note that the puppetmasterd needs to be restarted -after revoking certificates. +parameter. Note that the puppetmasterd needs to be +restarted after revoking certificates. .TP -.B sign: Sign an outstanding certificate request. Unless \(aq\-\-all\(aq is +.B sign: Sign an outstanding certificate request. Unless \(aq\-\-all\(aq is . specified, hosts must be listed after all flags. .UNINDENT .sp -verbose: Enable verbosity. -.sp -version: Print the puppet version number and exit. +verbose: Enable verbosity. .sp -verify: Verify the named certificate against the local CA certificate. +version: Print the puppet version number and exit. +.INDENT 0.0 +.TP +.B verify: Verify the named certificate against the local CA +. +certificate. +.UNINDENT .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -$ puppetca \-l +$ puppet cert \-l culain.madstop.com -$ puppetca \-s culain.madstop.com +$ puppet cert \-s culain.madstop.com .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. .\" . diff --git a/man/man8/puppetd.8 b/man/man8/puppetd.8 index a913531a0..090c3342d 100644 --- a/man/man8/puppetd.8 +++ b/man/man8/puppetd.8 @@ -1,185 +1,227 @@ .TH SYNOPSIS "" "" "" .SH NAME Synopsis \- .\" Man page generated from reStructeredText. . .sp -Retrieve the client configuration from the central puppet server and -apply it to the local host. +Retrieve the client configuration from the puppet master and apply it to +the local host. .sp Currently must be run out periodically, using cron or something similar. .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP -.B puppetd [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-disable] [\-\-enable] +.B puppet agent [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] . +[\-\-detailed\-exitcodes] [\-\-disable] [\-\-enable] [\-h|\-\-help] [\-\-fqdn ] [\-l|\-\-logdest syslog||console] [\-o|\-\-onetime] [\-\-serve ] [\-t|\-\-test] [\-\-noop] -[\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert ] +[\-\-digest ] [\-\-fingerprint] [\-V|\-\-version] +[\-v|\-\-verbose] [\-w|\-\-waitforcert ] .UNINDENT .UNINDENT .UNINDENT .SH DESCRIPTION .sp This is the main puppet client. Its job is to retrieve the local machine\(aqs configuration from a remote server and apply it. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default). The client will connect and request a signed certificate, and will continue connecting until it receives one. .sp Once the client has a signed certificate, it will retrieve its configuration and apply it. .SH USAGE NOTES .sp -+puppetd+ does its best to find a compromise between interactive use and -daemon use. Run with no arguments and no configuration, it will go into -the backgroun, attempt to get a signed certificate, and retrieve and -apply its configuration every 30 minutes. ++puppet agent+ does its best to find a compromise between interactive +use and daemon use. Run with no arguments and no configuration, it will +go into the backgroun, attempt to get a signed certificate, and retrieve +and apply its configuration every 30 minutes. .sp Some flags are meant specifically for interactive use \-\- in particular, -+test+ and +tags+ are useful. +test+ enables verbose logging, causes the -daemon to stay in the foreground, exits if the server\(aqs configuration is -invalid (this happens if, for instance, you\(aqve left a syntax error on -the server), and exits after running the configuration once (rather than -hanging around as a long\-running process). ++test+, +tags+ or +fingerprint+ are useful. +test+ enables verbose +logging, causes the daemon to stay in the foreground, exits if the +server\(aqs configuration is invalid (this happens if, for instance, you\(aqve +left a syntax error on the server), and exits after running the +configuration once (rather than hanging around as a long\-running +process). .sp +tags+ allows you to specify what portions of a configuration you want to apply. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the +tags+ flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage +ntpd+, you would put all of the new elements into an +ntpd+ class, and call puppet with +\-\-tags ntpd+, which would only apply that small portion of the configuration during your testing, rather than applying the whole thing. +.sp ++fingerprint+ is a one\-time flag. In this mode +puppet agent+ will run +once and display on the console (and in the log) the current certificate +(or certificate request) fingerprint. Providing the +\-\-digest+ option +allows to use a different digest algorithm to generate the fingerprint. +The main use is to verify that before signing a certificate request on +the master, the certificate request the master received is the same as +the one the client sent (to prevent against man\-in\-the\-middle attacks +when signing certificates). .SH OPTIONS .sp Note that any configuration parameter that\(aqs valid in the configuration file is also a valid long argument. For example, \(aqserver\(aq is a valid configuration parameter, so you can specify \(aq\-\-server \(aq as an argument. .sp See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the +\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppetd with +configuration options can also be generated by running puppet agent with \(aq\-\-genconfig\(aq. +.INDENT 0.0 +.TP +.B daemonize: Send the process into the background. This is the +. +default. +.UNINDENT .sp -daemonize: Send the process into the background. This is the default. -.sp -no\-daemonize: Do not send the process into the background. +no\-daemonize: Do not send the process into the background. .sp -debug: Enable full debugging. +debug: Enable full debugging. .INDENT 0.0 .TP -.B disable: Disable working on the local system. This puts a lock file +.B digest: Change the certificate fingerprinting digest +. +algorithm. The default is MD5. Valid values depends +on the version of OpenSSL installed, but should +always at least contain MD5, MD2, SHA1 and SHA256. +.TP +.B detailed\-exitcodes: Provide transaction information via exit codes. If +. +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. This +option only makes sense in conjunction with +\-\-onetime. +.TP +.B disable: Disable working on the local system. This puts a . -in place, causing +puppetd+ not to work on the system -until the lock file is removed. This is useful if you are -testing a configuration and do not want the central -configuration to override the local state until everything -is tested and committed. +lock file in place, causing +puppet agent+ not to +work on the system until the lock file is removed. +This is useful if you are testing a configuration +and do not want the central configuration to +override the local state until everything is tested +and committed. .UNINDENT .sp -+puppetd+ uses the same lock file while it is running, so no more than -one +puppetd+ process is working at a time. ++puppet agent+ uses the same lock file while it is running, so no more +than one +puppet agent+ process is working at a time. .sp -+puppetd+ exits after executing this. ++puppet agent+ exits after executing this. .INDENT 0.0 .TP -.B enable: Enable working on the local system. This removes any lock +.B enable: Enable working on the local system. This removes any . -file, causing +puppetd+ to start managing the local system -again (although it will continue to use its normal -scheduling, so it might not start for another half hour). +lock file, causing +puppet agent+ to start managing +the local system again (although it will continue to +use its normal scheduling, so it might not start for +another half hour). .UNINDENT .sp -+puppetd+ exits after executing this. ++puppet agent+ exits after executing this. .INDENT 0.0 .TP -.B fqdn: Set the fully\-qualified domain name of the client. This is +.B fqdn: Set the fully\-qualified domain name of the client. . -only used for certificate purposes, but can be used to -override the discovered hostname. If you need to use this -flag, it is generally an indication of a setup problem. +This is only used for certificate purposes, but can +be used to override the discovered hostname. If you +need to use this flag, it is generally an indication +of a setup problem. .UNINDENT .sp -help: Print this help message +help: Print this help message .INDENT 0.0 .TP -.B logdest: Where to send messages. Choose between syslog, the +.B logdest: Where to send messages. Choose between syslog, the . -console, and a log file. Defaults to sending messages to -syslog, or the console if debugging or verbosity is -enabled. +console, and a log file. Defaults to sending +messages to syslog, or the console if debugging or +verbosity is enabled. .TP -.B no\-client: Do not create a config client. This will cause the daemon +.B no\-client: Do not create a config client. This will cause the . -to run without ever checking for its configuration -automatically, and only makes sense when used in -conjunction with \-\-listen. +daemon to run without ever checking for its +configuration automatically, and only makes sense +when used in conjunction with \-\-listen. .TP -.B onetime: Run the configuration once. Runs a single daemonized +.B onetime: Run the configuration once. Runs a single (normally . -Puppet run. Useful for interactively running puppetd and -hence used in conjunction with the \-\-no\-daemonize option. +daemonized) Puppet run. Useful for interactively +running puppet agent when used in conjunction with +the \-\-no\-daemonize option. .TP -.B serve: Start another type of server. By default, +puppetd+ will -. -start a service handler that allows authenticated and -authorized remote nodes to trigger the configuration to be -pulled down and applied. You can specify any handler here -that does not require configuration, e.g., filebucket, ca, -or resource. The handlers are in -+lib/puppet/network/handler+, and the names must match -exactly, both in the call to +serve+ and in -+namespaceauth.conf+. +.B fingerprint: Display the current certificate or certificate +. +signing request fingerprint and then exit. Use the ++\-\-digest+ option to change the digest algorithm +used. .TP -.B test: Enable the most common options used for testing. These are +.B serve: Start another type of server. By default, +puppet . -+onetime+, +verbose+, +ignorecache, +no\-daemonize+, and -+no\-usecacheonfailure+. +agent+ will start a service handler that allows +authenticated and authorized remote nodes to trigger +the configuration to be pulled down and applied. You +can specify any handler here that does not require +configuration, e.g., filebucket, ca, or resource. +The handlers are in +lib/puppet/network/handler+, +and the names must match exactly, both in the call +to +serve+ and in +namespaceauth.conf+. .TP -.B noop: Use +noop+ mode where the daemon runs in a no\-op or +.B test: Enable the most common options used for testing. +. +These are +onetime+, +verbose+, +ignorecache, ++no\-daemonize+, and +no\-usecacheonfailure+. +.TP +.B noop: Use +noop+ mode where the daemon runs in a no\-op or . dry\-run mode. This is useful for seeing what changes -Puppet will make without actually executing the changes. +Puppet will make without actually executing the +changes. .UNINDENT .sp -verbose: Turn on verbose reporting. +verbose: Turn on verbose reporting. .sp -version: Print the puppet version number and exit. +version: Print the puppet version number and exit. .INDENT 0.0 .TP -.B waitforcert: This option only matters for daemons that do not yet have -. -certificates and it is enabled by default, with a value of -120 (seconds). This causes +puppetd+ to connect to the -server every 2 minutes and ask it to sign a certificate -request. This is useful for the initial setup of a puppet -client. You can turn off waiting for certificates by -specifying a time of 0. +.B waitforcert: This option only matters for daemons that do not yet +. +have certificates and it is enabled by default, with +a value of 120 (seconds). This causes +puppet agent+ +to connect to the server every 2 minutes and ask it +to sign a certificate request. This is useful for +the initial setup of a puppet client. You can turn +off waiting for certificates by specifying a time of +0. .UNINDENT .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -puppetd \-\-server puppet.domain.com +puppet agent \-\-server puppet.domain.com .UNINDENT .UNINDENT .SH AUTHOR .sp Luke Kanies .SH COPYRIGHT .sp Copyright (c) 2005, 2006 Reductive Labs, LLC Licensed under the GNU Public License .\" Generated by docutils manpage writer. .\" . diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8 index 5cf7269f0..281b7385e 100644 --- a/man/man8/puppetdoc.8 +++ b/man/man8/puppetdoc.8 @@ -1,104 +1,108 @@ .TH "" "" "" .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 ] [\-m|\-\-mode ] +.B puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir ] [\-m|\-\-mode ] . -[\-r|\-\-reference <[type]|configuration|..>] [manifest\-file] +[\-r|\-\-reference <[type]|configuration|..>] [\-\-charset CHARSET] [manifest\-file] .UNINDENT .UNINDENT .UNINDENT .SH DESCRIPTION .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. .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 \(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 +puppet doc 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 \(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 \(aqrdoc\(aq mode. .TP .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 \(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+. +running +puppet doc \-\-list+. +.TP +.B charset: Used only in \(aqrdoc\(aq mode. It sets the charset used in the +. +html files produced. .UNINDENT .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -$ puppetdoc \-r type > /tmp/type_reference.rst +$ puppet doc \-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 +$ puppet doc \-\-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 +$ puppet doc /etc/puppet/manifests/site.pp .UNINDENT .UNINDENT .sp or .INDENT 0.0 .INDENT 3.5 .sp -$ puppetdoc \-m markdown \-r configuration +$ puppet doc \-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. .\" . diff --git a/man/man8/puppetmasterd.8 b/man/man8/puppetmasterd.8 index 680e5059d..f6fb1e095 100644 --- a/man/man8/puppetmasterd.8 +++ b/man/man8/puppetmasterd.8 @@ -1,72 +1,72 @@ .TH "" "" "" .SH NAME \- .\" Man page generated from reStructeredText. . .SH SYNOPSIS .sp The central puppet server. Functions as a certificate authority by default. .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP -.B puppetmasterd [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help] +.B puppet master [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help] . [\-l|\-\-logdest |console|syslog] [\-v|\-\-verbose] [\-V|\-\-version] .UNINDENT .UNINDENT .UNINDENT .SH DESCRIPTION .sp This is the puppet central daemon. .SH OPTIONS .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 \(aq as an argument. .sp See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the +\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetmasterdd with \(aq\-\-genconfig\(aq. .sp daemonize: Send the process into the background. This is the default. .sp no\-daemonize: Do not send the process into the background. .sp debug: Enable full debugging. .sp help: Print this help message. .INDENT 0.0 .TP .B logdest: Where to send messages. Choose between syslog, the . console, and a log file. Defaults to sending messages to syslog, or the console if debugging or verbosity is enabled. .UNINDENT .sp verbose: Enable verbosity. .sp version: Print the puppet version number and exit. .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -puppetmasterd +puppet master .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. .\" . diff --git a/man/man8/puppetqd.8 b/man/man8/puppetqd.8 index 2da8b985d..db27c664e 100644 --- a/man/man8/puppetqd.8 +++ b/man/man8/puppetqd.8 @@ -1,55 +1,55 @@ .TH SYNOPSIS "" "" "" .SH NAME Synopsis \- .\" Man page generated from reStructeredText. . .sp Retrieve serialized records from a queue and process them in order. .SH USAGE .INDENT 0.0 .INDENT 3.5 .sp -puppetqd [\-d|\-\-debug] [\-v|\-\-verbose] +puppet queue [\-d|\-\-debug] [\-v|\-\-verbose] .UNINDENT .UNINDENT .SH DESCRIPTION .sp This is a simple application that just processes entities in a queue as they are recieved. .SH OPTIONS .sp Note that any configuration parameter that\(aqs valid in the configuration file is also a valid long argument. For example, \(aqserver\(aq is a valid configuration parameter, so you can specify \(aq\-\-server \(aq as an argument. .sp See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the +\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetd with \(aq\-\-genconfig\(aq. .sp debug: Enable full debugging. .sp help: Print this help message .sp verbose: Turn on verbose reporting. .sp version: Print the puppet version number and exit. .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -puppetqd +puppet queue .UNINDENT .UNINDENT .SH AUTHOR .sp Luke Kanies .SH COPYRIGHT .sp Copyright (c) 2009 Reductive Labs, LLC Licensed under the GNU Public License .\" Generated by docutils manpage writer. .\" . diff --git a/man/man8/puppetrun.8 b/man/man8/puppetrun.8 index 73a4ba3f2..9cbc2bd9b 100644 --- a/man/man8/puppetrun.8 +++ b/man/man8/puppetrun.8 @@ -1,152 +1,153 @@ .TH "" "" "" .SH NAME \- .\" Man page generated from reStructeredText. . .SH SYNOPSIS .sp -Trigger a puppetd run on a set of hosts. +Trigger a puppet agent run on a set of hosts. .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .TP -.B puppetrun [\-a|\-\-all] [\-c|\-\-class ] [\-d|\-\-debug] [\-f|\-\-foreground] +.B puppet kick [\-a|\-\-all] [\-c|\-\-class ] [\-d|\-\-debug] [\-f|\-\-foreground] . [\-h|\-\-help] [\-\-host ] [\-\-no\-fqdn] [\-\-ignoreschedules] -[\-t|\-\-tag ] [\-\-test] [\-p|\-\-ping] +[\-t|\-\-tag ] [\-\-test] [\-p|\-\-ping] [ [...]] .UNINDENT .UNINDENT .UNINDENT .SH DESCRIPTION .sp -This script can be used to connect to a set of machines running -+puppetd+ and trigger them to run their configurations. The most common +This script can be used to connect to a set of machines running +puppet +agent+ and trigger them to run their configurations. The most common usage would be to specify a class of hosts and a set of tags, and -+puppetrun+ would look up in LDAP all of the hosts matching that class, -then connect to each host and trigger a run of all of the objects with -the specified tags. ++puppet kick+ would look up in LDAP all of the hosts matching that +class, then connect to each host and trigger a run of all of the objects +with the specified tags. .sp If you are not storing your host configurations in LDAP, you can specify hosts manually. .sp -You will most likely have to run +puppetrun+ as root to get access to +You will most likely have to run +puppet kick+ as root to get access to the SSL certificates. .sp -+puppetrun+ reads +puppetmaster+\(aqs configuration file, so that it can ++puppet kick+ reads +puppet master+\(aqs configuration file, so that it can copy things like LDAP settings. .SH USAGE NOTES .sp -+puppetrun+ is useless unless +puppetd+ is listening. See its ++puppet kick+ is useless unless +puppet agent+ is listening. See its documentation for more information, but the gist is that you must enable -+listen+ on the +puppetd+ daemon, either using +\-\-listen+ on the command -line or adding \(aqlisten: true\(aq in its config file. In addition, you need -to set the daemons up to specifically allow connections by creating the -+namespaceauth+ file, normally at \(aq/etc/puppet/namespaceauth.conf\(aq. This -file specifies who has access to each namespace; if you create the file -you must add every namespace you want any Puppet daemon to allow \-\- it -is currently global to all Puppet daemons. ++listen+ on the +puppet agent+ daemon, either using +\-\-listen+ on the +command line or adding \(aqlisten: true\(aq in its config file. In addition, +you need to set the daemons up to specifically allow connections by +creating the +namespaceauth+ file, normally at +\(aq/etc/puppet/namespaceauth.conf\(aq. This file specifies who has access to +each namespace; if you create the file you must add every namespace you +want any Puppet daemon to allow \-\- it is currently global to all Puppet +daemons. .sp An example file looks like this: .sp .nf .ft C [fileserver] allow *.madstop.com [puppetmaster] allow *.madstop.com [puppetrunner] allow culain.madstop.com .ft P .fi .sp This is what you would install on your Puppet master; non\-master hosts could leave off the \(aqfileserver\(aq and \(aqpuppetmaster\(aq namespaces. .sp Expect more documentation on this eventually. .SH OPTIONS .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 \(aq as an argument. .sp See the configuration file documentation at \fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for the full list of acceptable parameters. A commented list of all -configuration options can also be generated by running puppetmasterdd +configuration options can also be generated by running puppet master with \(aq\-\-genconfig\(aq. .INDENT 0.0 .TP .B all: Connect to all available hosts. Requires LDAP support . at this point. .TP .B class: Specify a class of machines to which to connect. This . only works if you have LDAP configured, at the moment. .UNINDENT .sp debug: Enable full debugging. .INDENT 0.0 .TP .B foreground: Run each configuration in the foreground; that is, when . connecting to a host, do not return until the host has finished its run. The default is false. .UNINDENT .sp help: Print this help message .INDENT 0.0 .TP .B host: A specific host to which to connect. This flag can be . specified more than once. .TP .B ignoreschedules: Whether the client should ignore schedules when running . its configuration. This can be used to force the client to perform work it would not normally perform so soon. The default is false. .TP .B parallel: How parallel to make the connections. Parallelization . is provided by forking for each client to which to connect. The default is 1, meaning serial execution. .TP .B tag: Specify a tag for selecting the objects to apply. Does . not work with the \-\-test option. .TP .B test: Print the hosts you would connect to but do not . actually connect. This option requires LDAP support at this point. .UNINDENT .sp ping: .sp .nf .ft C Do a ICMP echo against the target host. Skip hosts that don\(aqt respond to ping. .ft P .fi .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 .sp -sudo puppetrun \-p 10 \-\-host host1 \-\-host host2 \-t remotefile \-t webserver +sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2 .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. .\" . diff --git a/man/man8/ralsh.8 b/man/man8/ralsh.8 index 8380b883a..83494bba5 100644 --- a/man/man8/ralsh.8 +++ b/man/man8/ralsh.8 @@ -1,123 +1,122 @@ .TH "" "" "" .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 ] +.B puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] . -[\-p|\-\-param ] [\-t|\-\-types] type +[\-H|\-\-host ] [\-p|\-\-param ] [\-t|\-\-types] +type .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. +By default, you must at least provide a type to list, which case puppet +resource will tell you everything it knows about all instances of that +type. You can optionally specify an instance name, and puppet resource +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. +You can also add +\-\-edit+ as an argument, and puppet resource 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 .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 \(aq as an argument. .sp See the configuration file documentation at -\fI\%http://docs/puppetlabs.com/references/stable/configuration.html\fP for the +\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with \(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: +This example uses \fBpuppet resource\fP to return Puppet configuration for +the user \fBluke\fP: .sp .nf .ft C -$ ralsh user luke +$ puppet resource user luke 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. .\" .