Module: Kontena::Cli::Services::ServicesHelper

Includes:
Common
Included in:
Certificate::AuthorizeCommand, ContainersCommand, CreateCommand, DeployCommand, Envs::AddCommand, Envs::ListCommand, Envs::RemoveCommand, EventsCommand, ExecCommand, LinkCommand, ListCommand, LogsCommand, MonitorCommand, RemoveCommand, RestartCommand, ScaleCommand, Kontena::Cli::Services::Secrets::LinkCommand, Kontena::Cli::Services::Secrets::UnlinkCommand, ShowCommand, StartCommand, StatsCommand, StopCommand, UnlinkCommand, UpdateCommand, Kontena::Cli::Stacks::Common, Kontena::Cli::Stacks::ServiceGenerator
Defined in:
lib/kontena/cli/services/services_helper.rb

Instance Method Summary collapse

Methods included from Common

#access_token=, #add_master, #any_key_to_continue, #any_key_to_continue_with_timeout, #api_url, #api_url=, #caret, #clear_current_grid, #client, #cloud_auth?, #cloud_client, #config, #confirm, #confirm_command, #current_grid, #current_master_index, #debug?, #display_account_login_info, #display_login_info, display_logo, #display_master_login_info, #error, exit_with_error, #kontena_account, #logger, #pastel, #print, #prompt, #puts, #require_api_url, #require_token, #reset_client, #reset_cloud_client, #running_quiet?, #running_silent?, #running_verbose?, #spin_if, #spinner, #sprint, #sputs, #stdin_input, #use_refresh_token, #vfakespinner, #vputs, #vspinner, #warning

Instance Method Details

#create_service(token, grid_id, data) ⇒ Object

Parameters:



13
14
15
 
# File 'lib/kontena/cli/services/services_helper.rb', line 13

def create_service(token, grid_id, data)
  client(token).post("grids/#{grid_id}/services", data)
end

#delete_service(token, service_id) ⇒ Object

Parameters:



354
355
356
357
 
# File 'lib/kontena/cli/services/services_helper.rb', line 354

def delete_service(token, service_id)
  param = parse_service_id(service_id)
  client(token).delete("services/#{param}")
end

#deploy_service(token, service_id, data) ⇒ Object

Parameters:



283
284
285
286
 
# File 'lib/kontena/cli/services/services_helper.rb', line 283

def deploy_service(token, service_id, data)
  param = parse_service_id(service_id)
  client(token).post("services/#{param}/deploy", data)
end

#get_service(token, service_id) ⇒ Object

Parameters:



35
36
37
38
 
# File 'lib/kontena/cli/services/services_helper.rb', line 35

def get_service(token, service_id)
  param = parse_service_id(service_id)
  client(token).get("services/#{param}")
end

#health_status(service) ⇒ Symbol

Parameters:

  • service (Hash)

Returns:

  • (Symbol) 


561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/kontena/cli/services/services_helper.rb', line 561

def health_status(service)
  if service['health_status']
    healthy = service.dig('health_status', 'healthy')
    total = service.dig('health_status', 'total')
    if healthy == 0
      :unhealthy
    elsif healthy > 0 && healthy < total
      :partial
    else
      :healthy
    end
  else
    :unknown
  end
end

#health_status_icon(health) ⇒ String

Parameters:

  • health (Symbol)

Returns:



549
550
551
552
553
554
555
556
557
 
# File 'lib/kontena/cli/services/services_helper.rb', line 549

def health_status_icon(health)
  case health
  when :unhealthy then pastel.red('⊗')
  when :partial   then pastel.yellow('⊙')
  when :healthy   then pastel.green('⊛')
  else
    pastel.dim('⊝')
  end
end

#int_to_filesize(int) ⇒ Object 



489
490
491
492
493
494
495
496
497
 
# File 'lib/kontena/cli/services/services_helper.rb', line 489

def int_to_filesize(int)
  {
    'B'  => 1000,
    'KB' => 1000 * 1000,
    'MB' => 1000 * 1000 * 1000,
    'GB' => 1000 * 1000 * 1000 * 1000,
    'TB' => 1000 * 1000 * 1000 * 1000 * 1000
  }.each_pair { |e, s| return "#{(int.to_i / (s / 1000))}#{e}" if int < s }
end

#parse_build_args(args) ⇒ Object 



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/kontena/cli/services/services_helper.rb', line 499

def parse_build_args(args)
  build_args = {}
  if args.kind_of?(Array)
    args.each do |arg|
      key, val = arg.split('=')
      build_args[key] = val
    end
  elsif args.kind_of?(Hash)
    build_args = build_args.merge(args)
    build_args.each do |k, v|
      if v.nil?
        build_args[k] = ENV[k.to_s] # follow docker compose functionality here
      end
    end
  end

  build_args
