puppet 2.7.26 → 3.0.0.rc4

data/man/man8/puppetd.8

@@ -1,154 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-AGENT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
-.
-.SH "NAME"
-\fBpuppet\-agent\fR \- The puppet agent daemon
-.
-.SH "SYNOPSIS"
-Retrieves the client configuration from the puppet master and applies it to the local host\.
-.
-.P
-This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\.
-.
-.SH "USAGE"
-puppet agent [\-\-certname \fIname\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIdigest\fR] [\-\-disable] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-no\-client] [\-\-noop] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fIseconds\fR]
-.
-.SH "DESCRIPTION"
-This is the main puppet client\. Its job is to retrieve the local machine\'s 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\.
-.
-.P
-Once the client has a signed certificate, it will retrieve its configuration and apply it\.
-.
-.SH "USAGE NOTES"
-\'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 background, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes\.
-.
-.P
-Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' or \'fingerprint\' are useful\. \'test\' enables verbose logging, causes the daemon to stay in the foreground, exits if the server\'s configuration is invalid (this happens if, for instance, you\'ve left a syntax error on the server), and exits after running the configuration once (rather than hanging around as a long\-running process)\.
-.
-.P
-\'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\.
-.
-.P
-\'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"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid configuration parameter, so you can specify \'\-\-server \fIservername\fR\' as an argument\.
-.
-.P
-See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet agent with \'\-\-genconfig\'\.
-.
-.TP
-\-\-certname
-Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\.
-.
-.TP
-\-\-daemonize
-Send the process into the background\. This is the default\.
-.
-.TP
-\-\-no\-daemonize
-Do not send the process into the background\.
-.
-.TP
-\-\-debug
-Enable full debugging\.
-.
-.TP
-\-\-detailed\-exitcodes
-Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\.
-.
-.TP
-\-\-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
-\-\-disable
-Disable working on the local system\. This puts a 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\.
-.
-.IP
-\'puppet agent\' uses the same lock file while it is running, so no more than one \'puppet agent\' process is working at a time\.
-.
-.IP
-\'puppet agent\' exits after executing this\.
-.
-.TP
-\-\-enable
-Enable working on the local system\. This removes any 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)\.
-.
-.IP
-\'puppet agent\' exits after executing this\.
-.
-.TP
-\-\-fingerprint
-Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\.
-.
-.TP
-\-\-help
-Print this help message
-.
-.TP
-\-\-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\.
-.
-.TP
-\-\-no\-client
-Do not create a config client\. This will cause the daemon to run without ever checking for its configuration automatically, and only makes sense when puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\.
-.
-.TP
-\-\-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\.
-.
-.TP
-\-\-onetime
-Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\.
-.
-.TP
-\-\-serve
-Start another type of server\. By default, \'puppet 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
-\-\-test
-Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exit\-codes\', \'no\-splay\', and \'show_diff\'\.
-.
-.TP
-\-\-verbose
-Turn on verbose reporting\.
-.
-.TP
-\-\-version
-Print the puppet version number and exit\.
-.
-.TP
-\-\-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\.
-.
-.SH "EXAMPLE"
-.
-.nf
-
-$ puppet agent \-\-server puppet\.domain\.com
-.
-.fi
-.
-.SH "DIAGNOSTICS"
-Puppet agent accepts the following signals:
-.
-.TP
-SIGHUP
-Restart the puppet agent daemon\.
-.
-.TP
-SIGINT and SIGTERM
-Shut down the puppet agent daemon\.
-.
-.TP
-SIGUSR1
-Immediately retrieve and apply configurations from the puppet master\.
-.
-.SH "AUTHOR"
-Luke Kanies
-.
-.SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppetdoc.8

