puppet 4.10.9-x64-mingw32 → 4.10.10-x64-mingw32

data/man/man8/extlookup2hiera.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "EXTLOOKUP2HIERA" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "EXTLOOKUP2HIERA" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBextlookup2hiera\fR

data/man/man8/puppet-agent.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-AGENT" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-AGENT" "8" "January 2018" "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 [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-masterport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR]
+puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-masterport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-\-sourceaddress \fIIP_ADDRESS\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\.
@@ -25,19 +25,22 @@ Once the client has a signed certificate, it will retrieve its configuration and
 \'puppet agent\' does its best to find a compromise between interactive use and daemon use\. Run with no arguments and no configuration, it will go into the background, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes\.
 .
 .P
-Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' or \'fingerprint\' are useful\. \'test\' enables verbose logging, causes the daemon to stay in the foreground, exits if the server\'s configuration is invalid (this happens if, for instance, you\'ve left a syntax error on the server), and exits after running the configuration once (rather than hanging around as a long\-running process)\.
+Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' and \'fingerprint\' are useful\.
 .
 .P
-\'tags\' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the \'tags\' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage \'ntpd\', you would put all of the new elements into an \'ntpd\' class, and call puppet with \'\-\-tags ntpd\', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
+\'\-\-test\' does a single run in the foreground with verbose logging, then exits\. It will also exit if it can\'t get a valid catalog\. The exit code after running with \'\-\-test\' is 0 if the catalog was successfully applied, and 1 if the run either failed or wasn\'t attempted (due to another run already in progress)\.
 .
 .P
-\'fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
+\'\-\-tags\' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the \'tags\' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage \'ntpd\', you would put all of the new elements into an \'ntpd\' class, and call puppet with \'\-\-tags ntpd\', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
+.
+.P
+\'\-\-fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
 .
 .SH "OPTIONS"
 Note that any Puppet setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid setting, so you can specify \'\-\-server \fIservername\fR\' as an argument\. Boolean settings translate into \'\-\-setting\' and \'\-\-no\-setting\' pairs\.
 .
 .P
-See the configuration file documentation at https://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with \'\-\-genconfig\'\.
+See the configuration file documentation at https://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with \'\-\-genconfig\'\.
 .
 .TP
 \-\-certname
@@ -57,7 +60,22 @@ 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, 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\.
+Provide extra information about the run via exit codes; only works if \'\-\-test\' or \'\-\-onetime\' is also specified\. If enabled, \'puppet agent\' will use the following exit codes:
+.
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.
+.IP
+1: The run failed, or wasn\'t attempted due to another run already in progress\.
+.
+.IP
+2: The run succeeded, and some resources were changed\.
+.
+.IP
+4: The run succeeded, and some resources failed\.
+.
+.IP
+6: The run succeeded, and included both changes and failures\.
 .
 .TP
 \-\-digest
@@ -111,8 +129,12 @@ Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is u
 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\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.)
 .
 .TP
+\-\-sourceaddress
+Set the source IP address for transactions\. This defaults to automatically selected\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.
+.TP
 \-\-test
-Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exitcodes\', \'no\-splay\', and \'show_diff\'\.
+Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exitcodes\', \'no\-splay\', \'show_diff\', and \'no\-use_cached_catalog\'\.
 .
 .TP
 \-\-verbose
@@ -157,4 +179,4 @@ Close file descriptors for log files and reopen them\. Used with logrotate\.
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-apply.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-APPLY" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-APPLY" "8" "January 2018" "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|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR
+puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-L|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR
 .
 .SH "DESCRIPTION"
 This is the standalone puppet execution tool; use it to apply individual manifests\.
@@ -25,13 +25,28 @@ Most users should use \'puppet agent\' and \'puppet master\' for site\-wide mani
 Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'tags\' is a valid setting, so you can specify \'\-\-tags \fIclass\fR,\fItag\fR\' as an argument\.
 .
 .P