end

#parse_container_name(service_name, instance_number) ⇒ Object

Parses container name based on service name and instance number

Parameters:

  • service_name (String)
  • instance_number (Integer) 


375
376
377
378
379
380
381
 
# File 'lib/kontena/cli/services/services_helper.rb', line 375

def parse_container_name(service_name, instance_number)
  base = service_name.gsub('/', '-')
  unless service_name.include?('/')
    base = "null-#{base}"
  end
  "#{base}-#{instance_number}"
end

#parse_deploy_opts ⇒ Hash

Returns:

  • (Hash) 


519
520
521
522
523
524
525
526
527
528
 
# File 'lib/kontena/cli/services/services_helper.rb', line 519

def parse_deploy_opts
  deploy_opts = {}
  deploy_opts[:min_health] = deploy_min_health.to_f if deploy_min_health
  deploy_opts[:wait_for_port] = deploy_wait_for_port.to_i if deploy_wait_for_port
  if deploy_interval
    deploy_opts[:interval] = parse_relative_time(deploy_interval)
  end

  deploy_opts
end

#parse_health_check ⇒ Hash

Returns:

  • (Hash) 


531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/kontena/cli/services/services_helper.rb', line 531

def parse_health_check
  health_check = {}
  if health_check_port
    health_check[:port] = health_check_port == 'none' ? nil : health_check_port
  end
  if health_check_protocol
    health_check[:protocol] = health_check_protocol == 'none' ? nil : health_check_protocol
  end
  health_check[:uri] = health_check_uri if health_check_uri
  health_check[:timeout] = health_check_timeout if health_check_timeout
  health_check[:interval] = health_check_interval if health_check_interval
  health_check[:initial_delay] = health_check_initial_delay if health_check_initial_delay

  health_check
end

#parse_image(image = nil) ⇒ String

Parameters:

  • image (String) (defaults to: nil)

Returns:



439
440
441
442
443
444
445
 
# File 'lib/kontena/cli/services/services_helper.rb', line 439

def parse_image(image = nil)
  return if image.nil?
  unless image.include?(":")
    image = "#{image}:latest"
  end
  image
end

#parse_links(link_options) ⇒ Array<Hash>

Parameters:

  • link_options (Array<String>)

Returns:

  • (Array<Hash>) 


406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/kontena/cli/services/services_helper.rb', line 406

def parse_links(link_options)
  link_options.map{|l|
    service_name, alias_name = l.split(':')
    if service_name.nil?
      raise ArgumentError.new("Invalid link value #{l}")
    end
    alias_name = service_name if alias_name.nil?
    {
        name: service_name,
        alias: alias_name
    }
  }
end

#parse_log_opts(log_opts) ⇒ Hash

Parameters:

  • log_opts (Array)

Returns:

  • (Hash) 


450
451
452
453
454
455
456
457
 
# File 'lib/kontena/cli/services/services_helper.rb', line 450

def parse_log_opts(log_opts)
  opts = {}
  log_opts.each do |opt|
    key, value = opt.split('=')
    opts[key] = value
  end
  opts
end

#parse_memory(memory) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/kontena/cli/services/services_helper.rb', line 422

def parse_memory(memory)
  case memory
  when /^\d+(k|K)$/
    memory.to_i * 1024
  when /^\d+(m|M)$/
    memory.to_i * 1024 * 1024
  when /^\d+(g|G)$/
    memory.to_i * 1024 * 1024 * 1024
  when /^\d+$/
    memory.to_i
  else
    raise ArgumentError.new("Invalid memory value: #{memory}")
  end
end

#parse_ports(port_options) ⇒ Array<Hash>

Parameters:

  • port_options (Array<String>)

Returns:

  • (Array<Hash>) 


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/kontena/cli/services/services_helper.rb', line 385

def parse_ports(port_options)
  port_regex = Regexp.new(/\A(?<ip>\d+\.\d+\.\d+\.\d+)?:?(?<node_port>\d+)\:(?<container_port>\d+)\/?(?<protocol>\w+)?\z/)
  port_options.map do |p|
    if p.kind_of?(Hash)
      raise ArgumentError, "Missing or invalid node port" unless p['node_port'].to_i > 0
      raise ArgumentError, "Missing or invalid container port" unless p['container_port'].to_i > 0
      { ip: p['ip'] || '0.0.0.0', protocol: p['protocol'] || 'tcp', node_port: p['node_port'].to_i, container_port: p['container_port'].to_i }
    else
      match_data = port_regex.match(p.to_s)
      raise ArgumentError, "Invalid port value #{p}" unless match_data

      {
        ip: '0.0.0.0',
        protocol: 'tcp'
      }.merge(match_data.names.map { |name| [name.to_sym, match_data[name]] }.to_h.reject { |_,v| v.nil? })
    end
  end
