puppet 8.8.1 → 8.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +2 -0
  3. data/Gemfile.lock +37 -29
  4. data/ext/project_data.yaml +12 -0
  5. data/install.rb +3 -74
  6. data/lib/puppet/application/apply.rb +1 -0
  7. data/lib/puppet/application/filebucket.rb +6 -4
  8. data/lib/puppet/application/ssl.rb +4 -4
  9. data/lib/puppet/defaults.rb +62 -52
  10. data/lib/puppet/face/catalog.rb +24 -8
  11. data/lib/puppet/face/help.rb +43 -23
  12. data/lib/puppet/functions/capitalize.rb +1 -1
  13. data/lib/puppet/functions/find_file.rb +4 -0
  14. data/lib/puppet/functions/hiera.rb +1 -0
  15. data/lib/puppet/functions/index.rb +2 -2
  16. data/lib/puppet/functions/lookup.rb +1 -1
  17. data/lib/puppet/functions/new.rb +1 -1
  18. data/lib/puppet/functions/regsubst.rb +1 -1
  19. data/lib/puppet/functions/unique.rb +3 -2
  20. data/lib/puppet/functions/yaml_data.rb +1 -0
  21. data/lib/puppet/interface/action_manager.rb +1 -1
  22. data/lib/puppet/provider/package/pacman.rb +9 -10
  23. data/lib/puppet/reference/configuration.rb +6 -1
  24. data/lib/puppet/resource/type.rb +15 -1
  25. data/lib/puppet/settings.rb +2 -2
  26. data/lib/puppet/transaction/resource_harness.rb +7 -3
  27. data/lib/puppet/type/exec.rb +3 -4
  28. data/lib/puppet/type/file/checksum.rb +4 -2
  29. data/lib/puppet/type/file/ctime.rb +2 -2
  30. data/lib/puppet/type/file/mtime.rb +2 -2
  31. data/lib/puppet/type/file/selcontext.rb +6 -6
  32. data/lib/puppet/type/package.rb +4 -3
  33. data/lib/puppet/type/user.rb +1 -1
  34. data/lib/puppet/util/checksums.rb +1 -0
  35. data/lib/puppet/util/profiler/aggregate.rb +2 -2
  36. data/lib/puppet/util/profiler/wall_clock.rb +2 -2
  37. data/lib/puppet/util/reference.rb +0 -1
  38. data/lib/puppet/util/selinux.rb +26 -14
  39. data/lib/puppet/version.rb +1 -1
  40. data/locales/puppet.pot +71 -71
  41. data/man/man5/puppet.conf.5 +18 -18
  42. data/man/man8/puppet-agent.8 +1 -1
  43. data/man/man8/puppet-apply.8 +2 -1
  44. data/man/man8/puppet-catalog.8 +5 -2
  45. data/man/man8/puppet-config.8 +1 -1
  46. data/man/man8/puppet-describe.8 +1 -1
  47. data/man/man8/puppet-device.8 +1 -1
  48. data/man/man8/puppet-doc.8 +1 -1
  49. data/man/man8/puppet-epp.8 +1 -1
  50. data/man/man8/puppet-facts.8 +1 -1
  51. data/man/man8/puppet-filebucket.8 +10 -1
  52. data/man/man8/puppet-generate.8 +1 -1
  53. data/man/man8/puppet-help.8 +1 -1
  54. data/man/man8/puppet-lookup.8 +1 -1
  55. data/man/man8/puppet-module.8 +1 -1
  56. data/man/man8/puppet-node.8 +1 -1
  57. data/man/man8/puppet-parser.8 +1 -1
  58. data/man/man8/puppet-plugin.8 +1 -1
  59. data/man/man8/puppet-report.8 +1 -1
  60. data/man/man8/puppet-resource.8 +1 -1
  61. data/man/man8/puppet-script.8 +1 -1
  62. data/man/man8/puppet-ssl.8 +3 -3
  63. data/man/man8/puppet.8 +128 -9
  64. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f89da386754e99d82576c50391217640d9d740f5aa41df6d0a091aafd35377b1
4
- data.tar.gz: bfb37d9f9f20cc9607976f782622fb16ff6146cdef2642ad5cd46e55b31d7f40
3
+ metadata.gz: '08fa93960fb1b1b45faf01adeada66909e0e3312ba1de1d90c44aba5812c728b'
4
+ data.tar.gz: 045f5f6ce8cb20b9c8ed0428a0126e4bf917d0feebc02b70539874586d69bee8
5
5
  SHA512:
