Skip to content

Commit ffb5d57

Browse files
(packaging) Updating manpage file for main
1 parent 55556e2 commit ffb5d57

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

man/man5/puppet.conf.5

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Whether to allow a new certificate request to overwrite an existing certificate
6363
.IP "" 0
6464
.
6565
.SS "allow_pson_serialization"
66-
Whether when unable to serialize to JSON or other formats, Puppet falls back to PSON\. This option affects both puppetserver\'s configuration management service responses and when the agent saves its cached catalog\. This option is useful in preventing the loss of data because rich data cannot be serialized via PSON\.
66+
Whether to allow PSON serialization\. When unable to serialize to JSON or other formats, Puppet falls back to PSON\. This option affects the configuration management service responses of Puppet Server and the process by which the agent saves its cached catalog\. With a default value of \fBfalse\fR, this option is useful in preventing the loss of data because rich data cannot be serialized via PSON\.
6767
.
6868
.IP "\(bu" 4
6969
\fIDefault\fR: \fBfalse\fR
@@ -164,13 +164,13 @@ The port to use for the certificate authority\.
164164
.IP "" 0
165165
.
166166
.SS "ca_refresh_interval"
167-
How often the Puppet agent refreshes its local CA certs\. By default the CA certs are refreshed once every 24 hours\. If a different duration is specified, then the agent will refresh its CA certs whenever it next runs and the elapsed time since the certs were last refreshed exceeds the duration\.
167+
How often the Puppet agent refreshes its local CA certificates\. By default, CA certificates are refreshed every 24 hours\. If a different interval is specified, the agent refreshes its CA certificates during the next agent run if the elapsed time since the certificates were last refreshed exceeds the specified duration\.
168168
.
169169
.P
170-
In general, the duration should be greater than the \fBruninterval\fR\. Setting it to 0 or an equal or lesser value than \fBruninterval\fR, will cause the CA certs to be refreshed on every run\.
170+
In general, the interval should be greater than the \fBruninterval\fR value\. Setting the \fBca_refresh_interval\fR value to 0 or an equal or lesser value than \fBruninterval\fR causes the CA certificates to be refreshed on every run\.
171171
.
172172
.P
173-
If the agent downloads new CA certs, the agent will use it for subsequent network requests\. If the refresh request fails or if the CA certs are unchanged on the server, then the agent run will continue using the local CA certs it already has\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
173+
If the agent downloads new CA certs, the agent uses those for subsequent network requests\. If the refresh request fails or if the CA certs are unchanged on the server, then the agent run will continue using the local CA certs it already has\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
174174
.
175175
.IP "\(bu" 4
176176
\fIDefault\fR: \fB1d\fR
@@ -406,10 +406,10 @@ Setting a global value for config_version in puppet\.conf is not allowed (but it
406406
Prints 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\'\. This setting is deprecated, the \'puppet config\' command replaces this functionality\.
407407
.
408408
.SS "crl_refresh_interval"
409-
How often the Puppet agent refreshes its local CRL\. By default the CRL is refreshed once every 24 hours\. If a different duration is specified, then the agent will refresh its CRL whenever it next runs and the elapsed time since the CRL was last refreshed exceeds the duration\.
409+
How often the Puppet agent refreshes its local Certificate Revocation List (CRL)\. By default, the CRL is refreshed every 24 hours\. If a different interval is specified, the agent refreshes its CRL on the next Puppet agent run if the elapsed time since the CRL was last refreshed exceeds the specified interval\.
410410
.
411411
.P
412-
In general, the duration should be greater than the \fBruninterval\fR\. Setting it to 0 or an equal or lesser value than \fBruninterval\fR, will cause the CRL to be refreshed on every run\.
412+
In general, the interval should be greater than the \fBruninterval\fR value\. Setting the \fBcrl_refresh_interval\fR value to 0 or an equal or lesser value than \fBruninterval\fR causes the CRL to be refreshed on every run\.
413413
.
414414
.P
415415
If the agent downloads a new CRL, the agent will use it for subsequent network requests\. If the refresh request fails or if the CRL is unchanged on the server, then the agent run will continue using the local CRL it already has\.This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
@@ -670,7 +670,7 @@ Whether each resource should log when it is being evaluated\. This allows you to
670670
.IP "" 0
671671
.
672672
.SS "exclude_unchanged_resources"
673-
When set to true, resources that have had no changes after catalog application will not have corresponding unchanged resource status updates listed in the report\.
673+
Specifies how unchanged resources are listed in reports\. When set to \fBtrue\fR, resources that have had no changes after catalog application will not have corresponding unchanged resource status updates listed in a report\.
674674
.
675675
.IP "\(bu" 4
676676
\fIDefault\fR: \fBtrue\fR
@@ -849,13 +849,13 @@ Where individual hosts store and look for their certificates\.
849849
.IP "" 0
850850
.
851851
.SS "hostcert_renewal_interval"
852-
When the Puppet agent refreshes its client certificate\. By default the client certificate will refresh 30 days before the certificate expires\. If a different duration is specified, then the agent will refresh its client certificate whenever it next runs and if the client certificate expires within the duration specified\.
852+
How often the Puppet agent renews its client certificate\. By default, the client certificate is renewed 30 days before the certificate expires\. If a different interval is specified, the agent renews its client certificate during the next agent run, assuming that the client certificate has expired within the specified duration\.
853853
.
854854
.P
855-
In general, the duration should be greater than the \fBruninterval\fR\. Setting it to 0 will disable automatic renewal\.
855+
In general, the \fBhostcert_renewal_interval\fR value should be greater than the \fBruninterval\fR value\. Setting the \fBhostcert_renewal_interval\fR value to 0 disables automatic renewal\.
856856
.
857857
.P
858-
If the agent downloads a new certificate, the agent will use it for subsequent network requests\. If the refresh request fails, then the agent run will continue using the certificate it already has\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
858+
If the agent downloads a new certificate, the agent will use it for subsequent network requests\. If the refresh request fails, the agent run continues to use its existing certificate\. This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y)\.
859859
.
860860
.IP "\(bu" 4
861861
\fIDefault\fR: \fB30d\fR
@@ -1002,7 +1002,7 @@ Boolean; whether puppet agent should ignore schedules\. This is useful for initi
10021002
.IP "" 0
10031003
.
10041004
.SS "include_legacy_facts"
1005-
Whether to include legacy facts when requesting a catalog\. This option can be set to false provided all puppet manifests, hiera\.yaml and hiera configuration layers no longer access legacy facts, such as \fB$osfamily\fR, and instead access structured facts, such as \fB$facts[\'os\'][\'family\']\fR\.
1005+
Whether to include legacy facts when requesting a catalog\. This option can be set to \fBfalse\fR if all puppet manifests, hiera\.yaml, and hiera configuration layers no longer access legacy facts, such as \fB$osfamily\fR, and instead access structured facts, such as \fB$facts[\'os\'][\'family\']\fR\.
10061006
.
10071007
.IP "\(bu" 4
10081008
\fIDefault\fR: \fBfalse\fR
@@ -1539,7 +1539,7 @@ The preferred means of serializing ruby instances for passing over the wire\. Th
15391539
.IP "" 0
15401540
.
15411541
.SS "preprocess_deferred"
1542-
Whether puppet should call deferred functions before applying the catalog\. If set to \fBtrue\fR, then all prerequisites needed for the deferred function must be satisfied prior to puppet running\. If set to \fBfalse\fR, then deferred functions will follow puppet relationships and ordering\. This allows puppet to install prerequisites needed for a deferred function and call the deferred function in the same run\.
1542+
Whether Puppet should call deferred functions before applying the catalog\. If set to \fBtrue\fR, all prerequisites required for the deferred function must be satisfied before the Puppet run\. If set to \fBfalse\fR, deferred functions follow Puppet relationships and ordering\. In this way, Puppet can install the prerequisites required for a deferred function and call the deferred function in the same run\.
15431543
.
15441544
.IP "\(bu" 4
15451545
\fIDefault\fR: \fBfalse\fR
@@ -1636,10 +1636,10 @@ Whether to send reports after every transaction\.
16361636
.IP "" 0
16371637
.
16381638
.SS "report_configured_environmentpath"
1639-
When versioned_environment_dirs is \fBtrue\fR Puppet will readlink the environmentpath when constructing the environment\'s modulepath\. The full readlinked path is referred to as the "resolved path" and the configured path potentially containing symlinks is the "configured path"\. When reporting where resources come from users may choose between the configured or resolved path\.
1639+
Specifies how environment paths are reported\. When the value of \fBversioned_environment_dirs\fR is \fBtrue\fR, Puppet applies the readlink function to the \fBenvironmentpath\fR setting when constructing the environment\'s modulepath\. The full readlinked path is referred to as the "resolved path," and the configured path potentially containing symlinks is the "configured path\." When reporting where resources come from, users may choose between the configured and resolved path\.
16401640
.
16411641
.P
1642-
When set to false, the resolved paths are reported instead of the configured paths\.
1642+
When set to \fBfalse\fR, the resolved paths are reported instead of the configured paths\.
16431643
.
16441644
.IP "\(bu" 4
16451645
\fIDefault\fR: \fBtrue\fR
@@ -1832,7 +1832,7 @@ Where the CA stores signed certificates\.
18321832
.IP "" 0
18331833
.
18341834
.SS "skip_logging_catalog_request_destination"
1835-
If you wish to suppress the notice of which compiler supplied the catalog
1835+
Specifies whether to suppress the notice of which compiler supplied the catalog\. A value of \fBtrue\fR suppresses the notice\.
18361836
.
18371837
.IP "\(bu" 4
18381838
\fIDefault\fR: \fBfalse\fR

man/man8/puppet-apply.8

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ A path ending with \'\.jsonl\' will receive structured output in JSON Lines form
8787
.
8888
.nf
8989

90+
$ puppet apply \-e \'notify { "hello world": }\'
9091
$ puppet apply \-l /tmp/manifest\.log manifest\.pp
9192
$ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server"
9293
$ puppet apply \-\-catalog catalog\.json

man/man8/puppet-ssl.8

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Perform all of the steps necessary to request and download a client certificate\
3939
.
4040
.TP
4141
submit_request
42-
Generate a certificate signing request (CSR) and submit it to the CA\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\. If a CSR has already been submitted with the given \fBcertname\fR, then the operation will fail\.
42+
Generate a certificate signing request (CSR) and submit it to the CA\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise, a new key pair will be generated\. If a CSR has already been submitted with the given \fBcertname\fR, then the operation will fail\.
4343
.
4444
.TP
4545
generate_request
46-
Generate a certificate signing request (CSR)\. If a private and public key pair already exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\.
46+
Generate a certificate signing request (CSR)\. If a private and public key pair exist, they will be used to generate the CSR\. Otherwise a new key pair will be generated\.
4747
.
4848
.TP
4949
download_cert

0 commit comments

Comments
 (0)