Class: Bolt::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/config.rb

Constant Summary collapse

TRANSPORT_OPTIONS = 
%i[password run-as sudo-password extensions
private-key tty tmpdir user connect-timeout
cacert token-file service-url interpreters file-protocol smb-port].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/bolt/config.rb', line 57

def initialize(boltdir, config_data, overrides = {})
  @logger = Logging.logger[self]

  @boltdir = boltdir
  @concurrency = 100
  @compile_concurrency = Concurrent.processor_count
  @transport = 'ssh'
  @format = 'human'
  @puppetdb = {}
  @color = true

  # add an entry for the default console logger
  @log = { 'console' => {} }

  @transports = {}

  TRANSPORTS.each do |key, transport|
    @transports[key] = transport.default_options
  end

  update_from_file(config_data)
  apply_overrides(overrides)

  validate
end

Instance Attribute Details

#color ⇒ Object

Returns the value of attribute color.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def color
  @color
end

#compile_concurrency ⇒ Object

Returns the value of attribute compile_concurrency.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def compile_concurrency
  @compile_concurrency
end

#concurrency ⇒ Object

Returns the value of attribute concurrency.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def concurrency
  @concurrency
end

#format ⇒ Object

Returns the value of attribute format.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def format
  @format
end

#inventoryfile ⇒ Object

Returns the value of attribute inventoryfile.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def inventoryfile
  @inventoryfile
end

#log ⇒ Object

Returns the value of attribute log.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def log
  @log
end

#modulepath ⇒ Object 



225
226
227
 
# File 'lib/bolt/config.rb', line 225

def modulepath
  @modulepath || @boltdir.modulepath
end

#puppetdb ⇒ Object

Returns the value of attribute puppetdb.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def puppetdb
  @puppetdb
end

#trace ⇒ Object

Returns the value of attribute trace.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def trace
  @trace
end

#transport ⇒ Object

Returns the value of attribute transport.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def transport
  @transport
end

#transports ⇒ Object

Returns the value of attribute transports.



33
34
35
 
# File 'lib/bolt/config.rb', line 33

def transports
  @transports
end

Class Method Details

.default ⇒ Object 



41
42
43
 
# File 'lib/bolt/config.rb', line 41

def self.default
  new(Bolt::Boltdir.new('.'), {})
end

.from_boltdir(boltdir, overrides = {}) ⇒ Object 



45
46
47
48
 
# File 'lib/bolt/config.rb', line 45

def self.from_boltdir(boltdir, overrides = {})
  data = Bolt::Util.read_config_file(nil, [boltdir.config_file], 'config') || {}
  new(boltdir, data, overrides)
end

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



50
51
52
53
54
55
 
# File 'lib/bolt/config.rb', line 50

def self.from_file(configfile, overrides = {})
  boltdir = Bolt::Boltdir.new(Pathname.new(configfile).expand_path.dirname)
  data = Bolt::Util.read_config_file(configfile, [], 'config') || {}

  new(boltdir, data, overrides)
end

Instance Method Details

#apply_overrides(options) ⇒ Object 



165
166
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
192
193
194
195
196
197
198
 
# File 'lib/bolt/config.rb', line 165

def apply_overrides(options)
  %i[concurrency transport format trace modulepath inventoryfile color].each do |key|
    send("#{key}=", options[key]) if options.key?(key)
  end

  if options[:debug]
    @log['console'][:level] = :debug
  elsif options[:verbose]
    @log['console'][:level] = :info
  end

  @compile_concurrency = options[:'compile-concurrency'] if options[:'compile-concurrency']

  TRANSPORTS.each_key do |transport|
    transport = @transports[transport]
    TRANSPORT_OPTIONS.each do |key|
      if options[key]
        transport[key.to_s] = Bolt::Util.walk_keys(options[key], &:to_s)
      end
    end
  end

  if options.key?(:ssl) # this defaults to true so we need to check the presence of the key
    @transports[:winrm]['ssl'] = options[:ssl]
  end

  if options.key?(:'ssl-verify') # this defaults to true so we need to check the presence of the key
    @transports[:winrm]['ssl-verify'] = options[:'ssl-verify']
  end

  if options.key?(:'host-key-check') # this defaults to true so we need to check the presence of the key
    @transports[:ssh]['host-key-check'] = options[:'host-key-check']
  end