@@ -1,113 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-DOC" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
-.
-.SH "NAME"
-\fBpuppet\-doc\fR \- Generate Puppet documentation and references
-.
-.SH "SYNOPSIS"
-Generates a reference for all Puppet types\. Largely meant for internal Puppet Labs use\.
-.
-.SH "USAGE"
-puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir \fIrdoc\-outputdir\fR] [\-m|\-\-mode text|pdf|rdoc] [\-r|\-\-reference \fIreference\-name\fR] [\-\-charset \fIcharset\fR] [\fImanifest\-file\fR]
-.
-.SH "DESCRIPTION"
-If mode is not \'rdoc\', then this command generates a Markdown 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 Puppet Labs web site\.
-.
-.P
-In \'rdoc\' mode, this command generates an html RDoc hierarchy describing the manifests that are in \'manifestdir\' and \'modulepath\' configuration directives\. The generated documentation directory is doc by default but can be changed with the \'outputdir\' option\.
-.
-.P
-If the command is run with the name of a manifest file as an argument, puppet doc will output a single manifest\'s documentation on stdout\.
-.
-.SH "OPTIONS"
-.
-.TP
-\-\-all
-Output the docs for all of the reference types\. In \'rdoc\' mode, this also outputs documentation for all resources\.
-.
-.TP
-\-\-help
-Print this help message
-.
-.TP
-\-\-outputdir
-Used only in \'rdoc\' mode\. The directory to which the rdoc output should be written\.
-.
-.TP
-\-\-mode
-Determine the output mode\. Valid modes are \'text\', \'pdf\' and \'rdoc\'\. The \'pdf\' mode creates PDF formatted files in the /tmp directory\. The default mode is \'text\'\. In \'rdoc\' mode you must provide \'manifests\-path\'
-.
-.TP
-\-\-reference
-Build a particular reference\. Get a list of references by running \'puppet doc \-\-list\'\.
-.
-.TP
-\-\-charset
-Used only in \'rdoc\' mode\. It sets the charset used in the html files produced\.
-.
-.TP
-\-\-manifestdir
-Used only in \'rdoc\' mode\. The directory to scan for stand\-alone manifests\. If not supplied, puppet doc will use the manifestdir from puppet\.conf\.
-.
-.TP
-\-\-modulepath
-Used only in \'rdoc\' mode\. The directory or directories to scan for modules\. If not supplied, puppet doc will use the modulepath from puppet\.conf\.
-.
-.TP
-\-\-environment
-Used only in \'rdoc\' mode\. The configuration environment from which to read the modulepath and manifestdir settings, when reading said settings from puppet\.conf\. Due to a known bug, this option is not currently effective\.
-.
-.SH "EXAMPLE"
-.
-.nf
-
-$ puppet doc \-r type > /tmp/type_reference\.markdown
-.
-.fi
-.
-.P
-or
-.
-.IP "" 4
-.
-.nf
-
-$ puppet doc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
-.
-.fi
-.
-.IP "" 0
-.
-.P
-or
-.
-.IP "" 4
-.
-.nf
-
-$ puppet doc /etc/puppet/manifests/site\.pp
-.
-.fi
-.
-.IP "" 0
-.
-.P
-or
-.
-.IP "" 4
-.
-.nf
-
-$ puppet doc \-m pdf \-r configuration
-.
-.fi
-.
-.IP "" 0
-.
-.SH "AUTHOR"
-Luke Kanies
-.
-.SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppetmasterd.8

@@ -1,78 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-MASTER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
-.
-.SH "NAME"
-\fBpuppet\-master\fR \- The puppet master daemon
-.
-.SH "SYNOPSIS"
-The central puppet server\. Functions as a certificate authority by default\.
-.
-.SH "USAGE"
-puppet master [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help] [\-l|\-\-logdest \fIfile\fR|console|syslog] [\-v|\-\-verbose] [\-V|\-\-version] [\-\-compile \fInode\-name\fR]
-.
-.SH "DESCRIPTION"
-This command starts an instance of puppet master, running as a daemon and using Ruby\'s built\-in Webrick webserver\. Puppet master can also be managed by other application servers; when this is the case, this executable is not used\.
-.
-.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 \fIdirectory\fR\' as an argument\.
-.
-.P
-See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet master with \'\-\-genconfig\'\.
-.
-.TP
-\-\-daemonize
-Send the process into the background\. This is the default\.
-.
-.TP
-\-\-no\-daemonize
-Do not send the process into the background\.
-.
-.TP
-\-\-debug
-Enable full debugging\.
-.
-.TP
-\-\-help
-Print this help message\.
-.
-.TP
-\-\-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\.
-.
-.TP
-\-\-verbose
-Enable verbosity\.
-.
-.TP
-\-\-version
-Print the puppet version number and exit\.
-.
-.TP
-\-\-compile
-Compile a catalogue and output it in JSON from the puppet master\. Uses facts contained in the $vardir/yaml/ directory to compile the catalog\.
-.
-.SH "EXAMPLE"
-puppet master
-.
-.SH "DIAGNOSTICS"
-When running as a standalone daemon, puppet master accepts the following signals:
-.
-.TP
-SIGHUP
-Restart the puppet master server\.
-.
-.TP
-SIGINT and SIGTERM
-Shut down the puppet master server\.
-.
-.TP
-SIGUSR2
-Close file descriptors for log files and reopen them\. Used with logrotate\.
-.
-.SH "AUTHOR"
-Luke Kanies
-.
-.SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppetqd.8

