1 files changed, 151 insertions, 0 deletions
diff --git a/man/man8/puppetrun.8 b/man/man8/puppetrun.8
new file mode 100644
index 000000000..753be1ca0
--- /dev/null
+++ b/man/man8/puppetrun.8
@@ -0,0 +1,151 @@
+.TH   "" "" ""
+.SH NAME
+ \- 
+
+.\" Man page generated from reStructeredText.
+
+.SH SYNOPSIS
+Trigger a puppetd run on a set of hosts.
+
+
+.SH USAGE
+
+.\" visit_block_quote
+
+.TP
+.B puppetrun [\-a|\-\-all] [\-c|\-\-class <class>] [\-d|\-\-debug] [\-f|\-\-foreground]
+[\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules]
+[\-t|\-\-tag <tag>] [\-\-test]
+
+
+.\" depart_block_quote
+
+.SH DESCRIPTION
+This script can be used to connect to a set of machines running
++puppetd+ 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.
+
+If you are not storing your host configurations in LDAP, you can specify
+hosts manually.
+
+You will most likely have to run +puppetrun+ as root to get access to
+the SSL certificates.
+
++puppetrun+ reads +puppetmaster+\'s configuration file, so that it can
+copy things like LDAP settings.
+
+
+.SH USAGE NOTES
++puppetrun+ is useless unless +puppetd+ 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 \'listen: true\' in its config file. In addition, you need
+to set the daemons up to specifically allow connections by creating the
++namespaceauth+ file, normally at \'/etc/puppet/namespaceauth.conf\'. 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.
+
+An example file looks like this:
+
+
+.nf
+[fileserver]
+    allow *.madstop.com
+
+[puppetmaster]
+    allow *.madstop.com
+
+[puppetrunner]
+    allow culain.madstop.com
+.fi
+This is what you would install on your Puppet master; non\-master hosts
+could leave off the \'fileserver\' and \'puppetmaster\' namespaces.
+
+Expect more documentation on this eventually.
+
+
+.SH OPTIONS
+Note that any configuration parameter that\'s valid in the configuration
+file is also a valid long argument. For example, \'ssldir\' is a valid
+configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an
+argument.
+
+See the configuration file documentation at
+http://reductivelabs.com/projects/puppet/reference/configref.html for
+the full list of acceptable parameters. A commented list of all
+configuration options can also be generated by running puppetmasterdd
+with \'\-\-genconfig\'.
+
+
+.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.
+
+debug:           Enable full debugging.
+
+
+.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.
+
+help:            Print this help message
+
+
+.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.
+
+
+.SH EXAMPLE
+
+.\" visit_block_quote
+sudo puppetrun \-p 10 \-\-host host1 \-\-host host2 \-t remotefile \-t webserver
+
+
+.\" depart_block_quote
+
+.SH AUTHOR
+Luke Kanies
+
+
+.SH COPYRIGHT
+Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public
+License
+
+
+.\" Generated by docutils manpage writer on 2008-03-22 17:46.
+.\"