Module: Kubeclient::ClientMixin

Included in:
Client
Defined in:
lib/kubeclient/common.rb

Overview

Common methods this is mixed in by other gems

Constant Summary collapse

ENTITY_METHODS = 
%w[get watch delete create update patch].freeze
DEFAULT_SSL_OPTIONS = 
{
  client_cert: nil,
  client_key:  nil,
  ca_file:     nil,
  cert_store:  nil,
  verify_ssl:  OpenSSL::SSL::VERIFY_PEER
}.freeze
DEFAULT_AUTH_OPTIONS = 
{
  username:          nil,
  password:          nil,
  bearer_token:      nil,
  bearer_token_file: nil
}.freeze
DEFAULT_SOCKET_OPTIONS = 
{
  socket_class:     nil,
  ssl_socket_class: nil
}.freeze
DEFAULT_TIMEOUTS = 
{
  # These do NOT affect watch, watching never times out.
  open: Net::HTTP.new('127.0.0.1').open_timeout, # depends on ruby version
  read: Net::HTTP.new('127.0.0.1').read_timeout
}.freeze
DEFAULT_HTTP_PROXY_URI = 
nil
SEARCH_ARGUMENTS = 
{
  'labelSelector' => :label_selector,
  'fieldSelector' => :field_selector,
  'limit'         => :limit,
  'continue'      => :continue
}.freeze
WATCH_ARGUMENTS = 
{
  'labelSelector'   => :label_selector,
  'fieldSelector'   => :field_selector,
  'resourceVersion' => :resource_version
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_sym, *args, &block) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/kubeclient/common.rb', line 93

def method_missing(method_sym, *args, &block)
  if discovery_needed?(method_sym)
    discover
    send(method_sym, *args, &block)
  else
    super
  end
end

Instance Attribute Details

#api_endpoint ⇒ Object (readonly)

Returns the value of attribute api_endpoint.



51
52
53
 
# File 'lib/kubeclient/common.rb', line 51

def api_endpoint
  @api_endpoint
end

#auth_options ⇒ Object (readonly)

Returns the value of attribute auth_options.



53
54
55
 
# File 'lib/kubeclient/common.rb', line 53

def auth_options
  @auth_options
end

#discovered ⇒ Object (readonly)

Returns the value of attribute discovered.



56
57
58
 
# File 'lib/kubeclient/common.rb', line 56

def discovered
  @discovered
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



55
56
57
 
# File 'lib/kubeclient/common.rb', line 55

def headers
  @headers
end

#http_proxy_uri ⇒ Object (readonly)

Returns the value of attribute http_proxy_uri.



54
55
56
 
# File 'lib/kubeclient/common.rb', line 54

def http_proxy_uri
  @http_proxy_uri
end

#ssl_options ⇒ Object (readonly)

Returns the value of attribute ssl_options.



52
53
54
 
# File 'lib/kubeclient/common.rb', line 52

def ssl_options
  @ssl_options
end

Class Method Details

.parse_definition(kind, name) ⇒ Object 



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
 
# File 'lib/kubeclient/common.rb', line 134

def self.parse_definition(kind, name)
  # Kubernetes gives us 3 inputs:
  #   kind: "ComponentStatus", "NetworkPolicy", "Endpoints"
  #   name: "componentstatuses", "networkpolicies", "endpoints"
  #   singularName: "componentstatus" etc (usually omitted, defaults to kind.downcase)
  # and want to derive singular and plural method names, with underscores:
  #   "network_policy"
  #   "network_policies"
  # kind's CamelCase word boundaries determine our placement of underscores.

  if IRREGULAR_NAMES[kind]
    # In a few cases, the given kind / singularName itself is still plural.
    # We require a distinct singular method name, so force it.
    method_names = IRREGULAR_NAMES[kind]
  else
    # TODO: respect singularName from discovery?
    # But how?  If it differs from kind.downcase, kind's word boundaries don't apply.
    singular_name = kind.downcase

    if !(/[A-Z]/ =~ kind)
      # Some custom resources have a fully lowercase kind - can't infer underscores.
      method_names = [singular_name, name]
    else
      # Some plurals are not exact suffixes, e.g. NetworkPolicy -> networkpolicies.
      # So don't expect full last word to match.
      /^(?<prefix>(.*[A-Z]))(?<singular_suffix>[^A-Z]*)$/ =~ kind  # "NetworkP", "olicy"
      if name.start_with?(prefix.downcase)
        plural_suffix = name[prefix.length..-1]                    # "olicies"
        prefix_underscores = ClientMixin.underscore_entity(prefix) # "network_p"
        method_names = [prefix_underscores + singular_suffix,      # "network_policy"
                        prefix_underscores + plural_suffix]        # "network_policies"
      else
        method_names = resolve_unconventional_method_names(name, kind, singular_name)
      end
    end
  end

  OpenStruct.new(
    entity_type:   kind,
    resource_name: name,
    method_names:  method_names
  )
