Class: OodCore::Job::Adapters::Kubernetes::Helper

Inherits:
Object
  • Object
show all
Defined in:
lib/ood_core/job/adapters/kubernetes/helper.rb

Overview

Utility class for the Kubernetes adapter to parse json data into Ruby objects.

Defined Under Namespace

Classes: K8sDataError

Instance Method Summary collapse

Instance Method Details

#configmap_from_native(native, id, script_content) ⇒ OodCore::Job::Adapters::Kubernetes::Resources::ConfigMap

Turn a configmap hash into a Kubernetes::Resources::ConfigMap that can be used in templates. Needs an id so that the resulting configmap has a known name.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 96

def configmap_from_native(native, id, script_content)
  configmap = native.fetch(:configmap, {})
  configmap[:files] ||= []
  configmap[:files] << {
    filename: 'script.sh',
    data: script_content,
    mount_path: '/ood/script.sh',
    sub_path: 'script.sh',
  } unless configmap[:files].any? { |f| f[:filename] == 'script.sh' }

  OodCore::Job::Adapters::Kubernetes::Resources::ConfigMap.new(
    configmap_name(id),
    (configmap[:files] || [])
  )
end

#configmap_name(id) ⇒ Object 



140
141
142
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 140

def configmap_name(id)
  id + '-configmap'
end

#container_from_native(container, default_env) ⇒ OodCore::Job::Adapters::Kubernetes::Resources::Container

Turn a container hash into a Kubernetes::Resources::Container



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

def container_from_native(container, default_env)
  env = container.fetch(:env, {}).to_h.symbolize_keys
  OodCore::Job::Adapters::Kubernetes::Resources::Container.new(
    container[:name],
    container[:image],
    command: parse_command(container[:command]),
    port: container[:port],
    env: default_env.merge(env),
    memory_limit: container[:memory_limit] || container[:memory],
    memory_request: container[:memory_request] || container[:memory],
    cpu_limit: container[:cpu_limit] || container[:cpu],
    cpu_request: container[:cpu_request] || container[:cpu],
    working_dir: container[:working_dir],
    restart_policy: container[:restart_policy],
    image_pull_policy: container[:image_pull_policy],
    image_pull_secret: container[:image_pull_secret],
    supplemental_groups: container[:supplemental_groups],
    startup_probe: container[:startup_probe],
    labels: container[:labels],
  )
end

#info_from_json(pod_json: nil, service_json: nil, secret_json: nil, ns_prefix: nil) ⇒ OodCore::Job::Adapters::Kubernetes::K8sJobInfo

Extract info from json data. The data is expected to be from the kubectl command and conform to kubernetes’ datatype structures.

Returns K8sJobInfo in the in lieu of writing a connection.yml



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 29

def info_from_json(pod_json: nil, service_json: nil, secret_json: nil, ns_prefix: nil)
  pod_hash = pod_info_from_json(pod_json, ns_prefix: ns_prefix)
  service_hash = service_info_from_json(service_json)
  secret_hash = secret_info_from_json(secret_json)

  pod_hash.deep_merge!(service_hash)
  pod_hash.deep_merge!(secret_hash)
  OodCore::Job::Adapters::Kubernetes::K8sJobInfo.new(**pod_hash)
rescue NoMethodError
  raise K8sDataError, "unable to read data correctly from json"
end

#init_ctrs_from_native(ctrs, default_env) ⇒ Array<OodCore::Job::Adapters::Kubernetes::Resources::Container>

parse initialization containers from native data



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 121

def init_ctrs_from_native(ctrs, default_env)
  init_ctrs = []

  ctrs&.each do |ctr_raw|
    ctr = container_from_native(ctr_raw, default_env)
    init_ctrs.push(ctr)
  end

  init_ctrs
end

#parse_command(cmd) ⇒ Array<#to_s>

Parse a command string given from a user and return an array. If given an array, the input is simply returned back.



77
78
79
80
81
82
83
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 77

def parse_command(cmd)
  if cmd&.is_a?(Array)
    cmd
  else
    Shellwords.split(cmd.to_s)
  end
end

#pod_info_from_json(json_data, ns_prefix: nil) ⇒ #to_h

Extract pod info from json data. The data is expected to be from the kubectl command and conform to kubernetes’ datatype structures.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 157

def pod_info_from_json(json_data, ns_prefix: nil)
  {
    id: json_data.dig(:metadata, :name).to_s,
    job_name: name_from_metadata(json_data.dig(:metadata)),
    status: OodCore::Job::Status.new(state: pod_status_from_json(json_data)),
    job_owner: job_owner_from_json(json_data, ns_prefix),
    submission_time: submission_time(json_data),
    dispatch_time: dispatch_time(json_data),
    wallclock_time: wallclock_time(json_data),
    ood_connection_info: { host: get_host(json_data.dig(:status, :hostIP)) },
    procs: procs_from_json(json_data)
  }
rescue NoMethodError
  # gotta raise an error because Info.new will throw an error if id is undefined
  raise K8sDataError, "unable to read data correctly from json"
end

#seconds_to_duration(s) ⇒ Object 



144
145
146
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 144

def seconds_to_duration(s)
  "%02dh%02dm%02ds" % [s / 3600, s / 60 % 60, s % 60]
end

#secret_name(id) ⇒ Object 



136
137
138
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 136

def secret_name(id)
  id + '-secret'
end

#service_name(id) ⇒ Object 



132
133
134
 
# File 'lib/ood_core/job/adapters/kubernetes/helper.rb', line 132

def service_name(id)
  id + '-service'
end