Class: Bolt::Config

Inherits:
Object
  • Object
show all
Includes:
Options
Defined in:
lib/bolt/config.rb,
lib/bolt/config/options.rb,
lib/bolt/config/modulepath.rb,
lib/bolt/config/transport/ssh.rb,
lib/bolt/config/transport/base.rb,
lib/bolt/config/transport/orch.rb,
lib/bolt/config/transport/local.rb,
lib/bolt/config/transport/winrm.rb,
lib/bolt/config/transport/docker.rb,
lib/bolt/config/transport/remote.rb,
lib/bolt/config/transport/options.rb

Defined Under Namespace

Modules: Options, Transport Classes: Modulepath

Constant Summary collapse

BOLT_CONFIG_NAME = 
'bolt.yaml'
BOLT_DEFAULTS_NAME = 
'bolt-defaults.yaml'
DEFAULT_DEFAULT_CONCURRENCY =

The default concurrency value that is used when the ulimit is not low (i.e. < 700)

100

Constants included from Options

Options::BOLT_DEFAULTS_OPTIONS, Options::BOLT_OPTIONS, Options::BOLT_PROJECT_OPTIONS, Options::INVENTORY_OPTIONS, Options::OPTIONS, Options::PLUGIN, Options::TRANSPORT_CONFIG

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(project, config_data, overrides = {}) ⇒ Config

Returns a new instance of Config.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/bolt/config.rb', line 193

def initialize(project, config_data, overrides = {})
  unless config_data.is_a?(Array)
    config_data = [{ filepath: project.config_file,
                     data: config_data,
                     logs: [],
                     deprecations: [] }]
  end

  @logger       = Bolt::Logger.logger(self)
  @project      = project
  @logs         = @project.logs.dup
  @deprecations = @project.deprecations.dup
  @transports   = {}
  @config_files = []

  default_data = {
    'apply_settings'      => {},
    'color'               => true,
    'compile-concurrency' => Etc.nprocessors,
    'concurrency'         => default_concurrency,
    'format'              => 'human',
    'log'                 => { 'console' => {} },
    'plugin_hooks'        => {},
    'plugins'             => {},
    'puppetdb'            => {},
    'puppetfile'          => {},
    'save-rerun'          => true,
    'transport'           => 'ssh'
  }

  if project.path.directory?
    default_data['log']['bolt-debug.log'] = {
      'level' => 'debug',
      'append' => false
    }
  end

  loaded_data = config_data.each_with_object([]) do |data, acc|
    @logs.concat(data[:logs]) if data[:logs].any?
    @deprecations.concat(data[:deprecations]) if data[:deprecations].any?

    if data[:data].any?
      @config_files.push(data[:filepath])
      acc.push(data[:data])
    end
  end

  override_data = normalize_overrides(overrides)

  # If we need to lower concurrency and concurrency is not configured
  ld_concurrency = loaded_data.map(&:keys).flatten.include?('concurrency')
  @modified_concurrency = default_concurrency != DEFAULT_DEFAULT_CONCURRENCY &&
                          !ld_concurrency &&
                          !override_data.key?('concurrency')

  @data = merge_config_layers(default_data, *loaded_data, override_data)

  TRANSPORT_CONFIG.each do |transport, config|
    @transports[transport] = config.new(@data.delete(transport), @project.path)
  end

  finalize_data
  validate
end

Instance Attribute Details

#config_files ⇒ Object (readonly)

Returns the value of attribute config_files.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def config_files
  @config_files
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def data
  @data
end

#deprecations ⇒ Object (readonly)

Returns the value of attribute deprecations.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def deprecations
  @deprecations
end

#logs ⇒ Object (readonly)

Returns the value of attribute logs.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def logs
  @logs
end

#modified_concurrency ⇒ Object (readonly)

Returns the value of attribute modified_concurrency.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def modified_concurrency
  @modified_concurrency
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def project
  @project
end

#transports ⇒ Object (readonly)

Returns the value of attribute transports.



22
23
24
 
