Class: Bosh::Cli::Client::Director

Inherits:
Object
  • Object
show all
Includes:
VersionCalc
Defined in:
lib/cli/client/director.rb

Constant Summary collapse

DIRECTOR_HTTP_ERROR_CODES = 
[400, 403, 404, 500]
API_TIMEOUT = 
86400 * 3
CONNECT_TIMEOUT = 
30

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from VersionCalc

#major_version, #minor_version, #version_cmp, #version_greater, #version_less, #version_same

Constructor Details

#initialize(director_uri, user = nil, password = nil, options = {}) ⇒ Director

Options can include:

  • :no_track => true - do not use TaskTracker for long-running

    +request_and_track+ calls



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cli/client/director.rb', line 33

def initialize(director_uri, user = nil, password = nil, options = {})
  if director_uri.nil? || director_uri =~ /^\s*$/
    raise DirectorMissing, 'no director URI given'
  end

  @director_uri        = URI.parse(director_uri)
  @director_ip         = Resolv.getaddresses(@director_uri.host).last
  @scheme              = @director_uri.scheme
  @port                = @director_uri.port
  @user                = user
  @password            = password
  @track_tasks         = !options.delete(:no_track)
  @num_retries         = options.fetch(:num_retries, 5)
  @retry_wait_interval = options.fetch(:retry_wait_interval, 5)
end

Instance Attribute Details

#director_uri ⇒ Object (readonly)

Returns the value of attribute director_uri.



22
23
24
 
# File 'lib/cli/client/director.rb', line 22

def director_uri
  @director_uri
end

#password ⇒ String

Returns:



28
29
30
 
# File 'lib/cli/client/director.rb', line 28

def password
  @password
end

#user ⇒ String

Returns:



25
26
27
 
# File 'lib/cli/client/director.rb', line 25

def user
  @user
end

Instance Method Details

#apply_resolutions(deployment_name, resolutions, options = {}) ⇒ Object 



456
457
458
459
460
461
462
463
464
 
# File 'lib/cli/client/director.rb', line 456

def apply_resolutions(deployment_name, resolutions, options = {})
  options = options.dup

  url                    = "/deployments/#{deployment_name}/problems"
  options[:content_type] = 'application/json'
  options[:payload]      = JSON.generate('resolutions' => resolutions)

  request_and_track(:put, url, options)
end

#authenticated? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
72
73
74
75
76
77
 
# File 'lib/cli/client/director.rb', line 69

def authenticated?
  status = get_status
  # Backward compatibility: older directors return 200
  # only for logged in users
  return true if !status.has_key?('version')
  !status['user'].nil?
rescue DirectorError
  false
end

#cancel_task(task_id) ⇒ Object

Raises:



530
531
532
533
534
535
 
# File 'lib/cli/client/director.rb', line 530

def cancel_task(task_id)
  response_code, body = delete("/task/#{task_id}")
  raise AuthError if response_code == 401
  raise MissingTask, "No task##{task_id} found" if response_code == 404
  [body, response_code]
end

#change_job_state(deployment_name, manifest_yaml, job_name, index, new_state, options = {}) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/cli/client/director.rb', line 295

