~ubuntu-branches/ubuntu/quantal/puppet/quantal

« back to all changes in this revision

Viewing changes to man/man5/puppet.conf.5

  • Committer: Package Import Robot
  • Author(s): Marc Deslauriers
  • Date: 2012-07-14 01:56:30 UTC
  • mfrom: (1.1.29) (3.1.43 sid)
  • Revision ID: package-import@ubuntu.com-20120714015630-ntj41rkvkq4zph4y
Tags: 2.7.18-1ubuntu1
* Resynchronise with Debian. (LP: #1023931) Remaining changes:
  - debian/puppetmaster-passenger.postinst: Make sure we error if puppet
    config print doesn't work
  - debian/puppetmaster-passenger.postinst: Ensure upgrades from
    <= 2.7.11-1 fixup passenger apache configuration.
* Dropped upstreamed patches:
  - debian/patches/CVE-2012-1906_CVE-2012-1986_to_CVE-2012-1989.patch
  - debian/patches/puppet-12844
  - debian/patches/2.7.17-Puppet-July-2012-CVE-fixes.patch
* Drop Build-Depends on ruby-rspec (in universe):
  - debian/control: remove ruby-rspec from Build-Depends
  - debian/patches/no-rspec.patch: make Rakefile work anyway if rspec
    isn't installed so we can use it in debian/rules.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" generated with Ronn/v0.7.3
2
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
3
.
4
 
.TH "PUPPETCONF" "5" "June 2011" "Puppet Labs, LLC" "Puppet manual"
5
 
\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on Wed Jun 08 17:09:41 \-0700 2011)\fR
 
4
.TH "PUPPETCONF" "5" "June 2012" "Puppet Labs, LLC" "Puppet manual"
 
5
\fBThis page is autogenerated; any changes will get overwritten\fR \fI(last generated on Wed Jun 06 13:43:46 \-0700 2012)\fR
6
6
.
7
7
.SH "Configuration Settings"
8
8
.
73
73
Whether log files should always flush to disk\.
74
74
.
75
75
.IP "\(bu" 4
76
 
\fIDefault\fR: false
 
76
\fIDefault\fR: true
77
77
.
78
78
.IP "" 0
79
79
.
105
105
.IP "" 0
106
106
.
107
107
.SS "ca_days"
108
 
How long a certificate should be valid\. This parameter is deprecated, use ca_ttl instead
 
108
How long a certificate should be valid, in days\. This setting is deprecated; use \fBca_ttl\fR instead
109
109
.
110
110
.SS "ca_md"
111
111
The type of hash used in certificates\.
140
140
.IP "" 0
141
141
.
142
142
.SS "ca_ttl"
143
 
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)
 
143
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)
144
144
.
145
145
.IP "\(bu" 4
146
146
\fIDefault\fR: 5y
231
231
.IP "" 0
232
232
.
233
233
.SS "certdnsnames"
234
 
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\'\.
 
234
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\.
235
235
.
236
236
.SS "certificate_revocation"
237
237
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
245
The name to use when handling certificates\. Defaults to the fully qualified domain name\.
246
246
.
247
247
.IP "\(bu" 4
248
 
\fIDefault\fR: magpie\.puppetlabs\.lan
 
248
\fIDefault\fR: wyclef\.puppetlabs\.lan
249
249
.
250
250
.IP "" 0
251
251
.
285
285
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
286
286
.
287
287
.SS "color"
288
 
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\.
 
288
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\.
289
289
.
290
290
.IP "\(bu" 4
291
291
\fIDefault\fR: ansi
293
293
.IP "" 0
294
294
.
295
295
.SS "confdir"
296
 
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\.
 
296
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\.
297
297
.
298
298
.IP "\(bu" 4
299
299
\fIDefault\fR: /etc/puppet
312
312
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\.
313
313
.
314
314
.SS "configprint"
315
 
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\.
 
315
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\'\.
316
316
.
317
317
.SS "configtimeout"
318
318
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
339
.IP "" 0
340
340
.
341
341
.SS "daemonize"
342
 
Send the process into the background\. This is the default\.
 
342
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)\.
343
343
.
344
344
.IP "\(bu" 4
345
345
\fIDefault\fR: true
428
428
.IP "" 0
429
429
.
430
430
.SS "diff"
431
 
Which diff command to use when printing differences between files\.
 
431
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\.
432
432
.
433
433
.IP "\(bu" 4
434
434
\fIDefault\fR: diff
436
436
.IP "" 0
437
437
.
438
438
.SS "diff_args"
439
 
Which arguments to pass to the diff command when printing differences between files\.
 
439
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\.
440
440
.
441
441
.IP "\(bu" 4
442
442
\fIDefault\fR: \-u
443
443
.
444
444
.IP "" 0
445
445
.
 
446
.SS "dns_alt_names"
 
447
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\.
 
448
.
446
449
.SS "document_all"
447
450
Document all resources
448
451
.
484
487
.IP "" 0
485
488
.
486
489
.SS "external_nodes"
487
 
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\.
 
490
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\.
488
491
.
489
492
.IP "\(bu" 4
490
493
\fIDefault\fR: none
500
503
.IP "" 0
501
504
.
502
505
.SS "factpath"
503
 
Where Puppet should look for facts\. Multiple directories should be colon\-separated, like normal PATH variables\.
 
506
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 \';\'\.)
504
507
.
505
508
.IP "\(bu" 4
506
509
\fIDefault\fR: $vardir/lib/facter:$vardir/facts
684
687
.IP "" 0
685
688
.
686
689
.SS "ignoreimport"
687
 
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\.
 