end

.resolve_unconventional_method_names(name, kind, singular_name) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/kubeclient/common.rb', line 178

def self.resolve_unconventional_method_names(name, kind, singular_name)
  underscored_name = name.tr('-', '_')
  singular_underscores = ClientMixin.underscore_entity(kind)
  if underscored_name.start_with?(singular_underscores)
    [singular_underscores, underscored_name]
  else
    # fallback to lowercase, no separators for both names
    [singular_name, underscored_name.tr('_', '')]
  end
end

.underscore_entity(entity_name) ⇒ Object 



243
244
245
 
# File 'lib/kubeclient/common.rb', line 243

def self.underscore_entity(entity_name)
  entity_name.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
end

Instance Method Details

#all_entities(options = {}) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/kubeclient/common.rb', line 391

def all_entities(options = {})
  discover unless @discovered
  @entities.values.each_with_object({}) do |entity, result_hash|
    # method call for get each entities
    # build hash of entity name to array of the entities
    method_name = "get_#{entity.method_names[1]}"
    begin
      result_hash[entity.method_names[0]] = send(method_name, options)
    rescue Kubeclient::HttpError
      next # do not fail due to resources not supporting get
    end
  end
end

#api ⇒ Object 



465
466
467
468
 
# File 'lib/kubeclient/common.rb', line 465

def api
  response = handle_exception { create_rest_client.get(@headers) }
  JSON.parse(response)
end

#api_valid? ⇒ Boolean

Returns:

  • (Boolean) 


458
459
460
461
462
463
 
# File 'lib/kubeclient/common.rb', line 458

def api_valid?
  result = api
  result.is_a?(Hash) && (result['versions'] || []).any? do |group|
    @api_group.empty? ? group.include?(@api_version) : group['version'] == @api_version
  end
end

#build_namespace_prefix(namespace) ⇒ Object 



198
199
200
 
# File 'lib/kubeclient/common.rb', line 198

def build_namespace_prefix(namespace)
  namespace.to_s.empty? ? '' : "namespaces/#{namespace}/"
end

#create_entity(entity_type, resource_name, entity_config) ⇒ Object 



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

def create_entity(entity_type, resource_name, entity_config)
  # Duplicate the entity_config to a hash so that when we assign
  # kind and apiVersion, this does not mutate original entity_config obj.
  hash = entity_config.to_hash

  ns_prefix = build_namespace_prefix(hash[:metadata][:namespace])

  # TODO: temporary solution to add "kind" and apiVersion to request
  # until this issue is solved
  # https://github.com/GoogleCloudPlatform/kubernetes/issues/6439
  hash[:kind] = entity_type
  hash[:apiVersion] = @api_group + @api_version
  response = handle_exception do
    rest_client[ns_prefix + resource_name]
      .post(hash.to_json, { 'Content-Type' => 'application/json' }.merge(@headers))
  end
  format_response(@as, response.body)
end

#create_rest_client(path = nil) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/kubeclient/common.rb', line 247

def create_rest_client(path = nil)
  path ||= @api_endpoint.path
  options = {
    ssl_ca_file: @ssl_options[:ca_file],
    ssl_cert_store: @ssl_options[:cert_store],
    verify_ssl: @ssl_options[:verify_ssl],
    ssl_client_cert: @ssl_options[:client_cert],
    ssl_client_key: @ssl_options[:client_key],
    proxy: @http_proxy_uri,
    user: @auth_options[:username],
    password: @auth_options[:password],
    open_timeout: @timeouts[:open],
    read_timeout: @timeouts[:read]
  }
  RestClient::Resource.new(@api_endpoint.merge(path).to_s, options)