6
- metadata.gz: 43d308cfe325c7985ff9d0a6310ee36a7d23f3c4080bd97445375d0d01ed59ed9cbed104efd5a40824b0cef277b2934976df028a827965612eac1c2a97659b9c
7
- data.tar.gz: 87293cc2c9f04ec783873109a65d30162d02698ddc5947287a71a3662c53041e5b6eefbc166595fc3a014f18025311d3117ef93bd8cc07fa5f4c1d5da73082da
6
+ metadata.gz: 5501e4ef60157bc7d9868ee781ed4f2920f4f91d9f4ec2dc0db42f881414d96351b64506e89fc1a8154f886555c2f82a847d442714edea6350068d1fde6c9906
7
+ data.tar.gz: 28cd5445dde17a7b25f560161f301e176298b98c5e11e3fb909810a0623ea668be9785fb69ec1199106b814fc42578b8b32fe1d6e2ecee032e85c5d19c55b64f
data/Gemfile CHANGED
@@ -75,6 +75,8 @@ end
75
75
  group(:documentation, optional: true) do
76
76
  gem 'gettext-setup', '~> 1.0', require: false, platforms: [:ruby]
77
77
  gem 'ronn', '~> 0.7.3', require: false, platforms: [:ruby]
78
+ gem 'puppet-strings', require: false, platforms: [:ruby]
79
+ gem 'pandoc-ruby', require: false, platforms: [:ruby]
78
80
  end
79
81
 
80
82
  if File.exist? "#{__FILE__}.local"
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- puppet (8.8.1)
4
+ puppet (8.9.0)
5
5
  concurrent-ruby (~> 1.0)
6
6
  deep_merge (~> 1.0)
7
7
  facter (>= 4.3.0, < 5)
@@ -27,7 +27,7 @@ GEM
27
27
  base64 (0.2.0)
28
28
  bigdecimal (3.1.8)
29
29
  coderay (1.1.3)
30
- concurrent-ruby (1.3.3)
30
+ concurrent-ruby (1.3.4)
31
31
  crack (1.0.0)
32
32
  bigdecimal
33
33
  rexml
@@ -39,13 +39,13 @@ GEM
39
39
  rake (>= 12.0.0, < 14.0.0)
40
40
  docopt (0.6.1)
41
41
  erubi (1.13.0)
42
- facter (4.8.0)
42
+ facter (4.9.0)
43
43
  hocon (~> 1.3)
44
44
  thor (>= 1.0.1, < 1.3)
45
- faraday (2.10.0)
46
- faraday-net_http (>= 2.0, < 3.2)
45
+ faraday (2.11.0)
46
+ faraday-net_http (>= 2.0, < 3.4)
47
47
  logger
48
- faraday-net_http (3.1.0)
48
+ faraday-net_http (3.3.0)
49
49
  net-http
50
50
  fast_gettext (2.4.0)
51
51
  prime
@@ -62,22 +62,22 @@ GEM
62
62
  fast_gettext (~> 2.1)
63
63
  gettext (~> 3.4)
64
64
  locale
65
- google-apis-core (0.15.0)
65
+ google-apis-core (0.15.1)
66
66
  addressable (~> 2.5, >= 2.5.1)
67
67
  googleauth (~> 1.9)
68
- httpclient (>= 2.8.1, < 3.a)
68
+ httpclient (>= 2.8.3, < 3.a)
69
69
  mini_mime (~> 1.0)
70
+ mutex_m
70
71
  representable (~> 3.0)
71
72
  retriable (>= 2.0, < 4.a)
72
- rexml
73
73
  google-apis-iamcredentials_v1 (0.21.0)
74
74
  google-apis-core (>= 0.15.0, < 2.a)
75
- google-apis-storage_v1 (0.40.0)
75
+ google-apis-storage_v1 (0.44.0)
76
76
  google-apis-core (>= 0.15.0, < 2.a)
77
- google-cloud-core (1.7.0)
77
+ google-cloud-core (1.7.1)
78
78
  google-cloud-env (>= 1.0, < 3.a)
79
79
  google-cloud-errors (~> 1.0)
80
- google-cloud-env (2.1.1)
80
+ google-cloud-env (2.2.0)
81
81
  faraday (>= 1.0, < 3.a)
82
82
  google-cloud-errors (1.4.0)
83
83
  google-cloud-storage (1.52.0)
@@ -96,7 +96,7 @@ GEM
96
96
  multi_json (~> 1.11)