end

#parse_relative_time(time) ⇒ Integer, NilClass

Parameters:

Returns:

  • (Integer, NilClass) 


472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/kontena/cli/services/services_helper.rb', line 472

def parse_relative_time(time)
  if time.end_with?('min')
    time.to_i * 60
  elsif time.end_with?('h')
    time.to_i * 60 * 60
  elsif time.end_with?('d')
    time.to_i * 60 * 60 * 24
  else
    time = time.to_i
    if time == 0
      nil
    else
      time
    end
  end
end

#parse_secrets(secret_opts) ⇒ Array<Hash>

Parameters:

Returns:

  • (Array<Hash>) 


461
462
463
464
465
466
467
468
 
# File 'lib/kontena/cli/services/services_helper.rb', line 461

def parse_secrets(secret_opts)
  secrets = []
  secret_opts.each do |s|
    secret, name, type = s.split(':')
    secrets << {secret: secret, name: name, type: type}
  end
  secrets
end

#parse_service_id(service_id) ⇒ String

Parameters:

Returns:



361
362
363
364
365
366
367
368
369
370
 
# File 'lib/kontena/cli/services/services_helper.rb', line 361

def parse_service_id(service_id)
  count = service_id.to_s.count('/')
  if count == 2
    param = service_id
  elsif count == 1
    param = "#{current_grid}/#{service_id}"
  else
    param = "#{current_grid}/null/#{service_id}"
  end
end

#render_service_deploy_instances(deployment) ⇒ String

Returns multi-line.

Parameters:

  • deployment (Hash)

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/kontena/cli/services/services_helper.rb', line 290

def render_service_deploy_instances(deployment)
  deployment['instance_deploys'].map{ |instance_deploy|
    description = "instance #{deployment['service_id']}-#{instance_deploy['instance_number']} to node #{instance_deploy['node']}"

    case instance_deploy['state']
    when 'created'
      "#{pastel.dark('⊝')} Deploy #{description}"
    when 'ongoing'
      "#{pastel.cyan('⊙')} Deploying #{description}..."
    when 'success'
      "#{pastel.green('⊛')} Deployed #{description}"
    when 'error'
      "#{pastel.red('⊗')} Failed to deploy #{description}: #{instance_deploy['error']}"
    else
      "#{pastel.dark('⊗')} Deploy #{description}?"
    end
  }
end

#restart_service(token, service_id) ⇒ Object

Parameters:



347
348
349
350
 
# File 'lib/kontena/cli/services/services_helper.rb', line 347

def restart_service(token, service_id)
  param = parse_service_id(service_id)
  client(token).post("services/#{param}/restart", {})
end

#scale_service(token, service_id, instances) ⇒ Object

Parameters:



28
29
30
31
 
# File 'lib/kontena/cli/services/services_helper.rb', line 28

def scale_service(token, service_id, instances)
  param = parse_service_id(service_id)
  client(token).post("services/#{param}/scale", {instances: instances})
end

#show_service(token, service_id) ⇒ Object

Parameters:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
82
83
84
85
86
87
88
89
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
147
148
149
150
151
152
153
154
155
156
157
158
159
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
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
212
213
214
215
 
# File 'lib/kontena/cli/services/services_helper.rb', line 42

def show_service(token, service_id)
  service = get_service(token, service_id)
  puts "#{service['id']}:"
  puts "  created: #{service['created_at']}"
  puts "  updated: #{service['updated_at']}"
  puts "  stack: #{service['stack']['id'] }"
  puts "  desired_state: #{service['state'] }"
  puts "  image: #{service['image']}"
  puts "  revision: #{service['revision']}"
  puts "  stack_revision: #{service['stack_revision']}" if service['stack_revision']
  puts "  stateful: #{service['stateful'] == true ? 'yes' : 'no' }"
  puts "  scaling: #{service['instances'] }"
  puts "  strategy: #{service['strategy']}"
  puts "  read_only: #{service['read_only'] == true ? 'yes' : 'no'}"
  unless service['stop_signal'].to_s.empty?
    puts "  stop_signal: #{service['stop_signal']}"
  end
  puts "  stop_grace_period: #{service['stop_grace_period']}s"
  puts "  deploy_opts:"
  if service['deploy_opts']['min_health']
    puts "    min_health: #{service['deploy_opts']['min_health']}"
  end
  if service['deploy_opts']['wait_for_port']
    puts "    wait_for_port: #{service['deploy_opts']['wait_for_port']}"
  end
  if service['deploy_opts']['interval']
    puts "    interval: #{service['deploy_opts']['interval']}"
  end
  puts "  dns: #{service['dns']}"

  if service['affinity'].to_a.size > 0
    puts "  affinity: "
    service['affinity'].to_a.each do |a|
      puts "    - #{a}"
    end
  end

  unless service['cmd'].to_s.empty?
    if service['cmd']
      puts "  cmd: #{service['cmd'].join(' ')}"
    else
      puts "  cmd: "
    end
  end

  if service['hooks'].to_a.size > 0
    puts "  hooks: "
    service['hooks'].to_a.each do |hook|
        puts "    - name: #{hook['name']}"
        puts "      type: #{hook['type']}"
        puts "      cmd: #{hook['cmd']}"
        puts "      oneshot: #{hook['oneshot']}"
    end
  end

  if service['secrets'].to_a.size > 0
    puts "  secrets: "
    service['secrets'].to_a.each do |s|
      puts "    - secret: #{s['secret']}"
      puts "      name: #{s['name']}"
      puts "      type: #{s['type']}"
    end
  end

  if service['certificates'].to_a.size > 0
    puts "  certificates: "
    service['certificates'].to_a.each do |c|
      puts "    - subject: #{c['subject']}"
      puts "      name: #{c['name']}"
      puts "      type: #{c['type']}"
    end
  end

  if service['env'].to_a.size > 0
    puts "  env: "
    service['env'].to_a.each do |e|
      puts "    - #{e}"
    end
  end

  if service['net'].to_s != 'bridge'
    puts "  net: #{service['net']}"
  end

  if service['ports'].to_a.size > 0
    puts "  ports:"
    service['ports'].to_a.each do |p|
      puts "    - #{p['node_port']}:#{p['container_port']}/#{p['protocol']}"
    end
  end

  if service['volumes'].to_a.size > 0
    puts "  volumes:"
    service['volumes'].to_a.each do |v|
      puts "    - #{v}"
    end
  end

  if service['volumes_from'].to_a.size > 0
    puts "  volumes_from:"
    service['volumes_from'].to_a.each do |v|
      puts "    - #{v}"
    end
  end

  if service['links'].to_a.size > 0
    puts "  links: "
    service['links'].to_a.each do |l|
      puts "    - #{l['alias']}"
    end
  end

  if service['cap_add'].to_a.size > 0
    puts "  cap_add:"
    service['cap_add'].to_a.each do |c|
      puts "    - #{c}"
    end
  end

  if service['cap_drop'].to_a.size > 0
    puts "  cap_drop:"
    service['cap_drop'].to_a.each do |c|
      puts "    - #{c}"
    end
  end

  unless service['log_driver'].to_s.empty?
    puts "  log_driver: #{service['log_driver']}"
    puts "  log_opts:"
    service['log_opts'].each do |opt, value|
      puts "    #{opt}: #{value}"
    end
  end

  unless service['cpus'].to_s.empty?
    puts "  cpus: #{service['cpus']}"
  end

  unless service['cpu_shares'].to_s.empty?
    puts "  cpu_shares: #{service['cpu_shares']}"
  end

  unless service['memory'].to_s.empty?
    puts "  memory: #{int_to_filesize(service['memory'])}"
  end

  unless service['memory_swap'].to_s.empty?
    puts "  memory_swap: #{int_to_filesize(service['memory_swap'])}"
  end

  unless service['shm_size'].to_s.empty?
    puts "  shm_size: #{int_to_filesize(service['shm_size'])}"
  end

  unless service['pid'].to_s.empty?
    puts "  pid: #{service['pid']}"
  end

  if service['health_check']
    puts "  health check:"
    puts "    protocol: #{service['health_check']['protocol']}"
    puts "    uri: #{service['health_check']['uri']}" if service['health_check']['protocol'] == 'http'
    puts "    port: #{service['health_check']['port']}"
    puts "    timeout: #{service['health_check']['timeout']}"
    puts "    interval: #{service['health_check']['interval']}"
    puts "    initial_delay: #{service['health_check']['initial_delay']}"
  end

  if service['health_status']
    puts "  health status:"
    puts "    healthy: #{service['health_status']['healthy']}"
    puts "    total: #{service['health_status']['total']}"
  end
end

#show_service_containers(token, service_id) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/kontena/cli/services/services_helper.rb', line 251

def show_service_containers(token, service_id)
  puts "  instances:"
  result = client(token).get("services/#{parse_service_id(service_id)}/containers")
  result['containers'].each do |container|
    puts "    #{container['name']}:"
    puts "      rev: #{container['deploy_rev']}"
    puts "      service_rev: #{container['service_rev']}"
    puts "      node: #{container['node']['name'] rescue 'unknown'}"
    puts "      dns: #{container['hostname']}.#{container['domainname']}"
    puts "      ip: #{container['ip_address']}"
    puts "      public ip: #{container['node']['public_ip'] rescue 'unknown'}"
    if container['health_status']
      health_time = Time.now - Time.parse(container.dig('health_status', 'updated_at'))
      puts "      health: #{container.dig('health_status', 'status')} (#{health_time.to_i}s ago)"
    end
    if container['status'] == 'unknown'
      puts "      status: #{pastel.yellow(container['status'])}"
    else
      puts "      status: #{container['status']}"
    end
    if container['state']['error'] && container['state']['error'] != ''
      puts "      reason: #{container['state']['error']}"
    end
    if container['state']['exit_code'] && container['state']['exit_code'] != ''
      puts "      exit code: #{container['state']['exit_code']}"
    end
  end
end

#show_service_instances(token, service_id) ⇒ Object 



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
243
244
245
246
247
248
249
 
# File 'lib/kontena/cli/services/services_helper.rb', line 217

def show_service_instances(token, service_id)
  puts "  instances:"
  instances = client(token).get("services/#{parse_service_id(service_id)}/instances")['instances']
  containers = client(token).get("services/#{parse_service_id(service_id)}/containers")['containers']
  instances.each do |i|
    puts "    #{name}/#{i['instance_number']}:"
    puts "      scheduled_to: #{i.dig('node', 'name') || '-'}"
    puts "      deploy_rev: #{i['deploy_rev']}"
    puts "      rev: #{i['rev']}"
    puts "      state: #{i['state']}"
    puts "      error: #{i['error'] || '-'}" if i['error']
    puts "      containers:"
    containers.select { |c|
      c['instance_number'] == i['instance_number']
    }.each do |container|
      puts "        #{container['name']} (on #{container.dig('node', 'name')}):"
      puts "          dns: #{container['hostname']}.#{container['domainname']}"
      puts "          ip: #{container['ip_address']}"
      puts "          public ip: #{container['node']['public_ip'] rescue 'unknown'}"
      if container['health_status']
        health_time = Time.now - Time.parse(container.dig('health_status', 'updated_at'))
        puts "          health: #{container.dig('health_status', 'status')} (#{health_time.to_i}s ago)"
      end
      puts "          status: #{container['status']}"
      if container.dig('state', 'error') != ''
        puts "          reason: #{container['state']['error']}"
      end
      if container.dig('state', 'exit_code').to_i != 0
        puts "          exit code: #{container['state']['exit_code']}"
      end
    end
  end
end

#start_service(token, service_id) ⇒ Object

Parameters:



333
334
335
336
 
# File 'lib/kontena/cli/services/services_helper.rb', line 333

def start_service(token, service_id)
  param = parse_service_id(service_id)
  client(token).post("services/#{param}/start", {})
end

#stop_service(token, service_id) ⇒ Object

Parameters:



340
341
342
343
 
# File 'lib/kontena/cli/services/services_helper.rb', line 340

def stop_service(token, service_id)
  param = parse_service_id(service_id)
  client(token).post("services/#{param}/stop", {})
end

#update_service(token, service_id, data) ⇒ Object

Parameters:



20
21
22
23
 
# File 'lib/kontena/cli/services/services_helper.rb', line 20

def update_service(token, service_id, data)
  param = parse_service_id(service_id)
  client(token).put("services/#{param}", data)
end

#wait_for_deploy_to_finish(token, deployment, timeout: 600) ⇒ Object

Parameters:

  • token (String)
  • deployment (Hash)
  • timeout (Fixnum) (defaults to: 600)
  • verbose (Boo lean)

Raises:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/kontena/cli/services/services_helper.rb', line 314

def wait_for_deploy_to_finish(token, deployment, timeout: 600)
  Timeout::timeout(timeout) do
    until deployment['finished_at']
      sleep 1
      deployment = client(token).get("services/#{deployment['service_id']}/deploys/#{deployment['id']}")
    end

    if deployment['state'] == 'error'
      raise Kontena::Errors::StandardErrorArray.new(500, deployment['reason'], render_service_deploy_instances(deployment))
    else
      puts render_service_deploy_instances(deployment).join("\n")
    end
  end
rescue Timeout::Error
  raise Kontena::Errors::StandardError.new(500, 'deploy timed out')
end