end

#define_entity_methods ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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
 
# File 'lib/kubeclient/common.rb', line 202

def define_entity_methods
  @entities.values.each do |entity|
    # get all entities of a type e.g. get_nodes, get_pods, etc.
    define_singleton_method("get_#{entity.method_names[1]}") do |options = {}|
      get_entities(entity.entity_type, entity.resource_name, options)
    end

    # watch all entities of a type e.g. watch_nodes, watch_pods, etc.
    define_singleton_method("watch_#{entity.method_names[1]}") do |options = {}|
      # This method used to take resource_version as a param, so
      # this conversion is to keep backwards compatibility
      options = { resource_version: options } unless options.is_a?(Hash)

      watch_entities(entity.resource_name, options)
    end

    # get a single entity of a specific type by name
    define_singleton_method("get_#{entity.method_names[0]}") \
    do |name, namespace = nil, opts = {}|
      get_entity(entity.resource_name, name, namespace, opts)
    end

    define_singleton_method("delete_#{entity.method_names[0]}") \
    do |name, namespace = nil, opts = {}|
      delete_entity(entity.resource_name, name, namespace, opts)
    end

    define_singleton_method("create_#{entity.method_names[0]}") do |entity_config|
      create_entity(entity.entity_type, entity.resource_name, entity_config)
    end

    define_singleton_method("update_#{entity.method_names[0]}") do |entity_config|
      update_entity(entity.resource_name, entity_config)
    end

    define_singleton_method("patch_#{entity.method_names[0]}") do |name, patch, namespace = nil|
      patch_entity(entity.resource_name, name, patch, namespace)
    end
  end
end

#delete_entity(resource_name, name, namespace = nil, delete_options: {}) ⇒ Object

delete_options are passed as a JSON payload in the delete request



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/kubeclient/common.rb', line 332

def delete_entity(resource_name, name, namespace = nil, delete_options: {})
  delete_options_hash = delete_options.to_hash
  ns_prefix = build_namespace_prefix(namespace)
  payload = delete_options_hash.to_json unless delete_options_hash.empty?
  response = handle_exception do
    rs = rest_client[ns_prefix + resource_name + "/#{name}"]
    RestClient::Request.execute(
      rs.options.merge(
        method: :delete,
        url: rs.url,
        headers: { 'Content-Type' => 'application/json' }.merge(@headers),
        payload: payload
      )
    )
  end
  format_response(@as, response.body)
end

#discover ⇒ Object 



128
129
130
131
132
 
# File 'lib/kubeclient/common.rb', line 128

def discover
  load_entities
  define_entity_methods
  @discovered = true
end

#discovery_needed?(method_sym) ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/kubeclient/common.rb', line 111

def discovery_needed?(method_sym)
  !@discovered && ENTITY_METHODS.any? { |x| method_sym.to_s.start_with?(x) }
end

#get_entities(entity_type, resource_name, options = {}) ⇒ Object

Accepts the following options:

:namespace (string) - the namespace of the entity.
:label_selector (string) - a selector to restrict the list of returned objects by labels.
:field_selector (string) - a selector to restrict the list of returned objects by fields.
:limit (integer) - a maximum number of items to return in each response
:continue (string) - a token used to retrieve the next chunk of entities
:as (:raw|:ros) - defaults to :ros
  :raw - return the raw response body as a string
  :ros - return a collection of RecursiveOpenStruct objects



306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/kubeclient/common.rb', line 306

def get_entities(entity_type, resource_name, options = {})
  params = {}
  SEARCH_ARGUMENTS.each { |k, v| params[k] = options[v] if options[v] }

  ns_prefix = build_namespace_prefix(options[:namespace])
  response = handle_exception do
    rest_client[ns_prefix + resource_name]
      .get({ 'params' => params }.merge(@headers))
  end
  format_response(options[:as] || @as, response.body, entity_type)
end

#get_entity(resource_name, name, namespace = nil, options = {}) ⇒ Object

Accepts the following options:

:as (:raw|:ros) - defaults to :ros
  :raw - return the raw response body as a string
  :ros - return a collection of RecursiveOpenStruct objects



322
323
324
325
326
327
328
329
 
