Class: K8s::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/k8s/client.rb,
lib/k8s/client/version.rb

Overview

Top-level client wrapper. Uses a Transport instance to talk to the kube API. Offers access to APIClient and ResourceClient instances.

Constant Summary collapse

VERSION =

Updated on releases using semver.

"0.6.4"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport, namespace: nil) ⇒ Client

Returns a new instance of Client.

Parameters:

  • transport (K8s::Transport)
  • namespace (String) (defaults to: nil) —

    default namespace for all operations



53
54
55
56
57
58
 
# File 'lib/k8s/client.rb', line 53

def initialize(transport, namespace: nil)
  @transport = transport
  @namespace = namespace

  @api_clients = {}
end

Instance Attribute Details

#transport ⇒ Object (readonly)

Returns the value of attribute transport.



49
50
51
 
# File 'lib/k8s/client.rb', line 49

def transport
  @transport
end

Class Method Details

.config(config, namespace: nil, **options) ⇒ K8s::Client

Parameters:

  • config (Phraos::Kube::Config)
  • namespace (String) (defaults to: nil) —

    @see #initialize

  • options (Hash) —

    @see Transport.config

Returns:



37
38
39
40
41
42
 
# File 'lib/k8s/client.rb', line 37

def self.config(config, namespace: nil, **options)
  new(
    Transport.config(config, **options),
    namespace: namespace
  )
end

.in_cluster_config ⇒ K8s::Client

Returns:



45
46
47
 
# File 'lib/k8s/client.rb', line 45

def self.in_cluster_config
  new(Transport.in_cluster_config)
end

Instance Method Details

#api(api_version = 'v1') ⇒ APIClient

Parameters:

  • api_version (String) (defaults to: 'v1') —

    “group/version” or “version” (core)

Returns:



68
69
70
 
# File 'lib/k8s/client.rb', line 68

def api(api_version = 'v1')
  @api_clients[api_version] ||= APIClient.new(@transport, api_version)
end

#api_groups ⇒ Array<String>

Cached /apis preferred group apiVersions

Returns:

  • (Array<String>) 


85
86
87
 
# File 'lib/k8s/client.rb', line 85

def api_groups
  @api_groups || api_groups!
end

#api_groups! ⇒ Array<String>

Force-update /apis cache. Required if creating new CRDs/apiservices.

Returns:

  • (Array<String>) 


76
77
78
79
80
81
 
# File 'lib/k8s/client.rb', line 76

def api_groups!
  @api_groups = @transport.get(
    '/apis',
    response_class: K8s::API::MetaV1::APIGroupList
  ).groups.map{ |api_group| api_group.versions.map(&:groupVersion) }.flatten
end

#apis(api_versions = nil, prefetch_resources: false, skip_missing: false) ⇒ Array<APIClient>

Parameters:

  • api_versions (Array<String>) (defaults to: nil) —

    defaults to all APIs

  • prefetch_resources (Boolean) (defaults to: false) —

    prefetch any missing api_resources for each api_version

  • skip_missing (Boolean) (defaults to: false) —

    return APIClient without api_resources? if 404

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/k8s/client.rb', line 93

def apis(api_versions = nil, prefetch_resources: false, skip_missing: false)
  api_versions ||= ['v1'] + api_groups

  if prefetch_resources
    # api groups that are missing their api_resources
    api_paths = api_versions
                .uniq
                .reject{ |api_version| api(api_version).api_resources? }
                .map{ |api_version| APIClient.path(api_version) }

    # load into APIClient.api_resources=
    @transport.gets(*api_paths, response_class: K8s::API::MetaV1::APIResourceList, skip_missing: skip_missing).each do |api_resource_list|
      api(api_resource_list.groupVersion).api_resources = api_resource_list.resources if api_resource_list
    end
  end

  api_versions.map{ |api_version| api(api_version) }
end

#client_for_resource(resource, namespace: nil) ⇒ K8s::ResourceClient

Parameters:

  • resource (K8s::Resource)
  • namespace (String, nil) (defaults to: nil) —

    default if resource is missing namespace

Returns:

Raises:



136
137
138
 
# File 'lib/k8s/client.rb', line 136

def client_for_resource(resource, namespace: nil)
  api(resource.apiVersion).client_for_resource(resource, namespace: namespace)
end

#create_resource(resource) ⇒ K8s::Resource

Parameters:

Returns:



142
143
144
 
# File 'lib/k8s/client.rb', line 142

def create_resource(resource)
  client_for_resource(resource).create_resource(resource)
end

#delete_resource(resource, **options) ⇒ K8s::Resource

Parameters:

Returns:

See Also:



190
191
192
 
# File 'lib/k8s/client.rb', line 190

def delete_resource(resource, **options)
  client_for_resource(resource).delete_resource(resource, **options)
end

#get_resource(resource) ⇒ K8s::Resource

Parameters:

Returns:



148
149
150
 
# File 'lib/k8s/client.rb', line 148

def get_resource(resource)
  client_for_resource(resource).get_resource(resource)
end

#get_resources(resources) ⇒ Array<K8s::Resource, nil>

Returns nils for any resources that do not exist. This includes custom resources that were not yet defined.

Parameters:

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/k8s/client.rb', line 157

def get_resources(resources)
  # prefetch api resources, skip missing APIs
  resource_apis = apis(resources.map(&:apiVersion), prefetch_resources: true, skip_missing: true)

  # map each resource to excon request options, or nil if resource is not (yet) defined
  requests = resources.zip(resource_apis).map{ |resource, api_client|
    next nil unless api_client.api_resources?

    resource_client = api_client.client_for_resource(resource)

    {
      method: 'GET',
      path: resource_client.path(resource.metadata.name, namespace: resource.metadata.namespace),
      response_class: resource_client.resource_class
    }
  }

  # map non-nil requests to response objects, or nil for nil request options
  Util.compact_map(requests) { |reqs|
    @transport.requests(*reqs, skip_missing: true)
  }
end

#list_resources(resources = nil, **options) ⇒ Array<K8s::Resource>

Pipeline list requests for multiple resource types.

Returns flattened array with mixed resource kinds.

Parameters:

  • resources (Array<K8s::ResourceClient>) (defaults to: nil) —

    default is all listable resources for api

  • options —

    @see K8s::ResourceClient#list

Returns:



125
126
127
128
129
 
# File 'lib/k8s/client.rb', line 125

def list_resources(resources = nil, **options)
  resources ||= self.resources.select(&:list?)

  ResourceClient.list(resources, @transport, **options)
end

#patch_resource(resource, attrs) ⇒ Object 



194
195
196
 
# File 'lib/k8s/client.rb', line 194

def patch_resource(resource, attrs)
  client_for_resource(resource).json_patch(resource.metadata.name, attrs)
end

#resources(namespace: nil) ⇒ Array<K8s::ResourceClient>

Parameters:

  • namespace (String, nil) (defaults to: nil)

Returns:



114
115
116
 
# File 'lib/k8s/client.rb', line 114

def resources(namespace: nil)
  apis(prefetch_resources: true).map { |api| api.resources(namespace: namespace) }.flatten
end

#update_resource(resource) ⇒ K8s::Resource

Parameters:

Returns:



182
183
184
 
# File 'lib/k8s/client.rb', line 182

def update_resource(resource)
  client_for_resource(resource).update_resource(resource)
end

#version ⇒ K8s::API::Version

Returns:

Raises:



62
63
64
 
# File 'lib/k8s/client.rb', line 62

def version
  @version ||= @transport.version
end