Skip to content

@k8slens/extensions

Globals / "src/main/cluster" / Cluster

Class: Cluster#

Hierarchy#

  • Cluster

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Cluster(model: ClusterModel): Cluster

Defined in src/main/cluster.ts:91

Parameters:

Name Type
model ClusterModel

Returns: Cluster

Properties#

accessible#

• accessible: boolean = false

Implementation of ClusterState.accessible

Defined in src/main/cluster.ts:72

accessibleNamespaces#

• accessibleNamespaces: string[] = []

Implementation of ClusterModel.accessibleNamespaces

Defined in src/main/cluster.ts:83

activated#

• Protected activated: boolean = false

Defined in src/main/cluster.ts:59

allowedNamespaces#

• allowedNamespaces: string[] = []

Implementation of ClusterState.allowedNamespaces

Defined in src/main/cluster.ts:81

allowedResources#

• allowedResources: string[] = []

Implementation of ClusterState.allowedResources

Defined in src/main/cluster.ts:82

apiUrl#

• apiUrl: string

Implementation of ClusterState.apiUrl

Defined in src/main/cluster.ts:68

contextHandler#

• contextHandler: ContextHandler

Defined in src/main/cluster.ts:55

contextName#

• contextName: string

Implementation of ClusterModel.contextName

Defined in src/main/cluster.ts:65

disconnected#

• disconnected: boolean = true

Implementation of ClusterState.disconnected

Defined in src/main/cluster.ts:75

enabled#

• enabled: boolean = false

Defined in src/main/cluster.ts:70

eventCount#

• eventCount: number = 0

Implementation of ClusterState.eventCount

Defined in src/main/cluster.ts:78

eventDisposers#

• Protected eventDisposers: Function[] = []

Defined in src/main/cluster.ts:58

failureReason#

• failureReason: string

Implementation of ClusterState.failureReason

Defined in src/main/cluster.ts:76

frameId#

• frameId: number

Defined in src/main/cluster.ts:53

id#

• id: ClusterId

Implementation of ClusterModel.id

Defined in src/main/cluster.ts:52

initialized#

• initialized: boolean = false

Implementation of ClusterState.initialized

Defined in src/main/cluster.ts:64

isAdmin#

• isAdmin: boolean = false

Implementation of ClusterState.isAdmin

Defined in src/main/cluster.ts:77

kubeConfigPath#

• kubeConfigPath: string

Implementation of ClusterModel.kubeConfigPath

Defined in src/main/cluster.ts:67

kubeCtl#

• kubeCtl: Kubectl

Defined in src/main/cluster.ts:54

kubeProxyUrl#

• kubeProxyUrl: string

Defined in src/main/cluster.ts:69

kubeconfigManager#

• Protected kubeconfigManager: KubeconfigManager

Defined in src/main/cluster.ts:57

metadata#

• metadata: ClusterMetadata

Implementation of ClusterModel.metadata

Defined in src/main/cluster.ts:80

online#

• online: boolean = false

Implementation of ClusterState.online

Defined in src/main/cluster.ts:71

ownerRef#

• ownerRef: string

Implementation of ClusterModel.ownerRef

Defined in src/main/cluster.ts:56

preferences#

• preferences: ClusterPreferences

Implementation of ClusterModel.preferences

Defined in src/main/cluster.ts:79

ready#

• ready: boolean = false

Implementation of ClusterState.ready

Defined in src/main/cluster.ts:73

reconnecting#

• reconnecting: boolean = false

Defined in src/main/cluster.ts:74

whenInitialized#

• whenInitialized: Promise\ & { cancel: () => void } = when(() => this.initialized)

Defined in src/main/cluster.ts:61

whenReady#

• whenReady: Promise\ & { cancel: () => void } = when(() => this.ready)

Defined in src/main/cluster.ts:62

workspace#

• workspace: WorkspaceId

Implementation of ClusterModel.workspace

Defined in src/main/cluster.ts:66

Accessors#

available#

• get available(): boolean

Defined in src/main/cluster.ts:85

Returns: boolean

isManaged#

• get isManaged(): boolean

Defined in src/main/cluster.ts:101

Returns: boolean

version#

• get version(): string

Defined in src/main/cluster.ts:89

Returns: string

Methods#

activate#

▸ activate(force?: boolean): Promise\

Defined in src/main/cluster.ts:153

Parameters:

Name Type Default value
force boolean false

Returns: Promise\

bindEvents#

