Skip to content

Class: Cluster#

Hierarchy#

  • Cluster

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Cluster(model: ClusterModel): Cluster

Defined in src/main/cluster.ts:102

Parameters:

Name Type
model ClusterModel

Returns: Cluster

Properties#

accessible#

• accessible: boolean = false

Defined in src/main/cluster.ts:72

accessibleNamespaces#

• accessibleNamespaces: string[] = []

Implementation of ClusterModel.accessibleNamespaces

Defined in src/main/cluster.ts:82

Protected activated#

• activated: boolean = false

Defined in src/main/cluster.ts:59

allowedNamespaces#

• allowedNamespaces: string[] = []

Defined in src/main/cluster.ts:80

allowedResources#

• allowedResources: string[] = []

Defined in src/main/cluster.ts:81

apiUrl#

• apiUrl: string

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

Defined in src/main/cluster.ts:75

enabled#

• enabled: boolean = false

Defined in src/main/cluster.ts:70

Protected eventDisposers#

• eventDisposers: Function[] = []

Defined in src/main/cluster.ts:58

failureReason#

• failureReason: string

Defined in src/main/cluster.ts:76

id#

• id: ClusterId

Implementation of ClusterModel.id

Defined in src/main/cluster.ts:53

initialized#

• initialized: boolean = false

Defined in src/main/cluster.ts:64

isAdmin#

• isAdmin: boolean = false

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

Protected kubeconfigManager#

• kubeconfigManager: KubeconfigManager

Defined in src/main/cluster.ts:57

metadata#

• metadata: ClusterMetadata

Implementation of ClusterModel.metadata

Defined in src/main/cluster.ts:79

online#

• online: boolean = false

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:78

ready#

• ready: boolean = false

Defined in src/main/cluster.ts:73

reconnecting#

• reconnecting: boolean = false

Defined in src/main/cluster.ts:74

whenInitialized#

• whenInitialized: Promise‹void› & object = when(() => this.initialized)

Defined in src/main/cluster.ts:61

whenReady#

• whenReady: Promise‹void› & object = 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:84

Returns: boolean

isManaged#

• get isManaged(): boolean

Defined in src/main/cluster.ts:113

Returns: boolean

name#

• get name(): string

Defined in src/main/cluster.ts:88

Returns: string

prometheusPreferences#

• get prometheusPreferences(): ClusterPrometheusPreferences

Defined in src/main/cluster.ts:92

Returns: ClusterPrometheusPreferences

version#

• get version(): string

Defined in src/main/cluster.ts:100

Returns: string

Methods#

activate#

▸ activate(force: boolean): Promise‹void›

Defined in src/main/cluster.ts:166

Parameters:

Name Type Default
force boolean false

Returns: Promise‹void›

Protected bindEvents#

▸ bindEvents(): void

Defined in src/main/cluster.ts:142

Returns: void

canI#

▸ canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

Defined in src/main/cluster.ts:332

Parameters:

Name Type
resourceAttributes V1ResourceAttributes

Returns: Promise‹boolean›

disconnect#

▸ disconnect(): void

Defined in src/main/cluster.ts:208

Returns: void

Protected ensureKubectl#

▸ ensureKubectl(): Promise‹boolean›

Defined in src/main/cluster.ts:193

Returns: Promise‹boolean›

Protected getAllowedNamespaces#

▸ getAllowedNamespaces(): Promise‹string[]›

Defined in src/main/cluster.ts:419

Returns: Promise‹string[]›

Protected getAllowedResources#

▸ getAllowedResources(): Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

Defined in src/main/cluster.ts:439

Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

Protected getConnectionStatus#

▸ getConnectionStatus(): Promise‹ClusterStatus›

Defined in src/main/cluster.ts:294

Returns: Promise‹ClusterStatus›

Protected getKubeconfig#

▸ getKubeconfig(): KubeConfig

Defined in src/main/cluster.ts:261

Returns: KubeConfig

getMeta#

▸ getMeta(): object

Defined in src/main/cluster.ts:407

Returns: object

  • accessible: boolean = this.accessible

  • disconnected: boolean = this.disconnected

  • id: string = this.id

  • initialized: boolean = this.initialized

  • name: string = this.contextName

  • online: boolean = this.online

  • ready: boolean = this.ready

getMetrics#

▸ getMetrics(prometheusPath: string, queryParams: IMetricsReqParams & object): Promise‹any›

Defined in src/main/cluster.ts:282

Parameters:

Name Type
prometheusPath string
queryParams IMetricsReqParams & object

Returns: Promise‹any›

getProxyKubeconfig#

▸ getProxyKubeconfig(): KubeConfig

Defined in src/main/cluster.ts:265

Returns: KubeConfig

getProxyKubeconfigPath#

▸ getProxyKubeconfigPath(): string

Defined in src/main/cluster.ts:269

Returns: string

getState#

▸ getState(): ClusterState

Defined in src/main/cluster.ts:376

Returns: ClusterState

init#

▸ init(port: number): Promise‹void›

Defined in src/main/cluster.ts:123

Parameters:

Name Type
port number

Returns: Promise‹void›

isClusterAdmin#

▸ isClusterAdmin(): Promise‹boolean›

Defined in src/main/cluster.ts:350

Returns: Promise‹boolean›

Protected k8sRequest#

▸ k8sRequest‹T›(path: string, options: RequestPromiseOptions): Promise‹T›

Defined in src/main/cluster.ts:273

Type parameters:

▪ T

Parameters:

Name Type Default
path string -
options RequestPromiseOptions {}

Returns: Promise‹T›

pushState#

▸ pushState(state: ClusterState): void

Defined in src/main/cluster.ts:401

Parameters:

Name Type Default
state ClusterState this.getState()

Returns: void

reconnect#

▸ reconnect(): Promise‹void›

Defined in src/main/cluster.ts:200

Returns: Promise‹void›

refresh#

▸ refresh(opts: ClusterRefreshOptions): Promise‹void›

Defined in src/main/cluster.ts:221

Parameters:

Name Type Default
opts ClusterRefreshOptions {}

Returns: Promise‹void›

refreshAllowedResources#

▸ refreshAllowedResources(): Promise‹void›

Defined in src/main/cluster.ts:256

Returns: Promise‹void›

refreshConnectionStatus#

▸ refreshConnectionStatus(): Promise‹void›

Defined in src/main/cluster.ts:248

Returns: Promise‹void›

refreshMetadata#

▸ refreshMetadata(): Promise‹void›

Defined in src/main/cluster.ts:239

Returns: Promise‹void›

setState#

▸ setState(state: ClusterState): void

Defined in src/main/cluster.ts:397

Parameters:

Name Type
state ClusterState

Returns: void

toJSON#

▸ toJSON(): ClusterModel

Defined in src/main/cluster.ts:358

Returns: ClusterModel

Protected unbindEvents#

▸ unbindEvents(): void

Defined in src/main/cluster.ts:159

Returns: void

updateModel#

▸ updateModel(model: ClusterModel): void

Defined in src/main/cluster.ts:118

Parameters:

Name Type
model ClusterModel

Returns: void