97
97
  os (>= 0.9, < 2.0)
98
98
  signet (>= 0.16, < 2.a)
99
- hashdiff (1.1.0)
99
+ hashdiff (1.1.1)
100
100
  hiera-eyaml (4.1.0)
101
101
  highline (~> 2.1)
102
102
  optimist (~> 3.1)
@@ -111,28 +111,32 @@ GEM
111
111
  base64
112
112
  language_server-protocol (3.17.0.3)
113
113
  locale (2.1.4)
114
- logger (1.6.0)
114
+ logger (1.6.1)
115
115
  memory_profiler (1.0.2)
116
116
  method_source (1.1.0)
117
117
  mini_mime (1.1.5)
118
- minitar (0.9)
118
+ minitar (0.12.1)
119
119
  msgpack (1.7.2)
120
120
  multi_json (1.15.0)
121
121
  mustache (1.1.1)
122
+ mutex_m (0.2.0)
122
123
  net-http (0.4.1)
123
124
  uri
124
125
  nkf (0.2.0)
125
126
  optimist (3.1.0)
126
127
  os (1.1.4)
127
- packaging (0.120.0)
128
+ packaging (0.122.0)
128
129
  artifactory (~> 3)
129
130
  csv (>= 3.1.5)
130
131
  google-cloud-storage
131
132
  googleauth
132
133
  rake (>= 12.3)
133
134
  release-metrics
134
- parallel (1.25.1)
135
- parser (3.3.4.0)
135
+ retriable (~> 3.1, >= 3.1.2)
136
+ rexml
137
+ pandoc-ruby (2.1.10)
138
+ parallel (1.26.3)
139
+ parser (3.3.5.0)
136
140
  ast (~> 2.4.1)
137
141
  racc
138
142
  prime (0.1.2)
@@ -144,6 +148,9 @@ GEM
144
148
  public_suffix (6.0.1)
145
149
  puppet-resource_api (1.9.0)
146
150
  hocon (>= 1.0)
151
+ puppet-strings (4.1.3)
152
+ rgen (~> 0.9)
153
+ yard (~> 0.9, < 0.9.37)
147
154
  puppetserver-ca (2.7.0)
148
155
  facter (>= 2.0.1, < 5)
149
156
  racc (1.5.2)
@@ -160,8 +167,8 @@ GEM
160
167
  trailblazer-option (>= 0.1.1, < 0.2.0)
161
168
  uber (< 0.2.0)
162
169
  retriable (3.1.2)
163
- rexml (3.3.2)
164
- strscan
170
+ rexml (3.3.7)
171
+ rgen (0.9.1)
165
172
  ronn (0.7.3)
166
173
  hpricot (>= 0.8.2)
167
174
  mustache (>= 0.7.0)
@@ -170,9 +177,9 @@ GEM
170
177
  rspec-core (~> 3.13.0)
171
178
  rspec-expectations (~> 3.13.0)
172
179
  rspec-mocks (~> 3.13.0)
173
- rspec-core (3.13.0)
180
+ rspec-core (3.13.1)
174
181
  rspec-support (~> 3.13.0)
175
- rspec-expectations (3.13.1)
182
+ rspec-expectations (3.13.2)
176
183
  diff-lcs (>= 1.2.0, < 2.0)
177
184
  rspec-support (~> 3.13.0)
178
185
  rspec-its (1.3.0)
@@ -182,18 +189,17 @@ GEM
182
189
  diff-lcs (>= 1.2.0, < 2.0)
183
190
  rspec-support (~> 3.13.0)
184
191
  rspec-support (3.13.1)
185
- rubocop (1.65.0)
192
+ rubocop (1.66.1)
186
193
  json (~> 2.3)
187
194
  language_server-protocol (>= 3.17.0)
188
195
  parallel (~> 1.10)
189
196
  parser (>= 3.3.0.2)
190
197
  rainbow (>= 2.2.2, < 4.0)
191
198
  regexp_parser (>= 2.4, < 3.0)
192
- rexml (>= 3.2.5, < 4.0)
193
- rubocop-ast (>= 1.31.1, < 2.0)
199
+ rubocop-ast (>= 1.32.2, < 2.0)
194
200
  ruby-progressbar (~> 1.7)
195
201
  unicode-display_width (>= 2.4.0, < 3.0)
196
- rubocop-ast (1.31.3)
202
+ rubocop-ast (1.32.3)
197
203
  parser (>= 3.3.1.0)
198
204
  rubocop-capybara (2.21.0)