-See the configuration file documentation at https://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \'\-\-genconfig\'\.
+See the configuration file documentation at https://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \'\-\-genconfig\'\.
 .
 .IP "\(bu" 4
 \-\-debug: Enable full debugging\.
 .
 .IP "\(bu" 4
-\-\-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\.
+\-\-detailed\-exitcodes: Provide extra information about the run via exit codes\. If enabled, \'puppet apply\' will use the following exit codes:
+.
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.
+.IP
+1: The run failed\.
+.
+.IP
+2: The run succeeded, and some resources were changed\.
+.
+.IP
+4: The run succeeded, and some resources failed\.
+.
+.IP
+6: The run succeeded, and included both changes and failures\.
 .
 .IP "\(bu" 4
 \-\-help: Print this help message
@@ -79,4 +94,4 @@ $ puppet apply \-\-catalog catalog\.json
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-ca.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CA" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CA" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-ca\fR \- Local Puppet Certificate Authority management\.
@@ -19,7 +19,7 @@ You can use this subcommand to sign outstanding certificate requests, list and m
 Note that any setting 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 and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://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\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/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
 \-\-render\-as FORMAT
@@ -35,9 +35,8 @@ Whether to log debug information\.
 .
 .SH "ACTIONS"
 .
-.TP
-\fBdestroy\fR \- Destroy named certificate or pending certificate request\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBdestroy\fR \- Destroy named certificate or pending certificate request\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca destroy
@@ -48,9 +47,8 @@ puppet ca destroy
 .IP
 Destroy named certificate or pending certificate request\.
 .
-.TP
-\fBfingerprint\fR \- Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBfingerprint\fR \- Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s certificate\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca fingerprint [\-\-digest ALGORITHM]
@@ -64,9 +62,8 @@ Print the DIGEST (defaults to the signing algorithm) fingerprint of a host\'s ce
 .IP
 \fBOPTIONS\fR \fI\-\-digest ALGORITHM\fR \- The hash algorithm to use when displaying the fingerprint
 .
-.TP
-\fBgenerate\fR \- Generate a certificate for a named client\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBgenerate\fR \- Generate a certificate for a named client\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca generate [\-\-dns\-alt\-names NAMES]
@@ -78,23 +75,42 @@ puppet ca generate [\-\-dns\-alt\-names NAMES]
 Generate a certificate for a named client\.
 .
 .IP
-\fBOPTIONS\fR \fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\.
+\fBOPTIONS\fR \fI\-\-dns\-alt\-names NAMES\fR \- A comma\-separated list of alternate DNS names for Puppet Server\. These are extra hostnames (in addition to its \fBcertname\fR) that the server is allowed to use when serving agents\. Puppet checks this setting when automatically requesting a certificate for Puppet agent or Puppet Server, and when manually generating a certificate with \fBpuppet cert generate\fR\.
 .
 .IP
-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\.
+In order to handle agent requests at a given hostname (like "puppet\.example\.com"), Puppet Server needs a certificate that proves it\'s allowed to use that name; if a server shows a certificate that doesn\'t include its hostname, Puppet agents will refuse to trust it\. If you use a single hostname for Puppet traffic but load\-balance it to multiple Puppet Servers, each of those servers needs to include the official hostname in its list of extra names\.
 .
 .IP
-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\.
+\fBNote:\fR The list of alternate names is locked in when the server\'s certificate is signed\. If you need to change the list later, you can\'t just change this setting; you also need to:
 .
-.IP
-This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\.
+.IP "\(bu" 4
+On the server: Stop Puppet Server\.
+.
+.IP "\(bu" 4
+On the CA server: Revoke and clean the server\'s old certificate\. (\fBpuppet cert clean <NAME>\fR)
+.
+.IP "\(bu" 4
+On the server: Delete the old certificate (and any old certificate signing requests) from the ssldir \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/dirs_ssldir\.html\fR\.
+.
+.IP "\(bu" 4
+On the server: Run \fBpuppet agent \-t \-\-ca_server <CA HOSTNAME>\fR to request a new certificate
+.
+.IP "\(bu" 4
+On the CA server: Sign the certificate request, explicitly allowing alternate names (\fBpuppet cert sign \-\-allow\-dns\-alt\-names <NAME>\fR)\.
+.
+.IP "\(bu" 4
+On the server: Run \fBpuppet agent \-t \-\-ca_server <CA HOSTNAME>\fR to retrieve the cert\.
+.
+.IP "\(bu" 4
+On the server: Start Puppet Server again\.
+.
+.IP "" 0
 .
 .IP