end

#deep_clone ⇒ Object 



92
93
94
 
# File 'lib/bolt/config.rb', line 92

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

#default_inventoryfile ⇒ Object 



213
214
215
 
# File 'lib/bolt/config.rb', line 213

def default_inventoryfile
  [@boltdir.inventory_file]
end

#hiera_config ⇒ Object 



217
218
219
 
# File 'lib/bolt/config.rb', line 217

def hiera_config
  @hiera_config || @boltdir.hiera_config
end

#normalize_interpreters(interpreters) ⇒ Object 



96
97
98
99
100
 
# File 'lib/bolt/config.rb', line 96

def normalize_interpreters(interpreters)
  Bolt::Util.walk_keys(interpreters) do |key|
    key.chars[0] == '.' ? key : '.' + key
  end
end

#normalize_log(target) ⇒ Object 



102
103
104
105
106
 
# File 'lib/bolt/config.rb', line 102

def normalize_log(target)
  return target if target == 'console'
  target = target[5..-1] if target.start_with?('file:')
  'file:' + File.expand_path(target)
end

#overwrite_transport_data(transport, transports) ⇒ Object 



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

def overwrite_transport_data(transport, transports)
  @transport = transport
  @transports = transports
end

#puppetfile ⇒ Object 



221
222
223
 
# File 'lib/bolt/config.rb', line 221

def puppetfile
  @boltdir.puppetfile
end

#transport_conf ⇒ Object 



208
209
210
211
 
# File 'lib/bolt/config.rb', line 208

def transport_conf
  { transport: @transport,
    transports: @transports }
end

#transport_data_get ⇒ Object 



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

def transport_data_get
  { transport: @transport, transports: @transports }
end

#update_from_inventory(data) ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/bolt/config.rb', line 200

def update_from_inventory(data)
  update_from_file(data)

  if data['transport']
    @transport = data['transport']
  end
end

#update_logs(logs) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/bolt/config.rb', line 108

def update_logs(logs)
  logs.each_pair do |k, v|
    log_name = normalize_log(k)
    @log[log_name] ||= {}
    log = @log[log_name]

    next unless v.is_a?(Hash)

    if v.key?('level')
      log[:level] = v['level'].to_s
    end

    if v.key?('append')
      log[:append] = v['append']
    end
  end
end

#validate ⇒ Object 



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
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/bolt/config.rb', line 229

def validate
  @log.each_pair do |name, params|
    if params.key?(:level) && !Bolt::Logger.valid_level?(params[:level])
      raise Bolt::ValidationError,
            "level of log #{name} must be one of: #{Bolt::Logger.levels.join(', ')}; received #{params[:level]}"
    end
    if params.key?(:append) && params[:append] != true && params[:append] != false
      raise Bolt::ValidationError, "append flag of log #{name} must be a Boolean, received #{params[:append]}"
    end
  end

  unless @concurrency.is_a?(Integer) && @concurrency > 0
    raise Bolt::ValidationError, 'Concurrency must be a positive integer'
  end

  unless @compile_concurrency.is_a?(Integer) && @compile_concurrency > 0
    raise Bolt::ValidationError, 'Compile concurrency must be a positive integer'
  end

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

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

  if @hiera_config && !(File.file?(@hiera_config) && File.readable?(@hiera_config))
    raise Bolt::FileError, "Could not read hiera-config file #{@hiera_config}", @hiera_config
  end

  unless @transport.nil? || Bolt::TRANSPORTS.include?(@transport.to_sym)
    raise UnknownTransportError, @transport
  end

  TRANSPORTS.each do |transport, impl|
    impl.validate(@transports[transport])
  end
end