Class: BoltServer::TransportApp

Inherits:
Sinatra::Base
  • Object
show all
Defined in:
lib/bolt_server/transport_app.rb

Constant Summary collapse

PARTIAL_SCHEMAS =

These partial schemas are reused to build multiple request schemas

%w[target-any target-ssh target-winrm task].freeze
REQUEST_SCHEMAS =

These schemas combine shared schemas to describe client requests

%w[
  action-check_node_connections
  action-run_command
  action-run_task
  action-run_script
  action-upload_file
  transport-ssh
  transport-winrm
].freeze
PE_BOLTLIB_PATH =

PE_BOLTLIB_PATH is intended to function exactly like the BOLTLIB_PATH used in Bolt::PAL. Paths and variable names are similar to what exists in Bolt::PAL, but with a ‘PE’ prefix.

'/opt/puppetlabs/server/apps/bolt-server/pe-bolt-modules'
DEFAULT_BOLT_CODEDIR =

For now at least, we maintain an entirely separate codedir from puppetserver by default, so that filesync can work properly. If filesync is not used, this can instead match the usual puppetserver codedir. See the ‘orchestrator.bolt.codedir` tk config setting.

'/opt/puppetlabs/server/data/orchestration-services/code'
ACTIONS = 
%w[
  check_node_connections
  run_command
  run_task
  run_script
  upload_file
  apply
  apply_prep
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ TransportApp

Returns a new instance of TransportApp.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bolt_server/transport_app.rb', line 48

def initialize(config)
  @config = config
  @schemas = Hash[REQUEST_SCHEMAS.map do |basename|
    [basename, JSON.parse(File.read(File.join(__dir__, ['schemas', "#{basename}.json"])))]
  end]

  PARTIAL_SCHEMAS.each do |basename|
    schema_content = JSON.parse(File.read(File.join(__dir__, ['schemas', 'partials', "#{basename}.json"])))
    shared_schema = JSON::Schema.new(schema_content, Addressable::URI.parse("partial:#{basename}"))
    JSON::Validator.add_schema(shared_schema)
  end
  @file_cache = BoltServer::FileCache.new(@config).setup
  @executor = Bolt::Executor.new(0)

  # This is needed until the PAL is threadsafe.
  @pal_mutex = Mutex.new

  @logger = Bolt::Logger.logger(self)

  super(nil)
end

Instance Method Details

#allowed_helper(pal, metadata, allowlist) ⇒ Object 



332
333
334
335
 
# File 'lib/bolt_server/transport_app.rb', line 332

def allowed_helper(pal, metadata, allowlist)
  allowed = !pal.filter_content([metadata['name']], allowlist).empty?
  metadata.merge({ 'allowed' => allowed })
end

#build_puppetserver_uri(file_identifier, module_name, parameters) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/bolt_server/transport_app.rb', line 284

def build_puppetserver_uri(file_identifier, module_name, parameters)
  segments = file_identifier.split('/', 3)
  if segments.size == 1
    {
      'path' => "/puppet/v3/file_content/tasks/#{module_name}/#{file_identifier}",
      'params' => parameters
    }
  else
    module_segment, mount_segment, name_segment = *segments
    {
      'path' => case mount_segment
                when 'files'
                  "/puppet/v3/file_content/modules/#{module_segment}/#{name_segment}"
                when 'scripts'
                  "/puppet/v3/file_content/scripts/#{module_segment}/#{name_segment}"
                when 'tasks'
                  "/puppet/v3/file_content/tasks/#{module_segment}/#{name_segment}"
                when 'lib'
                  "/puppet/v3/file_content/plugins/#{name_segment}"
                end,
      'params' => parameters
    }
  end
end

#check_node_connections(targets, body) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/bolt_server/transport_app.rb', line 160

def check_node_connections(targets, body)
  validate_schema(@schemas["action-check_node_connections"], body)

  # Puppet Enterprise's orchestrator service uses the
  # check_node_connections endpoint to check whether nodes that should be
  # contacted over SSH or WinRM are responsive. The wait time here is 0
  # because the endpoint is meant to be used for a single check of all
  # nodes; External implementations of wait_until_available (like
  # orchestrator's) should contact the endpoint in their own loop.
  @executor.wait_until_available(targets, wait_time: 0)
end

#in_pe_pal_env(environment) ⇒ Object

Raises:



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/bolt_server/transport_app.rb', line 257

def in_pe_pal_env(environment)
  raise BoltServer::RequestError, "'environment' is a required argument" if environment.nil?
  @pal_mutex.synchronize do
    modulepath_obj = Bolt::Config::Modulepath.new(
      modulepath_from_environment(environment),
      boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
    )
    pal = Bolt::PAL.new(modulepath_obj, nil, nil)
    yield pal
  rescue Puppet::Environments::EnvironmentNotFound
    raise BoltServer::RequestError, "environment: '#{environment}' does not exist"
  end
end

#make_ssh_target(target_hash) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/bolt_server/transport_app.rb', line 381

def make_ssh_target(target_hash)
  defaults = {
    'host-key-check' => false
  }

  overrides = {
    'load-config' => false
  }

  opts = defaults.merge(target_hash).merge(overrides)

  if opts['private-key-content']
    private_key_content = opts.delete('private-key-content')
    opts['private-key'] = { 'key-data' => private_key_content }
  end

  data = {
    'uri' => target_hash['hostname'],
    'config' => {
      'transport' => 'ssh',
      'ssh' => opts.slice(*Bolt::Config::Transport::SSH.options)
    }
  }

  inventory = Bolt::Inventory.empty
  Bolt::Target.from_hash(data, inventory)
end

#make_winrm_target(target_hash) ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/bolt_server/transport_app.rb', line 427

def make_winrm_target(target_hash)
  defaults = {
    'ssl' => false,
    'ssl-verify' => false
  }

  opts = defaults.merge(target_hash)

  data = {
    'uri' => target_hash['hostname'],
    'config' => {
      'transport' => 'winrm',
      'winrm' => opts.slice(*Bolt::Config::Transport::WinRM.options)
    }
  }

  inventory = Bolt::Inventory.empty
  Bolt::Target.from_hash(data, inventory)
end

#modulepath_from_environment(environment_name) ⇒ Object

Use puppet to identify the modulepath from an environment.

WARNING: THIS FUNCTION SHOULD ONLY BE CALLED INSIDE A SYNCHRONIZED PAL MUTEX



247
248
249
250
251
252
253
254
255
 
# File 'lib/bolt_server/transport_app.rb', line 247

def modulepath_from_environment(environment_name)
  codedir = @config['environments-codedir'] || DEFAULT_BOLT_CODEDIR
  environmentpath = @config['environmentpath'] || "#{codedir}/environments"
  basemodulepath = @config['basemodulepath'] || "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
  with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) do
    environment = Puppet.lookup(:environments).get!(environment_name)
    environment.modulepath
  end
end

#pe_plan_info(pal, module_name, plan_name) ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/bolt_server/transport_app.rb', line 271

def pe_plan_info(pal, module_name, plan_name)
  # Handle case where plan name is simply module name with special `init.pp` plan
  plan_name = if plan_name == 'init' || plan_name.nil?
                module_name
              else
                "#{module_name}::#{plan_name}"
              end
  plan_info = pal.get_plan_info(plan_name)
  # Path to module is meaningless in PE
  plan_info.delete('module')
  plan_info
end

#pe_task_info(pal, module_name, task_name, parameters) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/bolt_server/transport_app.rb', line 309

def pe_task_info(pal, module_name, task_name, parameters)
  # Handle case where task name is simply module name with special `init` task
  task_name = if task_name == 'init' || task_name.nil?
                module_name
              else
                "#{module_name}::#{task_name}"
              end
  task = pal.get_task(task_name)
  files = task.files.map do |file_hash|
    {
      'filename' => file_hash['name'],
      'sha256' => Digest::SHA256.hexdigest(File.read(file_hash['path'])),
      'size_bytes' => File.size(file_hash['path']),
      'uri' => build_puppetserver_uri(file_hash['name'], module_name, parameters)
    }
  end
  {
    'metadata' => task.metadata,
    'name' => task.name,
    'files' => files
  }
end

#plan_list(pal) ⇒ Object 



342
343
344
345
 
# File 'lib/bolt_server/transport_app.rb', line 342

def plan_list(pal)
  plans = pal.list_plans.flatten
  plans.map { |plan_name| { 'name' => plan_name } }
end

#result_set_to_data(result_set, aggregate: false) ⇒ Object

Turns a Bolt::ResultSet object into a status hash that is fit to return to the client in a response. In the case of every action except check_node_connections the response will be a single serialized Result. In the check_node_connections case the response will be a hash with the top level “status” of the result and the serialized individual target results.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/bolt_server/transport_app.rb', line 90

def result_set_to_data(result_set, aggregate: false)
  # use ResultSet#ok method to determine status of a (potentially) aggregate result before serializing
  result_set_status = result_set.ok ? 'success' : 'failure'
  scrubbed_results = result_set.map do |result|
    scrub_stack_trace(result.to_data)
  end

  if aggregate
    {
      status: result_set_status,
      result: scrubbed_results
    }
  else
    # If there was only one target, return the first result on its own
    scrubbed_results.first
  end
end

#run_command(target, body) ⇒ Object 



154
155
156
157
158
 
# File 'lib/bolt_server/transport_app.rb', line 154

def run_command(target, body)
  validate_schema(@schemas["action-run_command"], body)
  command = body['command']
  @executor.run_command(target, command)
end

#run_script(target, body) ⇒ Object 



213
214
215
216
217
218
 
# File 'lib/bolt_server/transport_app.rb', line 213

def run_script(target, body)
  validate_schema(@schemas["action-run_script"], body)
  # Download the file onto the machine.
  file_location = @file_cache.update_file(body['script'])
  @executor.run_script(target, file_location, body['arguments'])
end

#run_task(target, body) ⇒ Object 



146
147
148
149
150
151
152
 
# File 'lib/bolt_server/transport_app.rb', line 146

def run_task(target, body)
  validate_schema(@schemas["action-run_task"], body)

  task_data = body['task']
  task = Bolt::Task::PuppetServer.new(task_data['name'], task_data['metadata'], task_data['files'], @file_cache)
  task_helper(target, task, body['parameters'] || {}, body['timeout'])
end

#scrub_stack_trace(result) ⇒ Object 



70
71
72
73
74
75
 
# File 'lib/bolt_server/transport_app.rb', line 70

def scrub_stack_trace(result)
  if result.dig('value', '_error', 'details', 'stack_trace')
    result['value']['_error']['details'].reject! { |k| k == 'stack_trace' }
  end
  result
end

#task_helper(target, task, parameters, timeout = nil) ⇒ Object 



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
 
# File 'lib/bolt_server/transport_app.rb', line 118

def task_helper(target, task, parameters, timeout = nil)
  # Wrap parameters marked with '"sensitive": true' in the task metadata with a
  # Sensitive wrapper type. This way it's not shown in logs.
  if (param_spec = task.parameters)
    parameters.each do |k, v|
      if param_spec[k] && param_spec[k]['sensitive']
        parameters[k] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(v)
      end
    end
  end

  if timeout && timeout > 0
    task_thread = Thread.new do
      unwrap_sensitive_results(@executor.run_task(target, task, parameters))
    end
    # Wait for the timeout for the task to execute in the thread. If `join` times out, result will be nil.
    if task_thread.join(timeout).nil?
      task_thread.kill
      raise Bolt::Error.new("Task execution on #{target.first.safe_name} timed out after #{timeout} seconds",
                            'boltserver/task-timeout')
    else
      task_thread.value
    end
  else
    unwrap_sensitive_results(@executor.run_task(target, task, parameters))
  end
end

#task_list(pal) ⇒ Object 



337
338
339
340
 
# File 'lib/bolt_server/transport_app.rb', line 337

def task_list(pal)
  tasks = pal.list_tasks
  tasks.map { |task_name, _description| { 'name' => task_name } }
end

#unwrap_sensitive_results(result_set) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/bolt_server/transport_app.rb', line 108

def unwrap_sensitive_results(result_set)
  # Take a ResultSet and unwrap sensitive values
  result_set.each do |result|
    value = result.value
    next unless value.is_a?(Hash)
    next unless value.key?('_sensitive')
    value['_sensitive'] = value['_sensitive'].unwrap
  end
end

#upload_file(target, body) ⇒ Object 



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
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/bolt_server/transport_app.rb', line 172

def upload_file(target, body)
  validate_schema(@schemas["action-upload_file"], body)
  files = body['files']
  destination = body['destination']
  job_id = body['job_id']
  cache_dir = @file_cache.create_cache_dir(job_id.to_s)
  FileUtils.mkdir_p(cache_dir)
  files.each do |file|
    relative_path = file['relative_path']
    uri = file['uri']
    sha256 = file['sha256']
    kind = file['kind']
    path = File.join(cache_dir, relative_path)
    case kind
    when 'file'
      # The parent should already be created by `directory` entries,
      # but this is to be on the safe side.
      parent = File.dirname(path)
      FileUtils.mkdir_p(parent)
      @file_cache.serial_execute { @file_cache.download_file(path, sha256, uri) }
    when 'directory'
      # Create directory in cache so we can move files in.
      FileUtils.mkdir_p(path)
    else
      raise BoltServer::RequestError, "Invalid kind: '#{kind}' supplied. Must be 'file' or 'directory'."
    end
  end
  # We need to special case the scenario where only one file was
  # included in the request to download. Otherwise, the call to upload_file
  # will attempt to upload with a directory as a source and potentially a
  # filename as a destination on the host. In that case the end result will
  # be the file downloaded to a directory with the same name as the source
  # filename, rather than directly to the filename set in the destination.
  upload_source = if files.size == 1 && files[0]['kind'] == 'file'
                    File.join(cache_dir, files[0]['relative_path'])
                  else
                    cache_dir
                  end
  @executor.upload_file(target, upload_source, destination)
end

#validate_schema(schema, body) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/bolt_server/transport_app.rb', line 77

def validate_schema(schema, body)
  schema_error = JSON::Validator.fully_validate(schema, body)
  if schema_error.any?
    raise BoltServer::RequestError.new("There was an error validating the request body.",
                                       schema_error)
  end
end

#with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) ⇒ Object

This function is nearly identical to Bolt::Pal’s ‘with_puppet_settings` with the one difference that we set the codedir to point to actual code, rather than the tmpdir. We only use this funtion inside the Modulepath initializer so that Puppet is correctly configured to pull environment configuration correctly. If we don’t set codedir in this way: when we try to load and interpolate the modulepath it won’t correctly load.

WARNING: THIS FUNCTION SHOULD ONLY BE CALLED INSIDE A SYNCHRONIZED PAL MUTEX



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/bolt_server/transport_app.rb', line 228

def with_pe_pal_init_settings(codedir, environmentpath, basemodulepath)
  Dir.mktmpdir('pe-bolt') do |dir|
    cli = []
    Puppet::Settings::REQUIRED_APP_SETTINGS.each do |setting|
      dir = setting == :codedir ? codedir : dir
      cli << "--#{setting}" << dir
    end
    cli << "--environmentpath" << environmentpath
    cli << "--basemodulepath" << basemodulepath
    Puppet.settings.send(:clear_everything_for_tests)
    Puppet.initialize_settings(cli)
    Puppet[:versioned_environment_dirs] = true
    yield
  end
end