▸ ProtectedbindEvents(): void

Defined in src/main/cluster.ts:130

Returns: void

canI#

▸ canI(resourceAttributes: V1ResourceAttributes): Promise\

Defined in src/main/cluster.ts:309

Parameters:

Name Type
resourceAttributes V1ResourceAttributes

Returns: Promise\

disconnect#

▸ disconnect(): void

Defined in src/main/cluster.ts:186

Returns: void

getAllowedNamespaces#

▸ ProtectedgetAllowedNamespaces(): Promise\

Defined in src/main/cluster.ts:429

Returns: Promise\

getAllowedResources#

▸ ProtectedgetAllowedResources(): Promise\<KubeResource[]>

Defined in src/main/cluster.ts:454

Returns: Promise\<KubeResource[]>

getConnectionStatus#

▸ ProtectedgetConnectionStatus(): Promise\<ClusterStatus>

Defined in src/main/cluster.ts:279

Returns: Promise\<ClusterStatus>

getEventCount#

▸ ProtectedgetEventCount(): Promise\

Defined in src/main/cluster.ts:332

Returns: Promise\

getKubeconfig#

▸ ProtectedgetKubeconfig(): KubeConfig

Defined in src/main/cluster.ts:243

Returns: KubeConfig

getMeta#

▸ getMeta(): object

Defined in src/main/cluster.ts:417

Returns: object

Name Type
accessible boolean
disconnected boolean
id string
initialized boolean
name string
online boolean
ready boolean

getMetrics#

▸ getMetrics(prometheusPath: string, queryParams: IMetricsReqParams & { query: string }): Promise\

Defined in src/main/cluster.ts:268

Parameters:

Name Type
prometheusPath string
queryParams IMetricsReqParams & { query: string }

Returns: Promise\

getProxyKubeconfig#

▸ getProxyKubeconfig(): KubeConfig

Defined in src/main/cluster.ts:247

Returns: KubeConfig

getProxyKubeconfigPath#

▸ getProxyKubeconfigPath(): string

Defined in src/main/cluster.ts:251

Returns: string

getState#

▸ getState(): ClusterState

Defined in src/main/cluster.ts:383

Returns: ClusterState

init#

▸ init(port: number): Promise\

Defined in src/main/cluster.ts:111

Parameters:

Name Type
port number

Returns: Promise\

isClusterAdmin#

▸ isClusterAdmin(): Promise\

Defined in src/main/cluster.ts:324

Returns: Promise\

k8sRequest#

▸ Protectedk8sRequest\(path: string, options?: RequestPromiseOptions): Promise\

Defined in src/main/cluster.ts:255

Type parameters:

Name Default
T any

Parameters:

Name Type Default value
path string -
options RequestPromiseOptions {}

Returns: Promise\

pushState#

▸ pushState(state?: ClusterState): void

Defined in src/main/cluster.ts:407

Parameters:

Name Type Default value
state ClusterState this.getState()

Returns: void

reconnect#

▸ reconnect(): Promise\

Defined in src/main/cluster.ts:178

Returns: Promise\

refresh#

▸ refresh(opts?: ClusterRefreshOptions): Promise\

Defined in src/main/cluster.ts:199

Parameters:

Name Type Default value
opts ClusterRefreshOptions {}

Returns: Promise\

refreshAllowedResources#

▸ refreshAllowedResources(): Promise\

Defined in src/main/cluster.ts:233

Returns: Promise\

refreshConnectionStatus#

▸ refreshConnectionStatus(): Promise\

Defined in src/main/cluster.ts:226

Returns: Promise\

refreshEvents#

▸ refreshEvents(): Promise\

Defined in src/main/cluster.ts:239

Returns: Promise\

refreshMetadata#

▸ refreshMetadata(): Promise\

Defined in src/main/cluster.ts:218

Returns: Promise\

setState#

▸ setState(state: ClusterState): void

Defined in src/main/cluster.ts:403

Parameters:

Name Type
state ClusterState

Returns: void

toJSON#

▸ toJSON(): ClusterModel

Defined in src/main/cluster.ts:366

Returns: ClusterModel

unbindEvents#

▸ ProtectedunbindEvents(): void

Defined in src/main/cluster.ts:146

Returns: void

updateModel#

▸ updateModel(model: ClusterModel): void

Defined in src/main/cluster.ts:106

Parameters:

Name Type
model ClusterModel

Returns: void

Last update: November 10, 2020