class Kube::Client

• Kube::Client
• Reference
• Object

Overview

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

Defined in:

kube-client/version.cr
kube/client.cr

Constant Summary

VERSION = {{ (`shards version \"/home/runner/work/kube-client.cr/kube-client.cr/src/kube-client\"`).chomp.stringify }}

Constructors

• .new(transport : Kube::Transport, namespace : String | Nil = nil)

Class Method Summary

• .autoconfig(namespace : String | Nil = nil, **options) : Kube::Client

  Attempts to create a K8s::Client instance automatically using environment variables, existing configuration files or in cluster configuration.

• .config(config : Kube::Config, namespace : String | Nil = nil, **options) : Kube::Client
• .in_cluster_config(namespace : String | Nil = nil, **options) : Kube::Client

  An Kube::Client instance from in-cluster config within a kube pod, using the kubernetes service envs and serviceaccount secrets

• .logger

Instance Method Summary

• #api(api_version : String = "v1") : Kube::ApiClient

  api_version [String] "group/version" or "version" (core)

• #api_groups : Array(String)

  Cached /apis preferred group apiVersions

• #api_groups! : Array(String)

  Force-update /apis cache.

• #apis(api_versions : Array(String) | Nil = nil, prefetch_resources = false, skip_missing = false, skip_forbidden = true, skip_unknown = true) : Array(Kube::ApiClient)

  api_versions [Array(String)] defaults to all APIs prefetch_resources [Bool] prefetch any missing api_resources for each api_version skip_missing [Bool] return Kube::ApiClient without api_resources? if 404

• #client_for_resource(resource : T.class | T, namespace : String | Nil = nil) forall T
• #create_resource(resource : T) forall T
• #delete_resource(resource : T, **options) forall T
• #get_resource(resource : T) forall T
• #get_resources(resources : Enumerable(T)) forall T
• #list_resources(resource_list : Array(Kube::ResourceClient) | Nil = nil, **options)

  Pipeline list requests for multiple resource types.

• #logger
• #patch_resource(resource, attrs)
• #resources(namespace : String | Nil = nil)
• #update_resource(resource : T) forall T
• #version : K8S::Apimachinery::Version::Info

Constructor Detail

Class Method Detail

Instance Method Detail