diff options
Diffstat (limited to 'man/man8')
39 files changed, 2841 insertions, 152 deletions
diff --git a/man/man8/filebucket.8 b/man/man8/filebucket.8 index 7ff0da9af..990756858 100644 --- a/man/man8/filebucket.8 +++ b/man/man8/filebucket.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FILEBUCKET" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket @@ -78,4 +78,4 @@ $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/pi.8 b/man/man8/pi.8 index c54a7bec7..af246f16b 100644 --- a/man/man8/pi.8 +++ b/man/man8/pi.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DESCRIBE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types @@ -48,4 +48,4 @@ $ puppet describe user \-s \-m David Lutterkort . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-agent.8 b/man/man8/puppet-agent.8 index 3fadd9df7..2e5cedf51 100644 --- a/man/man8/puppet-agent.8 +++ b/man/man8/puppet-agent.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-AGENT" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-AGENT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon @@ -132,8 +132,23 @@ $ 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) 2005, 2006 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-apply.8 b/man/man8/puppet-apply.8 index d8d864b56..b93713ff5 100644 --- a/man/man8/puppet-apply.8 +++ b/man/man8/puppet-apply.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-APPLY" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-APPLY" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-apply\fR \- Apply Puppet manifests locally @@ -72,4 +72,4 @@ $ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server" Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-catalog.8 b/man/man8/puppet-catalog.8 new file mode 100644 index 000000000..e06ddefe7 --- /dev/null +++ b/man/man8/puppet-catalog.8 @@ -0,0 +1,286 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CATALOG" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\. +. +.SH "SYNOPSIS" +puppet catalog \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand deals with catalogs, which are compiled per\-node artifacts generated from a set of Puppet manifests\. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and \fBcertname\fR, but you can change the source of the catalog with the \fB\-\-terminus\fR option\. You can also choose to print any catalog in \'dot\' format (for easy graph viewing with OmniGraffle or Graphviz) with \'\-\-render\-as dot\'\. +. +.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 +\fBapply\fR \- Find and apply a catalog\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog apply [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Finds and applies a catalog\. This action takes no arguments, but the source of the catalog can be managed with the \fB\-\-terminus\fR option\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report object\. +. +.TP +\fBdestroy\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBdownload\fR \- Download this node\'s catalog from the puppet master server\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog download [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieves a catalog from the puppet master and saves it to the local yaml cache\. This action always contacts the puppet master and will ignore alternate termini\. +. +.IP +The saved catalog can be used in any subsequent catalog action by specifying \'\-\-terminus yaml\' for that action\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.IP +\fBNOTES\fR +. +.IP +When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\. +. +.TP +\fBfind\fR \- Retrieve the catalog for a node\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog find [\-\-terminus TERMINUS] \fIcertname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve the catalog for a node\. +. +.IP +\fBRETURNS\fR +. +.IP +A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::Catalog object\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog 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 catalog 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBselect\fR \- Retrieve a catalog and filter it for resources of a given type\. +\fBSYNOPSIS\fR +. +.IP +puppet catalog select [\-\-terminus TERMINUS] \fIhost\fR \fIresource_type\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieves a catalog for the specified host, then searches it for all resources of the requested type\. +. +.IP +\fBRETURNS\fR +. +.IP +A list of resource references ("Type[title]")\. When used from the API, returns an array of Puppet::Resource objects excised from a catalog\. +. +.IP +\fBNOTES\fR +. +.IP +By default, this action will retrieve a catalog from Puppet\'s compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the puppet master\. +. +.IP +FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\. +. +.SH "EXAMPLES" +\fBapply\fR +. +.P +Apply the locally cached catalog: +. +.P +$ puppet catalog apply \-\-terminus yaml +. +.P +Retrieve a catalog from the master and apply it, in one step: +. +.P +$ puppet catalog apply \-\-terminus rest +. +.P +From \fBsecret_agent\.rb\fR (API example): +. +.IP "" 4 +. +.nf + +# \.\.\. +Puppet::Face[:catalog, \'0\.0\.1\']\.download +# (Termini are singletons; catalog\.download has a side effect of +# setting the catalog terminus to yaml) +report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply +# \.\.\. +. +.fi +. +.IP "" 0 +. +.P +\fBdownload\fR +. +.P +Retrieve and store a catalog: +. +.P +$ puppet catalog download +. +.P +From \fBsecret_agent\.rb\fR (API example): +. +.IP "" 4 +. +.nf + +Puppet::Face[:plugin, \'0\.0\.1\']\.download +Puppet::Face[:facts, \'0\.0\.1\']\.upload +Puppet::Face[:catalog, \'0\.0\.1\']\.download +# \.\.\. +. +.fi +. +.IP "" 0 +. +.P +\fBselect\fR +. +.P +Ask the puppet master for a list of managed file resources for a node: +. +.P +$ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file +. +.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 +\fBactive_record\fR +. +.IP "\(bu" 4 +\fBcompiler\fR +. +.IP "\(bu" 4 +\fBqueue\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "\(bu" 4 +\fBstatic_compiler\fR +. +.IP "\(bu" 4 +\fByaml\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-cert.8 b/man/man8/puppet-cert.8 index bea7596d4..211f8ca7a 100644 --- a/man/man8/puppet-cert.8 +++ b/man/man8/puppet-cert.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERT" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-cert\fR \- Manage certificates and requests @@ -10,60 +10,67 @@ Standalone certificate authority\. Capable of generating certificates, but mostly used for signing certificate requests from puppet clients\. . .SH "USAGE" -puppet cert [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] [\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [\-\-digest \fIdigest\fR] [\-\-fingerprint] [host] +puppet cert \fIaction\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-\-digest \fIdigest\fR] [\fIhost\fR] . .SH "DESCRIPTION" Because the puppet master service 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" -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\. +.SH "ACTIONS" +Every action except \'list\' and \'generate\' requires a hostname to act on, unless the \'\-\-all\' option is set\. . -.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 cert with \'\-\-genconfig\'\. +.TP +clean +Revoke a host\'s certificate (if applicable) and remove all files related to that host from puppet cert\'s 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\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\. . .TP -\-\-all -Operate on all items\. Currently only makes sense with \'\-\-sign\', \'\-\-clean\', or \'\-\-list\'\. +fingerprint +Print the DIGEST (defaults to md5) fingerprint of a host\'s certificate\. . .TP -\-\-digest -Set the digest for fingerprinting (defaults to md5)\. Valid values depends on your openssl and openssl ruby extension version, but should contain at least md5, sha1, md2, sha256\. +generate +Generate a certificate for a named client\. A certificate/keypair will be generated for each client named on the command line\. . .TP -\-\-clean -Remove all files related to a host from puppet cert\'s 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 is also revoked\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\. +list +List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. . .TP -\-\-debug -Enable full debugging\. +print +Print the full\-text version of a host\'s certificate\. . .TP -\-\-generate -Generate a certificate for a named client\. A certificate/keypair will be generated for each client named on the command line\. +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 \'0x\') or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' configuration option\. Note that the puppet master needs to be restarted after revoking certificates\. . .TP -\-\-help -Print this help message +sign +Sign an outstanding certificate request\. . .TP -\-\-list -List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. +verify +Verify the named certificate against the local CA certificate\. +. +.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 cert with \'\-\-genconfig\'\. . .TP -\-\-print -Print the full\-text version of a host\'s certificate\. +\-\-all +Operate on all items\. Currently only makes sense with the \'sign\', \'clean\', \'list\', and \'fingerprint\' actions\. . .TP -\-\-fingerprint -Print the DIGEST (defaults to md5) fingerprint of a host\'s certificate\. +\-\-digest +Set the digest for fingerprinting (defaults to md5)\. Valid values depends on your openssl and openssl ruby extension version, but should contain at least md5, sha1, md2, sha256\. . .TP -\-\-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 \'0x\', or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' config parameter\. Note that the puppetmasterd needs to be restarted after revoking certificates\. +\-\-debug +Enable full debugging\. . .TP -\-\-sign -Sign an outstanding certificate request\. Unless \'\-\-all\' is specified, hosts must be listed after all flags\. +\-\-help +Print this help message . .TP \-\-verbose @@ -73,17 +80,13 @@ Enable verbosity\. \-\-version Print the puppet version number and exit\. . -.TP -\-\-verify -Verify the named certificate against the local CA certificate\. -. .SH "EXAMPLE" . .nf -$ puppet cert \-l +$ puppet cert list culain\.madstop\.com -$ puppet cert \-s culain\.madstop\.com +$ puppet cert sign culain\.madstop\.com . .fi . @@ -91,4 +94,4 @@ $ puppet cert \-s culain\.madstop\.com Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-certificate.8 b/man/man8/puppet-certificate.8 new file mode 100644 index 000000000..03f2b55e6 --- /dev/null +++ b/man/man8/puppet-certificate.8 @@ -0,0 +1,229 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CERTIFICATE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-certificate\fR \- Provide access to the CA for certificate management\. +. +.SH "SYNOPSIS" +puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +. +.SH "DESCRIPTION" +This subcommand interacts with a local or remote Puppet certificate authority\. Currently, its behavior is not a full superset of \fBpuppet cert\fR; specifically, it is unable to mimic puppet cert\'s "clean" option, and its "generate" action submits a CSR rather than creating a signed certificate\. +. +.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 +\-\-ca\-location LOCATION +Whether to act on the local certificate authority or one provided by a remote puppet master\. Allowed values are \'local\' and \'remote\.\' +. +.IP +This option is required\. +. +.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 a certificate\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate destroy [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Deletes a certificate\. This action currently only works on the local CA\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBfind\fR \- Retrieve a certificate\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate find [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a certificate\. +. +.IP +\fBRETURNS\fR +. +.IP +An x509 SSL certificate\. You will usually want to render this as a string (\-\-render\-as s)\. +. +.IP +Note that this action has a side effect of caching a copy of the certificate in Puppet\'s \fBssldir\fR\. +. +.TP +\fBgenerate\fR \- Generate a new certificate signing request\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate generate [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Generates and submits a certificate signing request (CSR) for the specified host\. This CSR will then have to be signed by a user with the proper authorization on the certificate authority\. +. +.IP +Puppet agent usually handles CSR submission automatically\. This action is primarily useful for requesting certificates for individual users and external applications\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate info [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +. +.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 +\fBlist\fR \- List all certificate signing requests\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate list [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +. +.IP +\fBDESCRIPTION\fR +. +.IP +List all certificate signing requests\. +. +.IP +\fBRETURNS\fR +. +.IP +An array of #inspect output from CSR objects\. This output is currently messy, but does contain the names of nodes requesting certificates\. This action returns #inspect strings even when used from the Ruby API\. +. +.TP +\fBsave\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate save [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsearch\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate search [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsign\fR \- Sign a certificate signing request for HOST\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate sign [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Sign a certificate signing request for HOST\. +. +.IP +\fBRETURNS\fR +. +.IP +A string that appears to be (but isn\'t) an x509 certificate\. +. +.SH "EXAMPLES" +\fBgenerate\fR +. +.P +Request a certificate for "somenode" from the site\'s CA: +. +.P +$ puppet certificate generate somenode\.puppetlabs\.lan \-\-ca\-location remote +. +.P +\fBsign\fR +. +.P +Sign somenode\.puppetlabs\.lan\'s certificate: +. +.P +$ puppet certificate sign somenode\.puppetlabs\.lan \-\-ca\-location remote +. +.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 "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-certificate_request.8 b/man/man8/puppet-certificate_request.8 new file mode 100644 index 000000000..faeb5a06c --- /dev/null +++ b/man/man8/puppet-certificate_request.8 @@ -0,0 +1,168 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-certificate_request\fR \- Manage certificate requests\. +. +.SH "SYNOPSIS" +puppet certificate_request \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand retrieves and submits certificate signing requests (CSRs)\. +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_request destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Retrieve a single CSR\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_request find [\-\-terminus TERMINUS] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a single CSR\. +. +.IP +\fBRETURNS\fR +. +.IP +A single certificate request\. When used from the Ruby API, returns a Puppet::SSL::CertificateRequest object\. +. +.IP +RENDERING ISSUES: In most cases, you will want to render this as a string (\'\-\-render\-as s\')\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_request 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: submit a certificate signing request\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_request save [\-\-terminus TERMINUS] \fIx509_CSR\fR +. +.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 \- Retrieve all outstanding CSRs\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_request search [\-\-terminus TERMINUS] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve all outstanding CSRs\. +. +.IP +\fBRETURNS\fR +. +.IP +A list of certificate requests; be sure to to render this as a string (\'\-\-render\-as s\')\. When used from the Ruby API, returns an array of Puppet::SSL::CertificateRequest objects\. +. +.IP +\fBNOTES\fR +. +.IP +Although this action always returns all CSRs, it requires a dummy search key; this is a known bug\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Retrieve a single CSR from the puppet master\'s CA: +. +.P +$ puppet certificate_request find somenode\.puppetlabs\.lan \-\-terminus rest +. +.P +\fBsearch\fR +. +.P +Retrieve all CSRs from the local CA (similar to \'puppet cert list\'): +. +.P +$ puppet certificate_request search x \-\-terminus ca +. +.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 "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-certificate_revocation_list.8 b/man/man8/puppet-certificate_revocation_list.8 new file mode 100644 index 000000000..4a9c856df --- /dev/null +++ b/man/man8/puppet-certificate_revocation_list.8 @@ -0,0 +1,165 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\. +. +.SH "SYNOPSIS" +puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand is primarily for retrieving the certificate revocation list from the CA\. +. +.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 the certificate revocation list\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Deletes the certificate revocation list\. This cannot be done over REST, but it is possible to delete the locally cached copy or the local CA\'s copy of the CRL\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.IP +\fBNOTES\fR +. +.IP +Although this action always deletes the CRL from the specified terminus, it requires a dummy argument; this is a known bug\. +. +.TP +\fBfind\fR \- Retrieve the certificate revocation list\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_revocation_list find [\-\-terminus TERMINUS] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve the certificate revocation list\. +. +.IP +\fBRETURNS\fR +. +.IP +The certificate revocation list\. When used from the Ruby API: returns an OpenSSL::X509::CRL object\. +. +.IP +RENDERING ISSUES: this should usually be rendered as a string (\'\-\-render\-as s\')\. +. +.IP +\fBNOTES\fR +. +.IP +Although this action always returns the CRL from the specified terminus, it requires a dummy argument; this is a known bug\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_revocation_list 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_revocation_list save [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsearch\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet certificate_revocation_list search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Retrieve a copy of the puppet master\'s CRL: +. +.P +$ puppet certificate_revocation_list find crl \-\-terminus rest +. +.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 "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-config.8 b/man/man8/puppet-config.8 new file mode 100644 index 000000000..f7592a43b --- /dev/null +++ b/man/man8/puppet-config.8 @@ -0,0 +1,80 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CONFIG" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-config\fR \- Interact with Puppet\'s configuration options\. +. +.SH "SYNOPSIS" +puppet config \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 +\fBprint\fR \- Examine Puppet\'s current configuration settings\. +\fBSYNOPSIS\fR +. +.IP +puppet config print (all | \fIsetting\fR [\fIsetting\fR \.\.\.] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Prints the value of a single configuration option or a list of configuration options\. +. +.IP +This action is an alternate interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\. +. +.IP +\fBRETURNS\fR +. +.IP +A single value when called with one config setting, and a list of settings and values when called with multiple options or "all\." +. +.IP +\fBNOTES\fR +. +.IP +By default, this action reads the configuration in agent mode\. Use the \'\-\-mode\' and \'\-\-environment\' flags to examine other configuration domains\. +. +.SH "EXAMPLES" +\fBprint\fR +. +.P +Get puppet\'s runfile directory: +. +.P +$ puppet config print rundir +. +.P +Get a list of important directories from the master\'s config: +. +.P +$ puppet config print all \-\-mode master | grep \-E "(path|dir)" +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-describe.8 b/man/man8/puppet-describe.8 index c54a7bec7..af246f16b 100644 --- a/man/man8/puppet-describe.8 +++ b/man/man8/puppet-describe.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DESCRIBE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types @@ -48,4 +48,4 @@ $ puppet describe user \-s \-m David Lutterkort . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-device.8 b/man/man8/puppet-device.8 new file mode 100644 index 000000000..a63f96ddf --- /dev/null +++ b/man/man8/puppet-device.8 @@ -0,0 +1,86 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-DEVICE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-device\fR \- Manage remote network devices +. +.SH "SYNOPSIS" +Retrieves all configurations from the puppet master and apply them to the remote devices configured in /etc/puppet/device\.conf\. +. +.P +Currently must be run out periodically, using cron or something similar\. +. +.SH "USAGE" +puppet device [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-V|\-\-version] +. +.IP "" 4 +. +.nf + + [\-h|\-\-help] [\-l|\-\-logdest syslog|<file>|console] + [\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>] +. +.fi +. +.IP "" 0 +. +.SH "DESCRIPTION" +Once the client has a signed certificate for a given remote device, it will retrieve its configuration and apply it\. +. +.SH "USAGE NOTES" +One need a /etc/puppet/device\.conf file with the following content: +. +.P +[remote\.device\.fqdn] type \fItype\fR url \fIurl\fR +. +.P +where: * type: the current device type (the only value at this time is cisco) * url: an url allowing to connect to the device +. +.P +Supported url must conforms to: scheme://user:password@hostname/?query +. +.P +with: * scheme: either ssh or telnet * user: username, can be omitted depending on the switch/router configuration * password: the connection password * query: this is device specific\. Cisco devices supports an enable parameter whose value would be the enable password\. +. +.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\. +. +.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, and an exit code of \'4\' means that there were failures during the transaction\. This option only makes sense in conjunction with \-\-onetime\. +. +.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 +Turn on verbose reporting\. +. +.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 device \-\-server puppet\.domain\.com +. +.fi +. +.SH "AUTHOR" +Brice Figureau +. +.SH "COPYRIGHT" +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-doc.8 b/man/man8/puppet-doc.8 index e0cabd5d1..f6de3951a 100644 --- a/man/man8/puppet-doc.8 +++ b/man/man8/puppet-doc.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DOC" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DOC" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet documentation and references @@ -98,4 +98,4 @@ $ puppet doc \-m pdf \-r configuration Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005\-2007 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-facts.8 b/man/man8/puppet-facts.8 new file mode 100644 index 000000000..25470cc0e --- /dev/null +++ b/man/man8/puppet-facts.8 @@ -0,0 +1,217 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-FACTS" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-facts\fR \- Retrieve and store facts\. +. +.SH "SYNOPSIS" +puppet facts \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand manages facts, which are collections of normalized system information used by Puppet\. It can read facts directly from the local system (with the default \fBfacter\fR terminus), look up facts reported by other systems, and submit facts to the puppet master\. +. +.P +When used with the \fBrest\fR terminus, this subcommand is essentially a front\-end to the inventory service REST API\. See the inventory service documentation at \fIhttp://docs\.puppetlabs\.com/guides/inventory_service\.html\fR for more detail\. +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet facts destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Retrieve a node\'s facts\. +\fBSYNOPSIS\fR +. +.IP +puppet facts find [\-\-terminus TERMINUS] \fInode_certname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a node\'s facts\. +. +.IP +\fBRETURNS\fR +. +.IP +A hash containing some metadata and (under the "values" key) the set of facts for the requested node\. When used from the Ruby API: A Puppet::Node::Facts object\. +. +.IP +RENDERING ISSUES: Facts cannot currently be rendered as a string; use yaml or json\. +. +.IP +\fBNOTES\fR +. +.IP +When using the \fBfacter\fR terminus, the host argument is ignored\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet facts 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 facts 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet facts search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBupload\fR \- Upload local facts to the puppet master\. +\fBSYNOPSIS\fR +. +.IP +puppet facts upload [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Reads facts from the local system using the \fBfacter\fR terminus, then saves the returned facts using the rest terminus\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.IP +\fBNOTES\fR +. +.IP +This action requires that the puppet master\'s \fBauth\.conf\fR file allow save access to the \fBfacts\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Get facts from the local system: +. +.P +$ puppet facts find x +. +.P +Ask the puppet master for facts for an arbitrary node: +. +.P +$ puppet facts find somenode\.puppetlabs\.lan \-\-terminus rest +. +.P +Query a DB\-backed inventory directly (bypassing the REST API): +. +.P +$ puppet facts find somenode\.puppetlabs\.lan \-\-terminus inventory_active_record \-\-mode master +. +.P +\fBupload\fR +. +.P +Upload facts: +. +.P +$ puppet facts upload +. +.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 +\fBactive_record\fR +. +.IP "\(bu" 4 +\fBcouch\fR +. +.IP "\(bu" 4 +\fBfacter\fR +. +.IP "\(bu" 4 +\fBinventory_active_record\fR +. +.IP "\(bu" 4 +\fBmemory\fR +. +.IP "\(bu" 4 +\fBnetwork_device\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "\(bu" 4 +\fByaml\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-file.8 b/man/man8/puppet-file.8 new file mode 100644 index 000000000..1c39df7f3 --- /dev/null +++ b/man/man8/puppet-file.8 @@ -0,0 +1,225 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-FILE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-file\fR \- Retrieve and store files in a filebucket +. +.SH "SYNOPSIS" +puppet file \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand interacts with objects stored in a local or remote filebucket\. File objects are accessed by their MD5 sum; see the examples for the relevant syntax\. +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet file destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBdownload\fR \- Download a file into the local filebucket\. +\fBSYNOPSIS\fR +. +.IP +puppet file download [\-\-terminus TERMINUS] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR ) +. +.IP +\fBDESCRIPTION\fR +. +.IP +Downloads a file from the puppet master\'s filebucket and duplicates it in the local filebucket\. This action\'s checksum syntax differs from \fBfind\fR\'s, and it can accept a <puppet:///> URL\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBfind\fR \- Retrieve a file from the filebucket\. +\fBSYNOPSIS\fR +. +.IP +puppet file find [\-\-terminus TERMINUS] md5/\fImd5sum\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a file from the filebucket\. +. +.IP +\fBRETURNS\fR +. +.IP +The file object with the specified checksum\. +. +.IP +RENDERING ISSUES: Rendering as a string returns the contents of the file object; rendering as yaml returns a hash of metadata about said file, including but not limited to its contents\. Rendering as json is currently broken, and returns a hash containing only the contents of the file\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet file 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 file 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet file search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBstore\fR \- Store a file in the local filebucket\. +\fBSYNOPSIS\fR +. +.IP +puppet file store [\-\-terminus TERMINUS] \fIfile\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Store a file in the local filebucket\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBupload\fR \- Upload a file to the remote filebucket\. +\fBSYNOPSIS\fR +. +.IP +puppet file upload [\-\-terminus TERMINUS] \fIfile\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Upload a file to the remote filebucket\. +. +.SH "EXAMPLES" +\fBdownload\fR +. +.P +Download a file by URL: +. +.P +$ puppet file download puppet:///modules/editors/vim/\.vimrc +. +.P +Download a file by MD5 sum: +. +.P +$ puppet file download {md5}8f798d4e754db0ac89186bbaeaf0af18 +. +.P +\fBfind\fR +. +.P +Retrieve the contents of a file: +. +.P +$ puppet file find md5/9aedba7f413c97dc65895b1cd9421f2c \-\-render\-as s +. +.P +\fBstore\fR +. +.P +Store a file: +. +.P +$ puppet file store /root/\.bashrc +. +.SH "NOTES" +To retrieve the unmunged contents of a file, you must call find with \-\-render\-as s\. Rendering as yaml will return a hash of metadata about the file, including its contents\. +. +.P +This subcommand does not interact with the \fBclientbucketdir\fR (the default local filebucket for puppet agent); it interacts with the primary "master"\-type filebucket located in the \fBbucketdir\fR\. If you wish to interact with puppet agent\'s default filebucket, you\'ll need to set the \fI\-\-bucketdir\fR option appropriately when invoking actions\. +. +.P +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 +\fBfile\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-filebucket.8 b/man/man8/puppet-filebucket.8 index 7ff0da9af..990756858 100644 --- a/man/man8/puppet-filebucket.8 +++ b/man/man8/puppet-filebucket.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FILEBUCKET" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket @@ -78,4 +78,4 @@ $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949 Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8 new file mode 100644 index 000000000..0f22ca887 --- /dev/null +++ b/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 diff --git a/man/man8/puppet-inspect.8 b/man/man8/puppet-inspect.8 index ae19deede..e11c9fe81 100644 --- a/man/man8/puppet-inspect.8 +++ b/man/man8/puppet-inspect.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-INSPECT" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-INSPECT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-inspect\fR \- Send an inspection report @@ -25,4 +25,4 @@ Any configuration setting which is valid in the configuration file is also a val Puppet Labs . .SH "COPYRIGHT" -Copyright (c) 2011 Puppet Labs, LLC Licensed under the GNU General Public License version 2 +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-key.8 b/man/man8/puppet-key.8 new file mode 100644 index 000000000..b0812d831 --- /dev/null +++ b/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 diff --git a/man/man8/puppet-kick.8 b/man/man8/puppet-kick.8 index b6a868918..2b7502310 100644 --- a/man/man8/puppet-kick.8 +++ b/man/man8/puppet-kick.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-KICK" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KICK" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-kick\fR \- Remotely control puppet agent @@ -25,30 +25,10 @@ You will most likely have to run \'puppet kick\' as root to get access to the SS \'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\. See its documentation for more information, but the gist is that you must enable \'listen\' on the \'puppet agent\' 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\. +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 -An example file looks like this: -. -.IP "" 4 -. -.nf - -[fileserver] - allow *\.madstop\.com - -[puppetmaster] - allow *\.madstop\.com - -[puppetrunner] - allow culain\.madstop\.com -. -.fi -. -.IP "" 0 -. -.P -This is what you would install on your Puppet master; non\-master hosts could leave off the \'fileserver\' and \'puppetmaster\' namespaces\. +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\. @@ -112,4 +92,4 @@ $ sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2 Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-man.8 b/man/man8/puppet-man.8 new file mode 100644 index 000000000..fe5f375eb --- /dev/null +++ b/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 diff --git a/man/man8/puppet-master.8 b/man/man8/puppet-master.8 index 9ed2a6ad6..c38d34afa 100644 --- a/man/man8/puppet-master.8 +++ b/man/man8/puppet-master.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MASTER" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MASTER" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-master\fR \- The puppet master daemon @@ -56,8 +56,19 @@ Compile a catalogue and output it in JSON from the puppet master\. Uses facts co .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) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-node.8 b/man/man8/puppet-node.8 new file mode 100644 index 000000000..4da08722f --- /dev/null +++ b/man/man8/puppet-node.8 @@ -0,0 +1,171 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-NODE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-node\fR \- View and manage node definitions\. +. +.SH "SYNOPSIS" +puppet node \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand interacts with node objects, which are used by Puppet to build a catalog\. A node object consists of the node\'s facts, environment, node parameters (exposed in the parser as top\-scope variables), and classes\. +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet node destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Retrieve a node object\. +\fBSYNOPSIS\fR +. +.IP +puppet node find [\-\-terminus TERMINUS] \fIhost\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a node object\. +. +.IP +\fBRETURNS\fR +. +.IP +A hash containing the node\'s \fBclasses\fR, \fBenvironment\fR, \fBexpiration\fR, \fBname\fR, \fBparameters\fR (its facts, combined with any ENC\-set parameters), and \fBtime\fR\. When used from the Ruby API: a Puppet::Node object\. +. +.IP +RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet node 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet node save [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsearch\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet node search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Retrieve an "empty" (no classes, no ENC\-imposed parameters, and an environment of "production") node: +. +.P +$ puppet node find somenode\.puppetlabs\.lan \-\-terminus plain \-\-render\-as yaml +. +.P +Retrieve a node using the puppet master\'s configured ENC: +. +.P +$ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-mode master \-\-render\-as yaml +. +.P +Retrieve the same node from the puppet master: +. +.P +$ puppet node find somenode\.puppetlabs\.lan \-\-terminus rest \-\-render\-as yaml +. +.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 +\fBactive_record\fR +. +.IP "\(bu" 4 +\fBexec\fR +. +.IP "\(bu" 4 +\fBldap\fR +. +.IP "\(bu" 4 +\fBmemory\fR +. +.IP "\(bu" 4 +\fBplain\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "\(bu" 4 +\fByaml\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-parser.8 b/man/man8/puppet-parser.8 new file mode 100644 index 000000000..0029907e6 --- /dev/null +++ b/man/man8/puppet-parser.8 @@ -0,0 +1,71 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-PARSER" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-parser\fR \- Interact directly with the parser\. +. +.SH "SYNOPSIS" +puppet parser \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 +\fBvalidate\fR \- Validate the syntax of one or more Puppet manifests\. +\fBSYNOPSIS\fR +. +.IP +puppet parser validate [\fImanifest\fR] [\fImanifest\fR \.\.\.] +. +.IP +\fBDESCRIPTION\fR +. +.IP +This action validates Puppet DSL syntax without compiling a catalog or syncing any resources\. If no manifest files are provided, it will validate the default site manifest\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing, or the first syntax error encountered\. +. +.SH "EXAMPLES" +\fBvalidate\fR +. +.P +Validate the default site manifest at /etc/puppet/manifests/site\.pp: +. +.P +$ puppet parser validate +. +.P +Validate two arbitrary manifest files: +. +.P +$ puppet parser validate init\.pp vhost\.pp +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-plugin.8 b/man/man8/puppet-plugin.8 new file mode 100644 index 000000000..05d1af0d5 --- /dev/null +++ b/man/man8/puppet-plugin.8 @@ -0,0 +1,77 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-PLUGIN" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\. +. +.SH "SYNOPSIS" +puppet plugin \fIaction\fR +. +.SH "DESCRIPTION" +This subcommand provides network access to the puppet master\'s store of plugins\. +. +.P +The puppet master serves Ruby code collected from the \fBlib\fR directories of its modules\. These plugins can be used on agent nodes to extend Facter and implement custom types and providers\. Plugins are normally downloaded by puppet agent during the course of a run\. +. +.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 +\fBdownload\fR \- Download plugins from the puppet master\. +\fBSYNOPSIS\fR +. +.IP +puppet plugin download +. +.IP +\fBDESCRIPTION\fR +. +.IP +Downloads plugins from the configured puppet master\. Any plugins downloaded in this way will be used in all subsequent Puppet activity\. This action modifies files on disk\. +. +.IP +\fBRETURNS\fR +. +.IP +A list of the files downloaded, or a confirmation that no files were downloaded\. When used from the Ruby API, this action returns an array of the files downloaded, which will be empty if none were retrieved\. +. +.SH "EXAMPLES" +\fBdownload\fR +. +.P +Retrieve plugins from the puppet master: +. +.P +$ puppet plugin download +. +.P +Retrieve plugins from the puppet master (API example): +. +.P +$ Puppet::Face[:plugin, \'0\.0\.1\']\.download +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-queue.8 b/man/man8/puppet-queue.8 index 7dbd683bf..1a3241c9f 100644 --- a/man/man8/puppet-queue.8 +++ b/man/man8/puppet-queue.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-QUEUE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-QUEUE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs @@ -52,4 +52,4 @@ $ puppet queue Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2009 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-report.8 b/man/man8/puppet-report.8 new file mode 100644 index 000000000..1c2c236b2 --- /dev/null +++ b/man/man8/puppet-report.8 @@ -0,0 +1,187 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-REPORT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-report\fR \- Create, display, and submit reports\. +. +.SH "SYNOPSIS" +puppet report \fIaction\fR [\-\-terminus TERMINUS] +. +.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 \- Invalid for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet report destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this face\. +. +.TP +\fBfind\fR \- Invalid for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet report find [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this face\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet report 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: submit a report\. +\fBSYNOPSIS\fR +. +.IP +puppet report save [\-\-terminus TERMINUS] \fIreport\fR +. +.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\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBsearch\fR \- Invalid for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet report search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this face\. +. +.TP +\fBsubmit\fR \- API only: submit a report with error handling\. +\fBSYNOPSIS\fR +. +.IP +puppet report submit [\-\-terminus TERMINUS] \fIreport\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +API only: Submits a report to the puppet master\. This action is essentially a shortcut and wrapper for the \fBsave\fR action with the \fBrest\fR terminus, and provides additional details in the event of a failure\. +. +.SH "EXAMPLES" +\fBsave\fR +. +.P +From the implementation of \fBpuppet report submit\fR (API example): +. +.IP "" 4 +. +.nf + +begin + Puppet::Transaction::Report\.indirection\.terminus_class = :rest + Puppet::Face[:report, "0\.0\.1"]\.save(report) + Puppet\.notice "Uploaded report for #{report\.name}" +rescue => detail + puts detail\.backtrace if Puppet[:trace] + Puppet\.err "Could not send report: #{detail}" +end +. +.fi +. +.IP "" 0 +. +.P +\fBsubmit\fR +. +.P +From secret_agent\.rb (API example): +. +.IP "" 4 +. +.nf + +# \.\.\. +report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply +Puppet::Face[:report, \'0\.0\.1\']\.submit(report) +return report +. +.fi +. +.IP "" 0 +. +.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 +\fBprocessor\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "\(bu" 4 +\fByaml\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-resource.8 b/man/man8/puppet-resource.8 index 738537e84..7e09c0739 100644 --- a/man/man8/puppet-resource.8 +++ b/man/man8/puppet-resource.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-RESOURCE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell @@ -81,4 +81,4 @@ user { \'luke\': Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005\-2007 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppet-resource_type.8 b/man/man8/puppet-resource_type.8 new file mode 100644 index 000000000..241b68207 --- /dev/null +++ b/man/man8/puppet-resource_type.8 @@ -0,0 +1,214 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-RESOURCE_TYPE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-resource_type\fR \- View classes, defined resource types, and nodes from all manifests\. +. +.SH "SYNOPSIS" +puppet resource_type \fIaction\fR [\-\-terminus TERMINUS] +. +.SH "DESCRIPTION" +This subcommand reads information about the resource collections (classes, nodes, and defined types) available in Puppet\'s site manifest and modules\. +. +.P +It will eventually be extended to examine native resource types\. +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet resource_type destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Retrieve info about a resource collection\. +\fBSYNOPSIS\fR +. +.IP +puppet resource_type find [\-\-terminus TERMINUS] \fIcollection_name\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve info about a resource collection\. +. +.IP +\fBRETURNS\fR +. +.IP +A hash of info about the requested resource collection\. When used from the Ruby API: returns a Puppet::Resource::Type object\. +. +.IP +RENDERING ISSUES: yaml and string output for this indirection are currently unusable; use json instead\. +. +.IP +\fBNOTES\fR +. +.IP +If two resource collections share the same name (e\.g\. you have both a node and a class named "default"), \fBfind\fR will only return one of them\. This can be worked around by using \fBsearch\fR instead\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet resource_type 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet resource_type save [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsearch\fR \- Search for collections matching a regular expression\. +\fBSYNOPSIS\fR +. +.IP +puppet resource_type search [\-\-terminus TERMINUS] \fIregular_expression\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Search for collections matching a regular expression\. +. +.IP +\fBRETURNS\fR +. +.IP +An array of hashes of resource collection info\. When used from the Ruby API: returns an array of Puppet::Resource::Type objects\. +. +.IP +RENDERING ISSUES: yaml and string output for this indirection are currently unusable; use json instead\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Retrieve info about a specific locally\-defined class: +. +.P +$ puppet resource_type find ntp::disabled +. +.P +Retrieve info from the puppet master about a specific class: +. +.P +$ puppet resource_type find ntp \-\-terminus rest +. +.P +\fBsearch\fR +. +.P +Retrieve all classes, nodes, and defined types: +. +.P +$ puppet resource_type search \'\.*\' +. +.P +Search for classes related to Nagios: +. +.P +$ puppet resource_type search nagios +. +.SH "NOTES" +The \fBfind\fR and \fBsearch\fR actions return similar hashes of resource collection info\. These hashes will include the following four keys: +. +.IP "\(bu" 4 +\fBfile\fR (a string) +. +.IP "\(bu" 4 +\fBname\fR (a string) +. +.IP "\(bu" 4 +\fBtype\fR (\fIhostclass\fR, \fIdefinition\fR, or \fInode\fR) +. +.IP "\(bu" 4 +\fBline\fR (an integer) +. +.IP "" 0 +. +.P +They may optionally include the following keys: +. +.IP "\(bu" 4 +\fBparent\fR (\fIname_of_resource_collection\fR) +. +.IP "\(bu" 4 +\fBarguments\fR (a hash of parameters and default values) +. +.IP "\(bu" 4 +\fBdoc\fR (a string) +. +.IP "" 0 +. +.P +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 +\fBparser\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-secret_agent.8 b/man/man8/puppet-secret_agent.8 new file mode 100644 index 000000000..f2e5c3a1c --- /dev/null +++ b/man/man8/puppet-secret_agent.8 @@ -0,0 +1,74 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-SECRET_AGENT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-secret_agent\fR \- Mimics puppet agent\. +. +.SH "SYNOPSIS" +puppet secret_agent \fIaction\fR +. +.SH "DESCRIPTION" +This subcommand currently functions as a proof of concept, demonstrating how the Faces API exposes Puppet\'s internal systems to application logic; compare the actual code for puppet agent\. It will eventually replace puppet agent entirely, and can provide a template for users who wish to implement agent\-like functionality with non\-standard application logic\. +. +.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 +\fBsynchronize\fR \- Run secret_agent once\. +\fBSYNOPSIS\fR +. +.IP +puppet secret_agent +. +.IP +\fBDESCRIPTION\fR +. +.IP +Mimics a single run of puppet agent\. This action does not currently daemonize, but can download plugins, submit facts, retrieve and apply a catalog, and submit a report to the puppet master\. +. +.IP +\fBRETURNS\fR +. +.IP +Verbose logging from the completed run\. When used from the Ruby API: returns a Puppet::Transaction::Report object\. +. +.IP +\fBNOTES\fR +. +.IP +This action requires that the puppet master\'s \fBauth\.conf\fR file allow save access to the \fBfacts\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\. +. +.SH "EXAMPLES" +\fBsynchronize\fR +. +.P +Trigger a Puppet run with the configured puppet master: +. +.P +$ puppet secret_agent +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-status.8 b/man/man8/puppet-status.8 new file mode 100644 index 000000000..c7707497a --- /dev/null +++ b/man/man8/puppet-status.8 @@ -0,0 +1,150 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-STATUS" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-status\fR \- View puppet server status\. +. +.SH "SYNOPSIS" +puppet status \fIaction\fR [\-\-terminus TERMINUS] +. +.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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet status destroy [\-\-terminus TERMINUS] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Check status of puppet master server\. +\fBSYNOPSIS\fR +. +.IP +puppet status find [\-\-terminus TERMINUS] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Checks whether a Puppet server is properly receiving and processing HTTP requests\. This action is only useful when used with \'\-\-terminus rest\'; when invoked with the \fBlocal\fR terminus, \fBfind\fR will always return true\. +. +.IP +Over REST, this action will query the configured puppet master by default\. To query other servers, including puppet agent nodes started with the \fI\-\-listen\fR option, you can set set the global \fI\-\-server\fR and \fI\-\-masterport\fR options on the command line; note that agent nodes listen on port 8139\. +. +.IP +\fBRETURNS\fR +. +.IP +A "true" response or a low\-level connection error\. When used from the Ruby API: returns a Puppet::Status object\. +. +.IP +\fBNOTES\fR +. +.IP +This action requires that the server\'s \fBauth\.conf\fR file allow find access to the \fBstatus\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\. +. +.IP +Although this action always returns an unnamed status object, it requires a dummy argument\. This is a known bug\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet status 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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet status save [\-\-terminus TERMINUS] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBsearch\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet status search [\-\-terminus TERMINUS] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Check the status of the configured puppet master: +. +.P +$ puppet status find x \-\-terminus rest +. +.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 +\fBlocal\fR +. +.IP "\(bu" 4 +\fBrest\fR +. +.IP "" 0 +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet.8 b/man/man8/puppet.8 index f58a54d41..ce6b6a458 100644 --- a/man/man8/puppet.8 +++ b/man/man8/puppet.8 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\fR . .P -Usage: puppet command \fIspace separated arguments\fR Available commands are: agent, apply, cert, describe, doc, filebucket, inspect, kick, master, queue, resource +See \'puppet help\' for help on available puppet subcommands diff --git a/man/man8/puppetca.8 b/man/man8/puppetca.8 index bea7596d4..211f8ca7a 100644 --- a/man/man8/puppetca.8 +++ b/man/man8/puppetca.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CERT" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-cert\fR \- Manage certificates and requests @@ -10,60 +10,67 @@ Standalone certificate authority\. Capable of generating certificates, but mostly used for signing certificate requests from puppet clients\. . .SH "USAGE" -puppet cert [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] [\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [\-\-digest \fIdigest\fR] [\-\-fingerprint] [host] +puppet cert \fIaction\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-\-digest \fIdigest\fR] [\fIhost\fR] . .SH "DESCRIPTION" Because the puppet master service 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" -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\. +.SH "ACTIONS" +Every action except \'list\' and \'generate\' requires a hostname to act on, unless the \'\-\-all\' option is set\. . -.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 cert with \'\-\-genconfig\'\. +.TP +clean +Revoke a host\'s certificate (if applicable) and remove all files related to that host from puppet cert\'s 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\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\. . .TP -\-\-all -Operate on all items\. Currently only makes sense with \'\-\-sign\', \'\-\-clean\', or \'\-\-list\'\. +fingerprint +Print the DIGEST (defaults to md5) fingerprint of a host\'s certificate\. . .TP -\-\-digest -Set the digest for fingerprinting (defaults to md5)\. Valid values depends on your openssl and openssl ruby extension version, but should contain at least md5, sha1, md2, sha256\. +generate +Generate a certificate for a named client\. A certificate/keypair will be generated for each client named on the command line\. . .TP -\-\-clean -Remove all files related to a host from puppet cert\'s 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 is also revoked\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\. +list +List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. . .TP -\-\-debug -Enable full debugging\. +print +Print the full\-text version of a host\'s certificate\. . .TP -\-\-generate -Generate a certificate for a named client\. A certificate/keypair will be generated for each client named on the command line\. +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 \'0x\') or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' configuration option\. Note that the puppet master needs to be restarted after revoking certificates\. . .TP -\-\-help -Print this help message +sign +Sign an outstanding certificate request\. . .TP -\-\-list -List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. +verify +Verify the named certificate against the local CA certificate\. +. +.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 cert with \'\-\-genconfig\'\. . .TP -\-\-print -Print the full\-text version of a host\'s certificate\. +\-\-all +Operate on all items\. Currently only makes sense with the \'sign\', \'clean\', \'list\', and \'fingerprint\' actions\. . .TP -\-\-fingerprint -Print the DIGEST (defaults to md5) fingerprint of a host\'s certificate\. +\-\-digest +Set the digest for fingerprinting (defaults to md5)\. Valid values depends on your openssl and openssl ruby extension version, but should contain at least md5, sha1, md2, sha256\. . .TP -\-\-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 \'0x\', or by its hostname\. The certificate is revoked by adding it to the Certificate Revocation List given by the \'cacrl\' config parameter\. Note that the puppetmasterd needs to be restarted after revoking certificates\. +\-\-debug +Enable full debugging\. . .TP -\-\-sign -Sign an outstanding certificate request\. Unless \'\-\-all\' is specified, hosts must be listed after all flags\. +\-\-help +Print this help message . .TP \-\-verbose @@ -73,17 +80,13 @@ Enable verbosity\. \-\-version Print the puppet version number and exit\. . -.TP -\-\-verify -Verify the named certificate against the local CA certificate\. -. .SH "EXAMPLE" . .nf -$ puppet cert \-l +$ puppet cert list culain\.madstop\.com -$ puppet cert \-s culain\.madstop\.com +$ puppet cert sign culain\.madstop\.com . .fi . @@ -91,4 +94,4 @@ $ puppet cert \-s culain\.madstop\.com Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppetd.8 b/man/man8/puppetd.8 index 3fadd9df7..2e5cedf51 100644 --- a/man/man8/puppetd.8 +++ b/man/man8/puppetd.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-AGENT" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-AGENT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon @@ -132,8 +132,23 @@ $ 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) 2005, 2006 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8 index e0cabd5d1..f6de3951a 100644 --- a/man/man8/puppetdoc.8 +++ b/man/man8/puppetdoc.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DOC" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DOC" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet documentation and references @@ -98,4 +98,4 @@ $ puppet doc \-m pdf \-r configuration Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005\-2007 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppetmasterd.8 b/man/man8/puppetmasterd.8 index 9ed2a6ad6..c38d34afa 100644 --- a/man/man8/puppetmasterd.8 +++ b/man/man8/puppetmasterd.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MASTER" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MASTER" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-master\fR \- The puppet master daemon @@ -56,8 +56,19 @@ Compile a catalogue and output it in JSON from the puppet master\. Uses facts co .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) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppetqd.8 b/man/man8/puppetqd.8 index 7dbd683bf..1a3241c9f 100644 --- a/man/man8/puppetqd.8 +++ b/man/man8/puppetqd.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-QUEUE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-QUEUE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs @@ -52,4 +52,4 @@ $ puppet queue Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2009 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/puppetrun.8 b/man/man8/puppetrun.8 index b6a868918..2b7502310 100644 --- a/man/man8/puppetrun.8 +++ b/man/man8/puppetrun.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-KICK" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KICK" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-kick\fR \- Remotely control puppet agent @@ -25,30 +25,10 @@ You will most likely have to run \'puppet kick\' as root to get access to the SS \'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\. See its documentation for more information, but the gist is that you must enable \'listen\' on the \'puppet agent\' 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\. +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 -An example file looks like this: -. -.IP "" 4 -. -.nf - -[fileserver] - allow *\.madstop\.com - -[puppetmaster] - allow *\.madstop\.com - -[puppetrunner] - allow culain\.madstop\.com -. -.fi -. -.IP "" 0 -. -.P -This is what you would install on your Puppet master; non\-master hosts could leave off the \'fileserver\' and \'puppetmaster\' namespaces\. +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\. @@ -112,4 +92,4 @@ $ sudo puppet kick \-p 10 \-t remotefile \-t webserver host1 host2 Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License diff --git a/man/man8/ralsh.8 b/man/man8/ralsh.8 index 738537e84..7e09c0739 100644 --- a/man/man8/ralsh.8 +++ b/man/man8/ralsh.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-RESOURCE" "8" "February 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell @@ -81,4 +81,4 @@ user { \'luke\': Luke Kanies . .SH "COPYRIGHT" -Copyright (c) 2005\-2007 Puppet Labs, LLC Licensed under the GNU Public License +Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License |