@@ -1,55 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-QUEUE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
-.
-.SH "NAME"
-\fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs
-.
-.SH "SYNOPSIS"
-Retrieves serialized storeconfigs records from a queue and processes them in order\.
-.
-.SH "USAGE"
-puppet queue [\-d|\-\-debug] [\-v|\-\-verbose]
-.
-.SH "DESCRIPTION"
-This application runs as a daemon and processes storeconfigs data, retrieving the data from a stomp server message queue and writing it to a database\.
-.
-.P
-For more information, including instructions for properly setting up your puppet master and message queue, see the documentation on setting up asynchronous storeconfigs at: http://projects\.puppetlabs\.com/projects/1/wiki/Using_Stored_Configuration
-.
-.SH "OPTIONS"
-Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid configuration parameter, so you can specify \'\-\-server \fIservername\fR\' as an argument\.
-.
-.P
-See the configuration file documentation at http://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet queue with \'\-\-genconfig\'\.
-.
-.TP
-\-\-debug
-Enable full debugging\.
-.
-.TP
-\-\-help
-Print this help message
-.
-.TP
-\-\-verbose
-Turn on verbose reporting\.
-.
-.TP
-\-\-version
-Print the puppet version number and exit\.
-.
-.SH "EXAMPLE"
-.
-.nf
-
-$ puppet queue
-.
-.fi
-.
-.SH "AUTHOR"
-Luke Kanies
-.
-.SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppetrun.8

@@ -1,127 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "PUPPET\-KICK" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual"
-.
-.SH "NAME"
-\fBpuppet\-kick\fR \- Remotely control puppet agent
-.
-.SH "SYNOPSIS"
-Trigger a puppet agent run on a set of hosts\.
-.
-.SH "USAGE"
-puppet kick [\-a|\-\-all] [\-c|\-\-class \fIclass\fR] [\-d|\-\-debug] [\-f|\-\-foreground] [\-h|\-\-help] [\-\-host \fIhost\fR] [\-\-no\-fqdn] [\-\-ignoreschedules] [\-t|\-\-tag \fItag\fR] [\-\-test] [\-p|\-\-ping] \fIhost\fR [\fIhost\fR [\.\.\.]]
-.
-.SH "DESCRIPTION"
-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 \'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\.
-.
-.P
-If you are not storing your host configurations in LDAP, you can specify hosts manually\.
-.
-.P
-You will most likely have to run \'puppet kick\' as root to get access to the SSL certificates\.
-.
-.P
-\'puppet kick\' reads \'puppet master\'\'s configuration file, so that it can copy things like LDAP settings\.
-.
-.SH "USAGE NOTES"
-Puppet kick needs the puppet agent on the target machine to be running as a daemon, be configured to listen for incoming network connections, and have an appropriate security configuration\.
-.
-.P
-The specific changes required are:
-.
-.IP "\(bu" 4
-Set \fBlisten = true\fR in the agent\'s \fBpuppet\.conf\fR file (or \fB\-\-listen\fR on the command line)
-.
-.IP "\(bu" 4
-Configure the node\'s firewall to allow incoming connections on port 8139
-.
-.IP "\(bu" 4
-Insert the following stanza at the top of the node\'s \fBauth\.conf\fR file:
-.
-.IP "" 4
-.
-.nf
-
-  # Allow puppet kick access
-  path    /run
-  method  save
-  auth    any
-  allow   workstation\.example\.com
-.
-.fi
-.
-.IP "" 0
-
-.
-.IP "" 0
-.
-.P
-This example would allow the machine \fBworkstation\.example\.com\fR to trigger a Puppet run; adjust the "allow" directive to suit your site\. You may also use \fBallow *\fR to allow anyone to trigger a Puppet run, but that makes it possible to interfere with your site by triggering excessive Puppet runs\.
-.
-.P
-See \fBhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details about security settings\.
-.
-.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 \fIdirectory\fR\' as an argument\.
-.
-.P
-See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet master with \'\-\-genconfig\'\.
-.
-.TP
-\-\-all
-Connect to all available hosts\. Requires LDAP support at this point\.
-.
-.TP
-\-\-class
-Specify a class of machines to which to connect\. This only works if you have LDAP configured, at the moment\.
-.
-.TP
-\-\-debug
-Enable full debugging\.
-.
-.TP
-\-\-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\.
-.
-.TP
-\-\-help
-Print this help message
-.
-.TP
-\-\-host
-A specific host to which to connect\. This flag can be specified more than once\.
-.
-.TP
-\-\-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
-\-\-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
-\-\-tag
-Specify a tag for selecting the objects to apply\. Does not work with the \-\-test option\.
-.
-.TP
-\-\-test
-Print the hosts you would connect to but do not actually connect\. This option requires LDAP support at this point\.
-.
-.TP
-\-\-ping
-Do a ICMP echo against the target host\. Skip hosts that don\'t respond to ping\.
-.
-.SH "EXAMPLE"
-.
-.nf
-
-$ sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2
-.
-.fi
-.
-.SH "AUTHOR"
-Luke Kanies
-.
-.SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License