# File 'lib/kubeclient/common.rb', line 322

def get_entity(resource_name, name, namespace = nil, options = {})
  ns_prefix = build_namespace_prefix(namespace)
  response = handle_exception do
    rest_client[ns_prefix + resource_name + "/#{name}"]
      .get(@headers)
  end
  format_response(options[:as] || @as, response.body)
end

#get_pod_log(pod_name, namespace, container: nil, previous: false, timestamps: false, since_time: nil, tail_lines: nil) ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/kubeclient/common.rb', line 405

def get_pod_log(pod_name, namespace,
                container: nil, previous: false,
                timestamps: false, since_time: nil, tail_lines: nil)
  params = {}
  params[:previous] = true if previous
  params[:container] = container if container
  params[:timestamps] = timestamps if timestamps
  params[:sinceTime] = format_datetime(since_time) if since_time
  params[:tailLines] = tail_lines if tail_lines

  ns = build_namespace_prefix(namespace)
  handle_exception do
    rest_client[ns + "pods/#{pod_name}/log"]
      .get({ 'params' => params }.merge(@headers))
  end
end

#handle_exception ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/kubeclient/common.rb', line 115

def handle_exception
  yield
rescue RestClient::Exception => e
  json_error_msg = begin
    JSON.parse(e.response || '') || {}
  rescue JSON::ParserError
    {}
  end
  err_message = json_error_msg['message'] || e.message
  error_klass = e.http_code == 404 ? ResourceNotFoundError : HttpError
  raise error_klass.new(e.http_code, err_message, e.response)
end

#handle_uri(uri, path) ⇒ Object

Raises:

  • (ArgumentError) 


189
190
191
192
193
194
195
196
 
# File 'lib/kubeclient/common.rb', line 189

def handle_uri(uri, path)
  raise ArgumentError, 'Missing uri' unless uri
  @api_endpoint = (uri.is_a?(URI) ? uri : URI.parse(uri))
  @api_endpoint.path = path if @api_endpoint.path.empty?
  @api_endpoint.path = @api_endpoint.path.chop if @api_endpoint.path.end_with?('/')
  components = @api_endpoint.path.to_s.split('/') # ["", "api"] or ["", "apis", batch]
  @api_group = components.length > 2 ? components[2] + '/' : ''
end

#initialize_client(uri, path, version, ssl_options: DEFAULT_SSL_OPTIONS, auth_options: DEFAULT_AUTH_OPTIONS, socket_options: DEFAULT_SOCKET_OPTIONS, timeouts: DEFAULT_TIMEOUTS, http_proxy_uri: DEFAULT_HTTP_PROXY_URI, as: :ros) ⇒ Object 



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
 
# File 'lib/kubeclient/common.rb', line 58

def initialize_client(
  uri,
  path,
  version,
  ssl_options: DEFAULT_SSL_OPTIONS,
  auth_options: DEFAULT_AUTH_OPTIONS,
  socket_options: DEFAULT_SOCKET_OPTIONS,
  timeouts: DEFAULT_TIMEOUTS,
  http_proxy_uri: DEFAULT_HTTP_PROXY_URI,
  as: :ros
)
  validate_auth_options(auth_options)
  handle_uri(uri, path)

  @entities = {}
  @discovered = false
  @api_version = version
  @headers = {}
  @ssl_options = ssl_options
  @auth_options = auth_options
  @socket_options = socket_options
  # Allow passing partial timeouts hash, without unspecified
  # @timeouts[:foo] == nil resulting in infinite timeout.
  @timeouts = DEFAULT_TIMEOUTS.merge(timeouts)
  @http_proxy_uri = http_proxy_uri ? http_proxy_uri.to_s : nil
  @as = as

  if auth_options[:bearer_token]
    bearer_token(@auth_options[:bearer_token])
  elsif auth_options[:bearer_token_file]
    validate_bearer_token_file
    bearer_token(File.read(@auth_options[:bearer_token_file]))
  end
end

#patch_entity(resource_name, name, patch, namespace = nil) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/kubeclient/common.rb', line 379