# File 'lib/bolt/config.rb', line 22

def transports
  @transports
end

Class Method Details

.default ⇒ Object 



30
31
32
 
# File 'lib/bolt/config.rb', line 30

def self.default
  new(Bolt::Project.default_project, {})
end

.from_file(configfile, overrides = {}) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/bolt/config.rb', line 54

def self.from_file(configfile, overrides = {})
  project = Bolt::Project.create_project(Pathname.new(configfile).expand_path.dirname)
  logs = []

  conf = if project.project_file == project.config_file
           project.data
         else
           c = Bolt::Util.read_yaml_hash(configfile, 'config')
           logs << { debug: "Loaded configuration from #{configfile}" }
           c
         end

  data = load_defaults(project).push(
    filepath: configfile,
    data: conf,
    logs: logs,
    deprecations: []
  )

  new(project, data, overrides)
end

.from_project(project, overrides = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/bolt/config.rb', line 34

def self.from_project(project, overrides = {})
  logs = []
  conf = if project.project_file == project.config_file
           project.data
         else
           c = Bolt::Util.read_optional_yaml_hash(project.config_file, 'config')
           logs << { debug: "Loaded configuration from #{project.config_file}" } if File.exist?(project.config_file)
           c
         end

  data = load_defaults(project).push(
    filepath: project.config_file,
    data: conf,
    logs: logs,
    deprecations: []
  )

  new(project, data, overrides)
end

.load_bolt_defaults_yaml(dir) ⇒ Object

Loads a ‘bolt-defaults.yaml’ file, which contains default configuration that applies to all projects. This file does not allow project-specific configuration such as ‘hiera-config’ and ‘inventoryfile’, and nests all default inventory configuration under an ‘inventory-config’ key.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bolt/config.rb', line 96

def self.load_bolt_defaults_yaml(dir)
  filepath = dir + BOLT_DEFAULTS_NAME
  data     = Bolt::Util.read_yaml_hash(filepath, 'config')
  logs     = [{ debug: "Loaded configuration from #{filepath}" }]

  # Warn if 'bolt.yaml' detected in same directory.
  if File.exist?(bolt_yaml = dir + BOLT_CONFIG_NAME)
    logs.push(
      warn: "Detected multiple configuration files: ['#{bolt_yaml}', '#{filepath}']. '#{bolt_yaml}' "\
      "will be ignored."
    )
  end

  # Remove project-specific config such as hiera-config, etc.
  project_config = data.slice(*(BOLT_PROJECT_OPTIONS - BOLT_DEFAULTS_OPTIONS))

  if project_config.any?
    data.reject! { |key, _| project_config.include?(key) }
    logs.push(
      warn: "Unsupported project configuration detected in '#{filepath}': #{project_config.keys}. "\
      "Project configuration should be set in 'bolt-project.yaml'."
    )
  end

  # Remove top-level transport config such as transport, ssh, etc.
  transport_config = data.slice(*INVENTORY_OPTIONS.keys)

  if transport_config.any?
    data.reject! { |key, _| transport_config.include?(key) }
    logs.push(
      warn: "Unsupported inventory configuration detected in '#{filepath}': #{transport_config.keys}. "\
      "Transport configuration should be set under the 'inventory-config' option or "\
      "in 'inventory.yaml'."
    )
  end

  # Move data under inventory-config to top-level so it can be easily merged with
  # config from other sources. Error early if inventory-config is not a hash or
  # has a plugin reference.
  if data.key?('inventory-config')
    unless data['inventory-config'].is_a?(Hash)
      raise Bolt::ValidationError,
            "Option 'inventory-config' must be of type Hash, received #{data['inventory-config']} "\
            "#{data['inventory-config']} (file: #{filepath})"
    end

    if data['inventory-config'].key?('_plugin')
      raise Bolt::ValidationError,
            "Found unsupported key '_plugin' for option 'inventory-config'; supported keys are "\
            "'#{INVENTORY_OPTIONS.keys.join("', '")}' (file: #{filepath})"
    end

    data = data.merge(data.delete('inventory-config'))
  end

  { filepath: filepath, data: data, logs: logs, deprecations: [] }
end

.load_bolt_yaml(dir) ⇒ Object

Loads a ‘bolt.yaml’ file, the legacy configuration file. There’s no special munging needed here since Bolt::Config will just ignore any invalid keys.



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/bolt/config.rb', line 156

def self.load_bolt_yaml(dir)
  filepath = dir + BOLT_CONFIG_NAME
  data     = Bolt::Util.read_yaml_hash(filepath, 'config')
  logs     = [{ debug: "Loaded configuration from #{filepath}" }]
  deprecations = [{ type: 'Using bolt.yaml for system configuration',
                    msg: "Configuration file #{filepath} is deprecated and will be removed in a future version "\
                    "of Bolt. Use '#{dir + BOLT_DEFAULTS_NAME}' instead." }]

  { filepath: filepath, data: data, logs: logs, deprecations: deprecations }
end

.load_defaults(project) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/bolt/config.rb', line 167

def self.load_defaults(project)
  confs = []

  # Load system-level config. Prefer a 'bolt-defaults.yaml' file, but fall back to the
  # legacy 'bolt.yaml' file. If the project-level config file is also the system-level
  # config file, don't load it a second time.
  if File.exist?(system_path + BOLT_DEFAULTS_NAME)
    confs << load_bolt_defaults_yaml(system_path)
  elsif File.exist?(system_path + BOLT_CONFIG_NAME) &&
        (system_path + BOLT_CONFIG_NAME) != project.config_file
    confs << load_bolt_yaml(system_path)
  end

  # Load user-level config if there is a homedir. Prefer a 'bolt-defaults.yaml' file, but
  # fall back to the legacy 'bolt.yaml' file.
  if user_path
    if File.exist?(user_path + BOLT_DEFAULTS_NAME)
      confs << load_bolt_defaults_yaml(user_path)
    elsif File.exist?(user_path + BOLT_CONFIG_NAME)
      confs << load_bolt_yaml(user_path)
    end
  end

  confs
end

.system_path ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bolt/config.rb', line 76

def self.system_path
  # Lazy-load expensive gem code
  require 'win32/dir' if Bolt::Util.windows?

  if Bolt::Util.windows?
    Pathname.new(File.join(Dir::COMMON_APPDATA, 'PuppetLabs', 'bolt', 'etc'))
  else
    Pathname.new(File.join('/etc', 'puppetlabs', 'bolt'))
  end
end

.user_path ⇒ Object 



87
88
89
90
91
 
# File 'lib/bolt/config.rb', line 87

def self.user_path
  Pathname.new(File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt')))
rescue StandardError
  nil
end

Instance Method Details

#apply_settings ⇒ Object 



523
524
525
 
# File 'lib/bolt/config.rb', line 523

def apply_settings
  @data['apply_settings']
end

#check_path_case(type, paths) ⇒ Object

Check if there is a case-insensitive match to the path



532
533
534
535
536
537
538
539
540
541
 
# File 'lib/bolt/config.rb', line 532

def check_path_case(type, paths)
  return if paths.nil?
  matches = matching_paths(paths)

  if matches.any?
    msg = "WARNING: Bolt is case sensitive when specifying a #{type}. Did you mean:\n"
    matches.each { |path| msg += "         #{path}\n" }
    @logger.warn msg
  end
end

#color ⇒ Object 



491
492
493
 
# File 'lib/bolt/config.rb', line 491

def color
  @data['color']
end

#compile_concurrency ⇒ Object 



503
504
505
 
# File 'lib/bolt/config.rb', line 503

def compile_concurrency
  @data['compile-concurrency']
end

#concurrency ⇒ Object 



467
468
469
 
# File 'lib/bolt/config.rb', line 467

def concurrency
  @data['concurrency']
end

#deep_clone ⇒ Object 



309
310
311
 
# File 'lib/bolt/config.rb', line 309

def deep_clone
  Bolt::Util.deep_clone(self)
end

#default_concurrency ⇒ Object 



559
560
561
562
563
564
565
 
# File 'lib/bolt/config.rb', line 559

def default_concurrency
  @default_concurrency ||= if !sc_open_max_available? || Etc.sysconf(Etc::SC_OPEN_MAX) >= 300
                             DEFAULT_DEFAULT_CONCURRENCY
                           else
                             Etc.sysconf(Etc::SC_OPEN_MAX) / 7
                           end
end

#default_inventoryfile ⇒ Object 



437
438
439
 
# File 'lib/bolt/config.rb', line 437

def default_inventoryfile
  @project.inventory_file
end

#format ⇒ Object 



471
472
473
 
# File 'lib/bolt/config.rb', line 471

def format
  @data['format']
end

#format=(value) ⇒ Object 



475
476
477
 
# File 'lib/bolt/config.rb', line 475

def format=(value)
  @data['format'] = value
end

#hiera_config ⇒ Object 



445
446
447
 
# File 'lib/bolt/config.rb', line 445

def hiera_config
  @data['hiera-config'] || @project.hiera_config
end

#inventoryfile ⇒ Object 



499
500
501
 
# File 'lib/bolt/config.rb', line 499

def inventoryfile
  @data['inventoryfile']
end

#log ⇒ Object 



483
484
485
 
# File 'lib/bolt/config.rb', line 483

def log
  @data['log']
end

#matching_paths(paths) ⇒ Object 



543
544
545
 
# File 'lib/bolt/config.rb', line 543

def matching_paths(paths)
  Array(paths).map { |p| Dir.glob([p, casefold(p)]) }.flatten.uniq.reject { |p| Array(paths).include?(p) }
end

#merge_config_layers(*config_data) ⇒ Object

Merge configuration from all sources into a single hash. Precedence from lowest to highest: defaults, system-wide, user-level, project-level, CLI overrides



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/bolt/config.rb', line 288

def merge_config_layers(*config_data)
  config_data.inject({}) do |acc, config|
    acc.merge(config) do |key, val1, val2|
      case key
      # Plugin config is shallow merged for each plugin
      when 'plugins'
        val1.merge(val2) { |_, v1, v2| v1.merge(v2) }
      # Transports are deep merged
      when *TRANSPORT_CONFIG.keys
        Bolt::Util.deep_merge(val1, val2)
      # Hash values are shallow merged
      when 'puppetdb', 'plugin_hooks', 'apply_settings', 'log'
        val1.merge(val2)
      # All other values are overwritten
      else
        val2
      end
    end
  end
end

#modulepath ⇒ Object 



453
454
455
456
457
458
459
460
461
 
# File 'lib/bolt/config.rb', line 453

def modulepath
  path = @data['modulepath'] || @project.modulepath

  if @project.modules
    path + [@project.managed_moduledir.to_s]
  else
    path
  end
end

#modulepath=(value) ⇒ Object 



463
464
465
 
# File 'lib/bolt/config.rb', line 463

def modulepath=(value)
  @data['modulepath'] = value
end

#normalize_overrides(options) ⇒ Object

Transforms CLI options into a config hash that can be merged with default and loaded config.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/bolt/config.rb', line 260

def normalize_overrides(options)
  opts = options.transform_keys(&:to_s)

  # Pull out config options. We need to add 'transport' as it's not part of the
  # OPTIONS hash but is a valid option that can be set with the --transport CLI option
  overrides = opts.slice(*OPTIONS.keys, 'transport')

  # Pull out transport config options
  TRANSPORT_CONFIG.each do |transport, config|
    overrides[transport] = opts.slice(*config.options)
  end

  # Set console log to debug if in debug mode
  if options[:debug]
    overrides['log'] = { 'console' => { 'level' => :debug } }
  end

  if options[:puppetfile_path]
    @puppetfile = options[:puppetfile_path]
  end

  overrides['trace'] = opts['trace'] if opts.key?('trace')

  overrides
end

#plugin_hooks ⇒ Object 



515
516
517
 
# File 'lib/bolt/config.rb', line 515

def plugin_hooks
  @data['plugin_hooks']
end

#plugins ⇒ Object 



511
512
513
 
# File 'lib/bolt/config.rb', line 511

def plugins
  @data['plugins']
end

#puppetdb ⇒ Object 



487
488
489
 
# File 'lib/bolt/config.rb', line 487

def puppetdb
  @data['puppetdb']
end

#puppetfile ⇒ Object 



449
450
451
 
# File 'lib/bolt/config.rb', line 449

def puppetfile
  @puppetfile || @project.puppetfile
end

#puppetfile_config ⇒ Object 



507
508
509
 
# File 'lib/bolt/config.rb', line 507

def puppetfile_config
  @data['puppetfile']
end

#rerunfile ⇒ Object 



441
442
443
 
# File 'lib/bolt/config.rb', line 441

def rerunfile
  @project.rerunfile
end

#save_rerun ⇒ Object 



495
496
497
 
# File 'lib/bolt/config.rb', line 495

def save_rerun
  @data['save-rerun']
end

#sc_open_max_available? ⇒ Boolean

Etc::SC_OPEN_MAX is meaningless on windows, not defined in PE Jruby and not available on some platforms. This method holds the logic to decide whether or not to even consider it.

Returns:

  • (Boolean) 


555
556
557
 
# File 'lib/bolt/config.rb', line 555

def sc_open_max_available?
  !Bolt::Util.windows? && defined?(Etc::SC_OPEN_MAX) && Etc.sysconf(Etc::SC_OPEN_MAX)
end

#trace ⇒ Object 



479
480
481
 
# File 'lib/bolt/config.rb', line 479

def trace
  @data['trace']
end

#transport ⇒ Object 



527
528
529
 
# File 'lib/bolt/config.rb', line 527

def transport
  @data['transport']
end

#trusted_external ⇒ Object 



519
520
521
 
# File 'lib/bolt/config.rb', line 519

def trusted_external
  @data['trusted-external-command']
end

#validate ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/bolt/config.rb', line 388

def validate
  if @data['future']
    msg = "Configuration option 'future' no longer exposes future behavior."
    @logs << { warn: msg }
  end

  if @project.modules && @data['modulepath']&.include?(@project.managed_moduledir.to_s)
    raise Bolt::ValidationError,
          "Found invalid path in modulepath: #{@project.managed_moduledir}. This path "\
          "is automatically appended to the modulepath and cannot be configured."
  end

  keys = OPTIONS.keys - %w[plugins plugin_hooks puppetdb]
  keys.each do |key|
    next unless Bolt::Util.references?(@data[key])
    valid_keys = TRANSPORT_CONFIG.keys + %w[plugins plugin_hooks puppetdb]
    raise Bolt::ValidationError,
          "Found unsupported key _plugin in config setting #{key}. Plugins are only available in "\
          "#{valid_keys.join(', ')}."
  end

  unless concurrency.is_a?(Integer) && concurrency > 0
    raise Bolt::ValidationError,
          "Concurrency must be a positive Integer, received #{concurrency.class} #{concurrency}"
  end

  unless compile_concurrency.is_a?(Integer) && compile_concurrency > 0
    raise Bolt::ValidationError,
          "Compile concurrency must be a positive Integer, received #{compile_concurrency.class} "\
          "#{compile_concurrency}"
  end

  compile_limit = 2 * Etc.nprocessors
  unless compile_concurrency < compile_limit
    raise Bolt::ValidationError, "Compilation is CPU-intensive, set concurrency less than #{compile_limit}"
  end

  unless %w[human json rainbow].include? format
    raise Bolt::ValidationError, "Unsupported format: '#{format}'"
  end

  Bolt::Util.validate_file('hiera-config', @data['hiera-config']) if @data['hiera-config']
  Bolt::Util.validate_file('trusted-external-command', trusted_external) if trusted_external

  unless TRANSPORT_CONFIG.include?(transport)
    raise UnknownTransportError, transport
  end
end