def change_job_state(deployment_name, manifest_yaml,
  job_name, index, new_state, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/jobs/#{job_name}"
  url += "/#{index}" if index
  url += "?state=#{new_state}"

  options[:payload]      = manifest_yaml
  options[:content_type] = 'text/yaml'

  request_and_track(:put, url, options)
end

#change_vm_resurrection(deployment_name, job_name, index, value) ⇒ Object 



309
310
311
312
313
 
# File 'lib/cli/client/director.rb', line 309

def change_vm_resurrection(deployment_name, job_name, index, value)
  url     = "/deployments/#{deployment_name}/jobs/#{job_name}/#{index}/resurrection"
  payload = JSON.generate('resurrection_paused' => value)
  put(url, 'application/json', payload)
end

#change_vm_resurrection_for_all(value) ⇒ Object 



315
316
317
318
319
 
# File 'lib/cli/client/director.rb', line 315

def change_vm_resurrection_for_all(value)
  url     = "/resurrection"
  payload = JSON.generate('resurrection_paused' => value)
  put(url, 'application/json', payload)
end

#cleanup_ssh(deployment_name, job, user_regex, indexes, options = {}) ⇒ Object 



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

def cleanup_ssh(deployment_name, job, user_regex, indexes, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/ssh"

  payload = {
    'command'         => 'cleanup',
    'deployment_name' => deployment_name,
    'target'          => {
      'job'     => job,
      'indexes' => (indexes || []).compact
    },
    'params'          => { 'user_regex' => user_regex }
  }

  options[:payload]      = JSON.generate(payload)
  options[:content_type] = 'application/json'

  request_and_track(:post, url, options)
end

#create_backup ⇒ Object 



537
538
539
 
# File 'lib/cli/client/director.rb', line 537

def create_backup
  request_and_track(:post, '/backups', {})
end

#create_property(deployment_name, property_name, value) ⇒ Object 



380
381
382
383
384
 
# File 'lib/cli/client/director.rb', line 380

def create_property(deployment_name, property_name, value)
  url     = "/deployments/#{deployment_name}/properties"
  payload = JSON.generate('name' => property_name, 'value' => value)
  post(url, 'application/json', payload)
end

#create_user(username, password) ⇒ Object 



79
80
81
82
83
 
# File 'lib/cli/client/director.rb', line 79

def create_user(username, password)
  payload          = JSON.generate('username' => username, 'password' => password)
  response_code, _ = post('/users', 'application/json', payload)
  response_code == 204
end

#delete_all_snapshots(deployment_name, options = {}) ⇒ Object 



428
429
430
431
432
433
434
 
# File 'lib/cli/client/director.rb', line 428

def delete_all_snapshots(deployment_name, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/snapshots"

  request_and_track(:delete, url, options)
end

#delete_deployment(name, options = {}) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/cli/client/director.rb', line 207

def delete_deployment(name, options = {})
  options = options.dup
  force   = options.delete(:force)

  url = "/deployments/#{name}"

  extras = []
  extras << 'force=true' if force

  request_and_track(:delete, add_query_string(url, extras), options)
end

#delete_property(deployment_name, property_name) ⇒ Object 



392
393
394
395
 
# File 'lib/cli/client/director.rb', line 392

def delete_property(deployment_name, property_name)
  url = "/deployments/#{deployment_name}/properties/#{property_name}"
  delete(url, 'application/json')
end

#delete_release(name, options = {}) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cli/client/director.rb', line 219

def delete_release(name, options = {})
  options = options.dup
  force   = options.delete(:force)
  version = options.delete(:version)

  url = "/releases/#{name}"

  extras = []
  extras << 'force=true' if force
  extras << "version=#{version}" if version

  request_and_track(:delete, add_query_string(url, extras), options)
end

#delete_snapshot(deployment_name, snapshot_cid, options = {}) ⇒ Object 



436
437
438
439
440
441
442
 
# File 'lib/cli/client/director.rb', line 436

def delete_snapshot(deployment_name, snapshot_cid, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/snapshots/#{snapshot_cid}"

  request_and_track(:delete, url, options)
end

#delete_stemcell(name, version, options = {}) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/cli/client/director.rb', line 195

def delete_stemcell(name, version, options = {})
  options = options.dup
  force   = options.delete(:force)

  url = "/stemcells/#{name}/#{version}"

  extras = []
  extras << 'force=true' if force

  request_and_track(:delete, add_query_string(url, extras), options)
end

#delete_user(username) ⇒ Object 



85
86
87
88
 
# File 'lib/cli/client/director.rb', line 85

def delete_user(username)
  response_code, _ = delete("/users/#{username}")
  response_code == 204
end

#deploy(manifest_yaml, options = {}) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/cli/client/director.rb', line 233

def deploy(manifest_yaml, options = {})
  options = options.dup

  recreate               = options.delete(:recreate)
  options[:content_type] = 'text/yaml'
  options[:payload]      = manifest_yaml

  url = '/deployments'

  extras = []
  extras << 'recreate=true' if recreate

  request_and_track(:post, add_query_string(url, extras), options)
end

#download_resource(id) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/cli/client/director.rb', line 368

def download_resource(id)
  status, tmp_file, _ = get("/resources/#{id}",
                            nil, nil, {}, :file => true)

  if status == 200
    tmp_file
  else
    raise DirectorError,
          "Cannot download resource `#{id}': HTTP status #{status}"
  end
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
56
57
58
59
60
 
# File 'lib/cli/client/director.rb', line 53

def exists?
  get_status
  true
rescue AuthError
  true # For compatibility with directors that return 401 for /info
rescue DirectorError
  false
end

#fetch_backup ⇒ Object 



541
542
543
544
 
# File 'lib/cli/client/director.rb', line 541

def fetch_backup
  _, path, _ = get('/backups', nil, nil, {}, :file => true)
  path
end

#fetch_logs(deployment_name, job_name, index, log_type, filters = nil, options = {}) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/cli/client/director.rb', line 337

def fetch_logs(deployment_name, job_name, index, log_type,
  filters = nil, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/jobs/#{job_name}"
  url += "/#{index}/logs?type=#{log_type}&filters=#{filters}"

  status, task_id = request_and_track(:get, url, options)

  return nil if status != :done
  get_task_result(task_id)
end

#fetch_vm_state(deployment_name, options = {}) ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/cli/client/director.rb', line 350

def fetch_vm_state(deployment_name, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/vms?format=full"

  status, task_id = request_and_track(:get, url, options)

  if status != :done
    raise DirectorError, 'Failed to fetch VMs information from director'
  end

  output = get_task_result_log(task_id)

  output.to_s.split("\n").map do |vm_state|
    JSON.parse(vm_state)
  end
end

#get_current_time ⇒ Object 



466
467
468
469
 
# File 'lib/cli/client/director.rb', line 466

def get_current_time
  _, _, headers = get('/info')
  Time.parse(headers[:date]) rescue nil
end

#get_deployment(name) ⇒ Object 



154
155
156
157
 
# File 'lib/cli/client/director.rb', line 154

def get_deployment(name)
  _, body = get_json_with_status("/deployments/#{name}")
  body
end

#get_property(deployment_name, property_name) ⇒ Object 



397
398
399
400
 
# File 'lib/cli/client/director.rb', line 397

def get_property(deployment_name, property_name)
  url = "/deployments/#{deployment_name}/properties/#{property_name}"
  get_json_with_status(url)
end

#get_release(name) ⇒ Object 



139
140
141
 
# File 'lib/cli/client/director.rb', line 139

def get_release(name)
  get_json("/releases/#{name}")
end

#get_status ⇒ Object 



110
111
112
 
# File 'lib/cli/client/director.rb', line 110

def get_status
  get_json('/info')
end

#get_task(task_id) ⇒ Object 



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/cli/client/director.rb', line 477

def get_task(task_id)
  response_code, body = get("/tasks/#{task_id}")
  raise AuthError if response_code == 401
  raise MissingTask, "Task #{task_id} not found" if response_code == 404

  if response_code != 200
    raise TaskTrackError, "Got HTTP #{response_code} " +
      'while tracking task state'
  end

  JSON.parse(body)
rescue JSON::ParserError
  raise TaskTrackError, 'Cannot parse task JSON, ' +
    'incompatible director version'
end

#get_task_output(task_id, offset, log_type = nil) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/cli/client/director.rb', line 506

def get_task_output(task_id, offset, log_type = nil)
  uri = "/tasks/#{task_id}/output"
  uri += "?type=#{log_type}" if log_type

  headers                      = { 'Range' => "bytes=#{offset}-" }
  response_code, body, headers = get(uri, nil, nil, headers)

  if response_code == 206 &&
    headers[:content_range].to_s =~ /bytes \d+-(\d+)\/\d+/
    new_offset = $1.to_i + 1
  else
    new_offset = nil
    # Delete the "Byte range unsatisfiable" message
    body = nil if response_code == 416
  end

  # backward compatible with renaming soap log to cpi log
  if response_code == 204 && log_type == 'cpi'
    get_task_output(task_id, offset, 'soap')
  else
    [body, new_offset]
  end
end

#get_task_result(task_id) ⇒ Object 



497
498
499
 
# File 'lib/cli/client/director.rb', line 497

def get_task_result(task_id)
  get_task(task_id)['result']
end

#get_task_result_log(task_id) ⇒ Object 



501
502
503
504
 
# File 'lib/cli/client/director.rb', line 501

def get_task_result_log(task_id)
  log, _ = get_task_output(task_id, 0, 'result')
  log
end

#get_task_state(task_id) ⇒ Object 



493
494
495
 
# File 'lib/cli/client/director.rb', line 493

def get_task_state(task_id)
  get_task(task_id)['state']
end

#get_time_difference ⇒ Object 



471
472
473
474
475
 
# File 'lib/cli/client/director.rb', line 471

def get_time_difference
  # This includes the round-trip to director
  ctime = get_current_time
  ctime ? Time.now - ctime : 0
end

#get_version ⇒ Object 



106
107
108
 
# File 'lib/cli/client/director.rb', line 106

def get_version
  get_status['version']
end

#list_deployments ⇒ Object 



122
123
124
 
# File 'lib/cli/client/director.rb', line 122

def list_deployments
  get_json('/deployments')
end

#list_locks ⇒ Object 



546
547
548
 
# File 'lib/cli/client/director.rb', line 546

def list_locks
  get_json('/locks')
end

#list_problems(deployment_name) ⇒ Object 



451
452
453
454
 
# File 'lib/cli/client/director.rb', line 451

def list_problems(deployment_name)
  url = "/deployments/#{deployment_name}/problems"
  get_json(url)
end

#list_properties(deployment_name) ⇒ Object 



402
403
404
405
 
# File 'lib/cli/client/director.rb', line 402

def list_properties(deployment_name)
  url = "/deployments/#{deployment_name}/properties"
  get_json(url)
end

#list_recent_tasks(count = 30, verbose = 1) ⇒ Object 



135
136
137
 
# File 'lib/cli/client/director.rb', line 135

def list_recent_tasks(count = 30, verbose = 1)
  get_json("/tasks?limit=#{count}&verbose=#{verbose}")
end

#list_releases ⇒ Object 



118
119
120
 
# File 'lib/cli/client/director.rb', line 118

def list_releases
  get_json('/releases')
end

#list_running_tasks(verbose = 1) ⇒ Object 



126
127
128
129
130
131
132
133
 
# File 'lib/cli/client/director.rb', line 126

def list_running_tasks(verbose = 1)
  if version_less(get_version, '0.3.5')
    get_json('/tasks?state=processing')
  else
    get_json('/tasks?state=processing,cancelling,queued' +
               "&verbose=#{verbose}")
  end
end

#list_snapshots(deployment_name, job = nil, index = nil) ⇒ Object 



419
420
421
422
423
424
425
426
 
# File 'lib/cli/client/director.rb', line 419

def list_snapshots(deployment_name, job = nil, index = nil)
  if job && index
    url = "/deployments/#{deployment_name}/jobs/#{job}/#{index}/snapshots"
  else
    url = "/deployments/#{deployment_name}/snapshots"
  end
  get_json(url)
end

#list_stemcells ⇒ Object 



114
115
116
 
# File 'lib/cli/client/director.rb', line 114

def list_stemcells
  get_json('/stemcells')
end

#list_vms(name) ⇒ Object 



159
160
161
162
 
# File 'lib/cli/client/director.rb', line 159

def list_vms(name)
  _, body = get_json_with_status("/deployments/#{name}/vms")
  body
end

#match_packages(manifest_yaml) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/cli/client/director.rb', line 143

def match_packages(manifest_yaml)
  url          = '/packages/matches'
  status, body = post(url, 'text/yaml', manifest_yaml)

  if status == 200
    JSON.parse(body)
  else
    err(parse_error_message(status, body))
  end
end

#perform_cloud_scan(deployment_name, options = {}) ⇒ Object 



444
445
446
447
448
449
 
# File 'lib/cli/client/director.rb', line 444

def perform_cloud_scan(deployment_name, options = {})
  options = options.dup
  url     = "/deployments/#{deployment_name}/scans"

  request_and_track(:post, url, options)
end

#rebase_release(filename, options = {}) ⇒ Object 



171
172
173
174
175
 
# File 'lib/cli/client/director.rb', line 171

def rebase_release(filename, options = {})
  options                = options.dup
  options[:content_type] = 'application/x-compressed'
  upload_and_track(:post, '/releases?rebase=true', filename, options)
end

#rebase_remote_release(release_location, options = {}) ⇒ Object 



186
187
188
189
190
191
192
193
 
# File 'lib/cli/client/director.rb', line 186

def rebase_remote_release(release_location, options = {})
  options                = options.dup
  payload                = { 'location' => release_location }
  options[:payload]      = JSON.generate(payload)
  options[:content_type] = 'application/json'

  request_and_track(:post, '/releases?rebase=true', options)
end

#rename_job(deployment_name, manifest_yaml, old_name, new_name, force = false, options = {}) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/cli/client/director.rb', line 321

def rename_job(deployment_name, manifest_yaml, old_name, new_name,
  force = false, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/jobs/#{old_name}"

  extras = []
  extras << "new_name=#{new_name}"
  extras << 'force=true' if force

  options[:content_type] = 'text/yaml'
  options[:payload]      = manifest_yaml

  request_and_track(:put, add_query_string(url, extras), options)
end

#request_and_track(method, uri, options = {}) ⇒ Object

Perform director HTTP request and track director task (if request started one).

Parameters:

  • method (Symbol) —

    HTTP method

  • uri (String) —

    URI

  • options (Hash) (defaults to: {}) —

    Request and tracking options



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/cli/client/director.rb', line 561

def request_and_track(method, uri, options = {})
  options = options.dup

  content_type = options.delete(:content_type)
  payload      = options.delete(:payload)
  track_opts   = options

  http_status, _, headers = request(method, uri, content_type, payload)
  location                = headers[:location]
  redirected              = [302, 303].include? http_status
  task_id                 = nil

  if redirected
    if location =~ /\/tasks\/(\d+)\/?$/ # Looks like we received task URI
      task_id = $1
      if @track_tasks
        tracker = Bosh::Cli::TaskTracking::TaskTracker.new(self, task_id, track_opts)
        status  = tracker.track
      else
        status = :running
      end
    else
      status = :non_trackable
    end
  else
    status = :failed
  end

  [status, task_id]
end

#setup_ssh(deployment_name, job, index, user, public_key, password, options = {}) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/cli/client/director.rb', line 248

def setup_ssh(deployment_name, job, index, user,
  public_key, password, options = {})
  options = options.dup

  url = "/deployments/#{deployment_name}/ssh"

  payload = {
    'command'         => 'setup',
    'deployment_name' => deployment_name,
    'target'          => {
      'job'     => job,
      'indexes' => [index].compact
    },
    'params'          => {
      'user'       => user,
      'public_key' => public_key,
      'password'   => password
    }
  }

  options[:payload]      = JSON.generate(payload)
  options[:content_type] = 'application/json'

  request_and_track(:post, url, options)
end

#take_snapshot(deployment_name, job = nil, index = nil, options = {}) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/cli/client/director.rb', line 407

def take_snapshot(deployment_name, job = nil, index = nil, options = {})
  options = options.dup

  if job && index
    url = "/deployments/#{deployment_name}/jobs/#{job}/#{index}/snapshots"
  else
    url = "/deployments/#{deployment_name}/snapshots"
  end

  request_and_track(:post, url, options)
end

#update_property(deployment_name, property_name, value) ⇒ Object 



386
387
388
389
390
 
# File 'lib/cli/client/director.rb', line 386

def update_property(deployment_name, property_name, value)
  url     = "/deployments/#{deployment_name}/properties/#{property_name}"
  payload = JSON.generate('value' => value)
  put(url, 'application/json', payload)
end

#upload_and_track(method, uri, filename, options = {}) ⇒ Object 



592
593
594
595
596
597
 
# File 'lib/cli/client/director.rb', line 592

def upload_and_track(method, uri, filename, options = {})
  file = FileWithProgressBar.open(filename, 'r')
  request_and_track(method, uri, options.merge(:payload => file))
ensure
  file.stop_progress_bar if file
end

#upload_release(filename, options = {}) ⇒ Object 



164
165
166
167
168
169
 
# File 'lib/cli/client/director.rb', line 164

def upload_release(filename, options = {})
  options                = options.dup
  options[:content_type] = 'application/x-compressed'

  upload_and_track(:post, '/releases', filename, options)
end

#upload_remote_release(release_location, options = {}) ⇒ Object 



177
178
179
180
181
182
183
184
 
# File 'lib/cli/client/director.rb', line 177

def upload_remote_release(release_location, options = {})
  options                = options.dup
  payload                = { 'location' => release_location }
  options[:payload]      = JSON.generate(payload)
  options[:content_type] = 'application/json'

  request_and_track(:post, '/releases', options)
end

#upload_remote_stemcell(stemcell_location, options = {}) ⇒ Object 



97
98
99
100
101
102
103
104
 
# File 'lib/cli/client/director.rb', line 97

def upload_remote_stemcell(stemcell_location, options = {})
  options                = options.dup
  payload                = { 'location' => stemcell_location }
  options[:payload]      = JSON.generate(payload)
  options[:content_type] = 'application/json'

  request_and_track(:post, '/stemcells', options)
end

#upload_stemcell(filename, options = {}) ⇒ Object 



90
91
92
93
94
95
 
# File 'lib/cli/client/director.rb', line 90

def upload_stemcell(filename, options = {})
  options                = options.dup
  options[:content_type] = 'application/x-compressed'

  upload_and_track(:post, '/stemcells', filename, options)
end

#uuid ⇒ Object 



49
50
51
 
# File 'lib/cli/client/director.rb', line 49

def uuid
  @uuid ||= get_status['uuid']
end

#wait_until_ready ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/cli/client/director.rb', line 62

def wait_until_ready
  num_retries.times do
    return if exists?
    sleep retry_wait_interval
  end
end