199
205
  rubocop (~> 1.41)
@@ -223,15 +229,15 @@ GEM
223
229
  jwt (>= 1.5, < 3.0)
224
230
  multi_json (~> 1.10)
225
231
  singleton (0.2.0)
226
- strscan (3.1.0)
227
232
  syslog (0.1.2)
228
233
  text (1.3.1)
229
234
  thor (1.2.2)
230
235
  trailblazer-option (0.1.2)
231
236
  uber (0.1.0)
232
237
  unicode-display_width (2.5.0)
233
- uri (0.13.0)
234
- vcr (6.2.0)
238
+ uri (0.13.1)
239
+ vcr (6.3.1)
240
+ base64
235
241
  webmock (3.23.1)
236
242
  addressable (>= 2.8.0)
237
243
  crack (>= 0.3.2)
@@ -255,9 +261,11 @@ DEPENDENCIES
255
261
  minitar (~> 0.9)
256
262
  msgpack (~> 1.2)
257
263
  packaging (~> 0.113)
264
+ pandoc-ruby
258
265
  pry
259
266
  puppet!
260
267
  puppet-resource_api (~> 1.5)
268
+ puppet-strings
261
269
  puppetserver-ca (~> 2.0)
262
270
  racc (= 1.5.2)
263
271
  rake (~> 13.0)
@@ -6,3 +6,15 @@ gem_rdoc_options:
6
6
  - --main
7
7
  - README.md
8
8
  - --line-numbers
9
+ # Array of files to include when building source tarballs
10
+ files:
11
+ - '[A-Z]*'
12
+ - install.rb
13
+ - bin
14
+ - lib
15
+ - conf
16
+ - man
17
+ - examples
18
+ - ext
19
+ - tasks
20
+ - locales
data/install.rb CHANGED
@@ -36,14 +36,6 @@ require 'tempfile'
36
36
  require 'optparse'
37
37
  require 'ostruct'
38
38
 
39
- begin
40
- require 'rdoc/rdoc'
41
- $haverdoc = true
42
- rescue LoadError
43
- puts "Missing rdoc; skipping documentation"
44
- $haverdoc = false
45
- end
46
-
47
39
  PREREQS = %w{openssl facter cgi}
48
40
  MIN_FACTER_VERSION = 1.5
49
41
 
@@ -140,25 +132,9 @@ def prepare_installation
140
132
  InstallOptions.check_prereqs = true
141
133
  InstallOptions.batch_files = true
142
134
 
143
- # Only try to do docs if we're sure they have rdoc
144
- if $haverdoc
145
- InstallOptions.rdoc = true
146
- InstallOptions.ri = true
147
- else
148
- InstallOptions.rdoc = false
149
- InstallOptions.ri = false
150
- end
151
-
152
-
153
135
  ARGV.options do |opts|
154
136
  opts.banner = "Usage: #{File.basename($0)} [options]"
155
137
  opts.separator ""
156
- opts.on('--[no-]rdoc', 'Prevents the creation of RDoc output.', 'Default on.') do |onrdoc|
157
- InstallOptions.rdoc = onrdoc
158
- end
159
- opts.on('--[no-]ri', 'Prevents the creation of RI output.', 'Default off on mswin32.') do |onri|
160
- InstallOptions.ri = onri
161
- end
162
138
  opts.on('--[no-]configs', 'Prevents the installation of config files', 'Default off.') do |ontest|
163
139
  InstallOptions.configs = ontest
164
140
  end
@@ -205,14 +181,8 @@ def prepare_installation
205
181
  InstallOptions.batch_files = false
206
182
  end
207
183
  opts.on('--quick', 'Performs a quick installation. Only the', 'installation is done.') do |quick|
208
- InstallOptions.rdoc = false
209
- InstallOptions.ri = false
210
- InstallOptions.configs = true
211
- end
212
- opts.on('--full', 'Performs a full installation. All', 'optional installation steps are run.') do |full|
213
- InstallOptions.rdoc = true
214
- InstallOptions.ri = true
215
184
  InstallOptions.configs = true
185
+ warn "--quick is deprecated. Use --configs"
216
186
  end
217
187
  opts.separator("")
218
188
  opts.on_tail('--help', "Shows this help text.") do
@@ -223,9 +193,6 @@ def prepare_installation
223
193
  opts.parse!
224
194
  end
225
195
 
