Class: KubeConfig

Quick start: const kc = new KubeConfig(); kc.loadFromDefault(); const api = kc.makeApiClient(CoreV1Api); — See examples

Defined in: src/config.ts:137

Implements

• SecurityAuthentication

Constructors

Constructor

new KubeConfig(): KubeConfig

Defined in: src/config.ts:181

Returns

KubeConfig

Properties

clusters

clusters: Cluster[]

Defined in: src/config.ts:164

The list of all known clusters

---

contexts

contexts: Context[]

Defined in: src/config.ts:174

The list of all known contexts

---

currentContext

currentContext: string

Defined in: src/config.ts:179

The name of the current context

---

users

users: User[]

Defined in: src/config.ts:169

The list of all known users

Methods

addAuthenticator()

addAuthenticator(authenticator): void

Defined in: src/config.ts:157

Parameters

authenticator

Authenticator

Returns

void

---

addCluster()

addCluster(cluster): void

Defined in: src/config.ts:435

Parameters

cluster

Cluster

Returns

void

---

addContext()

addContext(ctx): void

Defined in: src/config.ts:459

Parameters

ctx

Context

Returns

void

---

addUser()

addUser(user): void

Defined in: src/config.ts:447

Parameters

user

User

Returns

void

---

applySecurityAuthentication()

applySecurityAuthentication(context): Promise<void>

Defined in: src/config.ts:291

Applies SecurityAuthentication to RequestContext of an API Call from API Client

Parameters

context

RequestContext

Returns

Promise<void>

Implementation of

SecurityAuthentication.applySecurityAuthentication

---

applyToHTTPSOptions()

applyToHTTPSOptions(opts): Promise<void>

Defined in: src/config.ts:244

Parameters

opts

any

Returns

Promise<void>

---

createDispatcherOptions()

createDispatcherOptions(cluster, agentOptions): DispatcherOptions

Defined in: src/config.ts:651

Build the dispatcher configuration (options + type) without constructing the actual Dispatcher instance. Exposed as a separate method so that tests can validate the option-mapping logic directly instead of reaching into undici's Symbol-keyed private state.

Parameters

cluster

Cluster | null

agentOptions

AgentOptions

Returns

DispatcherOptions

---

exportConfig()

exportConfig(): string

Defined in: src/config.ts:576

Returns

string

---

getCluster()

getCluster(name): Cluster | null

Defined in: src/config.ts:222

Parameters

name

string

Returns

Cluster | null

---

getClusters()

getClusters(): Cluster[]

Defined in: src/config.ts:191

Returns

Cluster[]

---

getContextObject()

getContextObject(name): Context | null

Defined in: src/config.ts:207

Parameters

name

string

Returns

Context | null

---

getContexts()

getContexts(): Context[]

Defined in: src/config.ts:187

Returns

Context[]

---

getCurrentCluster()

getCurrentCluster(): Cluster | null

Defined in: src/config.ts:214

Returns

Cluster | null

---

getCurrentContext()

getCurrentContext(): string

Defined in: src/config.ts:199

Returns

string

---

getCurrentUser()

getCurrentUser(): User | null

Defined in: src/config.ts:226

Returns

User | null

---

getName()

getName(): string

Defined in: src/config.ts:335

Returns name of this security authentication method

Returns

string

string

Implementation of

SecurityAuthentication.getName

---

getUser()

getUser(name): User | null

Defined in: src/config.ts:234

Parameters

name

string

Returns

User | null

---

getUsers()

getUsers(): User[]

Defined in: src/config.ts:195

Returns

User[]

---

loadFromCluster()

loadFromCluster(pathPrefix?): void

Defined in: src/config.ts:367

Parameters

pathPrefix?

string = ''

Returns

void

---

loadFromClusterAndUser()

loadFromClusterAndUser(cluster, user): void

Defined in: src/config.ts:354

Parameters

cluster

Cluster

user

User

Returns

void

---

loadFromDefault()

loadFromDefault(opts?, contextFromStartingConfig?, platform?): void

Defined in: src/config.ts:471

Parameters

opts?

Partial<ConfigOptions>

contextFromStartingConfig?

boolean = false

platform?

string = process.platform

Returns

void

---

loadFromFile()

loadFromFile(file, opts?): void

Defined in: src/config.ts:238

Parameters

file

string

opts?

Partial<ConfigOptions>

Returns

void

---

loadFromOptions()

loadFromOptions(options): void

Defined in: src/config.ts:347

Parameters

options

any

Returns

void

---

loadFromString()

loadFromString(config, opts?): void

Defined in: src/config.ts:339

Parameters

config

string

opts?

Partial<ConfigOptions>

Returns

void

---

makeApiClient()

makeApiClient<T>(apiClientType): T

Defined in: src/config.ts:540

Type Parameters

T

T extends ApiType

Parameters

apiClientType

ApiConstructor<T>

Returns

T

---

makePathsAbsolute()

makePathsAbsolute(rootDirectory): void

Defined in: src/config.ts:560

Parameters

rootDirectory

string

Returns

void

---

mergeConfig()

mergeConfig(config, preserveContext?): void

Defined in: src/config.ts:420

Parameters

config

KubeConfig

preserveContext?

boolean = false

Returns

void

---

setCurrentContext()

setCurrentContext(context): void

Defined in: src/config.ts:203

Parameters

context

string

Returns

void