diff options
author | Matthaus Litteken <matthaus@puppetlabs.com> | 2012-06-06 13:48:19 -0700 |
---|---|---|
committer | Matthaus Litteken <matthaus@puppetlabs.com> | 2012-06-06 14:41:53 -0700 |
commit | da36281f07a61e2689d38cba5d5e4fe529548628 (patch) | |
tree | 27d8c8f1641dc177e7f000475ddeafaf9da1731d | |
parent | fb4c64b6a54b37ef1357f853fb6d00e17202b410 (diff) | |
download | puppet-da36281f07a61e2689d38cba5d5e4fe529548628.tar.gz |
Updated manpages, CHANGELOG, puppet.spec, puppet.rb for 2.7.16rc1.
49 files changed, 1687 insertions, 242 deletions
@@ -1,5 +1,12 @@ -2.7.15rc4 +2.7.16rc1 === +3a06246 (#8858) Explicitly set SSL peer verification mode. +cd4bee8 Test SSL setup code, not our stubbing of it. +ff052b8 (maint) Add mailmap to identify contributors +8dda6c2 (#14723) Fix http report description +ebf5386 Remove EL-related test changes from this commit. +2aea708 Revert changes to symbolic_modes.rb -- this test should indeed be pending (it should eventually work on Windows). +b601bb4 Update acceptance tests to use confine instead of skip_test loops e619304 (#14761) Add boot, reboot to excludes list for redhat provider 7c1d8c2 (maint) Disable upstart spec test on windows 37df5c4 (#14615) Final stub fixes for the tests. @@ -8,9 +15,6 @@ f11dfd6 (#14615) Fix provider spec tests to work on non gentoo systems c0cb0fa (Maint) Close filehandles after read in upstart 0788ea2 (#14615) Exclude helperscripts in gentoo service provider be6062c Apply commit from master that varies ports during tests - -2.7.15rc3 -=== a45942b (#14297) Don't remove tty1 or rsyslog during upstart acceptance 466ab49 (#14297) Define agent in upstart acceptance test f5d1f74 (#14297) Update upstart provider acceptance tests @@ -21,15 +25,9 @@ b9ed026 (#14297) Update spec tests for upstart provider 91827e8 (#14297) Handle upstart services better 3541db6 (#14343) Lookup in correct inherited scope 2d83e22 (Maint) Added test for fully qualified variable - -2.7.15rc2 -=== c6e006e (#8174) Allow defines to reference topscope e27adf4 Evaluate node classes either in top or node scope a3d51b2 Removed topscope being overridden by node - -2.7.15rc1 -=== 53e0057 Use internal domain name for module tool tests f4ba59e Use absolute_path in module install spec ead9d25 (Maint) Color console output when the win32console gem is installed diff --git a/conf/redhat/puppet.spec b/conf/redhat/puppet.spec index 0bdd4142a..e6edf589f 100644 --- a/conf/redhat/puppet.spec +++ b/conf/redhat/puppet.spec @@ -5,22 +5,22 @@ %global confdir conf/redhat Name: puppet -Version: 2.7.15 -Release: 0.1rc4%{?dist} +Version: 2.7.16 +Release: 0.1rc1%{?dist} #Release: 1%{?dist} Summary: A network tool for managing many disparate systems License: ASL 2.0 URL: http://puppetlabs.com #Source0: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}.tar.gz -Source0: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}rc4.tar.gz +Source0: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}rc1.tar.gz #Source1: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}.tar.gz.asc -Source1: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}rc4.tar.gz.asc +Source1: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}rc1.tar.gz.asc Group: System Environment/Base BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root-%(%{__id_u} -n) -BuildRequires: facter >= 1.5 +BuildRequires: facter >= 1.5, facter < 2.0 BuildRequires: ruby >= 1.8.5 BuildArch: noarch @@ -36,7 +36,7 @@ Requires: ruby-shadow %endif %endif -Requires: facter >= 1.5, facter <= 2.0 +Requires: facter >= 1.5, facter < 2.0 Requires: ruby >= 1.8.5 %{!?_without_augeas:Requires: ruby-augeas} @@ -67,7 +67,7 @@ The server can also function as a certificate authority and file server. %prep #%setup -q -n %{name}-%{version} -%setup -q -n %{name}-%{version}rc4 +%setup -q -n %{name}-%{version}rc1 patch -s -p1 < conf/redhat/rundir-perms.patch @@ -178,6 +178,7 @@ echo "D /var/run/%{name} 0755 %{name} %{name} -" > \ %{_mandir}/man8/puppet-apply.8.gz %{_mandir}/man8/puppet-catalog.8.gz %{_mandir}/man8/puppet-describe.8.gz +%{_mandir}/man8/puppet-ca.8.gz %{_mandir}/man8/puppet-cert.8.gz %{_mandir}/man8/puppet-certificate.8.gz %{_mandir}/man8/puppet-certificate_request.8.gz @@ -190,9 +191,13 @@ echo "D /var/run/%{name} 0755 %{name} %{name} -" > \ %{_mandir}/man8/puppet-filebucket.8.gz %{_mandir}/man8/puppet-help.8.gz %{_mandir}/man8/puppet-inspect.8.gz +%{_mandir}/man8/puppet-instrumentation_data.8.gz +%{_mandir}/man8/puppet-instrumentation_listener.8.gz +%{_mandir}/man8/puppet-instrumentation_probe.8.gz %{_mandir}/man8/puppet-key.8.gz %{_mandir}/man8/puppet-kick.8.gz %{_mandir}/man8/puppet-man.8.gz +%{_mandir}/man8/puppet-module.8.gz %{_mandir}/man8/puppet-node.8.gz %{_mandir}/man8/puppet-parser.8.gz %{_mandir}/man8/puppet-plugin.8.gz @@ -284,7 +289,10 @@ fi rm -rf %{buildroot} %changelog -* Fri Jun 1 2012 Matthaus Litteken <matthaus@puppetlabs.com> - 2.7.15-0.1rc4 +* Wed Jun 06 2012 Matthaus Litteken <matthaus@puppetlabs.com> - 2.7.16-0.1rc1 +- Update for 2.7.16rc1, added generated manpages + +* Fri Jun 01 2012 Matthaus Litteken <matthaus@puppetlabs.com> - 2.7.15-0.1rc4 - Update for 2.7.15rc4 * Tue May 29 2012 Moses Mendoza <moses@puppetlabs.com> - 2.7.15-0.1rc3 diff --git a/lib/puppet.rb b/lib/puppet.rb index 4192ea0f3..1fc9af2c3 100644 --- a/lib/puppet.rb +++ b/lib/puppet.rb @@ -24,7 +24,7 @@ require 'puppet/util/run_mode' # it's also a place to find top-level commands like 'debug' module Puppet - PUPPETVERSION = '2.7.15' + PUPPETVERSION = '2.7.16' def Puppet.version PUPPETVERSION diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5 index aa747bdd4..f1e407a39 100644 --- a/man/man5/puppet.conf.5 +++ b/man/man5/puppet.conf.5 @@ -1,8 +1,8 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPETCONF" "5" "June 2011" "Puppet Labs, LLC" "Puppet manual" -\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on Wed Jun 08 17:09:41 \-0700 2011)\fR +.TH "PUPPETCONF" "5" "June 2012" "Puppet Labs, LLC" "Puppet manual" +\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on Wed Jun 06 13:43:46 \-0700 2012)\fR . .SH "Configuration Settings" . @@ -73,7 +73,7 @@ The configuration file that defines the rights to the different namespaces and m Whether log files should always flush to disk\. . .IP "\(bu" 4 -\fIDefault\fR: false +\fIDefault\fR: true . .IP "" 0 . @@ -105,7 +105,7 @@ Wether the master should function as a certificate authority\. .IP "" 0 . .SS "ca_days" -How long a certificate should be valid\. This parameter is deprecated, use ca_ttl instead +How long a certificate should be valid, in days\. This setting is deprecated; use \fBca_ttl\fR instead . .SS "ca_md" The type of hash used in certificates\. @@ -140,7 +140,7 @@ The server to use for certificate authority requests\. It\'s a separate server b .IP "" 0 . .SS "ca_ttl" -The default TTL for new certificates; valid values must be an integer, optionally followed by one of the units \'y\' (years of 365 days), \'d\' (days), \'h\' (hours), or \'s\' (seconds)\. The unit defaults to seconds\. If this parameter is set, ca_days is ignored\. Examples are \'3600\' (one hour) and \'1825d\', which is the same as \'5y\' (5 years) +The default TTL for new certificates; valid values must be an integer, optionally followed by one of the units \'y\' (years of 365 days), \'d\' (days), \'h\' (hours), or \'s\' (seconds)\. The unit defaults to seconds\. If this setting is set, ca_days is ignored\. Examples are \'3600\' (one hour) and \'1825d\', which is the same as \'5y\' (5 years) . .IP "\(bu" 4 \fIDefault\fR: 5y @@ -231,7 +231,7 @@ The certificate directory\. .IP "" 0 . .SS "certdnsnames" -The DNS names on the Server certificate as a colon\-separated list\. If it\'s anything other than an empty string, it will be used as an alias in the created certificate\. By default, only the server gets an alias set up, and only for \'puppet\'\. +The \fBcertdnsnames\fR setting is no longer functional, after CVE\-2011\-3872\. We ignore the value completely\. For your own certificate request you can set \fBdns_alt_names\fR in the configuration and it will apply locally\. There is no configuration option to set DNS alt names, or any other \fBsubjectAltName\fR value, for another nodes certificate\. Alternately you can use the \fB\-\-dns_alt_names\fR command line option to set the labels added while generating your own CSR\. . .SS "certificate_revocation" Whether certificate revocation should be supported by downloading a Certificate Revocation List (CRL) to all clients\. If enabled, CA chaining will almost definitely not work\. @@ -245,7 +245,7 @@ Whether certificate revocation should be supported by downloading a Certificate The name to use when handling certificates\. Defaults to the fully qualified domain name\. . .IP "\(bu" 4 -\fIDefault\fR: magpie\.puppetlabs\.lan +\fIDefault\fR: wyclef\.puppetlabs\.lan . .IP "" 0 . @@ -285,7 +285,7 @@ The directory in which client\-side YAML data is stored\. Code to parse directly\. This is essentially only used by \fBpuppet\fR, and should only be set if you\'re writing your own Puppet executable . .SS "color" -Whether to use colors when logging to the console\. Valid values are \fBansi\fR (equivalent to \fBtrue\fR), \fBhtml\fR (mostly used during testing with TextMate), and \fBfalse\fR, which produces no color\. +Whether to use colors when logging to the console\. Valid values are \fBansi\fR (equivalent to \fBtrue\fR), \fBhtml\fR, and \fBfalse\fR, which produces no color\. . .IP "\(bu" 4 \fIDefault\fR: ansi @@ -293,7 +293,7 @@ Whether to use colors when logging to the console\. Valid values are \fBansi\fR .IP "" 0 . .SS "confdir" -The main Puppet configuration directory\. The default for this parameter is calculated based on the user\. If the process is running as root or the user that Puppet is supposed to run as, it defaults to a system directory, but if it\'s running as any other user, it defaults to being in the user\'s home directory\. +The main Puppet configuration directory\. The default for this setting is calculated based on the user\. If the process is running as root or the user that Puppet is supposed to run as, it defaults to a system directory, but if it\'s running as any other user, it defaults to being in the user\'s home directory\. . .IP "\(bu" 4 \fIDefault\fR: /etc/puppet @@ -312,7 +312,7 @@ The configuration file for doc\. How to determine the configuration version\. By default, it will be the time that the configuration is parsed, but you can provide a shell script to override how the version is determined\. The output of this script will be added to every log message in the reports, allowing you to correlate changes on your hosts to the source version on the server\. . .SS "configprint" -Print the value of a specific configuration parameter\. If a parameter is provided for this, then the value is printed and puppet exits\. Comma\-separate multiple values\. For a list of all values, specify \'all\'\. This feature is only available in Puppet versions higher than 0\.18\.4\. +Print the value of a specific configuration setting\. If the name of a setting is provided for this, then the value is printed and puppet exits\. Comma\-separate multiple values\. For a list of all values, specify \'all\'\. . .SS "configtimeout" How long the client should wait for the configuration to be retrieved before considering it a failure\. This can help reduce flapping if too many clients contact the server at one time\. @@ -339,7 +339,7 @@ Where the CA stores certificate requests .IP "" 0 . .SS "daemonize" -Send the process into the background\. This is the default\. +Whether to send the process into the background\. This defaults to true on POSIX systems, and to false on Windows (where Puppet currently cannot daemonize)\. . .IP "\(bu" 4 \fIDefault\fR: true @@ -428,7 +428,7 @@ The root directory of devices\' $vardir .IP "" 0 . .SS "diff" -Which diff command to use when printing differences between files\. +Which diff command to use when printing differences between files\. This setting has no default value on Windows, as standard \fBdiff\fR is not available, but Puppet can use many third\-party diff tools\. . .IP "\(bu" 4 \fIDefault\fR: diff @@ -436,13 +436,16 @@ Which diff command to use when printing differences between files\. .IP "" 0 . .SS "diff_args" -Which arguments to pass to the diff command when printing differences between files\. +Which arguments to pass to the diff command when printing differences between files\. The command to use can be chosen with the \fBdiff\fR setting\. . .IP "\(bu" 4 \fIDefault\fR: \-u . .IP "" 0 . +.SS "dns_alt_names" +The comma\-separated list of alternative DNS names to use for the local host\. When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. +. .SS "document_all" Document all resources . @@ -484,7 +487,7 @@ Whether each resource should log when it is being evaluated\. This allows you to .IP "" 0 . .SS "external_nodes" -An external command that can produce node information\. The output must be a YAML dump of a hash, and that hash must have one or both of \fBclasses\fR and \fBparameters\fR, where \fBclasses\fR is an array and \fBparameters\fR is a hash\. For unknown nodes, the commands should exit with a non\-zero exit code\. This command makes it straightforward to store your node mapping information in other data sources like databases\. +An external command that can produce node information\. The command\'s output must be a YAML dump of a hash, and that hash must have a \fBclasses\fR key and/or a \fBparameters\fR key, where \fBclasses\fR is an array or hash and \fBparameters\fR is a hash\. For unknown nodes, the command should exit with a non\-zero exit code\. This command makes it straightforward to store your node mapping information in other data sources like databases\. . .IP "\(bu" 4 \fIDefault\fR: none @@ -500,7 +503,7 @@ Where Puppet should store facts that it pulls down from the central server\. .IP "" 0 . .SS "factpath" -Where Puppet should look for facts\. Multiple directories should be colon\-separated, like normal PATH variables\. +Where Puppet should look for facts\. Multiple directories should be separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .IP "\(bu" 4 \fIDefault\fR: $vardir/lib/facter:$vardir/facts @@ -684,7 +687,7 @@ Ignore cache and always recompile the configuration\. This is useful for testing .IP "" 0 . .SS "ignoreimport" -A parameter that can be used in commit hooks, since it enables you to parse\-check a single file rather than requiring that all files exist\. +If true, allows the parser to continue without requiring all files referenced with \fBimport\fR statements to exist\. This setting was primarily designed for use with commit hooks for parse\-checking\. . .IP "\(bu" 4 \fIDefault\fR: false @@ -727,7 +730,7 @@ Should usually be the same as the facts terminus The bit length of keys\. . .IP "\(bu" 4 -\fIDefault\fR: 1024 +\fIDefault\fR: 4096 . .IP "" 0 . @@ -948,8 +951,24 @@ Whether to create the necessary user and group that puppet agent will run as\. . .IP "" 0 . +.SS "module_repository" +The module repository +. +.IP "\(bu" 4 +\fIDefault\fR: http://forge\.puppetlabs\.com +. +.IP "" 0 +. +.SS "module_working_dir" +The directory into which module tool data is stored +. +.IP "\(bu" 4 +\fIDefault\fR: $vardir/puppet\-module +. +.IP "" 0 +. .SS "modulepath" -The search path for modules as a colon\-separated list of directories\. +The search path for modules, as a list of directories separated by the system path separator character\. (The POSIX path separator is \':\', and the Windows path separator is \';\'\.) . .IP "\(bu" 4 \fIDefault\fR: $confdir/modules:/usr/share/puppet/modules @@ -972,6 +991,17 @@ How the puppet master determines the client\'s identity and sets the \'hostname\ . .IP "" 0 . +.SS "node_name_fact" +The fact name used to determine the node name used for all requests the agent makes to the master\. WARNING: This setting is mutually exclusive with node_name_value\. Changing this setting also requires changes to the default auth\.conf configuration on the Puppet Master\. Please see http://links\.puppetlabs\.com/node_name_fact for more information\. +. +.SS "node_name_value" +The explicit value used for the node name for all requests the agent makes to the master\. WARNING: This setting is mutually exclusive with node_name_fact\. Changing this setting also requires changes to the default auth\.conf configuration on the Puppet Master\. Please see http://links\.puppetlabs\.com/node_name_value for more information\. +. +.IP "\(bu" 4 +\fIDefault\fR: $certname +. +.IP "" 0 +. .SS "node_terminus" Where to find information about nodes\. . @@ -1182,7 +1212,7 @@ The directory in which to store reports received from the client\. Each client g The \'from\' email address for the reports\. . .IP "\(bu" 4 -\fIDefault\fR: report@magpie\.puppetlabs\.lan +\fIDefault\fR: report@wyclef\.puppetlabs\.lan . .IP "" 0 . @@ -1206,7 +1236,7 @@ The list of reports to generate\. All reports are looked for in \fBpuppet/report The URL used by the http reports processor to send reports . .IP "\(bu" 4 -\fIDefault\fR: http://localhost:3000/reports +\fIDefault\fR: http://localhost:3000/reports/upload . .IP "" 0 . @@ -1214,7 +1244,7 @@ The URL used by the http reports processor to send reports The bit length of the certificates\. . .IP "\(bu" 4 -\fIDefault\fR: 2048 +\fIDefault\fR: 4096 . .IP "" 0 . @@ -1226,6 +1256,14 @@ Where host certificate requests are stored\. . .IP "" 0 . +.SS "resourcefile" +The file in which puppet agent stores a list of the resources associated with the retrieved configuration\. +. +.IP "\(bu" 4 +\fIDefault\fR: $statedir/resources\.txt +. +.IP "" 0 +. .SS "rest_authconfig" The configuration file that defines the rights to the different rest indirections\. This can be used as a fine\-grained authorization system for \fBpuppet master\fR\. . @@ -1275,7 +1313,7 @@ Where Puppet PID files are kept\. .IP "" 0 . .SS "runinterval" -How often puppet agent applies the client configuration; in seconds\. +How often puppet agent applies the client configuration; in seconds\. Note that a runinterval of 0 means "run continuously" rather than "never run\." If you want puppet agent to never run, you should start it with the \fB\-\-no\-client\fR option\. . .IP "\(bu" 4 \fIDefault\fR: 1800 @@ -1323,7 +1361,7 @@ The type of server to use\. Currently supported options are webrick and mongrel\ .IP "" 0 . .SS "show_diff" -Whether to print a contextual diff when files are being replaced\. The diff is printed on stdout, so this option is meaningless unless you are running Puppet interactively\. This feature currently requires the \fBdiff/lcs\fR Ruby library\. +Whether to log and report a contextual diff when files are being replaced\. This causes partial file contents to pass through Puppet\'s normal logging and reporting system, so this setting should be used with caution if you are sending Puppet\'s reports to an insecure destination\. This feature currently requires the \fBdiff/lcs\fR Ruby library\. . .IP "\(bu" 4 \fIDefault\fR: false @@ -1403,13 +1441,21 @@ Where puppet agent and puppet master store state associated with the running con .IP "" 0 . .SS "storeconfigs" -Whether to store each client\'s configuration\. This requires ActiveRecord from Ruby on Rails\. +Whether to store each client\'s configuration, including catalogs, facts, and related data\. This also enables the import and export of resources in the Puppet language \- a mechanism for exchange resources between nodes\. By default this uses ActiveRecord and an SQL database to store and query the data; this, in turn, will depend on Rails being available\. You can adjust the backend using the storeconfigs_backend setting\. . .IP "\(bu" 4 \fIDefault\fR: false . .IP "" 0 . +.SS "storeconfigs_backend" +Configure the backend terminus used for StoreConfigs\. By default, this uses the ActiveRecord store, which directly talks to the database from within the Puppet Master process\. +. +.IP "\(bu" 4 +\fIDefault\fR: active_record +. +.IP "" 0 +. .SS "strict_hostname_checking" Whether to only search for the complete hostname as it is in the certificate when searching for node information in the catalogs\. . @@ -1446,7 +1492,7 @@ The mapping between reporting tags and email addresses\. Tags to use to find resources\. If this is set, then only resources tagged with the specified tags will be applied\. Values must be comma\-separated\. . .SS "templatedir" -Where Puppet looks for template files\. Can be a list of colon\-seperated directories\. +Where Puppet looks for template files\. Can be a list of colon\-separated directories\. . .IP "\(bu" 4 \fIDefault\fR: $vardir/templates @@ -1494,7 +1540,7 @@ The user puppet master should run as\. .IP "" 0 . .SS "vardir" -Where Puppet stores dynamic and growing data\. The default for this parameter is calculated specially, like \fBconfdir\fR_\. +Where Puppet stores dynamic and growing data\. The default for this setting is calculated specially, like \fBconfdir\fR_\. . .IP "\(bu" 4 \fIDefault\fR: /var/lib/puppet @@ -1518,4 +1564,4 @@ Boolean; whether to use the zlib library .IP "" 0 . .P -\fIThis page autogenerated on Wed Jun 08 17:09:41 \-0700 2011\fR +\fIThis page autogenerated on Wed Jun 06 13:43:46 \-0700 2012\fR diff --git a/man/man8/filebucket.8 b/man/man8/filebucket.8 index 990756858..31775c97a 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket diff --git a/man/man8/pi.8 b/man/man8/pi.8 index af246f16b..395ca3cd5 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types diff --git a/man/man8/puppet-agent.8 b/man/man8/puppet-agent.8 index 2e5cedf51..4d36fba5e 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-AGENT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon @@ -13,7 +13,7 @@ Retrieves the client configuration from the puppet master and applies it to the This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\. . .SH "USAGE" -puppet agent [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-disable] [\-\-enable] [\-h|\-\-help] [\-\-certname \fIhost name\fR] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-\-noop] [\-\-digest \fIdigest\fR] [\-\-fingerprint] [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR] +puppet agent [\-\-certname \fIname\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIdigest\fR] [\-\-disable] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-no\-client] [\-\-noop] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fIseconds\fR] . .SH "DESCRIPTION" This is the main puppet client\. Its job is to retrieve the local machine\'s configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\. @@ -40,6 +40,10 @@ Note that any configuration parameter that\'s valid in the configuration file is 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 agent with \'\-\-genconfig\'\. . .TP +\-\-certname +Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. +. +.TP \-\-daemonize Send the process into the background\. This is the default\. . @@ -52,12 +56,12 @@ Do not send the process into the background\. Enable full debugging\. . .TP -\-\-digest -Change the certificate fingerprinting digest algorithm\. The default is MD5\. Valid values depends on the version of OpenSSL installed, but should always at least contain MD5, MD2, SHA1 and SHA256\. +\-\-detailed\-exitcodes +Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .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\. +\-\-digest +Change the certificate fingerprinting digest algorithm\. The default is MD5\. Valid values depends on the version of OpenSSL installed, but should always at least contain MD5, MD2, SHA1 and SHA256\. . .TP \-\-disable @@ -77,8 +81,8 @@ Enable working on the local system\. This removes any lock file, causing \'puppe \'puppet agent\' exits after executing this\. . .TP -\-\-certname -Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. +\-\-fingerprint +Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\. . .TP \-\-help @@ -90,15 +94,15 @@ Where to send messages\. Choose between syslog, the console, and a log file\. De . .TP \-\-no\-client -Do not create a config client\. This will cause the daemon to run without ever checking for its configuration automatically, and only makes sense +Do not create a config client\. This will cause the daemon to run without ever checking for its configuration automatically, and only makes sense when puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\. . .TP -\-\-onetime -Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. +\-\-noop +Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. . .TP -\-\-fingerprint -Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\. +\-\-onetime +Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. . .TP \-\-serve @@ -109,10 +113,6 @@ Start another type of server\. By default, \'puppet agent\' will start a service Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exit\-codes\', \'no\-splay\', and \'show_diff\'\. . .TP -\-\-noop -Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. -. -.TP \-\-verbose Turn on verbose reporting\. . diff --git a/man/man8/puppet-apply.8 b/man/man8/puppet-apply.8 index b93713ff5..5b7b9013e 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-APPLY" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-apply\fR \- Apply Puppet manifests locally @@ -10,7 +10,7 @@ Applies a standalone Puppet manifest to the local system\. . .SH "USAGE" -puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-l|\-\-logdest \fIfile\fR] [\-\-apply \fIcatalog\fR] \fIfile\fR +puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-l|\-\-logdest \fIfile\fR] [\-\-apply \fIcatalog\fR] [\-\-catalog \fIcatalog\fR] \fIfile\fR . .SH "DESCRIPTION" This is the standalone puppet execution tool; use it to apply individual manifests\. @@ -33,7 +33,7 @@ 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\. +Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .TP \-\-help @@ -57,6 +57,10 @@ Print extra information\. . .TP \-\-apply +Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\. You can either specify a JSON file or pipe in JSON from standard input\. Deprecated, please use \-\-catalog instead\. +. +.TP +\-\-catalog Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\. You can either specify a JSON file or pipe in JSON from standard input\. . .SH "EXAMPLE" @@ -65,6 +69,7 @@ Apply a JSON catalog (such as one generated with \'puppet master \-\-compile\')\ $ puppet apply \-l /tmp/manifest\.log manifest\.pp $ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server" +$ puppet apply \-\-catalog catalog\.json . .fi . diff --git a/man/man8/puppet-ca.8 b/man/man8/puppet-ca.8 new file mode 100644 index 000000000..ca3a297b9 --- /dev/null +++ b/man/man8/puppet-ca.8 @@ -0,0 +1,183 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-CA" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-ca\fR \- Local Puppet Certificate Authority management\. +. +.SH "SYNOPSIS" +puppet ca \fIaction\fR +. +.SH "DESCRIPTION" +This provides local management of the Puppet Certificate Authority\. +. +.P +You can use this subcommand to sign outstanding certificate requests, list and manage local certificates, and inspect the state of 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\. +. +.SH "ACTIONS" +. +.TP +\fBdestroy\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca destroy +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.TP +\fBfingerprint\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca fingerprint [\-\-digest ALGORITHM] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-digest ALGORITHM\fR \- The hash algorithm to use when displaying the fingerprint +. +.TP +\fBgenerate\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca generate [\-\-dns\-alt\-names NAMES] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\. When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. +. +.TP +\fBlist\fR \- List certificates and/or certificate requests\. +\fBSYNOPSIS\fR +. +.IP +puppet ca list [\-\-[no\-]all] [\-\-[no\-]pending] [\-\-[no\-]signed] [\-\-subject PATTERN] +. +.IP +\fBDESCRIPTION\fR +. +.IP +This will list the current certificates and certificate signing requests in the Puppet CA\. You will also get the fingerprint, and any certificate verification failure reported\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-[no\-]all\fR \- Include all certificates and requests\. +. +.IP +\fI\-\-[no\-]pending\fR \- Include pending certificate signing requests\. +. +.IP +\fI\-\-[no\-]signed\fR \- Include signed certificates\. +. +.IP +\fI\-\-subject PATTERN\fR \- Only include certificates or requests where subject matches PATTERN\. +. +.IP +PATTERN is interpreted as a regular expression, allowing complex filtering of the content\. +. +.TP +\fBprint\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca print +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.TP +\fBrevoke\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca revoke +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.TP +\fBsign\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca sign [\-\-[no\-]allow\-dns\-alt\-names] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request +. +.TP +\fBverify\fR \- +\fBSYNOPSIS\fR +. +.IP +puppet ca verify +. +.IP +\fBDESCRIPTION\fR +. +.IP +Undocumented action\. +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2011 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-catalog.8 b/man/man8/puppet-catalog.8 index e06ddefe7..bbcbb9ce0 100644 --- a/man/man8/puppet-catalog.8 +++ b/man/man8/puppet-catalog.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-CATALOG" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\. . .SH "SYNOPSIS" -puppet catalog \fIaction\fR [\-\-terminus TERMINUS] +puppet catalog \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\'\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet catalog apply [\-\-terminus TERMINUS] +puppet catalog apply [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -70,7 +74,7 @@ Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report obj \fBSYNOPSIS\fR . .IP -puppet catalog destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet catalog destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -83,7 +87,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet catalog download [\-\-terminus TERMINUS] +puppet catalog download [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -111,7 +115,7 @@ When used from the Ruby API, this action has a side effect of leaving Puppet::Re \fBSYNOPSIS\fR . .IP -puppet catalog find [\-\-terminus TERMINUS] \fIcertname\fR +puppet catalog find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIcertname\fR . .IP \fBDESCRIPTION\fR @@ -130,7 +134,7 @@ A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource:: \fBSYNOPSIS\fR . .IP -puppet catalog info [\-\-terminus TERMINUS] +puppet catalog info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -143,7 +147,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet catalog save [\-\-terminus TERMINUS] +puppet catalog save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -156,7 +160,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren \fBSYNOPSIS\fR . .IP -puppet catalog search [\-\-terminus TERMINUS] \fIquery\fR +puppet catalog search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -169,7 +173,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet catalog select [\-\-terminus TERMINUS] \fIhost\fR \fIresource_type\fR +puppet catalog select [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR \fIresource_type\fR . .IP \fBDESCRIPTION\fR @@ -278,6 +282,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \ \fBstatic_compiler\fR . .IP "\(bu" 4 +\fBstore_configs\fR +. +.IP "\(bu" 4 \fByaml\fR . .IP "" 0 diff --git a/man/man8/puppet-cert.8 b/man/man8/puppet-cert.8 index 211f8ca7a..b58affaa6 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-cert\fR \- Manage certificates and requests diff --git a/man/man8/puppet-certificate.8 b/man/man8/puppet-certificate.8 index 03f2b55e6..1c3de0389 100644 --- a/man/man8/puppet-certificate.8 +++ b/man/man8/puppet-certificate.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-CERTIFICATE" "8" "June 2012" "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] +puppet certificate \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .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\. @@ -42,6 +42,10 @@ Whether to act on the local certificate authority or one provided by a remote pu This option is required\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -58,7 +62,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet certificate destroy [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +puppet certificate destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -77,7 +81,7 @@ Nothing\. \fBSYNOPSIS\fR . .IP -puppet certificate find [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +puppet certificate find [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -89,7 +93,7 @@ Retrieve a certificate\. \fBRETURNS\fR . .IP -An x509 SSL certificate\. You will usually want to render this as a string (\-\-render\-as s)\. +An x509 SSL certificate\. . .IP Note that this action has a side effect of caching a copy of the certificate in Puppet\'s \fBssldir\fR\. @@ -99,7 +103,7 @@ Note that this action has a side effect of caching a copy of the certificate in \fBSYNOPSIS\fR . .IP -puppet certificate generate [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +puppet certificate generate [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-dns\-alt\-names NAMES] \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -111,6 +115,12 @@ Generates and submits a certificate signing request (CSR) for the specified host Puppet agent usually handles CSR submission automatically\. This action is primarily useful for requesting certificates for individual users and external applications\. . .IP +\fBOPTIONS\fR +. +.IP +\fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\. When the node generates a CSR for itself, these are added to the request as the desired \fBsubjectAltName\fR in the certificate: additional DNS labels that the certificate is also valid answering as\. This is generally required if you use a non\-hostname \fBcertname\fR, or if you want to use \fBpuppet kick\fR or \fBpuppet resource \-H\fR and the primary certname does not match the DNS name you use to communicate with the host\. This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\. It is rarely necessary for servers; it is usually helpful only if you need to have a pool of multiple load balanced masters, or for the same master to respond on two physically separate networks under different names\. +. +.IP \fBRETURNS\fR . .IP @@ -121,7 +131,7 @@ Nothing\. \fBSYNOPSIS\fR . .IP -puppet certificate info [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +puppet certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .IP \fBDESCRIPTION\fR @@ -134,7 +144,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet certificate list [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +puppet certificate list [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR . .IP \fBDESCRIPTION\fR @@ -153,7 +163,7 @@ An array of #inspect output from CSR objects\. This output is currently messy, b \fBSYNOPSIS\fR . .IP -puppet certificate save [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] +puppet certificate save [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -166,7 +176,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet certificate search [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIquery\fR +puppet certificate search [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -179,7 +189,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet certificate sign [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIhost\fR +puppet certificate sign [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-[no\-]allow\-dns\-alt\-names] \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -188,6 +198,12 @@ puppet certificate sign [\-\-terminus TERMINUS] [\-\-ca\-location LOCATION] \fIh Sign a certificate signing request for HOST\. . .IP +\fBOPTIONS\fR +. +.IP +\fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request +. +.IP \fBRETURNS\fR . .IP diff --git a/man/man8/puppet-certificate_request.8 b/man/man8/puppet-certificate_request.8 index faeb5a06c..05ecef921 100644 --- a/man/man8/puppet-certificate_request.8 +++ b/man/man8/puppet-certificate_request.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-certificate_request\fR \- Manage certificate requests\. . .SH "SYNOPSIS" -puppet certificate_request \fIaction\fR [\-\-terminus TERMINUS] +puppet certificate_request \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand retrieves and submits certificate signing requests (CSRs)\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet certificate_request destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet certificate_request destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -64,7 +68,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet certificate_request find [\-\-terminus TERMINUS] \fIhost\fR +puppet certificate_request find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -78,15 +82,12 @@ Retrieve a single CSR\. .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] +puppet certificate_request info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -99,7 +100,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet certificate_request save [\-\-terminus TERMINUS] \fIx509_CSR\fR +puppet certificate_request save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIx509_CSR\fR . .IP \fBDESCRIPTION\fR @@ -112,7 +113,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren \fBSYNOPSIS\fR . .IP -puppet certificate_request search [\-\-terminus TERMINUS] \fIdummy_text\fR +puppet certificate_request search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR @@ -124,7 +125,7 @@ Retrieve all outstanding CSRs\. \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\. +A list of certificate requests\. When used from the Ruby API, returns an array of Puppet::SSL::CertificateRequest objects\. . .IP \fBNOTES\fR diff --git a/man/man8/puppet-certificate_revocation_list.8 b/man/man8/puppet-certificate_revocation_list.8 index 4a9c856df..d37197aec 100644 --- a/man/man8/puppet-certificate_revocation_list.8 +++ b/man/man8/puppet-certificate_revocation_list.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "June 2012" "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] +puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand is primarily for retrieving the certificate revocation list from the CA\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] \fIdummy_text\fR +puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR @@ -76,7 +80,7 @@ Although this action always deletes the CRL from the specified terminus, it requ \fBSYNOPSIS\fR . .IP -puppet certificate_revocation_list find [\-\-terminus TERMINUS] \fIdummy_text\fR +puppet certificate_revocation_list find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR @@ -91,9 +95,6 @@ Retrieve the certificate revocation list\. 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 @@ -104,7 +105,7 @@ Although this action always returns the CRL from the specified terminus, it requ \fBSYNOPSIS\fR . .IP -puppet certificate_revocation_list info [\-\-terminus TERMINUS] +puppet certificate_revocation_list info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -117,7 +118,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet certificate_revocation_list save [\-\-terminus TERMINUS] +puppet certificate_revocation_list save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -130,7 +131,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet certificate_revocation_list search [\-\-terminus TERMINUS] \fIquery\fR +puppet certificate_revocation_list search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR diff --git a/man/man8/puppet-config.8 b/man/man8/puppet-config.8 index f7592a43b..3eec9acfd 100644 --- a/man/man8/puppet-config.8 +++ b/man/man8/puppet-config.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-CONFIG" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-config\fR \- Interact with Puppet\'s configuration options\. diff --git a/man/man8/puppet-describe.8 b/man/man8/puppet-describe.8 index af246f16b..395ca3cd5 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types diff --git a/man/man8/puppet-device.8 b/man/man8/puppet-device.8 index a63f96ddf..72bf1d7aa 100644 --- a/man/man8/puppet-device.8 +++ b/man/man8/puppet-device.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-DEVICE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-device\fR \- Manage remote network devices @@ -53,7 +53,7 @@ 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\. +Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .TP \-\-help diff --git a/man/man8/puppet-doc.8 b/man/man8/puppet-doc.8 index f6de3951a..34285d46b 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DOC" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet documentation and references @@ -25,7 +25,7 @@ If the command is run with the name of a manifest file as an argument, puppet do . .TP \-\-all -Output the docs for all of the reference types\. In \'rdoc\' modes, this also outputs documentation for all resources +Output the docs for all of the reference types\. In \'rdoc\' mode, this also outputs documentation for all resources\. . .TP \-\-help @@ -33,7 +33,7 @@ Print this help message . .TP \-\-outputdir -Specifies the directory where to output the rdoc documentation in \'rdoc\' mode\. +Used only in \'rdoc\' mode\. The directory to which the rdoc output should be written\. . .TP \-\-mode @@ -47,6 +47,18 @@ Build a particular reference\. Get a list of references by running \'puppet doc \-\-charset Used only in \'rdoc\' mode\. It sets the charset used in the html files produced\. . +.TP +\-\-manifestdir +Used only in \'rdoc\' mode\. The directory to scan for stand\-alone manifests\. If not supplied, puppet doc will use the manifestdir from puppet\.conf\. +. +.TP +\-\-modulepath +Used only in \'rdoc\' mode\. The directory or directories to scan for modules\. If not supplied, puppet doc will use the modulepath from puppet\.conf\. +. +.TP +\-\-environment +Used only in \'rdoc\' mode\. The configuration environment from which to read the modulepath and manifestdir settings, when reading said settings from puppet\.conf\. Due to a known bug, this option is not currently effective\. +. .SH "EXAMPLE" . .nf diff --git a/man/man8/puppet-facts.8 b/man/man8/puppet-facts.8 index 25470cc0e..69b519769 100644 --- a/man/man8/puppet-facts.8 +++ b/man/man8/puppet-facts.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-FACTS" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-facts\fR \- Retrieve and store facts\. . .SH "SYNOPSIS" -puppet facts \fIaction\fR [\-\-terminus TERMINUS] +puppet facts \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -38,6 +38,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -54,7 +58,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet facts destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet facts destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -67,7 +71,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet facts find [\-\-terminus TERMINUS] \fInode_certname\fR +puppet facts find [\-\-terminus TERMINUS] [\-\-extra HASH] \fInode_certname\fR . .IP \fBDESCRIPTION\fR @@ -95,7 +99,7 @@ When using the \fBfacter\fR terminus, the host argument is ignored\. \fBSYNOPSIS\fR . .IP -puppet facts info [\-\-terminus TERMINUS] +puppet facts info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -108,7 +112,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet facts save [\-\-terminus TERMINUS] +puppet facts save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -121,7 +125,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren \fBSYNOPSIS\fR . .IP -puppet facts search [\-\-terminus TERMINUS] \fIquery\fR +puppet facts search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -134,7 +138,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet facts upload [\-\-terminus TERMINUS] +puppet facts upload [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -200,6 +204,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \ \fBinventory_active_record\fR . .IP "\(bu" 4 +\fBinventory_service\fR +. +.IP "\(bu" 4 \fBmemory\fR . .IP "\(bu" 4 @@ -209,6 +216,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \ \fBrest\fR . .IP "\(bu" 4 +\fBstore_configs\fR +. +.IP "\(bu" 4 \fByaml\fR . .IP "" 0 diff --git a/man/man8/puppet-file.8 b/man/man8/puppet-file.8 index 1c39df7f3..cbfbbb6a7 100644 --- a/man/man8/puppet-file.8 +++ b/man/man8/puppet-file.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-FILE" "8" "June 2012" "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] +puppet file \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet file destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet file destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -64,7 +68,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet file download [\-\-terminus TERMINUS] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR ) +puppet file download [\-\-terminus TERMINUS] [\-\-extra HASH] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR ) . .IP \fBDESCRIPTION\fR @@ -83,7 +87,7 @@ Nothing\. \fBSYNOPSIS\fR . .IP -puppet file find [\-\-terminus TERMINUS] md5/\fImd5sum\fR +puppet file find [\-\-terminus TERMINUS] [\-\-extra HASH] md5/\fImd5sum\fR . .IP \fBDESCRIPTION\fR @@ -105,7 +109,7 @@ RENDERING ISSUES: Rendering as a string returns the contents of the file object; \fBSYNOPSIS\fR . .IP -puppet file info [\-\-terminus TERMINUS] +puppet file info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -118,7 +122,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet file save [\-\-terminus TERMINUS] +puppet file save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -131,7 +135,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren \fBSYNOPSIS\fR . .IP -puppet file search [\-\-terminus TERMINUS] \fIquery\fR +puppet file search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -144,7 +148,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet file store [\-\-terminus TERMINUS] \fIfile\fR +puppet file store [\-\-terminus TERMINUS] [\-\-extra HASH] \fIfile\fR . .IP \fBDESCRIPTION\fR @@ -158,19 +162,6 @@ Store a file in the local filebucket\. .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 . diff --git a/man/man8/puppet-filebucket.8 b/man/man8/puppet-filebucket.8 index 990756858..31775c97a 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8 index 0f22ca887..e9aa69da7 100644 --- a/man/man8/puppet-help.8 +++ b/man/man8/puppet-help.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-HELP" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-help\fR \- Display Puppet help\. diff --git a/man/man8/puppet-inspect.8 b/man/man8/puppet-inspect.8 index e11c9fe81..02a211ba0 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-INSPECT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-inspect\fR \- Send an inspection report @@ -10,7 +10,7 @@ Prepares and submits an inspection report to the puppet master\. . .SH "USAGE" -puppet inspect +puppet inspect [\-\-archive_files] [\-\-archive_file_server] . .SH "DESCRIPTION" This command uses the cached catalog from the previous run of \'puppet agent\' to determine which attributes of which resources have been marked as auditable with the \'audit\' metaparameter\. It then examines the current state of the system, writes the state of the specified resource attributes to a report, and submits the report to the puppet master\. @@ -21,6 +21,14 @@ Puppet inspect does not run as a daemon, and must be run manually or from cron\. .SH "OPTIONS" Any configuration setting which is valid in the configuration file is also a valid long argument, e\.g\. \'\-\-server=master\.domain\.com\'\. See the configuration file documentation at http://docs\.puppetlabs\.com/references/latest/configuration\.html for the full list of acceptable settings\. . +.TP +\-\-archive_files +During an inspect run, whether to archive files whose contents are audited to a file bucket\. +. +.TP +\-\-archive_file_server +During an inspect run, the file bucket server to archive files to if archive_files is set\. The default value is \'$server\'\. +. .SH "AUTHOR" Puppet Labs . diff --git a/man/man8/puppet-instrumentation_data.8 b/man/man8/puppet-instrumentation_data.8 new file mode 100644 index 000000000..9326410eb --- /dev/null +++ b/man/man8/puppet-instrumentation_data.8 @@ -0,0 +1,145 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-INSTRUMENTATION_DATA" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-instrumentation_data\fR \- Manage instrumentation listener accumulated data\. +. +.SH "SYNOPSIS" +puppet instrumentation_data \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.SH "DESCRIPTION" +This subcommand allows to retrieve the various listener data\. +. +.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 +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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 instrumentation_data destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBfind\fR \- Retrieve listener data\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_data find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve listener data\. +. +.IP +\fBRETURNS\fR +. +.IP +The data of an instrumentation listener +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_data info [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.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 instrumentation_data save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\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 \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_data search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.SH "EXAMPLES" +\fBfind\fR +. +.P +Retrieve listener data: +. +.P +$ puppet instrumentation_data find performance \-\-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-instrumentation_listener.8 b/man/man8/puppet-instrumentation_listener.8 new file mode 100644 index 000000000..c77edd56a --- /dev/null +++ b/man/man8/puppet-instrumentation_listener.8 @@ -0,0 +1,222 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-INSTRUMENTATION_LISTENER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-instrumentation_listener\fR \- Manage instrumentation listeners\. +. +.SH "SYNOPSIS" +puppet instrumentation_listener \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.SH "DESCRIPTION" +This subcommand enables/disables or list instrumentation listeners\. +. +.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 +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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 instrumentation_listener destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBdisable\fR \- Disable a given instrumentation listener\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener disable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Disable a given instrumentation listener\. After being disabled the listener will stop receiving instrumentation notifications from the probes\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBenable\fR \- Enable a given instrumentation listener\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener enable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Enable a given instrumentation listener\. After being enabled the listener will start receiving instrumentation notifications from the probes if those are enabled\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBfind\fR \- Retrieve a single listener\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve a single listener\. +. +.IP +\fBRETURNS\fR +. +.IP +The status of an instrumentation listener +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener info [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.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: modify an instrumentation listener status\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\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 instrumentation listeners statuses\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_listener search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve all instrumentation listeners statuses\. +. +.IP +\fBRETURNS\fR +. +.IP +The statuses of all instrumentation listeners +. +.IP +\fBNOTES\fR +. +.IP +Although this action always returns all instrumentation listeners, it requires a dummy search key; this is a known bug\. +. +.SH "EXAMPLES" +\fBdisable\fR +. +.P +Disable the "performance" listener in the running master: +. +.P +$ puppet instrumentation_listener disable performance \-\-terminus rest +. +.P +\fBenable\fR +. +.P +Enable the "performance" listener in the running master: +. +.P +$ puppet instrumentation_listener enable performance \-\-terminus rest +. +.P +\fBfind\fR +. +.P +Retrieve a given listener: +. +.P +$ puppet instrumentation_listener find performance \-\-terminus rest +. +.P +\fBsearch\fR +. +.P +Retrieve the state of the listeners running in the remote puppet master: +. +.P +$ puppet instrumentation_listener search 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-instrumentation_probe.8 b/man/man8/puppet-instrumentation_probe.8 new file mode 100644 index 000000000..ff68c8822 --- /dev/null +++ b/man/man8/puppet-instrumentation_probe.8 @@ -0,0 +1,207 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-INSTRUMENTATION_PROBE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-instrumentation_probe\fR \- Manage instrumentation probes\. +. +.SH "SYNOPSIS" +puppet instrumentation_probe \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.SH "DESCRIPTION" +This subcommand enables/disables or list instrumentation listeners\. +. +.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 +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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 \- API only: disable all instrumentation probes\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +API only: disable all instrumentation probes\. +. +.TP +\fBdisable\fR \- Disable all instrumentation probes\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe disable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Disable all instrumentation probes\. After being disabled, no listeners will receive instrumentation notifications\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBenable\fR \- Enable all instrumentation probes\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe enable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Enable all instrumentation probes\. After being enabled, all enabled listeners will start receiving instrumentation notifications from the probes\. +. +.IP +\fBRETURNS\fR +. +.IP +Nothing\. +. +.TP +\fBfind\fR \- Invalid for this subcommand\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Invalid for this subcommand\. +. +.TP +\fBinfo\fR \- Print the default terminus class for this face\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe info [\-\-terminus TERMINUS] [\-\-extra HASH] +. +.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: enable all instrumentation probes\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy\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 probe statuses\. +\fBSYNOPSIS\fR +. +.IP +puppet instrumentation_probe search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Retrieve all probe statuses\. +. +.IP +\fBRETURNS\fR +. +.IP +The statuses of all instrumentation probes +. +.IP +\fBNOTES\fR +. +.IP +Although this action always returns all instrumentation probes, it requires a dummy search key; this is a known bug\. +. +.SH "EXAMPLES" +\fBdisable\fR +. +.P +Disable the probes for the running master: +. +.P +$ puppet instrumentation_probe disable x \-\-terminus rest +. +.P +\fBenable\fR +. +.P +Enable the probes for the running master: +. +.P +$ puppet instrumentation_probe enable x \-\-terminus rest +. +.P +\fBsearch\fR +. +.P +Retrieve the state of the probes running in the remote puppet master: +. +.P +$ puppet instrumentation_probe search 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-key.8 b/man/man8/puppet-key.8 index b0812d831..8d5bf5d4b 100644 --- a/man/man8/puppet-key.8 +++ b/man/man8/puppet-key.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-KEY" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-key\fR \- Create, save, and remove certificate keys\. . .SH "SYNOPSIS" -puppet key \fIaction\fR [\-\-terminus TERMINUS] +puppet key \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -51,7 +55,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet key destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet key destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -64,7 +68,7 @@ Delete an object\. \fBSYNOPSIS\fR . .IP -puppet key find [\-\-terminus TERMINUS] \fIkey\fR +puppet key find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -77,7 +81,7 @@ Retrieve an object by name\. \fBSYNOPSIS\fR . .IP -puppet key info [\-\-terminus TERMINUS] +puppet key info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -90,7 +94,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet key save [\-\-terminus TERMINUS] +puppet key save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -103,7 +107,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren \fBSYNOPSIS\fR . .IP -puppet key search [\-\-terminus TERMINUS] \fIquery\fR +puppet key search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR diff --git a/man/man8/puppet-kick.8 b/man/man8/puppet-kick.8 index 2b7502310..e59cd0d60 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KICK" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-kick\fR \- Remotely control puppet agent @@ -25,10 +25,42 @@ 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 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\. +Puppet kick needs the puppet agent on the target machine to be running as a daemon, be configured to listen for incoming network connections, and have an appropriate security configuration\. . .P -Additionally, due to a known bug, you must make sure a namespaceauth\.conf file exists in puppet agent\'s $confdir\. This file will not be consulted, and may be left empty\. +The specific changes required are: +. +.IP "\(bu" 4 +Set \fBlisten = true\fR in the agent\'s \fBpuppet\.conf\fR file (or \fB\-\-listen\fR on the command line) +. +.IP "\(bu" 4 +Configure the node\'s firewall to allow incoming connections on port 8139 +. +.IP "\(bu" 4 +Insert the following stanza at the top of the node\'s \fBauth\.conf\fR file: +. +.IP "" 4 +. +.nf + + # Allow puppet kick access + path /run + method save + auth any + allow workstation\.example\.com +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.P +This example would allow the machine \fBworkstation\.example\.com\fR to trigger a Puppet run; adjust the "allow" directive to suit your site\. You may also use \fBallow *\fR to allow anyone to trigger a Puppet run, but that makes it possible to interfere with your site by triggering excessive Puppet runs\. +. +.P +See \fBhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details about security settings\. . .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\. diff --git a/man/man8/puppet-man.8 b/man/man8/puppet-man.8 index fe5f375eb..5330a1aab 100644 --- a/man/man8/puppet-man.8 +++ b/man/man8/puppet-man.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-MAN" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-man\fR \- Display Puppet manual pages\. diff --git a/man/man8/puppet-master.8 b/man/man8/puppet-master.8 index c38d34afa..c91ad0605 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MASTER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-master\fR \- The puppet master daemon diff --git a/man/man8/puppet-module.8 b/man/man8/puppet-module.8 new file mode 100644 index 000000000..7614e7e30 --- /dev/null +++ b/man/man8/puppet-module.8 @@ -0,0 +1,451 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "PUPPET\-MODULE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" +. +.SH "NAME" +\fBpuppet\-module\fR \- Creates, installs and searches for modules on the Puppet Forge\. +. +.SH "SYNOPSIS" +puppet module \fIaction\fR +. +.SH "DESCRIPTION" +This subcommand can find, install, and manage modules from the Puppet Forge, a repository of user\-contributed Puppet code\. It can also generate empty modules, and prepare locally developed modules for release on the Forge\. +. +.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 +\fBbuild\fR \- Build a module release package\. +\fBSYNOPSIS\fR +. +.IP +puppet module build \fIpath\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Prepares a local module for release on the Puppet Forge by building a ready\-to\-upload archive file\. +. +.IP +This action uses the Modulefile in the module directory to set metadata used by the Forge\. See \fIhttp://links\.puppetlabs\.com/modulefile\fR for more about writing modulefiles\. +. +.IP +After being built, the release archive file can be found in the module\'s \fBpkg\fR directory\. +. +.IP +\fBRETURNS\fR +. +.IP +Pathname object representing the path to the release archive\. +. +.TP +\fBchanges\fR \- Show modified files of an installed module\. +\fBSYNOPSIS\fR +. +.IP +puppet module changes \fIpath\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Shows any files in a module that have been modified since it was installed\. This action compares the files on disk to the md5 checksums included in the module\'s metadata\. +. +.IP +\fBRETURNS\fR +. +.IP +Array of strings representing paths of modified files\. +. +.TP +\fBgenerate\fR \- Generate boilerplate for a new module\. +\fBSYNOPSIS\fR +. +.IP +puppet module generate \fIname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Generates boilerplate for a new module by creating the directory structure and files recommended for the Puppet community\'s best practices\. +. +.IP +A module may need additional directories beyond this boilerplate if it provides plugins, files, or templates\. +. +.IP +\fBRETURNS\fR +. +.IP +Array of Pathname objects representing paths of generated files\. +. +.TP +\fBinstall\fR \- Install a module from the Puppet Forge or a release archive\. +\fBSYNOPSIS\fR +. +.IP +puppet module install [\-\-force | \-f] [\-\-target\-dir DIR | \-i DIR] [\-\-ignore\-dependencies] [\-\-modulepath MODULEPATH] [\-\-version VER | \-v VER] [\-\-environment NAME] \fIname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Installs a module from the Puppet Forge or from a release archive file\. +. +.IP +The specified module will be installed into the directory specified with the \fB\-\-target\-dir\fR option, which defaults to /Users/matthaus/\.puppet/modules\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-environment NAME\fR \- The target environment to install modules into\. Only applicable if multiple environments (with different modulepaths) have been configured in puppet\.conf\. +. +.IP +\fI\-\-force\fR | \fI\-f\fR \- Force overwrite of existing module, if any\. +. +.IP +\fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies\. +. +.IP +\fI\-\-modulepath MODULEPATH\fR \- The list of directories to check for modules\. When installing a new module, this setting determines where the module tool will look for its dependencies\. If the \fB\-\-target dir\fR option is not specified, the first directory in the modulepath will also be used as the install directory\. +. +.IP +When installing a module into an environment whose modulepath is specified in puppet\.conf, you can use the \fB\-\-environment\fR option instead, and its modulepath will be used automatically\. +. +.IP +This setting should be a list of directories separated by the path separator character\. (The path separator is \fB:\fR on Unix\-like platforms and \fB;\fR on Windows\.) +. +.IP +\fI\-\-target\-dir DIR\fR | \fI\-i DIR\fR \- The directory into which modules are installed; defaults to the first directory in the modulepath\. +. +.IP +Specifying this option will change the installation directory, and will use the existing modulepath when checking for dependencies\. If you wish to check a different set of directories for dependencies, you must also use the \fB\-\-environment\fR or \fB\-\-modulepath\fR options\. +. +.IP +\fI\-\-version VER\fR | \fI\-v VER\fR \- Module version to install; can be an exact version or a requirement string, eg \'>= 1\.0\.3\'\. Defaults to latest version\. +. +.IP +\fBRETURNS\fR +. +.IP +Pathname object representing the path to the installed module\. +. +.TP +\fBlist\fR \- List installed modules +\fBSYNOPSIS\fR +. +.IP +puppet module list [\-\-environment NAME] [\-\-modulepath MODULEPATH] [\-\-tree] +. +.IP +\fBDESCRIPTION\fR +. +.IP +Lists the installed puppet modules\. By default, this action scans the modulepath from puppet\.conf\'s \fB[main]\fR block; use the \-\-modulepath option to change which directories are scanned\. +. +.IP +The output of this action includes information from the module\'s metadata, including version numbers and unmet module dependencies\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-environment NAME\fR \- Which environments\' modules to list\. +. +.IP +\fI\-\-modulepath MODULEPATH\fR \- Which directories to look for modules in; use the system path separator character (\fB:\fR on Unix\-like systems and \fB;\fR on Windows) to specify multiple directories\. +. +.IP +\fI\-\-tree\fR \- Whether to show dependencies as a tree view +. +.IP +\fBRETURNS\fR +. +.IP +hash of paths to module objects +. +.TP +\fBsearch\fR \- Search the Puppet Forge for a module\. +\fBSYNOPSIS\fR +. +.IP +puppet module search \fIsearch_term\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Searches the Puppet Forge for modules whose names, descriptions, or keywords match the provided search term\. +. +.IP +\fBRETURNS\fR +. +.IP +Array of module metadata hashes +. +.TP +\fBuninstall\fR \- Uninstall a puppet module\. +\fBSYNOPSIS\fR +. +.IP +puppet module uninstall [\-\-force | \-f] [\-\-environment NAME] [\-\-version=] [\-\-modulepath=] \fIname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Uninstalls a puppet module from the modulepath (or a specific target directory)\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-environment NAME\fR \- The target environment to uninstall modules from\. +. +.IP +\fI\-\-force\fR | \fI\-f\fR \- Force the uninstall of an installed module even if there are local changes or the possibility of causing broken dependencies\. +. +.IP +\fI\-\-modulepath=\fR \- The target directory to search for modules\. +. +.IP +\fI\-\-version=\fR \- The version of the module to uninstall\. When using this option, a module matching the specified version must be installed or else an error is raised\. +. +.IP +\fBRETURNS\fR +. +.IP +Hash of module objects representing uninstalled modules and related errors\. +. +.TP +\fBupgrade\fR \- Upgrade a puppet module\. +\fBSYNOPSIS\fR +. +.IP +puppet module upgrade [\-\-force | \-f] [\-\-ignore\-dependencies] [\-\-environment NAME] [\-\-version=] \fIname\fR +. +.IP +\fBDESCRIPTION\fR +. +.IP +Upgrades a puppet module\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-environment NAME\fR \- The target environment to search for modules\. +. +.IP +\fI\-\-force\fR | \fI\-f\fR \- Force the upgrade of an installed module even if there are local changes or the possibility of causing broken dependencies\. +. +.IP +\fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies +. +.IP +\fI\-\-version=\fR \- The version of the module to upgrade to\. +. +.IP +\fBRETURNS\fR +. +.IP +Hash +. +.SH "EXAMPLES" +\fBbuild\fR +. +.P +Build a module release: +. +.P +$ puppet module build puppetlabs\-apache notice: Building /Users/kelseyhightower/puppetlabs\-apache for release puppetlabs\-apache/pkg/puppetlabs\-apache\-0\.0\.1\.tar\.gz +. +.P +\fBchanges\fR +. +.P +Show modified files of an installed module: +. +.P +$ puppet module changes /etc/puppet/modules/vcsrepo/ warning: 1 files modified lib/puppet/provider/vcsrepo\.rb +. +.P +\fBgenerate\fR +. +.P +Generate a new module in the current directory: +. +.P +$ puppet module generate puppetlabs\-ssh notice: Generating module at /Users/kelseyhightower/puppetlabs\-ssh puppetlabs\-ssh puppetlabs\-ssh/tests puppetlabs\-ssh/tests/init\.pp puppetlabs\-ssh/spec puppetlabs\-ssh/spec/spec_helper\.rb puppetlabs\-ssh/spec/spec\.opts puppetlabs\-ssh/README puppetlabs\-ssh/Modulefile puppetlabs\-ssh/metadata\.json puppetlabs\-ssh/manifests puppetlabs\-ssh/manifests/init\.pp +. +.P +\fBinstall\fR +. +.P +Install a module: +. +.P +$ puppet module install puppetlabs\-vcsrepo Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a module to a specific environment: +. +.P +$ puppet module install puppetlabs\-vcsrepo \-\-environment development Preparing to install into /etc/puppet/environments/development/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/environments/development/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a specific module version: +. +.P +$ puppet module install puppetlabs\-vcsrepo \-v 0\.0\.4 Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a module into a specific directory: +. +.P +$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/usr/share/puppet/modules Preparing to install into /usr/share/puppet/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /usr/share/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a module into a specific directory and check for dependencies in other directories: +. +.P +$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/usr/share/puppet/modules \-\-modulepath /etc/puppet/modules Preparing to install into /usr/share/puppet/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /usr/share/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a module from a release archive: +. +.P +$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz Preparing to install into /etc/puppet/modules \.\.\. Downloading from http://forge\.puppetlabs\.com \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +Install a module from a release archive and ignore dependencies: +. +.P +$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz \-\-ignore\-dependencies Preparing to install into /etc/puppet/modules \.\.\. Installing \-\- do not interrupt \.\.\. /etc/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4) +. +.P +\fBlist\fR +. +.P +List installed modules: +. +.P +$ puppet module list /etc/puppet/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /usr/share/puppet/modules (no modules installed) +. +.P +List installed modules in a tree view: +. +.P +$ puppet module list \-\-tree /etc/puppet/modules └─┬ puppetlabs\-bacula (v0\.0\.2) +. +.IP "" 4 +. +.nf + +├── puppetlabs\-stdlib (v2\.2\.1) +├─┬ puppetlabs\-mysql (v0\.0\.1) +│ └── bodepd\-create_resources (v0\.0\.1) +└── puppetlabs\-sqlite (v0\.0\.1) +. +.fi +. +.IP "" 0 +. +.P +/usr/share/puppet/modules (no modules installed) +. +.P +List installed modules from a specified environment: +. +.P +$ puppet module list \-\-environment production /etc/puppet/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /usr/share/puppet/modules (no modules installed) +. +.P +List installed modules from a specified modulepath: +. +.P +$ puppet module list \-\-modulepath /usr/share/puppet/modules /usr/share/puppet/modules (no modules installed) +. +.P +\fBsearch\fR +. +.P +Search the Puppet Forge for a module: +. +.P +$ puppet module search puppetlabs NAME DESCRIPTION AUTHOR KEYWORDS bacula This is a generic Apache module @puppetlabs backups +. +.P +\fBuninstall\fR +. +.P +Uninstall a module: +. +.P +$ puppet module uninstall puppetlabs\-ssh Removed /etc/puppet/modules/ssh (v1\.0\.0) +. +.P +Uninstall a module from a specific directory: +. +.P +$ puppet module uninstall puppetlabs\-ssh \-\-modulepath /usr/share/puppet/modules Removed /usr/share/puppet/modules/ssh (v1\.0\.0) +. +.P +Uninstall a module from a specific environment: +. +.P +$ puppet module uninstall puppetlabs\-ssh \-\-environment development Removed /etc/puppet/environments/development/modules/ssh (v1\.0\.0) +. +.P +Uninstall a specific version of a module: +. +.P +$ puppet module uninstall puppetlabs\-ssh \-\-version 2\.0\.0 Removed /etc/puppet/modules/ssh (v2\.0\.0) +. +.P +\fBupgrade\fR +. +.P +upgrade an installed module to the latest version +. +.P +$ puppet module upgrade puppetlabs\-apache /etc/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0) +. +.P +upgrade an installed module to a specific version +. +.P +$ puppet module upgrade puppetlabs\-apache \-\-version 2\.1\.0 /etc/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.1\.0) +. +.P +upgrade an installed module for a specific environment +. +.P +$ puppet module upgrade puppetlabs\-apache \-\-environment test /usr/share/puppet/environments/test/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0) +. +.SH "COPYRIGHT AND LICENSE" +Copyright 2012 by Puppet Labs Apache 2 license; see COPYING diff --git a/man/man8/puppet-node.8 b/man/man8/puppet-node.8 index 4da08722f..d0b6ca2f1 100644 --- a/man/man8/puppet-node.8 +++ b/man/man8/puppet-node.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-NODE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-node\fR \- View and manage node definitions\. . .SH "SYNOPSIS" -puppet node \fIaction\fR [\-\-terminus TERMINUS] +puppet node \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -35,6 +35,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -46,12 +50,49 @@ The terminus for an action is often determined by context, but occasionally need . .SH "ACTIONS" . -.TP -\fBdestroy\fR \- Invalid for this subcommand\. -\fBSYNOPSIS\fR +.IP "\(bu" 4 +\fBclean\fR \- Clean up everything a puppetmaster knows about a node: \fBSYNOPSIS\fR . .IP -puppet node destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet node clean [\-\-terminus TERMINUS] [\-\-extra HASH] [\-\-[no\-]unexport] \fIhost1\fR [\fIhost2\fR \.\.\.] +. +.IP +\fBDESCRIPTION\fR +. +.IP +This includes +. +.IP "\(bu" 4 +Signed certificates ($vardir/ssl/ca/signed/node\.domain\.pem) +. +.IP "\(bu" 4 +Cached facts ($vardir/yaml/facts/node\.domain\.yaml) +. +.IP "\(bu" 4 +Cached node stuff ($vardir/yaml/node/node\.domain\.yaml) +. +.IP "\(bu" 4 +Reports ($vardir/reports/node\.domain) +. +.IP "\(bu" 4 +Stored configs: it can either remove all data from an host in your storedconfig database, or with \-\-unexport turn every exported resource supporting ensure to absent so that any other host checking out their config can remove those exported configurations\. +. +.IP "" 0 +. +.IP +This will unexport exported resources of a host, so that consumers of these resources can remove the exported resources and we will safely remove the node from our infrastructure\. +. +.IP +\fBOPTIONS\fR +. +.IP +\fI\-\-[no\-]unexport\fR \- Unexport exported resources +. +.IP "\(bu" 4 +\fBdestroy\fR \- Invalid for this subcommand\.: \fBSYNOPSIS\fR +. +.IP +puppet node destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -59,12 +100,11 @@ puppet node destroy [\-\-terminus TERMINUS] \fIkey\fR .IP Invalid for this subcommand\. . -.TP -\fBfind\fR \- Retrieve a node object\. -\fBSYNOPSIS\fR +.IP "\(bu" 4 +\fBfind\fR \- Retrieve a node object\.: \fBSYNOPSIS\fR . .IP -puppet node find [\-\-terminus TERMINUS] \fIhost\fR +puppet node find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR . .IP \fBDESCRIPTION\fR @@ -81,12 +121,11 @@ A hash containing the node\'s \fBclasses\fR, \fBenvironment\fR, \fBexpiration\fR .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 "\(bu" 4 +\fBinfo\fR \- Print the default terminus class for this face\.: \fBSYNOPSIS\fR . .IP -puppet node info [\-\-terminus TERMINUS] +puppet node info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -94,12 +133,11 @@ puppet node info [\-\-terminus TERMINUS] .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 "\(bu" 4 +\fBsave\fR \- Invalid for this subcommand\.: \fBSYNOPSIS\fR . .IP -puppet node save [\-\-terminus TERMINUS] +puppet node save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -107,12 +145,11 @@ puppet node save [\-\-terminus TERMINUS] .IP Invalid for this subcommand\. . -.TP -\fBsearch\fR \- Invalid for this subcommand\. -\fBSYNOPSIS\fR +.IP "\(bu" 4 +\fBsearch\fR \- Invalid for this subcommand\.: \fBSYNOPSIS\fR . .IP -puppet node search [\-\-terminus TERMINUS] \fIquery\fR +puppet node search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -120,6 +157,8 @@ puppet node search [\-\-terminus TERMINUS] \fIquery\fR .IP Invalid for this subcommand\. . +.IP "" 0 +. .SH "EXAMPLES" \fBfind\fR . @@ -163,6 +202,9 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \ \fBrest\fR . .IP "\(bu" 4 +\fBstore_configs\fR +. +.IP "\(bu" 4 \fByaml\fR . .IP "" 0 diff --git a/man/man8/puppet-parser.8 b/man/man8/puppet-parser.8 index 0029907e6..9e5b5d3ba 100644 --- a/man/man8/puppet-parser.8 +++ b/man/man8/puppet-parser.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-PARSER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-parser\fR \- Interact directly with the parser\. diff --git a/man/man8/puppet-plugin.8 b/man/man8/puppet-plugin.8 index 05d1af0d5..7e894134b 100644 --- a/man/man8/puppet-plugin.8 +++ b/man/man8/puppet-plugin.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-PLUGIN" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\. diff --git a/man/man8/puppet-queue.8 b/man/man8/puppet-queue.8 index 1a3241c9f..835938e9e 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-QUEUE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs diff --git a/man/man8/puppet-report.8 b/man/man8/puppet-report.8 index 1c2c236b2..9cc3c5e58 100644 --- a/man/man8/puppet-report.8 +++ b/man/man8/puppet-report.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-REPORT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-report\fR \- Create, display, and submit reports\. . .SH "SYNOPSIS" -puppet report \fIaction\fR [\-\-terminus TERMINUS] +puppet report \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -32,6 +32,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -48,7 +52,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet report destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet report destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -61,7 +65,7 @@ Invalid for this face\. \fBSYNOPSIS\fR . .IP -puppet report find [\-\-terminus TERMINUS] \fIkey\fR +puppet report find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -74,7 +78,7 @@ Invalid for this face\. \fBSYNOPSIS\fR . .IP -puppet report info [\-\-terminus TERMINUS] +puppet report info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -87,7 +91,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet report save [\-\-terminus TERMINUS] \fIreport\fR +puppet report save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIreport\fR . .IP \fBDESCRIPTION\fR @@ -106,7 +110,7 @@ Nothing\. \fBSYNOPSIS\fR . .IP -puppet report search [\-\-terminus TERMINUS] \fIquery\fR +puppet report search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR @@ -119,7 +123,7 @@ Invalid for this face\. \fBSYNOPSIS\fR . .IP -puppet report submit [\-\-terminus TERMINUS] \fIreport\fR +puppet report submit [\-\-terminus TERMINUS] [\-\-extra HASH] \fIreport\fR . .IP \fBDESCRIPTION\fR diff --git a/man/man8/puppet-resource.8 b/man/man8/puppet-resource.8 index 7e09c0739..d9ece39f3 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell diff --git a/man/man8/puppet-resource_type.8 b/man/man8/puppet-resource_type.8 index 241b68207..560837bff 100644 --- a/man/man8/puppet-resource_type.8 +++ b/man/man8/puppet-resource_type.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-RESOURCE_TYPE" "8" "June 2012" "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] +puppet resource_type \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .SH "DESCRIPTION" This subcommand reads information about the resource collections (classes, nodes, and defined types) available in Puppet\'s site manifest and modules\. @@ -38,6 +38,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -54,7 +58,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet resource_type destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet resource_type destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -67,7 +71,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet resource_type find [\-\-terminus TERMINUS] \fIcollection_name\fR +puppet resource_type find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIcollection_name\fR . .IP \fBDESCRIPTION\fR @@ -95,7 +99,7 @@ If two resource collections share the same name (e\.g\. you have both a node and \fBSYNOPSIS\fR . .IP -puppet resource_type info [\-\-terminus TERMINUS] +puppet resource_type info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -108,7 +112,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet resource_type save [\-\-terminus TERMINUS] +puppet resource_type save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -121,7 +125,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet resource_type search [\-\-terminus TERMINUS] \fIregular_expression\fR +puppet resource_type search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIregular_expression\fR . .IP \fBDESCRIPTION\fR diff --git a/man/man8/puppet-secret_agent.8 b/man/man8/puppet-secret_agent.8 index f2e5c3a1c..e61b0e55f 100644 --- a/man/man8/puppet-secret_agent.8 +++ b/man/man8/puppet-secret_agent.8 @@ -1,7 +1,7 @@ .\" 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" +.TH "PUPPET\-SECRET_AGENT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-secret_agent\fR \- Mimics puppet agent\. diff --git a/man/man8/puppet-status.8 b/man/man8/puppet-status.8 index c7707497a..065f15734 100644 --- a/man/man8/puppet-status.8 +++ b/man/man8/puppet-status.8 @@ -1,13 +1,13 @@ .\" 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" +.TH "PUPPET\-STATUS" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-status\fR \- View puppet server status\. . .SH "SYNOPSIS" -puppet status \fIaction\fR [\-\-terminus TERMINUS] +puppet status \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH] . .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\. @@ -32,6 +32,10 @@ Whether to log verbosely\. Whether to log debug information\. . .TP +\-\-extra HASH +A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\. +. +.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\. . @@ -48,7 +52,7 @@ The terminus for an action is often determined by context, but occasionally need \fBSYNOPSIS\fR . .IP -puppet status destroy [\-\-terminus TERMINUS] \fIkey\fR +puppet status destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -61,7 +65,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet status find [\-\-terminus TERMINUS] \fIdummy_text\fR +puppet status [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR . .IP \fBDESCRIPTION\fR @@ -92,7 +96,7 @@ Although this action always returns an unnamed status object, it requires a dumm \fBSYNOPSIS\fR . .IP -puppet status info [\-\-terminus TERMINUS] +puppet status info [\-\-terminus TERMINUS] [\-\-extra HASH] . .IP \fBDESCRIPTION\fR @@ -105,7 +109,7 @@ Prints the default terminus class for this subcommand\. Note that different run \fBSYNOPSIS\fR . .IP -puppet status save [\-\-terminus TERMINUS] +puppet status save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR . .IP \fBDESCRIPTION\fR @@ -118,7 +122,7 @@ Invalid for this subcommand\. \fBSYNOPSIS\fR . .IP -puppet status search [\-\-terminus TERMINUS] \fIquery\fR +puppet status search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR . .IP \fBDESCRIPTION\fR diff --git a/man/man8/puppet.8 b/man/man8/puppet.8 index ce6b6a458..31699b330 100644 --- a/man/man8/puppet.8 +++ b/man/man8/puppet.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\fR diff --git a/man/man8/puppetca.8 b/man/man8/puppetca.8 index 211f8ca7a..b58affaa6 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-CERT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-cert\fR \- Manage certificates and requests diff --git a/man/man8/puppetd.8 b/man/man8/puppetd.8 index 2e5cedf51..4d36fba5e 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-AGENT" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon @@ -13,7 +13,7 @@ Retrieves the client configuration from the puppet master and applies it to the This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\. . .SH "USAGE" -puppet agent [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-disable] [\-\-enable] [\-h|\-\-help] [\-\-certname \fIhost name\fR] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-\-noop] [\-\-digest \fIdigest\fR] [\-\-fingerprint] [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR] +puppet agent [\-\-certname \fIname\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIdigest\fR] [\-\-disable] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-no\-client] [\-\-noop] [\-o|\-\-onetime] [\-\-serve \fIhandler\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fIseconds\fR] . .SH "DESCRIPTION" This is the main puppet client\. Its job is to retrieve the local machine\'s configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\. @@ -40,6 +40,10 @@ Note that any configuration parameter that\'s valid in the configuration file is 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 agent with \'\-\-genconfig\'\. . .TP +\-\-certname +Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. +. +.TP \-\-daemonize Send the process into the background\. This is the default\. . @@ -52,12 +56,12 @@ Do not send the process into the background\. Enable full debugging\. . .TP -\-\-digest -Change the certificate fingerprinting digest algorithm\. The default is MD5\. Valid values depends on the version of OpenSSL installed, but should always at least contain MD5, MD2, SHA1 and SHA256\. +\-\-detailed\-exitcodes +Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, an exit code of \'4\' means there were failures during the transaction, and an exit code of \'6\' means there were both changes and failures\. . .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\. +\-\-digest +Change the certificate fingerprinting digest algorithm\. The default is MD5\. Valid values depends on the version of OpenSSL installed, but should always at least contain MD5, MD2, SHA1 and SHA256\. . .TP \-\-disable @@ -77,8 +81,8 @@ Enable working on the local system\. This removes any lock file, causing \'puppe \'puppet agent\' exits after executing this\. . .TP -\-\-certname -Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node\'s fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. +\-\-fingerprint +Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\. . .TP \-\-help @@ -90,15 +94,15 @@ Where to send messages\. Choose between syslog, the console, and a log file\. De . .TP \-\-no\-client -Do not create a config client\. This will cause the daemon to run without ever checking for its configuration automatically, and only makes sense +Do not create a config client\. This will cause the daemon to run without ever checking for its configuration automatically, and only makes sense when puppet agent is being run with listen = true in puppet\.conf or was started with the \fB\-\-listen\fR option\. . .TP -\-\-onetime -Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. +\-\-noop +Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. . .TP -\-\-fingerprint -Display the current certificate or certificate signing request fingerprint and then exit\. Use the \'\-\-digest\' option to change the digest algorithm used\. +\-\-onetime +Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. . .TP \-\-serve @@ -109,10 +113,6 @@ Start another type of server\. By default, \'puppet agent\' will start a service Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exit\-codes\', \'no\-splay\', and \'show_diff\'\. . .TP -\-\-noop -Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\. -. -.TP \-\-verbose Turn on verbose reporting\. . diff --git a/man/man8/puppetdoc.8 b/man/man8/puppetdoc.8 index f6de3951a..34285d46b 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-DOC" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet documentation and references @@ -25,7 +25,7 @@ If the command is run with the name of a manifest file as an argument, puppet do . .TP \-\-all -Output the docs for all of the reference types\. In \'rdoc\' modes, this also outputs documentation for all resources +Output the docs for all of the reference types\. In \'rdoc\' mode, this also outputs documentation for all resources\. . .TP \-\-help @@ -33,7 +33,7 @@ Print this help message . .TP \-\-outputdir -Specifies the directory where to output the rdoc documentation in \'rdoc\' mode\. +Used only in \'rdoc\' mode\. The directory to which the rdoc output should be written\. . .TP \-\-mode @@ -47,6 +47,18 @@ Build a particular reference\. Get a list of references by running \'puppet doc \-\-charset Used only in \'rdoc\' mode\. It sets the charset used in the html files produced\. . +.TP +\-\-manifestdir +Used only in \'rdoc\' mode\. The directory to scan for stand\-alone manifests\. If not supplied, puppet doc will use the manifestdir from puppet\.conf\. +. +.TP +\-\-modulepath +Used only in \'rdoc\' mode\. The directory or directories to scan for modules\. If not supplied, puppet doc will use the modulepath from puppet\.conf\. +. +.TP +\-\-environment +Used only in \'rdoc\' mode\. The configuration environment from which to read the modulepath and manifestdir settings, when reading said settings from puppet\.conf\. Due to a known bug, this option is not currently effective\. +. .SH "EXAMPLE" . .nf diff --git a/man/man8/puppetmasterd.8 b/man/man8/puppetmasterd.8 index c38d34afa..c91ad0605 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-MASTER" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-master\fR \- The puppet master daemon diff --git a/man/man8/puppetqd.8 b/man/man8/puppetqd.8 index 1a3241c9f..835938e9e 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-QUEUE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs diff --git a/man/man8/puppetrun.8 b/man/man8/puppetrun.8 index 2b7502310..e59cd0d60 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-KICK" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-kick\fR \- Remotely control puppet agent @@ -25,10 +25,42 @@ 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 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\. +Puppet kick needs the puppet agent on the target machine to be running as a daemon, be configured to listen for incoming network connections, and have an appropriate security configuration\. . .P -Additionally, due to a known bug, you must make sure a namespaceauth\.conf file exists in puppet agent\'s $confdir\. This file will not be consulted, and may be left empty\. +The specific changes required are: +. +.IP "\(bu" 4 +Set \fBlisten = true\fR in the agent\'s \fBpuppet\.conf\fR file (or \fB\-\-listen\fR on the command line) +. +.IP "\(bu" 4 +Configure the node\'s firewall to allow incoming connections on port 8139 +. +.IP "\(bu" 4 +Insert the following stanza at the top of the node\'s \fBauth\.conf\fR file: +. +.IP "" 4 +. +.nf + + # Allow puppet kick access + path /run + method save + auth any + allow workstation\.example\.com +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.P +This example would allow the machine \fBworkstation\.example\.com\fR to trigger a Puppet run; adjust the "allow" directive to suit your site\. You may also use \fBallow *\fR to allow anyone to trigger a Puppet run, but that makes it possible to interfere with your site by triggering excessive Puppet runs\. +. +.P +See \fBhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details about security settings\. . .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\. diff --git a/man/man8/ralsh.8 b/man/man8/ralsh.8 index 7e09c0739..d9ece39f3 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" "June 2011" "Puppet Labs, LLC" "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "June 2012" "Puppet Labs, LLC" "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell diff --git a/tasks/rake/gem.rake b/tasks/rake/gem.rake index efea73882..0ec54079c 100644 --- a/tasks/rake/gem.rake +++ b/tasks/rake/gem.rake @@ -27,7 +27,7 @@ spec = Gem::Specification.new do |spec| spec.files = GEM_FILES.to_a spec.executables = EXECUTABLES.gsub(/sbin\/|bin\//, '').to_a spec.version = Puppet::PUPPETVERSION - spec.add_dependency('facter', '>= 1.5.1') + spec.add_dependency('facter', '~> 1.5') spec.summary = 'Puppet, an automated configuration management tool' spec.description = 'Puppet, an automated configuration management tool' spec.author = 'Puppet Labs' |