226
- version = [RbConfig::CONFIG["MAJOR"], RbConfig::CONFIG["MINOR"]].join(".")
227
- libdir = File.join(RbConfig::CONFIG["libdir"], "ruby", version)
228
-
229
196
  # Mac OS X 10.5 and higher declare bindir
230
197
  # /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin
231
198
  # which is not generally where people expect executables to be installed
@@ -312,7 +279,8 @@ def prepare_installation
312
279
  if sitelibdir.nil?
313
280
  sitelibdir = $LOAD_PATH.find { |x| x =~ /site_ruby/ }
314
281
  if sitelibdir.nil?
315
- sitelibdir = File.join(libdir, "site_ruby")
282
+ version = [RbConfig::CONFIG["MAJOR"], RbConfig::CONFIG["MINOR"]].join(".")
283
+ sitelibdir = File.join(RbConfig::CONFIG["libdir"], "ruby", version, "site_ruby")
316
284
  elsif sitelibdir !~ Regexp.quote(version)
317
285
  sitelibdir = File.join(sitelibdir, version)
318
286
  end
@@ -328,10 +296,6 @@ def prepare_installation
328
296
  # This is the new way forward
329
297
  if not InstallOptions.destdir.nil?
330
298
  destdir = InstallOptions.destdir
331
- # To be deprecated once people move over to using --destdir option
332
- elsif not ENV['DESTDIR'].nil?
333
- destdir = ENV['DESTDIR']
334
- warn "DESTDIR is deprecated. Use --destdir instead."
335
299
  else
336
300
  destdir = ''
337
301
  end
@@ -362,7 +326,6 @@ def prepare_installation
362
326
  InstallOptions.codedir = codedir
363
327
  InstallOptions.config_dir = configdir
364
328
  InstallOptions.bin_dir = bindir
365
- InstallOptions.lib_dir = libdir
366
329
  InstallOptions.man_dir = mandir
367
330
  InstallOptions.var_dir = vardir
368
331
  InstallOptions.public_dir = publicdir
@@ -381,36 +344,6 @@ def join(basedir, dir)
381
344
  "#{basedir}#{dir}"
382
345
  end
383
346
 
384
- ##
385
- # Build the rdoc documentation. Also, try to build the RI documentation.
386
- #
387
- def build_rdoc(files)
388
- return unless $haverdoc
389
- begin
390
- r = RDoc::RDoc.new
391
- r.document(["--main", "README", "--title", "Puppet -- Site Configuration Management", "--line-numbers"] + files)
392
- rescue RDoc::RDocError => e
393
- $stderr.puts e.message
394
- rescue Exception => e
395
- $stderr.puts "Couldn't build RDoc documentation\n#{e.message}"
396
- end
397
- end
398
-
399
- def build_ri(files)
400
- return unless $haverdoc
401
- return if $osname == "windows"
402
- begin
403
- ri = RDoc::RDoc.new
404
- #ri.document(["--ri-site", "--merge"] + files)
405
- ri.document(["--ri-site"] + files)
406
- rescue RDoc::RDocError => e
407
- $stderr.puts e.message
408
- rescue Exception => e
409
- $stderr.puts "Couldn't build Ri documentation\n#{e.message}"
410
- $stderr.puts "Continuing with install..."
411
- end
412
- end
413
-
414
347
  ##
415
348
  # Install file(s) from ./bin to RbConfig::CONFIG['bindir']. Patch it on the way
416
349
  # to insert a #! line; on a Unix install, the command is named as expected
@@ -476,8 +409,6 @@ FileUtils.cd File.dirname(__FILE__) do
476
409
  # Set these values to what you want installed.
477
410
  configs = glob(%w{conf/puppet.conf conf/hiera.yaml})
478
411
  bins = glob(%w{bin/*})
479
- #rdoc = glob(%w{bin/* lib/**/*.rb README* }).reject { |e| e=~ /\.(bat|cmd)$/ }
480
- #ri = glob(%w{bin/*.rb lib/**/*.rb}).reject { |e| e=~ /\.(bat|cmd)$/ }
481
412
  man = glob(%w{man/man[0-9]/*})
482
413
  libs = glob(%w{lib/**/*})
483
414
  locales = glob(%w{locales/**/*})
