adding namespaceauth and --listen docs to puppetrun

git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1272 980ebf18-57e1-0310-9a29-db15c13687c0

1 files changed, 29 insertions, 1 deletions

diff --git a/bin/puppetrun b/bin/puppetrun
index 2bec5d029..4662ed573 100755
--- a/bin/puppetrun
+++ b/bin/puppetrun
@@ -7,7 +7,7 @@
 #
 # = Usage
 #
-#   puppet [-c|--class <class>] [-d|--debug] [-h|--help] [--host <host>]
+#   puppetrun [-c|--class <class>] [-d|--debug] [-h|--help] [--host <host>]
 #
 # = Description
 #
@@ -26,6 +26,34 @@
 # +puppetrun+ reads +puppetmaster+'s configuration file, so that it can copy
 # things like LDAP settings.
 #
+# = 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:
+#
+#     [fileserver]
+#         allow *.madstop.com
+# 
+#     [puppetmaster]
+#         allow *.madstop.com
+# 
+#     [puppetrunner]
+#         allow culain.madstop.com
+#
+# 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.
+#
 # = Options
 #
 # Note that any configuration parameter that's valid in the configuration file