def patch_entity(resource_name, name, patch, namespace = nil)
  ns_prefix = build_namespace_prefix(namespace)
  response = handle_exception do
    rest_client[ns_prefix + resource_name + "/#{name}"]
      .patch(
        patch.to_json,
        { 'Content-Type' => 'application/strategic-merge-patch+json' }.merge(@headers)
      )
  end
  format_response(@as, response.body)
end

#process_template(template) ⇒ Object 



449
450
451
452
453
454
455
456
 
# File 'lib/kubeclient/common.rb', line 449

def process_template(template)
  ns_prefix = build_namespace_prefix(template[:metadata][:namespace])
  response = handle_exception do
    rest_client[ns_prefix + 'processedtemplates']
      .post(template.to_h.to_json, { 'Content-Type' => 'application/json' }.merge(@headers))
  end
  JSON.parse(response)
end

#proxy_url(kind, name, port, namespace = '') ⇒ Object 



437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/kubeclient/common.rb', line 437

def proxy_url(kind, name, port, namespace = '')
  discover unless @discovered
  entity_name_plural =
    if %w[services pods nodes].include?(kind.to_s)
      kind.to_s
    else
      @entities[kind.to_s].resource_name
    end
  ns_prefix = build_namespace_prefix(namespace)
  rest_client["#{ns_prefix}#{entity_name_plural}/#{name}:#{port}/proxy"].url
end

#respond_to_missing?(method_sym, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
105
106
107
108
109
 
# File 'lib/kubeclient/common.rb', line 102

def respond_to_missing?(method_sym, include_private = false)
  if discovery_needed?(method_sym)
    discover
    respond_to?(method_sym, include_private)
  else
    super
  end
end

#rest_client ⇒ Object 



264
265
266
267
268
 
# File 'lib/kubeclient/common.rb', line 264

def rest_client
  @rest_client ||= begin
    create_rest_client("#{@api_endpoint.path}/#{@api_version}")
  end
end

#update_entity(resource_name, entity_config) ⇒ Object 



369
370
371
372
373
374
375
376
377
 
# File 'lib/kubeclient/common.rb', line 369

def update_entity(resource_name, entity_config)
  name      = entity_config[:metadata][:name]
  ns_prefix = build_namespace_prefix(entity_config[:metadata][:namespace])
  response = handle_exception do
    rest_client[ns_prefix + resource_name + "/#{name}"]
      .put(entity_config.to_h.to_json, { 'Content-Type' => 'application/json' }.merge(@headers))
  end
  format_response(@as, response.body)
end

#watch_entities(resource_name, options = {}) ⇒ Object

Accepts the following options:

:namespace (string) - the namespace of the entity.
:name (string) - the name of the entity to watch.
:label_selector (string) - a selector to restrict the list of returned objects by labels.
:field_selector (string) - a selector to restrict the list of returned objects by fields.
:resource_version (string) - shows changes that occur after passed version of a resource.
:as (:raw|:ros) - defaults to :ros
  :raw - return the raw response body as a string
  :ros - return a collection of RecursiveOpenStruct objects



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/kubeclient/common.rb', line 279

def watch_entities(resource_name, options = {})
  ns = build_namespace_prefix(options[:namespace])

  path = "watch/#{ns}#{resource_name}"
  path += "/#{options[:name]}" if options[:name]
  uri = @api_endpoint.merge("#{@api_endpoint.path}/#{@api_version}/#{path}")

  params = {}
  WATCH_ARGUMENTS.each { |k, v| params[k] = options[v] if options[v] }
  uri.query = URI.encode_www_form(params) if params.any?

  Kubeclient::Common::WatchStream.new(
    uri,
    http_options(uri),
    formatter: ->(value) { format_response(options[:as] || @as, value) }
  )
end

#watch_pod_log(pod_name, namespace, container: nil) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/kubeclient/common.rb', line 422

def watch_pod_log(pod_name, namespace, container: nil)
  # Adding the "follow=true" query param tells the Kubernetes API to keep
  # the connection open and stream updates to the log.
  params = { follow: true }
  params[:container] = container if container

  ns = build_namespace_prefix(namespace)

  uri = @api_endpoint.dup
  uri.path += "/#{@api_version}/#{ns}pods/#{pod_name}/log"
  uri.query = URI.encode_www_form(params)

  Kubeclient::Common::WatchStream.new(uri, http_options(uri), formatter: ->(value) { value })
end