-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\.
+To see all the alternate names your servers are using, log into your CA server and run \fBpuppet cert list \-a\fR, then check the output for \fB(alt names: \.\.\.)\fR\. Most agent nodes should NOT have alternate names; the only certs that should have them are Puppet Server nodes that you want other agents to trust\.
 .
-.TP
-\fBlist\fR \- List certificates and/or certificate requests\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBlist\fR \- List certificates and/or certificate requests\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca list [\-\-[no\-]all] [\-\-[no\-]pending] [\-\-[no\-]signed] [\-\-digest ALGORITHM] [\-\-subject PATTERN]
@@ -123,9 +139,8 @@ This will list the current certificates and certificate signing requests in the
 .IP
 PATTERN is interpreted as a regular expression, allowing complex filtering of the content\.
 .
-.TP
-\fBprint\fR \- Print the full\-text version of a host\'s certificate\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBprint\fR \- Print the full\-text version of a host\'s certificate\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca print
@@ -136,9 +151,8 @@ puppet ca print
 .IP
 Print the full\-text version of a host\'s certificate\.
 .
-.TP
-\fBrevoke\fR \- Add certificate to certificate revocation list\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBrevoke\fR \- Add certificate to certificate revocation list\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca revoke
@@ -149,9 +163,8 @@ puppet ca revoke
 .IP
 Add certificate to certificate revocation list\.
 .
-.TP
-\fBsign\fR \- Sign an outstanding certificate request\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBsign\fR \- Sign an outstanding certificate request\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca sign [\-\-[no\-]allow\-dns\-alt\-names]
@@ -165,9 +178,8 @@ Sign an outstanding certificate request\.
 .IP
 \fBOPTIONS\fR \fI\-\-[no\-]allow\-dns\-alt\-names\fR \- Whether or not to accept DNS alt names in the certificate request
 .
-.TP
-\fBverify\fR \- Verify the named certificate against the local CA certificate\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBverify\fR \- Verify the named certificate against the local CA certificate\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet ca verify
@@ -178,5 +190,7 @@ puppet ca verify
 .IP
 Verify the named certificate against the local CA certificate\.
 .
+.IP "" 0
+.
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-catalog.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CATALOG" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CATALOG" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
@@ -16,7 +16,7 @@ This subcommand deals with catalogs, which are compiled per\-node artifacts gene
 Note that any setting 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 and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://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\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/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
 \-\-render\-as FORMAT
@@ -260,4 +260,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-cert.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CERT" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERT" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-cert\fR \- Manage certificates and requests
@@ -18,6 +18,9 @@ Because the puppet master service defaults to not signing client certificate req
 .SH "ACTIONS"
 Every action except \'list\' and \'generate\' requires a hostname to act on, unless the \'\-\-all\' option is set\.
 .
+.P
+The most important actions for day\-to\-day use are \'list\' and \'sign\'\.
+.
 .TP
 clean
 Revoke a host\'s certificate (if applicable) and remove all files related to that host from puppet cert\'s storage\. This is useful when rebuilding hosts, since new certificate signing requests will only be honored if puppet cert does not have a copy of a signed certificate for that host\. If \'\-\-all\' is specified then all host certificates, both signed and unsigned, will be removed\.
@@ -32,7 +35,7 @@ Generate a certificate for a named client\. A certificate/keypair will be genera
 .
 .TP
 list
