Class: Bosh::Cli::Director

Inherits:
Object show all
Includes:
VersionCalc
Defined in:
lib/cli/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



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/cli/director.rb', line 24

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 = director_uri
  @user = user
  @password = password
  @track_tasks = !options.delete(:no_track)
end

Instance Attribute Details

#director_uri ⇒ Object (readonly)

Returns the value of attribute director_uri.



13
14
15
 
# File 'lib/cli/director.rb', line 13

def director_uri
  @director_uri
end

#password ⇒ String

Returns:



19
20
21
 
# File 'lib/cli/director.rb', line 19

def password
  @password
end

#user ⇒ String

Returns:



16
17
18
 
# File 'lib/cli/director.rb', line 16

def user
  @user
end

Instance Method Details

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/cli/director.rb', line 350

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) 


48
49
50
51
52
53
54
55
56
 
# File 'lib/cli/director.rb', line 48

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:



422
423
424
425
426
427
 
# File 'lib/cli/director.rb', line 422

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 



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

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

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/cli/director.rb', line 214

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_property(deployment_name, property_name, value) ⇒ Object 



311
312
313
314
315
 
# File 'lib/cli/director.rb', line 311

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 



58
59
60
61
62
 
# File 'lib/cli/director.rb', line 58

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

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/cli/director.rb', line 147

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 



323
324
325
326
 
# File 'lib/cli/director.rb', line 323

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

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



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cli/director.rb', line 159

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_stemcell(name, version, options = {}) ⇒ Object 



142
143
144
145
 
# File 'lib/cli/director.rb', line 142

def delete_stemcell(name, version, options = {})
  options = options.dup
  request_and_track(:delete, "/stemcells/#{name}/#{version}", options)
end

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cli/director.rb', line 173

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 



299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/cli/director.rb', line 299

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) 


39
40
41
42
43
44
45
46
 
# File 'lib/cli/director.rb', line 39

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

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/cli/director.rb', line 266

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)

  # TODO: this should be done in command handler, not in director.rb
  return nil if status != :done
  get_task_result(task_id)
end

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/cli/director.rb', line 280

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)

  # TODO: this should be done in command handler, not in director.rb
  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 



360
361
362
363
 
# File 'lib/cli/director.rb', line 360

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

#get_deployment(name) ⇒ Object 



119
120
121
122
 
# File 'lib/cli/director.rb', line 119

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

#get_property(deployment_name, property_name) ⇒ Object 



328
329
330
331
 
# File 'lib/cli/director.rb', line 328

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

#get_release(name) ⇒ Object 



104
105
106
 
# File 'lib/cli/director.rb', line 104

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

#get_status ⇒ Object 



75
76
77
 
# File 'lib/cli/director.rb', line 75

def get_status
  get_json("/info")
end

#get_task(task_id) ⇒ Object 



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/cli/director.rb', line 371

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 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/cli/director.rb', line 400

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
  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 



391
392
393
 
# File 'lib/cli/director.rb', line 391

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

#get_task_result_log(task_id) ⇒ Object 



395
396
397
398
 
# File 'lib/cli/director.rb', line 395

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

#get_task_state(task_id) ⇒ Object 



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

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

#get_time_difference ⇒ Object 



365
366
367
368
369
 
# File 'lib/cli/director.rb', line 365

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

#get_version ⇒ Object 



71
72
73
 
# File 'lib/cli/director.rb', line 71

def get_version
  get_status["version"]
end

#list_deployments ⇒ Object 



87
88
89
 
# File 'lib/cli/director.rb', line 87

def list_deployments
  get_json("/deployments")
end

#list_problems(deployment_name) ⇒ Object 



345
346
347
348
 
# File 'lib/cli/director.rb', line 345

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

#list_properties(deployment_name) ⇒ Object 



333
334
335
336
 
# File 'lib/cli/director.rb', line 333

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

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



100
101
102
 
# File 'lib/cli/director.rb', line 100

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

#list_releases ⇒ Object 



83
84
85
 
# File 'lib/cli/director.rb', line 83

def list_releases
  get_json("/releases")
end

#list_running_tasks(verbose = 1) ⇒ Object 



91
92
93
94
95
96
97
98
 
# File 'lib/cli/director.rb', line 91

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_stemcells ⇒ Object 



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

def list_stemcells
  get_json("/stemcells")
end

#list_vms(name) ⇒ Object 



124
125
126
127
 
# File 'lib/cli/director.rb', line 124

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

#match_packages(manifest_yaml) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cli/director.rb', line 108

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

#parse_error_message(status, body) ⇒ Object 



531
532
533
534
535
536
537
538
539
540
 
# File 'lib/cli/director.rb', line 531

def parse_error_message(status, body)
  parsed_body = JSON.parse(body.to_s) rescue {}

  if parsed_body["code"] && parsed_body["description"]
    "Error %s: %s" % [parsed_body["code"],
                      parsed_body["description"]]
  else
    "HTTP %s: %s" % [status, body]
  end
end

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



338
339
340
341
342
343
 
# File 'lib/cli/director.rb', line 338

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 



136
137
138
139
140
 
# File 'lib/cli/director.rb', line 136

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

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

TODO: should pass ‘force’ with options, not as a separate argument



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/cli/director.rb', line 250

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(method, uri, content_type = nil, payload = nil, headers = {}, options = {}) ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/cli/director.rb', line 478

def request(method, uri, content_type = nil, payload = nil,
            headers = {}, options = {})
  headers = headers.dup
  tmp_file = nil

  headers["Content-Type"] = content_type if content_type

  if options[:file]
    tmp_file = File.open(File.join(Dir.mktmpdir, "streamed-response"),
                         "w")

    response_reader = lambda do |part|
      tmp_file.write(part)
    end
  else
    response_reader = nil
  end

  response = perform_http_request(method, @director_uri + uri,
                                  payload, headers, &response_reader)

  if options[:file]
    tmp_file.close
    body = tmp_file.path
  else
    body = response.body
  end

  if DIRECTOR_HTTP_ERROR_CODES.include?(response.code)
    if response.code == 404
      raise ResourceNotFound, parse_error_message(response.code, body)
    else
      raise DirectorError, parse_error_message(response.code, body)
    end
  end

  headers = response.headers.inject({}) do |hash, (k, v)|
    # Some HTTP clients symbolize headers, some do not.
    # To make it easier to switch between them, we try
    # to symbolize them ourselves.
    hash[k.to_s.downcase.gsub(/-/, "_").to_sym] = v
    hash
  end

  [response.code, body, headers]

rescue URI::Error, SocketError, Errno::ECONNREFUSED => e
  raise DirectorInaccessible,
        "cannot access director (#{e.message})"
rescue SystemCallError => e
  raise DirectorError, "System call error while talking to director: #{e}"
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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/cli/director.rb', line 440

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 = http_status == 302
  task_id = nil

  if redirected
    if location =~ /\/tasks\/(\d+)\/?$/ # Looks like we received task URI
      task_id = $1
      if @track_tasks
        tracker = Bosh::Cli::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 



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
 
# File 'lib/cli/director.rb', line 188

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

#update_property(deployment_name, property_name, value) ⇒ Object 



317
318
319
320
321
 
# File 'lib/cli/director.rb', line 317

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 



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

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 



129
130
131
132
133
134
 
# File 'lib/cli/director.rb', line 129

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

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

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



64
65
66
67
68
69
 
# File 'lib/cli/director.rb', line 64

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

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

#uuid ⇒ Object 



35
36
37
 
# File 'lib/cli/director.rb', line 35

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