puppet 2.6.18 → 2.7.1

data/man/man8/puppet-help.8

@@ -0,0 +1,71 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-HELP" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-help\fR \- Display Puppet help\.
+.
+.SH "SYNOPSIS"
+puppet help \fIaction\fR
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+.
+.P
+See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.
+.TP
+\-\-mode MODE
+The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
+.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBhelp\fR \- Display help about Puppet subcommands and their actions\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet help [\-\-version VERSION] [\fIsubcommand\fR] [\fIaction\fR]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Display help about Puppet subcommands and their actions\.
+.
+.IP
+\fBOPTIONS\fR
+.
+.IP
+\fI\-\-version VERSION\fR \- The version of the subcommand for which to show help\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Short help text for the specified subcommand or action\.
+.
+.SH "EXAMPLES"
+\fBhelp\fR
+.
+.P
+Get help for an action:
+.
+.P
+$ puppet help
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-inspect.8

@@ -0,0 +1,28 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-INSPECT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-inspect\fR \- Send an inspection report
+.
+.SH "SYNOPSIS"
+Prepares and submits an inspection report to the puppet master\.
+.
+.SH "USAGE"
+puppet inspect
+.
+.SH "DESCRIPTION"
+This command uses the cached catalog from the previous run of \'puppet agent\' to determine which attributes of which resources have been marked as auditable with the \'audit\' metaparameter\. It then examines the current state of the system, writes the state of the specified resource attributes to a report, and submits the report to the puppet master\.
+.
+.P
+Puppet inspect does not run as a daemon, and must be run manually or from cron\.
+.
+.SH "OPTIONS"
+Any configuration setting which is valid in the configuration file is also a valid long argument, e\.g\. \'\-\-server=master\.domain\.com\'\. See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable settings\.
+.
+.SH "AUTHOR"
+Puppet Labs
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-key.8

@@ -0,0 +1,126 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-KEY" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-key\fR \- Create, save, and remove certificate keys\.
+.
+.SH "SYNOPSIS"
+puppet key \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+This subcommand manages certificate private keys\. Keys are created automatically by puppet agent and when certificate requests are generated with \'puppet certificate generate\'; it should not be necessary to use this subcommand directly\.
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+.
+.P
+See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.
+.TP
+\-\-mode MODE
+The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
+.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.TP
+\-\-terminus TERMINUS
+Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
+.
+.IP
+Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
+.
+.IP
+The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBdestroy\fR \- Delete an object\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet key destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Delete an object\.
+.
+.TP
+\fBfind\fR \- Retrieve an object by name\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet key find [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve an object by name\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet key info [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
+.
+.TP
+\fBsave\fR \- API only: create or overwrite an object\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet key save [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
+.
+.TP
+\fBsearch\fR \- Search for an object or retrieve multiple objects\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet key search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Search for an object or retrieve multiple objects\.
+.
+.SH "NOTES"
+This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
+.
+.IP "\(bu" 4
+\fBca\fR
+.
+.IP "\(bu" 4
+\fBfile\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-kick.8

@@ -0,0 +1,95 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-KICK" "8" "June 2011" "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 is useless unless puppet agent is listening for incoming connections and allowing access to the \fBrun\fR endpoint\. This entails starting the agent with \fBlisten = true\fR in its puppet\.conf file, and allowing access to the \fB/run\fR path in its auth\.conf file; see \fBhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\.
+.
+.P
+Additionally, due to a known bug, you must make sure a namespaceauth\.conf file exists in puppet agent\'s $confdir\. This file will not be consulted, and may be left empty\.
+.
+.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

data/man/man8/puppet-man.8

@@ -0,0 +1,74 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-MAN" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-man\fR \- Display Puppet manual pages\.
+.
+.SH "SYNOPSIS"
+puppet man \fIaction\fR
+.
+.SH "DESCRIPTION"
+This subcommand displays manual pages for all Puppet subcommands\. If the \fBronn\fR gem (\fIhttps://github\.com/rtomayko/ronn/\fR) is installed on your system, puppet man will display fully\-formated man pages\. If \fBronn\fR is not available, puppet man will display the raw (but human\-readable) source text in a pager\.
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
+.
+.P
+See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.
+.TP
+\-\-mode MODE
+The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
+.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.
+.TP
+\-\-debug
+Whether to log debug information\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBman\fR \- Display the manual page for a Puppet subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet man \fIsubcommand\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Display the manual page for a Puppet subcommand\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+The man data, in Markdown format, suitable for consumption by Ronn\.
+.
+.IP
+RENDERING ISSUES: To skip fancy formatting and output the raw Markdown text (e\.g\. for use in a pipeline), call this action with \'\-\-render\-as s\'\.
+.
+.SH "EXAMPLES"
+\fBman\fR
+.
+.P
+View the manual page for a subcommand:
+.
+.P
+$ puppet man facts
+.
+.SH "NOTES"
+The pager used for display will be the first found of \fB$MANPAGER\fR, \fB$PAGER\fR, \fBless\fR, \fBmost\fR, or \fBmore\fR\.
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-master.8

@@ -0,0 +1,74 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-MASTER" "8" "June 2011" "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\.
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License