-List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\.
+List outstanding certificate requests\. If \'\-\-all\' is specified, signed certificates are also listed, prefixed by \'+\', and revoked or invalid certificates are prefixed by \'\-\' (the verification outcome is printed in parenthesis)\. If \'\-\-human\-readable\' or \'\-H\' is specified, certificates are formatted in a way to improve human scan\-ability\. If \'\-\-machine\-readable\' or \'\-m\' is specified, output is formatted concisely for consumption by a script\.
 .
 .TP
 print
@@ -44,7 +47,7 @@ Revoke the certificate of a client\. The certificate can be specified either by
 .
 .TP
 sign
-Sign an outstanding certificate request\.
+Sign an outstanding certificate request\. If \'\-\-interactive\' or \'\-i\' is supplied the user will be prompted to confirm that they are signing the correct certificate (recommended)\. If \'\-\-assume\-yes\' or \'\-y\' is supplied the interactive prompt will assume the answer of \'yes\'\.
 .
 .TP
 verify
@@ -58,13 +61,27 @@ Build an inventory of the issued certificates\. This will destroy the current in
 Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\.
 .
 .P
-See the configuration file documentation at https://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet cert with \'\-\-genconfig\'\.
+See the configuration file documentation at https://docs\.puppetlabs\.com/puppet/latest/reference/configuration\.html for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet cert with \'\-\-genconfig\'\.
 .
 .TP
 \-\-all
 Operate on all items\. Currently only makes sense with the \'sign\', \'list\', and \'fingerprint\' actions\.
 .
 .TP
+\-\-allow\-dns\-alt\-names
+Sign a certificate request even if it contains one or more alternate DNS names\. If this option isn\'t specified, \'puppet cert sign\' will ignore any requests that contain alternate names\.
+.
+.IP
+In general, ONLY certs intended for a Puppet master server should include alternate DNS names, since Puppet agent relies on those names for identifying its rightful server\.
+.
+.IP
+You can make Puppet agent request a certificate with alternate names by setting \'dns_alt_names\' in puppet\.conf or specifying \'\-\-dns_alt_names\' on the command line\. The output of \'puppet cert list\' shows any requested alt names for pending certificate requests\.
+.
+.TP
+\-\-allow\-authorization\-extensions
+Enable the signing of a request with authorization extensions\. Such requests are sensitive because they can be used to write access rules in Puppet Server\. Currently, this is the only means by which such requests can be signed\.
+.
+.TP
 \-\-digest
 Set the digest for fingerprinting (defaults to the digest used when signing the cert)\. Valid values depends on your openssl and openssl ruby extension version\.
 .
@@ -98,4 +115,4 @@ $ puppet cert sign culain\.madstop\.com
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-certificate.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CERTIFICATE" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-certificate\fR \- Provide access to the CA for certificate management\.
@@ -16,7 +16,7 @@ This subcommand interacts with a local or remote Puppet certificate authority\.
 Note that any setting 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 and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://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\.
+See the configuration file documentation at \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/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
 \-\-render\-as FORMAT
@@ -53,9 +53,8 @@ The terminus for an action is often determined by context, but occasionally need
 .
 .SH "ACTIONS"
 .
-.TP
-\fBdestroy\fR \- Delete a certificate\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBdestroy\fR \- Delete a certificate\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet certificate destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR
@@ -72,9 +71,8 @@ Deletes a certificate\. This action currently only works on the local CA\.
 .IP
 Nothing\.
 .
