Class: K8s::Transport
Constant Summary collapse
- EXCON_MIDDLEWARES =
[ # XXX: necessary? redirected requests omit authz headers? Excon::Middleware::RedirectFollower, ]
- REQUEST_HEADERS =
{ 'Accept' => 'application/json', }
Constants included from Logging
Logging::LOG_LEVEL, Logging::LOG_TARGET
Instance Attribute Summary collapse
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#server ⇒ Object
readonly
Returns the value of attribute server.
Class Method Summary collapse
-
.config(config) ⇒ K8s::Transport
Construct transport from kubeconfig.
-
.in_cluster_config ⇒ K8s::Transport
In-cluster config within a kube pod, using the kubernetes service envs and serviceaccount secrets.
Instance Method Summary collapse
- #excon ⇒ Excon::Connection
- #format_request(options) ⇒ Object
- #get(*path, **options) ⇒ Object
- #gets(*paths, **options) ⇒ Object
-
#initialize(server, auth_token: nil, **options) ⇒ Transport
constructor
A new instance of Transport.
- #parse_response(response, request_options, response_class: nil) ⇒ response_class, Hash
- #path(*path) ⇒ String
- #request(response_class: nil, **options) ⇒ Object
- #request_options(request_object: nil, content_type: 'application/json', **options) ⇒ Hash
- #requests(*options, skip_missing: false, retry_errors: true, **common_options) ⇒ Array<response_class, Hash, nil>
Methods included from Logging
Methods included from Logging::ModuleMethods
#debug!, #log_level, #log_level=, #quiet!, #verbose!
Constructor Details
#initialize(server, auth_token: nil, **options) ⇒ Transport
Returns a new instance of Transport.
81 82 83 84 85 86 87 |
# File 'lib/k8s/transport.rb', line 81 def initialize(server, auth_token: nil, **) @server = server @auth_token = auth_token @options = logger! progname: @server end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
78 79 80 |
# File 'lib/k8s/transport.rb', line 78 def @options end |
#server ⇒ Object (readonly)
Returns the value of attribute server.
78 79 80 |
# File 'lib/k8s/transport.rb', line 78 def server @server end |
Class Method Details
.config(config) ⇒ K8s::Transport
Construct transport from kubeconfig
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/k8s/transport.rb', line 23 def self.config(config) = {} if config.cluster.insecure_skip_tls_verify logger.debug "Using config with .cluster.insecure_skip_tls_verify" [:ssl_verify_peer] = false end if path = config.cluster. logger.debug "Using config with .cluster.certificate_authority" [:ssl_ca_file] = path end if data = config.cluster. logger.debug "Using config with .cluster.certificate_authority_data" ssl_cert_store = [:ssl_cert_store] = OpenSSL::X509::Store.new ssl_cert_store.add_cert(OpenSSL::X509::Certificate.new(Base64.decode64(data))) end if (cert = config.user.client_certificate) && (key = config.user.client_key) logger.debug "Using config with .user.client_certificate/client_key" [:client_cert] = cert [:client_key] = key end if (cert_data = config.user.client_certificate_data) && (key_data = config.user.client_key_data) logger.debug "Using config with .user.client_certificate_data/client_key_data" [:client_cert_data] = Base64.decode64(cert_data) [:client_key_data] = Base64.decode64(key_data) end logger.info "Using config with server=#{config.cluster.server}" new(config.cluster.server, **) end |
.in_cluster_config ⇒ K8s::Transport
In-cluster config within a kube pod, using the kubernetes service envs and serviceaccount secrets
67 68 69 70 71 72 73 74 75 76 |
# File 'lib/k8s/transport.rb', line 67 def self.in_cluster_config host = ENV['KUBERNETES_SERVICE_HOST'] port = ENV['KUBERNETES_SERVICE_PORT_HTTPS'] new("https://#{host}:#{port}", ssl_verify_peer: true, ssl_ca_file: '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt', auth_token: File.read('/var/run/secrets/kubernetes.io/serviceaccount/token'), ) end |
Instance Method Details
#excon ⇒ Excon::Connection
90 91 92 93 94 95 96 97 |
# File 'lib/k8s/transport.rb', line 90 def excon @excon ||= Excon.new(@server, persistent: true, middlewares: EXCON_MIDDLEWARES, headers: REQUEST_HEADERS, **@options ) end |
#format_request(options) ⇒ Object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/k8s/transport.rb', line 120 def format_request() method = [:method] path = [:path] body = nil if [:query] path += Excon::Utils.query_string() end if obj = [:request_object] body = "<#{obj.class.name}>" end [method, path, body].compact.join " " end |
#get(*path, **options) ⇒ Object
246 247 248 249 250 251 252 |
# File 'lib/k8s/transport.rb', line 246 def get(*path, **) request( method: 'GET', path: self.path(*path), **, ) end |
#gets(*paths, **options) ⇒ Object
255 256 257 258 259 260 261 262 |
# File 'lib/k8s/transport.rb', line 255 def gets(*paths, **) requests(*paths.map{|path| { method: 'GET', path: self.path(path), } }, ** ) end |
#parse_response(response, request_options, response_class: nil) ⇒ response_class, Hash
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/k8s/transport.rb', line 138 def parse_response(response, , response_class: nil) method = [:method] path = [:path] content_type, = response.headers['Content-Type'].split(';') case content_type when 'application/json' response_data = JSON.parse(response.body) when 'text/plain' response_data = response.body # XXX: broken if status 2xx else raise K8s::Error::API.new(method, path, response.status, "Invalid response Content-Type: #{response.headers['Content-Type']}") end if response.status.between? 200, 299 unless response_data.is_a? Hash raise K8s::Error::API.new(method, path, response.status, "Invalid JSON response: #{response_data.inspect}") end if response_class return response_class.from_json(response_data) else return response_data # Hash end else error_class = K8s::Error::HTTP_STATUS_ERRORS[response.status] || K8s::Error::API if response_data.is_a?(Hash) && response_data['kind'] == 'Status' status = K8s::API::MetaV1::Status.new(response_data) raise error_class.new(method, path, response.status, response.reason_phrase, status) elsif response_data raise error_class.new(method, path, response.status, "#{response.reason_phrase}: #{response_data}") else raise error_class.new(method, path, response.status, response.reason_phrase) end end end |
#path(*path) ⇒ String
100 101 102 |
# File 'lib/k8s/transport.rb', line 100 def path(*path) File.join('/', *path) end |
#request(response_class: nil, **options) ⇒ Object
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/k8s/transport.rb', line 178 def request(response_class: nil, **) = (**) start = Time.now response = excon.request(**) t = Time.now - start obj = parse_response(response, , response_class: response_class, ) rescue K8s::Error::API => exc logger.warn { "#{format_request()} => HTTP #{exc.code} #{exc.reason} in #{'%.3f' % t}s"} logger.debug { "Request: #{[:body]}"} if [:body] logger.debug { "Response: #{response.body}"} raise else logger.info { "#{format_request()} => HTTP #{response.status}: <#{obj.class}> in #{'%.3f' % t}s"} logger.debug { "Request: #{[:body]}"} if [:body] logger.debug { "Response: #{response.body}"} return obj end |
#request_options(request_object: nil, content_type: 'application/json', **options) ⇒ Hash
105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/k8s/transport.rb', line 105 def (request_object: nil, content_type: 'application/json', **) [:headers] ||= {} if @auth_token [:headers]['Authorization'] = "Bearer #{@auth_token}" end if request_object [:headers]['Content-Type'] = content_type [:body] = request_object.to_json end end |
#requests(*options, skip_missing: false, retry_errors: true, **common_options) ⇒ Array<response_class, Hash, nil>
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 242 243 |
# File 'lib/k8s/transport.rb', line 204 def requests(*, skip_missing: false, retry_errors: true, **) return [] if .empty? # excon chokes start = Time.now responses = excon.requests( .map{|| (**.merge())} ) t = Time.now - start objects = responses.zip().map{|response, | response_class = [:response_class] || [:response_class] begin parse_response(response, , response_class: response_class, ) rescue K8s::Error::NotFound if skip_missing nil else raise end rescue K8s::Error::ServiceUnavailable => exc if retry_errors logger.warn { "Retry #{format_request()} => HTTP #{exc.code} #{exc.reason} in #{'%.3f' % t}s" } # only retry the failed request, not the entire pipeline request(response_class: response_class, **.merge()) else raise end end } rescue K8s::Error => exc logger.warn { "[#{.map{|o| format_request(o)}.join ', '}] => HTTP #{exc.code} #{exc.reason} in #{'%.3f' % t}s"} raise else logger.info { "[#{.map{|o| format_request(o)}.join ', '}] => HTTP [#{responses.map{|r| r.status}.join ', '}] in #{'%.3f' % t}s" } return objects end |