@@ -488,8 +419,6 @@ FileUtils.cd File.dirname(__FILE__) do
488
419
  windows_bins = glob(%w{ext/windows/*bat})
489
420
  end
490
421
 
491
- #build_rdoc(rdoc) if InstallOptions.rdoc
492
- #build_ri(ri) if InstallOptions.ri
493
422
  do_configs(configs, InstallOptions.config_dir) if InstallOptions.configs
494
423
  do_bins(bins, InstallOptions.bin_dir)
495
424
  do_bins(windows_bins, InstallOptions.bin_dir, 'ext/windows/') if $osname == "windows" && InstallOptions.batch_files
@@ -153,6 +153,7 @@ class Puppet::Application::Apply < Puppet::Application
153
153
 
154
154
  EXAMPLE
155
155
  -------
156
+ $ puppet apply -e 'notify { "hello world": }'
156
157
  $ puppet apply -l /tmp/manifest.log manifest.pp
157
158
  $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
158
159
  $ puppet apply --catalog catalog.json
@@ -76,10 +76,11 @@ class Puppet::Application::Filebucket < Puppet::Application
76
76
  use your local file bucket by specifying '--local', or by specifying
77
77
  '--bucket' with a local path.
78
78
 
79
- > **Note**: Enabling and using the backup option, and by extension the
80
- filebucket resource, requires appropriate planning and management to ensure
81
- that sufficient disk space is available for the file backups. Generally, you
82
- can implement this using one of the following two options:
79
+ **Important**: When you enable and use the backup option, and by extension
80
+ the filebucket resource, you must ensure that sufficient disk space is
81
+ available for the file backups. Generally, you can provide the disk space
82
+ by using one of the following two options:
83
+
83
84
  - Use a `find` command and `crontab` entry to retain only the last X days
84
85
  of file backups. For example:
85
86
 
@@ -187,6 +188,7 @@ class Puppet::Application::Filebucket < Puppet::Application
187
188
 
188
189
  $ puppet filebucket -l -t "2015-05-11 09:30:00" list
189
190
  d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile
191
+
190
192
  ## Manage files in a specific local filebucket
191
193
  $ puppet filebucket -b /tmp/TestBucket backup /tmp/TestFile2
192
194
  /tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
@@ -57,13 +57,13 @@ class Puppet::Application::Ssl < Puppet::Application
57
57
  * submit_request:
58
58
  Generate a certificate signing request (CSR) and submit it to the CA. If
59
59
  a private and public key pair already exist, they will be used to generate
60
- the CSR. Otherwise a new key pair will be generated. If a CSR has already
60
+ the CSR. Otherwise, a new key pair will be generated. If a CSR has already
61
61
  been submitted with the given `certname`, then the operation will fail.
62
62
 
63
63
  * generate_request:
64
- Generate a certificate signing request (CSR). If
65
- a private and public key pair already exist, they will be used to generate
66
- the CSR. Otherwise a new key pair will be generated.
64
+ Generate a certificate signing request (CSR). If a private and public key
65
+ pair exist, they will be used to generate the CSR. Otherwise a new key
66
+ pair will be generated.
67
67
 
68
68
  * download_cert:
69
69
  Download a certificate for this host. If the current private key matches
@@ -7,6 +7,7 @@ module Puppet
7
7
  '-u'
8
8
  end
9
9
 
10
+ # If you modify this, update puppet/type/file/checksum.rb too
10
11
  def self.default_digest_algorithm
11
12
  'sha256'
12
13
  end
@@ -161,8 +162,8 @@ module Puppet
161
162
  :skip_logging_catalog_request_destination => {
162
163
  :default => false,
163
164
  :type => :boolean,
164
- :desc => "If you wish to suppress the notice of which compiler supplied the
165
- catalog",
165
+ :desc => "Specifies whether to suppress the notice of which compiler
166
+ supplied the catalog. A value of `true` suppresses the notice.",
166
167
  },
167
168
  :merge_dependency_warnings => {
168
169
  :default => false,
@@ -417,13 +418,15 @@ module Puppet
417
418
  :type => :boolean,
418
419
  :default => true,
419
420
  :desc => <<-'EOT'
420
- When versioned_environment_dirs is `true` Puppet will readlink the environmentpath
421
- when constructing the environment's modulepath. The full readlinked path is referred
422
- to as the "resolved path" and the configured path potentially containing symlinks is
423
- the "configured path". When reporting where resources come from users may choose
424
- between the configured or resolved path.
425
-
426
- When set to false, the resolved paths are reported instead of the configured paths.
421
+ Specifies how environment paths are reported. When the value of
422
+ `versioned_environment_dirs` is `true`, Puppet applies the readlink function to
423
+ the `environmentpath` setting when constructing the environment's modulepath. The
424
+ full readlinked path is referred to as the "resolved path," and the configured
425
+ path potentially containing symlinks is the "configured path." When reporting
426
+ where resources come from, users may choose between the configured and resolved
427
+ path.
428
+
429
+ When set to `false`, the resolved paths are reported instead of the configured paths.
427
430
  EOT
428
431
  },
429
432
  :use_last_environment => {
@@ -1204,17 +1207,18 @@ EOT
1204
1207
  :ca_refresh_interval => {
1205
1208
  :default => "1d",
1206
1209
  :type => :duration,
1207
- :desc => "How often the Puppet agent refreshes its local CA certs. By
1208
- default the CA certs are refreshed once every 24 hours. If a different
1209
- duration is specified, then the agent will refresh its CA certs whenever
1210
- it next runs and the elapsed time since the certs were last refreshed
1211
- exceeds the duration.
1212
-
1213
- In general, the duration should be greater than the `runinterval`.
1214
- Setting it to 0 or an equal or lesser value than `runinterval`,
1215
- will cause the CA certs to be refreshed on every run.
1216
-
1217
- If the agent downloads new CA certs, the agent will use it for subsequent
1210
+ :desc => "How often the Puppet agent refreshes its local CA
1211
+ certificates. By default, CA certificates are refreshed every 24 hours. If a
1212
+ different interval is specified, the agent refreshes its CA certificates during
1213
+ the next agent run if the elapsed time since the certificates were last
1214
+ refreshed exceeds the specified duration.
1215
+
1216
+ In general, the interval should be greater than the `runinterval`
1217
+ value. Setting the `ca_refresh_interval` value to 0 or an equal or
1218
+ lesser value than `runinterval` causes the CA certificates to be
1219
+ refreshed on every run.
1220
+
1221
+ If the agent downloads new CA certs, the agent uses those for subsequent
1218
1222
  network requests. If the refresh request fails or if the CA certs are
1219
1223
  unchanged on the server, then the agent run will continue using the
1220
1224
  local CA certs it already has. #{AS_DURATION}",
@@ -1222,15 +1226,15 @@ EOT
1222
1226
  :crl_refresh_interval => {
1223
1227
  :default => "1d",
1224
1228
  :type => :duration,
1225
- :desc => "How often the Puppet agent refreshes its local CRL. By
1226
- default the CRL is refreshed once every 24 hours. If a different
1227
- duration is specified, then the agent will refresh its CRL whenever
1228
- it next runs and the elapsed time since the CRL was last refreshed
1229
- exceeds the duration.
1229
+ :desc => "How often the Puppet agent refreshes its local Certificate
1230
+ Revocation List (CRL). By default, the CRL is refreshed every 24 hours. If
1231
+ a different interval is specified, the agent refreshes its CRL on the next
1232
+ Puppet agent run if the elapsed time since the CRL was last refreshed
1233
+ exceeds the specified interval.
1230
1234
 
1231
- In general, the duration should be greater than the `runinterval`.
1232
- Setting it to 0 or an equal or lesser value than `runinterval`,
1233
- will cause the CRL to be refreshed on every run.
1235
+ In general, the interval should be greater than the `runinterval` value.
1236
+ Setting the `crl_refresh_interval` value to 0 or an equal or lesser value
1237
+ than `runinterval` causes the CRL to be refreshed on every run.
1234
1238
 
1235
1239
  If the agent downloads a new CRL, the agent will use it for subsequent
1236
1240
  network requests. If the refresh request fails or if the CRL is
@@ -1240,18 +1244,19 @@ EOT
1240
1244
  :hostcert_renewal_interval => {
1241
1245
  :default => "30d",
1242
1246
  :type => :duration,
1243
- :desc => "When the Puppet agent refreshes its client certificate.
1244
- By default the client certificate will refresh 30 days before the certificate
1245
- expires. If a different duration is specified, then the agent will refresh its
1246
- client certificate whenever it next runs and if the client certificate expires
1247
- within the duration specified.
1247
+ :desc => "How often the Puppet agent renews its client certificate. By
1248
+ default, the client certificate is renewed 30 days before the certificate
1249
+ expires. If a different interval is specified, the agent renews its client
1250
+ certificate during the next agent run, assuming that the client certificate has
1251
+ expired within the specified duration.
1248
1252
 
1249
- In general, the duration should be greater than the `runinterval`.
1250
- Setting it to 0 will disable automatic renewal.
1253
+ In general, the `hostcert_renewal_interval` value should be greater than the
1254
+ `runinterval` value. Setting the `hostcert_renewal_interval` value to 0 disables
1255
+ automatic renewal.
1251
1256
 
1252
- If the agent downloads a new certificate, the agent will use it for subsequent
1253
- network requests. If the refresh request fails, then the agent run will continue using the
1254
- certificate it already has. #{AS_DURATION}",
1257
+ If the agent downloads a new certificate, the agent will use it
1258
+ for subsequent network requests. If the refresh request fails, the agent run
1259
+ continues to use its existing certificate. #{AS_DURATION}",
1255
1260
  },
1256
1261
  :keylength => {
1257
1262
  :default => 4096,
@@ -1492,8 +1497,10 @@ EOT
1492
1497
  :exclude_unchanged_resources => {
1493
1498
  :default => true,
1494
1499
  :type => :boolean,
1495
- :desc => 'When set to true, resources that have had no changes after catalog application
1496
- will not have corresponding unchanged resource status updates listed in the report.'
1500
+ :desc => "Specifies how unchanged resources are listed in reports. When
1501
+ set to `true`, resources that have had no changes after catalog application
1502
+ will not have corresponding unchanged resource status updates listed in a
1503
+ report."
1497
1504
  },
1498
1505
  :reportdir => {
1499
1506
  :default => "$vardir/reports",
@@ -1745,11 +1752,12 @@ EOT
1745
1752
  :allow_pson_serialization => {
1746
1753
  :default => false,
1747
1754
  :type => :boolean,
1748
- :desc => "Whether when unable to serialize to JSON or other formats,
1749
- Puppet falls back to PSON. This option affects both puppetserver's
1750
- configuration management service responses and when the agent saves its
1751
- cached catalog. This option is useful in preventing the loss of data because
1752
- rich data cannot be serialized via PSON.",
1755
+ :desc => "Whether to allow PSON serialization. When unable to serialize to
1756
+ JSON or other formats, Puppet falls back to PSON. This option affects the
1757
+ configuration management service responses of Puppet Server and the process by
1758
+ which the agent saves its cached catalog. With a default value of `false`, this
1759
+ option is useful in preventing the loss of data because rich data cannot be
1760
+ serialized via PSON.",
1753
1761
  },
1754
1762
  :agent_catalog_run_lockfile => {
1755
1763
  :default => "$statedir/agent_catalog_run.lock",
@@ -1775,7 +1783,7 @@ EOT
1775
1783
  :type => :boolean,
1776
1784
  :default => false,
1777
1785
  :desc => "Whether to include legacy facts when requesting a catalog. This
1778
- option can be set to false provided all puppet manifests, hiera.yaml and hiera
1786
+ option can be set to `false` if all puppet manifests, hiera.yaml, and hiera
1779
1787
  configuration layers no longer access legacy facts, such as `$osfamily`, and
1780
1788
  instead access structured facts, such as `$facts['os']['family']`."
1781
1789
  },
@@ -2091,12 +2099,12 @@ EOT
2091
2099
  :preprocess_deferred => {
2092
2100
  :default => false,
2093
2101
  :type => :boolean,
2094
- :desc => "Whether puppet should call deferred functions before applying
2095
- the catalog. If set to `true`, then all prerequisites needed for the
2096
- deferred function must be satisfied prior to puppet running. If set to
2097
- `false`, then deferred functions will follow puppet relationships and
2098
- ordering. This allows puppet to install prerequisites needed for a
2099
- deferred function and call the deferred function in the same run."
2102
+ :desc => "Whether Puppet should call deferred functions before applying
2103
+ the catalog. If set to `true`, all prerequisites required for the
2104
+ deferred function must be satisfied before the Puppet run. If set to
2105
+ `false`, deferred functions follow Puppet relationships and
2106
+ ordering. In this way, Puppet can install the prerequisites required for a
2107
+ deferred function and call the deferred function in the same run.",
2100
2108
  },
2101
2109
  :summarize => {
2102
2110
  :default => false,
@@ -2118,10 +2126,12 @@ EOT
2118
2126
  can produce node information. The command must:
2119
2127
 
2120
2128
  * Take the name of a node as a command-line argument.
2129
+
2121
2130
  * Return a YAML hash with up to three keys:
2122
2131
  * `classes` --- A list of classes, as an array or hash.
2123
2132
  * `environment` --- A string.
2124
2133
  * `parameters` --- A list of top-scope variables to set, as a hash.
2134
+
2125
2135
  * For unknown nodes, exit with a non-zero exit code.
2126
2136
 
2127
2137
  Generally, an ENC script makes requests to an external data source.