puppet 2.6.18 → 2.7.1

data/man/man8/puppet-resource.8

@@ -0,0 +1,84 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-RESOURCE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-resource\fR \- The resource abstraction layer shell
+.
+.SH "SYNOPSIS"
+Uses the Puppet RAL to directly interact with the system\.
+.
+.SH "USAGE"
+puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-H|\-\-host \fIhost\fR] [\-p|\-\-param \fIparameter\fR] [\-t|\-\-types] \fItype\fR [\fIname\fR] [\fIattribute\fR=\fIvalue\fR \.\.\.]
+.
+.SH "DESCRIPTION"
+This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet\'s RAL\.
+.
+.P
+By default, you must at least provide a type to list, in which case puppet resource will tell you everything it knows about all resources of that type\. You can optionally specify an instance name, and puppet resource will only describe that single instance\.
+.
+.P
+If given a type, a name, and a series of \fIattribute\fR=\fIvalue\fR pairs, puppet resource will modify the state of the specified resource\. Alternately, if given a type, a name, and the \'\-\-edit\' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction\.
+.
+.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 with \'\-\-genconfig\'\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-edit
+Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest\.
+.
+.TP
+\-\-host
+When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified\.
+.
+.TP
+\-\-help
+Print this help message\.
+.
+.TP
+\-\-param
+Add more parameters to be outputted from queries\.
+.
+.TP
+\-\-types
+List all available types\.
+.
+.TP
+\-\-verbose
+Print extra information\.
+.
+.SH "EXAMPLE"
+This example uses \fBpuppet resource\fR to return a Puppet configuration for the user \fBluke\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ puppet resource user luke
+user { \'luke\':
+ home => \'/home/luke\',
+ uid => \'100\',
+ ensure => \'present\',
+ comment => \'Luke Kanies,,,\',
+ gid => \'1000\',
+ shell => \'/bin/bash\',
+ groups => [\'sysadmin\',\'audio\',\'video\',\'puppet\']
+}
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/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

data/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

data/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