690
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\.
688
691
.
689
692
.IP "\(bu" 4
690
693
\fIDefault\fR: false
727
730
The bit length of keys\.
728
731
.
729
732
.IP "\(bu" 4
730
 
\fIDefault\fR: 1024
 
733
\fIDefault\fR: 4096
731
734
.
732
735
.IP "" 0
733
736
.
948
951
.
949
952
.IP "" 0
950
953
.
 
954
.SS "module_repository"
 
955
The module repository
 
956
.
 
957
.IP "\(bu" 4
 
958
\fIDefault\fR: http://forge\.puppetlabs\.com
 
959
.
 
960
.IP "" 0
 
961
.
 
962
.SS "module_working_dir"
 
963
The directory into which module tool data is stored
 
964
.
 
965
.IP "\(bu" 4
 
966
\fIDefault\fR: $vardir/puppet\-module
 
967
.
 
968
.IP "" 0
 
969
.
951
970
.SS "modulepath"
952
 
The search path for modules as a colon\-separated list of directories\.
 
971
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 \';\'\.)
953
972
.
954
973
.IP "\(bu" 4
955
974
\fIDefault\fR: $confdir/modules:/usr/share/puppet/modules
972
991
.
973
992
.IP "" 0
974
993
.
 
994
.SS "node_name_fact"
 
995
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\.
 
996
.
 
997
.SS "node_name_value"
 
998
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\.
 
999
.
 
1000
.IP "\(bu" 4
 
1001
\fIDefault\fR: $certname
 
1002
.
 
1003
.IP "" 0
 
1004
.
975
1005
.SS "node_terminus"
976
1006
Where to find information about nodes\.
977
1007
.
1182
1212
The \'from\' email address for the reports\.
1183
1213
.
1184
1214
.IP "\(bu" 4
1185
 
\fIDefault\fR: report@magpie\.puppetlabs\.lan
 
1215
\fIDefault\fR: report@wyclef\.puppetlabs\.lan
1186
1216
.
1187
1217
.IP "" 0
1188
1218
.
1206
1236
The URL used by the http reports processor to send reports
1207
1237
.
1208
1238
.IP "\(bu" 4
1209
 
\fIDefault\fR: http://localhost:3000/reports
 
1239
\fIDefault\fR: http://localhost:3000/reports/upload
1210
1240
.
1211
1241
.IP "" 0
1212
1242
.
1214
1244
The bit length of the certificates\.
1215
1245
.
1216
1246
.IP "\(bu" 4
1217
 
\fIDefault\fR: 2048
 
1247
\fIDefault\fR: 4096
1218
1248
.
1219
1249
.IP "" 0
1220
1250
.
1226
1256
.
1227
1257
.IP "" 0
1228
1258
.
 
1259
.SS "resourcefile"
 
1260
The file in which puppet agent stores a list of the resources associated with the retrieved configuration\.
 
1261
.
 
1262
.IP "\(bu" 4
 
1263
\fIDefault\fR: $statedir/resources\.txt
 
1264
.
 
1265
.IP "" 0
 
1266
.
1229
1267
.SS "rest_authconfig"
1230
1268
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\.
1231
1269
.
1275
1313
.IP "" 0
1276
1314
.
1277
1315
.SS "runinterval"
1278
 
How often puppet agent applies the client configuration; in seconds\.
 
1316
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\.
1279
1317
.
1280
1318
.IP "\(bu" 4
1281
1319
\fIDefault\fR: 1800
1323
1361
.IP "" 0
1324
1362
.
1325
1363
.SS "show_diff"
1326
 
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\.
 
1364
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\.
1327
1365
.
1328
1366
.IP "\(bu" 4
1329
1367
\fIDefault\fR: false
1403
1441
.IP "" 0
1404
1442
.
1405
1443
.SS "storeconfigs"
1406
 
Whether to store each client\'s configuration\. This requires ActiveRecord from Ruby on Rails\.
 
1444
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\.
1407
1445
.
1408
1446
.IP "\(bu" 4
1409
1447
\fIDefault\fR: false
1410
1448
.
1411
1449
.IP "" 0
1412
1450
.
 
1451
.SS "storeconfigs_backend"
 
1452
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\.
 
1453
.
 
1454
.IP "\(bu" 4
 
1455
\fIDefault\fR: active_record
 
1456
.
 
1457
.IP "" 0
 
1458
.
1413
1459
.SS "strict_hostname_checking"
1414
1460
Whether to only search for the complete hostname as it is in the certificate when searching for node information in the catalogs\.
1415
1461
.
1446
1492
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\.
1447
1493
.
1448
1494
.SS "templatedir"
1449
 
Where Puppet looks for template files\. Can be a list of colon\-seperated directories\.
 
1495
Where Puppet looks for template files\. Can be a list of colon\-separated directories\.
1450
1496
.
1451
1497
.IP "\(bu" 4
1452
1498
\fIDefault\fR: $vardir/templates
1494
1540
.IP "" 0
1495
1541
.
1496
1542
.SS "vardir"
1497
 
Where Puppet stores dynamic and growing data\. The default for this parameter is calculated specially, like \fBconfdir\fR_\.
 
1543
Where Puppet stores dynamic and growing data\. The default for this setting is calculated specially, like \fBconfdir\fR_\.
1498
1544
.
1499
1545
.IP "\(bu" 4
1500
1546
\fIDefault\fR: /var/lib/puppet
1518
1564
.IP "" 0
1519
1565
.
1520
1566
.P
1521
 
\fIThis page autogenerated on Wed Jun 08 17:09:41 \-0700 2011\fR
 
1567
\fIThis page autogenerated on Wed Jun 06 13:43:46 \-0700 2012\fR