-.TP
-\fBfind\fR \- Retrieve a certificate\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBfind\fR \- Retrieve a certificate\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet certificate find [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR \fIhost\fR
@@ -94,9 +92,8 @@ 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\.
 .
-.TP
-\fBgenerate\fR \- Generate a new certificate signing request\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBgenerate\fR \- Generate a new certificate signing request\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet certificate generate [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-dns\-alt\-names NAMES] \fIhost\fR
@@ -111,19 +108,39 @@ 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 \fI\-\-dns\-alt\-names NAMES\fR \- The comma\-separated list of alternative DNS names to use for the local host\.
+\fBOPTIONS\fR \fI\-\-dns\-alt\-names NAMES\fR \- A comma\-separated list of alternate DNS names for Puppet Server\. These are extra hostnames (in addition to its \fBcertname\fR) that the server is allowed to use when serving agents\. Puppet checks this setting when automatically requesting a certificate for Puppet agent or Puppet Server, and when manually generating a certificate with \fBpuppet cert generate\fR\.
 .
 .IP
-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\.
+In order to handle agent requests at a given hostname (like "puppet\.example\.com"), Puppet Server needs a certificate that proves it\'s allowed to use that name; if a server shows a certificate that doesn\'t include its hostname, Puppet agents will refuse to trust it\. If you use a single hostname for Puppet traffic but load\-balance it to multiple Puppet Servers, each of those servers needs to include the official hostname in its list of extra names\.
 .
 .IP
-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\.
+\fBNote:\fR The list of alternate names is locked in when the server\'s certificate is signed\. If you need to change the list later, you can\'t just change this setting; you also need to:
 .
-.IP
-This is unnecessary for agents, unless you intend to use them as a server for \fBpuppet kick\fR or remote \fBpuppet resource\fR management\.
+.IP "\(bu" 4
+On the server: Stop Puppet Server\.
+.
+.IP "\(bu" 4
+On the CA server: Revoke and clean the server\'s old certificate\. (\fBpuppet cert clean <NAME>\fR)
+.
+.IP "\(bu" 4
+On the server: Delete the old certificate (and any old certificate signing requests) from the ssldir \fIhttps://docs\.puppetlabs\.com/puppet/latest/reference/dirs_ssldir\.html\fR\.
+.
+.IP "\(bu" 4
+On the server: Run \fBpuppet agent \-t \-\-ca_server <CA HOSTNAME>\fR to request a new certificate
+.
+.IP "\(bu" 4
+On the CA server: Sign the certificate request, explicitly allowing alternate names (\fBpuppet cert sign \-\-allow\-dns\-alt\-names <NAME>\fR)\.
+.
+.IP "\(bu" 4
+On the server: Run \fBpuppet agent \-t \-\-ca_server <CA HOSTNAME>\fR to retrieve the cert\.
+.
+.IP "\(bu" 4
+On the server: Start Puppet Server again\.
+.
+.IP "" 0
 .
 .IP
-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\.
+To see all the alternate names your servers are using, log into your CA server and run \fBpuppet cert list \-a\fR, then check the output for \fB(alt names: \.\.\.)\fR\. Most agent nodes should NOT have alternate names; the only certs that should have them are Puppet Server nodes that you want other agents to trust\.
 .
 .IP
 \fBRETURNS\fR
@@ -131,9 +148,8 @@ It is rarely necessary for servers; it is usually helpful only if you need to ha
 .IP
 Nothing\.
 .
-.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 certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR
@@ -144,9 +160,8 @@ puppet certificate info [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-loca
 .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 \'\-\-run_mode\' option\.
 .
-.TP
-\fBlist\fR \- List all certificate signing requests\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBlist\fR \- List all certificate signing requests\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet certificate list [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR
@@ -163,9 +178,8 @@ List all certificate signing requests\.
 .IP
 An array of #inspect output from CSR objects\. This output is currently messy, but does contain the names of nodes requesting certificates\. This action returns #inspect strings even when used from the Ruby API\.
 .
-.TP
-\fBsign\fR \- Sign a certificate signing request for HOST\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBsign\fR \- Sign a certificate signing request for HOST\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet certificate sign [\-\-terminus TERMINUS] [\-\-extra HASH] \fI\-\-ca\-location LOCATION\fR [\-\-[no\-]allow\-dns\-alt\-names] \fIhost\fR
@@ -185,6 +199,8 @@ Sign a certificate signing request for HOST\.
 .IP
 A string that appears to be (but isn\'t) an x509 certificate\.
 .
+.IP "" 0
+.
 .SH "EXAMPLES"
 \fBgenerate\fR
 .
@@ -221,4 +237,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING