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

Includes:
Common
Included in:
Apps::Common, Apps::ServiceGenerator, ContainersCommand, CreateCommand, DeleteCommand, DeployCommand, Envs::AddCommand, Envs::ListCommand, Envs::RemoveCommand, 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=, #api_url_version, #ask, #clear_current_grid, #client, #cloud_auth?, #cloud_client, #config, #confirm, #confirm_command, #current_account, #current_grid, #current_grid=, #current_master, #current_master=, #current_master_index, #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_current_account, #require_current_grid, #require_current_master, #require_token, #reset_client, #reset_cloud_client, #running_silent?, #running_verbose?, #settings, #settings_filename, #spinner, #sprint, #sputs, #use_refresh_token, #vfakespinner, #vputs, #vspinner, #warning, #yes?

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:



268
269
270
271
 
# File 'lib/kontena/cli/services/services_helper.rb', line 268

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:



219
220
221
222
 
# File 'lib/kontena/cli/services/services_helper.rb', line 219

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) 


452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/kontena/cli/services/services_helper.rb', line 452

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:



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/kontena/cli/services/services_helper.rb', line 434

def health_status_icon(health)
  if health == :unhealthy
    icon = '⊗'.freeze
    icon.colorize(:red)
  elsif health == :partial
    icon = '⊙'.freeze
    icon.colorize(:yellow)
  elsif health == :healthy
    icon = '⊛'.freeze
    icon.colorize(:green)
  else
    icon = '⊝'.freeze
    icon.colorize(:dim)
  end
end

#int_to_filesize(int) ⇒ Object 



403
404
405
406
407
408
409
410
411
 
# File 'lib/kontena/cli/services/services_helper.rb', line 403

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 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/kontena/cli/services/services_helper.rb', line 413

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) 


289
290
291
292
293
294
295
 
# File 'lib/kontena/cli/services/services_helper.rb', line 289

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_image(image) ⇒ String

Parameters:

Returns:



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

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

#parse_links(link_options) ⇒ Array<Hash>

Parameters:

  • link_options (Array<String>)

Returns:

  • (Array<Hash>) 


321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/kontena/cli/services/services_helper.rb', line 321

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) 


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

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) 


337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/kontena/cli/services/services_helper.rb', line 337

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


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/kontena/cli/services/services_helper.rb', line 299

def parse_ports(port_options)
  port_options.map{|p|
    port, protocol = p.split('/')
    protocol ||= 'tcp'
    port_elements = port.split(':')
    container_port = port_elements[-1]
    node_port = port_elements[-2]
    ip = port_elements[-3] || '0.0.0.0'
    if node_port.nil? || container_port.nil?
      raise ArgumentError.new("Invalid port value #{p}")
    end
    {
      ip: ip,
      container_port: container_port,
      node_port: node_port,
      protocol: protocol
    }
  }
end

#parse_relative_time(time) ⇒ Integer, NilClass

Parameters:

Returns:

  • (Integer, NilClass) 


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

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


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

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:



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/kontena/cli/services/services_helper.rb', line 275

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

#restart_service(token, service_id) ⇒ Object

Parameters:



261
262
263
264
 
# File 'lib/kontena/cli/services/services_helper.rb', line 261

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
 
# File 'lib/kontena/cli/services/services_helper.rb', line 42

def show_service(token, service_id)
  service = get_service(token, service_id)
  grid = service['id'].split('/')[0]
  puts "#{service['id']}:"
  puts "  stack: #{service['stack']['id'] }"
  puts "  status: #{service['state'] }"
  puts "  image: #{service['image']}"
  puts "  revision: #{service['revision']}"
  puts "  stateful: #{service['stateful'] == true ? 'yes' : 'no' }"
  puts "  scaling: #{service['instances'] }"
  puts "  strategy: #{service['strategy']}"
  puts "  deploy_opts:"
  puts "    min_health: #{service['deploy_opts']['min_health']}"
  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['env'].to_a.size > 0
    puts "  env: "
    service['env'].to_a.each do |e|
      puts "    - #{e}"
    end
  end

  unless service['net'].to_s.empty?
    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['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['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_instances(token, service_id) ⇒ Object 



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
 
# File 'lib/kontena/cli/services/services_helper.rb', line 187

def show_service_instances(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: #{container['status'].colorize(:yellow)}"
    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

#start_service(token, service_id) ⇒ Object

Parameters:



247
248
249
250
 
# File 'lib/kontena/cli/services/services_helper.rb', line 247

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:



254
255
256
257
 
# File 'lib/kontena/cli/services/services_helper.rb', line 254

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) ⇒ Boolean

Parameters:

  • token (String)
  • deployment (Hash)

Returns:

  • (Boolean) 


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/kontena/cli/services/services_helper.rb', line 227

def wait_for_deploy_to_finish(token, deployment, timeout = 600)
  deployed = false
  Timeout::timeout(timeout) do
    until deployed
      deployment = client(token).get("services/#{deployment['service_id']}/deploys/#{deployment['id']}")
      deployed = true if deployment['finished_at']
      sleep 1
    end
    if deployment['state'] == 'error'
      raise Kontena::Errors::StandardError.new(500, deployment['reason'])
    end
  end

  deployed
rescue Timeout::Error
  raise Kontena::Errors::StandardError.new(500, 'deploy timed out')
end