Class: Bolt::Config

Inherits:
Object
  • Object
show all
Includes:
Options
Defined in:
lib/bolt/config.rb,
lib/bolt/config/options.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

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.



186
187
188
189
190
191
192
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
 
# File 'lib/bolt/config.rb', line 186

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

  @logger       = Logging.logger[self]
  @project      = project
  @warnings     = @project.warnings.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'
  }

  loaded_data = config_data.each_with_object([]) do |data, acc|
    @warnings.concat(data[:warnings]) if data[:warnings].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

#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

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



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

def warnings
  @warnings
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 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bolt/config.rb', line 51

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

  conf = if project.project_file == project.config_file
           project.data
         else
           Bolt::Util.read_yaml_hash(configfile, 'config')
         end

  data = load_defaults(project).push(
    filepath: project.config_file,
    data: conf,
    warnings: [],
    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
 
# File 'lib/bolt/config.rb', line 34

def self.from_project(project, overrides = {})
  conf = if project.project_file == project.config_file
           project.data
         else
           Bolt::Util.read_optional_yaml_hash(project.config_file, 'config')
         end

  data = load_defaults(project).push(
    filepath: project.config_file,
    data: conf,
    warnings: [],
    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.



90
91
92
93
94
95
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
 
# File 'lib/bolt/config.rb', line 90

def self.load_bolt_defaults_yaml(dir)
  filepath = dir + BOLT_DEFAULTS_NAME
  data     = Bolt::Util.read_yaml_hash(filepath, 'config')
  warnings = []

  # Warn if 'bolt.yaml' detected in same directory.
  if File.exist?(bolt_yaml = dir + BOLT_CONFIG_NAME)
    warnings.push(
      msg: "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) }
    warnings.push(
      msg: "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) }
    warnings.push(
      msg: "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, warnings: warnings, 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.



150
151
152
153
154
155
156
157
158
 
# File 'lib/bolt/config.rb', line 150

def self.load_bolt_yaml(dir)
  filepath = dir + BOLT_CONFIG_NAME
  data     = Bolt::Util.read_yaml_hash(filepath, 'config')
  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, warnings: [], deprecations: deprecations }
end

.load_defaults(project) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/bolt/config.rb', line 160

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 



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/bolt/config.rb', line 70

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 



81
82
83
84
85
 
# File 'lib/bolt/config.rb', line 81

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

Instance Method Details

#apply_settings ⇒ Object 



481
482
483
 
# File 'lib/bolt/config.rb', line 481

def apply_settings
  @data['apply_settings']
end

#check_path_case(type, paths) ⇒ Object

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



490
491
492
493
494
495
496
497
498
499
 
# File 'lib/bolt/config.rb', line 490

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 



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

def color
  @data['color']
end

#compile_concurrency ⇒ Object 



461
462
463
 
# File 'lib/bolt/config.rb', line 461

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

#concurrency ⇒ Object 



425
426
427
 
# File 'lib/bolt/config.rb', line 425

def concurrency
  @data['concurrency']
end

#deep_clone ⇒ Object 



295
296
297
 
# File 'lib/bolt/config.rb', line 295

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

#default_concurrency ⇒ Object 



517
518
519
520
521
522
523
 
# File 'lib/bolt/config.rb', line 517

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 



401
402
403
 
# File 'lib/bolt/config.rb', line 401

def default_inventoryfile
  @project.inventory_file
end

#format ⇒ Object 



429
430
431
 
# File 'lib/bolt/config.rb', line 429

def format
  @data['format']
end

#format=(value) ⇒ Object 



433
434
435
 
# File 'lib/bolt/config.rb', line 433

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

#hiera_config ⇒ Object 



409
410
411
 
# File 'lib/bolt/config.rb', line 409

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

#inventoryfile ⇒ Object 



457
458
459
 
# File 'lib/bolt/config.rb', line 457

def inventoryfile
  @data['inventoryfile']
end

#log ⇒ Object 



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

def log
  @data['log']
end

#matching_paths(paths) ⇒ Object 



501
502
503
 
# File 'lib/bolt/config.rb', line 501

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bolt/config.rb', line 274

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 



417
418
419
 
# File 'lib/bolt/config.rb', line 417

def modulepath
  @data['modulepath'] || @project.modulepath
end

#modulepath=(value) ⇒ Object 



421
422
423
 
# File 'lib/bolt/config.rb', line 421

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.



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/bolt/config.rb', line 246

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 



473
474
475
 
# File 'lib/bolt/config.rb', line 473

def plugin_hooks
  @data['plugin_hooks']
end

#plugins ⇒ Object 



469
470
471
 
# File 'lib/bolt/config.rb', line 469

def plugins
  @data['plugins']
end

#puppetdb ⇒ Object 



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

def puppetdb
  @data['puppetdb']
end

#puppetfile ⇒ Object 



413
414
415
 
# File 'lib/bolt/config.rb', line 413

def puppetfile
  @puppetfile || @project.puppetfile
end

#puppetfile_config ⇒ Object 



465
466
467
 
# File 'lib/bolt/config.rb', line 465

def puppetfile_config
  @data['puppetfile']
end

#rerunfile ⇒ Object 



405
406
407
 
# File 'lib/bolt/config.rb', line 405

def rerunfile
  @project.rerunfile
end

#save_rerun ⇒ Object 



453
454
455
 
# File 'lib/bolt/config.rb', line 453

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) 


513
514
515
 
# File 'lib/bolt/config.rb', line 513

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

#trace ⇒ Object 



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

def trace
  @data['trace']
end

#transport ⇒ Object 



485
486
487
 
# File 'lib/bolt/config.rb', line 485

def transport
  @data['transport']
end

#trusted_external ⇒ Object 



477
478
479
 
# File 'lib/bolt/config.rb', line 477

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

#validate ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/bolt/config.rb', line 358

def validate
  if @data['future']
    msg = "Configuration option 'future' no longer exposes future behavior."
    @warnings << { option: 'future', msg: msg }
  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