diff --git a/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html index 0074c10c5e..1b6ce90b74 100644 --- a/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html +++ b/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -1024,13 +1024,13 @@

Properties#

templateContext#

• templateContext: any

-

Defined in src/extensions/cluster-feature.ts:29

+

Defined in src/extensions/cluster-feature.ts:30

this field sets the template parameters that are to be applied to any templated kubernetes resources that are to be installed for the feature. See the renderTemplates() method for more details

Methods#

Protected applyResources#

-

▸ applyResources(cluster: Cluster, resourceSpec: string | string[]): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:85

+

▸ applyResources(cluster: KubernetesCluster, resourceSpec: string | string[]): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:86

this is a helper method that conveniently applies kubernetes resources to the cluster.

Parameters:

@@ -1044,7 +1044,7 @@ See the renderTemplates() method for more details

- + @@ -1057,8 +1057,8 @@ See the renderTemplates() method for more details

Returns: Promise‹void›

Abstract install#

-

▸ install(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:47

+

▸ install(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:48

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be installed. The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi)

Parameters:

@@ -1073,7 +1073,7 @@ of this method should install kubernetes resources using the applyResources() me - + @@ -1082,7 +1082,7 @@ of this method should install kubernetes resources using the applyResources() me

Protected renderTemplates#

▸ renderTemplates(folderPath: string): string[]

-

Defined in src/extensions/cluster-feature.ts:109

+

Defined in src/extensions/cluster-feature.ts:116

this is a helper method that conveniently reads kubernetes resource files into a string array. It also fills templated resource files with the template parameter values specified by the templateContext field. Templated files must end with the extension '.hb' and the template syntax must be compatible with handlebars.js

Parameters:

@@ -1106,8 +1106,8 @@ specified by the templateContext field. Templated files must end with the extens

an array of strings, each string being the contents of a resource file found in the folder path. This can be passed directly to applyResources()

Abstract uninstall#

-

▸ uninstall(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:63

+

▸ uninstall(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:64

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be uninstalled. The implementation of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)

Parameters:

@@ -1122,7 +1122,7 @@ of this method should uninstall kubernetes resources using the kubernetes api (K - + @@ -1130,8 +1130,8 @@ of this method should uninstall kubernetes resources using the kubernetes api (K

Returns: Promise‹void›

Abstract updateStatus#

-

▸ updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus›

-

Defined in src/extensions/cluster-feature.ts:75

+

▸ updateStatus(cluster: KubernetesCluster): Promise‹ClusterFeatureStatus›

+

Defined in src/extensions/cluster-feature.ts:76

to be implemented in the derived class, this method is called periodically by Lens to determine details about the feature's current status. The implementation of this method should provide the current status information. The currentVersion and latestVersion fields may be displayed by Lens in describing the feature. The installed field should be set to true if the feature has been installed, otherwise false. Also, Lens relies on the canUpgrade field to determine if the feature @@ -1148,7 +1148,7 @@ can be upgraded so the implementation should set the canUpgrade field according

- + @@ -1157,8 +1157,8 @@ can be upgraded so the implementation should set the canUpgrade field according

a promise, resolved with the updated ClusterFeatureStatus

Abstract upgrade#

-

▸ upgrade(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:55

+

▸ upgrade(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:56

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be upgraded. The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature

Parameters:

@@ -1173,7 +1173,7 @@ of this method should upgrade the kubernetes resources already installed, if rel - + @@ -1182,20 +1182,20 @@ of this method should upgrade the kubernetes resources already installed, if rel

Object literals#

status#

▪ status: object#

-

Defined in src/extensions/cluster-feature.ts:34

+

Defined in src/extensions/cluster-feature.ts:35

this field holds the current feature status, is accessed directly by Lens

canUpgrade#

• canUpgrade: false = false

-

Defined in src/extensions/cluster-feature.ts:38

+

Defined in src/extensions/cluster-feature.ts:39

currentVersion#

• currentVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:35

+

Defined in src/extensions/cluster-feature.ts:36

installed#

• installed: false = false

-

Defined in src/extensions/cluster-feature.ts:36

+

Defined in src/extensions/cluster-feature.ts:37

latestVersion#

• latestVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:37

+

Defined in src/extensions/cluster-feature.ts:38

diff --git a/master/extensions/api/classes/_core_api_stores_.cluster/index.html b/master/extensions/api/classes/_core_api_stores_.cluster/index.html deleted file mode 100644 index 2966d581cf..0000000000 --- a/master/extensions/api/classes/_core_api_stores_.cluster/index.html +++ /dev/null @@ -1,2184 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Cluster - Lens Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Cluster#

-

Cluster

-

beta

-

Hierarchy#

-
    -
  • Cluster
    • -
-

Implements#

- -

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Cluster(model: ClusterModel): Cluster

-

Defined in src/main/cluster.ts:256

-

Parameters:

-
clusterClusterKubernetesCluster the cluster that the resources are to be applied to
clusterClusterKubernetesCluster the cluster that the feature is to be installed on
clusterClusterKubernetesCluster the cluster that the feature is to be uninstalled from
clusterClusterKubernetesCluster the cluster that the feature may be installed on
clusterClusterKubernetesCluster the cluster that the feature is to be upgraded on
- - - - - - - - - - - - -
NameType
modelClusterModel
-

Returns: Cluster

-

Properties#

-

accessible#

-

• accessible: boolean = false

-

Defined in src/main/cluster.ts:149

-

Can user access cluster resources

-

observable

-
-

accessibleNamespaces#

-

• accessibleNamespaces: string[] = []

-

Implementation of ClusterModel.accessibleNamespaces

-

Defined in src/main/cluster.ts:217

-

List of accessible namespaces provided by user in the Cluster Settings

-

observable

-
-

Protected activated#

-

• activated: boolean = false

-

Defined in src/main/cluster.ts:82

-
-

allowedNamespaces#

-

• allowedNamespaces: string[] = []

-

Defined in src/main/cluster.ts:204

-

List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

-

observable

-
-

allowedResources#

-

• allowedResources: string[] = []

-

Defined in src/main/cluster.ts:211

-

List of allowed resources

-

observable

-

internal

-
-

apiUrl#

-

• apiUrl: string

-

Defined in src/main/cluster.ts:124

-

Kubernetes API server URL

-

observable

-
-

contextHandler#

-

• contextHandler: ContextHandler

-

Defined in src/main/cluster.ts:73

-

Context handler

-

internal

-
-

contextName#

-

• contextName: string

-

Implementation of ClusterModel.contextName

-

Defined in src/main/cluster.ts:106

-

Kubeconfig context name

-

observable

-
-

disconnected#

-

• disconnected: boolean = true

-

Defined in src/main/cluster.ts:167

-

Is cluster disconnected. False if user has selected to connect.

-

observable

-
-

enabled#

-

• enabled: boolean = false

-

Defined in src/main/cluster.ts:137

-

Is cluster instance enabled (disabled clusters are currently hidden)

-

observable

-
-

Protected eventDisposers#

-

• eventDisposers: Function[] = []

-

Defined in src/main/cluster.ts:81

-
-

failureReason#

-

• failureReason: string

-

Defined in src/main/cluster.ts:173

-

Connection failure reason

-

observable

-
-

id#

-

• id: ClusterId

-

Implementation of ClusterModel.id

-

Defined in src/main/cluster.ts:61

-

Unique id for a cluster

-
-

initialized#

-

• initialized: boolean = false

-

Defined in src/main/cluster.ts:100

-

Is cluster object initialized

-

observable

-
-

initializing#

-

• initializing: boolean = false

-

Defined in src/main/cluster.ts:93

-

Is cluster object initializinng on-going

-

observable

-
-

isAdmin#

-

• isAdmin: boolean = false

-

Defined in src/main/cluster.ts:179

-

Does user have admin like access

-

observable

-
-

isGlobalWatchEnabled#

-

• isGlobalWatchEnabled: boolean = false

-

Defined in src/main/cluster.ts:186

-

Global watch-api accessibility , e.g. "/api/v1/services?watch=1"

-

observable

-
-

kubeConfigPath#

-

• kubeConfigPath: string

-

Implementation of ClusterModel.kubeConfigPath

-

Defined in src/main/cluster.ts:118

-

Path to kubeconfig

-

observable

-
-

kubeCtl#

-

• kubeCtl: Kubectl

-

Defined in src/main/cluster.ts:67

-

Kubectl

-

internal

-
-

kubeProxyUrl#

-

• kubeProxyUrl: string

-

Defined in src/main/cluster.ts:131

-

Internal authentication proxy URL

-

observable

-

internal

-
-

Protected kubeconfigManager#

-

• kubeconfigManager: KubeconfigManager

-

Defined in src/main/cluster.ts:80

-
-

metadata#

-

• metadata: ClusterMetadata

-

Implementation of ClusterModel.metadata

-

Defined in src/main/cluster.ts:198

-

Metadata

-

observable

-
-

online#

-

• online: boolean = false

-

Defined in src/main/cluster.ts:143

-

Is cluster online

-

observable

-
-

ownerRef#

-

• ownerRef: string

-

Implementation of ClusterModel.ownerRef

-

Defined in src/main/cluster.ts:79

-

Owner reference

-

If extension sets this it needs to also mark cluster as enabled on activate (or when added to a store)

-
-

preferences#

-

• preferences: ClusterPreferences

-

Implementation of ClusterModel.preferences

-

Defined in src/main/cluster.ts:192

-

Preferences

-

observable

-
-

ready#

-

• ready: boolean = false

-

Defined in src/main/cluster.ts:155

-

Is cluster instance in usable state

-

observable

-
-

reconnecting#

-

• reconnecting: boolean = false

-

Defined in src/main/cluster.ts:161

-

Is cluster currently reconnecting

-

observable

-
-

whenInitialized#

-

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

-

Defined in src/main/cluster.ts:85

-
-

whenReady#

-

• whenReady: Promise‹void› & object = when(() => this.ready)

-

Defined in src/main/cluster.ts:86

-
-

workspace#

-

• workspace: WorkspaceId

-

Implementation of ClusterModel.workspace

-

Defined in src/main/cluster.ts:112

-

Workspace id

-

observable

-

Accessors#

-

available#

-

• get available(): boolean

-

Defined in src/main/cluster.ts:224

-

Is cluster available

-

computed

-

Returns: boolean

-
-

isManaged#

-

• get isManaged(): boolean

-

Defined in src/main/cluster.ts:276

-

Is cluster managed by an extension

-

Returns: boolean

-
-

name#

-

• get name(): string

-

Defined in src/main/cluster.ts:233

-

Cluster name

-

computed

-

Returns: string

-
-

prometheusPreferences#

-

• get prometheusPreferences(): ClusterPrometheusPreferences

-

Defined in src/main/cluster.ts:243

-

Prometheus preferences

-

computed

-

internal

-

Returns: ClusterPrometheusPreferences

-
-

version#

-

• get version(): string

-

Defined in src/main/cluster.ts:254

-

Kubernetes version

-

Returns: string

-

Methods#

-

activate#

-

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

-

Defined in src/main/cluster.ts:352

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
forcebooleanfalseforce activation
-

Returns: Promise‹void›

-
-

Protected bindEvents#

-

▸ bindEvents(): void

-

Defined in src/main/cluster.ts:321

-

internal

-

Returns: void

-
-

canI#

-

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

-

Defined in src/main/cluster.ts:570

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
resourceAttributesV1ResourceAttributesresource attributes
-

Returns: Promise‹boolean›

-
-

canUseWatchApi#

-

▸ canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:602

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
customizeResourceV1ResourceAttributes{}
-

Returns: Promise‹boolean›

-
-

disconnect#

-

▸ disconnect(): void

-

Defined in src/main/cluster.ts:400

-

internal

-

Returns: void

-
-

Protected ensureKubectl#

-

▸ ensureKubectl(): Promise‹boolean›

-

Defined in src/main/cluster.ts:380

-

internal

-

Returns: Promise‹boolean›

-
-

Protected getAllowedNamespaces#

-

▸ getAllowedNamespaces(): Promise‹string[]›

-

Defined in src/main/cluster.ts:681

-

Returns: Promise‹string[]›

-
-

Protected getAllowedResources#

-

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

-

Defined in src/main/cluster.ts:705

-

Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "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:526

-

Returns: Promise‹ClusterStatus›

-
-

Protected getKubeconfig#

-

▸ getKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:478

-

Returns: KubeConfig

-
-

getMeta#

-

▸ getMeta(): object

-

Defined in src/main/cluster.ts:669

-

Returns: object

- -
-

getMetrics#

-

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

-

Defined in src/main/cluster.ts:513

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
prometheusPathstringpath to prometheus service
queryParamsIMetricsReqParams & objectquery parameters
-

Returns: Promise‹any›

-
-

getProxyKubeconfig#

-

▸ getProxyKubeconfig(): Promise‹KubeConfig›

-

Defined in src/main/cluster.ts:485

-

internal

-

Returns: Promise‹KubeConfig›

-
-

getProxyKubeconfigPath#

-

▸ getProxyKubeconfigPath(): Promise‹string›

-

Defined in src/main/cluster.ts:494

-

internal

-

Returns: Promise‹string›

-
-

getState#

-

▸ getState(): ClusterState

-

Defined in src/main/cluster.ts:630

-

Serializable cluster-state used for sync btw main <-> renderer

-

Returns: ClusterState

-
-

init#

-

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

-

Defined in src/main/cluster.ts:296

-

Initialize a cluster (can be done only in main process)

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
portnumberport where internal auth proxy is listening
-

Returns: Promise‹void›

-
-

isAllowedResource#

-

▸ isAllowedResource(kind: string): boolean

-

Defined in src/main/cluster.ts:740

-

Parameters:

- - - - - - - - - - - - - -
NameType
kindstring
-

Returns: boolean

-
-

isClusterAdmin#

-

▸ isClusterAdmin(): Promise‹boolean›

-

Defined in src/main/cluster.ts:591

-

internal

-

Returns: Promise‹boolean›

-
-

Protected k8sRequest#

-

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

-

Defined in src/main/cluster.ts:498

-

Type parameters:

-

▪ T

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
pathstring-
optionsRequestPromiseOptions{}
-

Returns: Promise‹T›

-
-

pushState#

-

▸ pushState(state: ClusterState): void

-

Defined in src/main/cluster.ts:663

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
stateClusterStatethis.getState()cluster state
-

Returns: void

-
-

reconnect#

-

▸ reconnect(): Promise‹void›

-

Defined in src/main/cluster.ts:390

-

internal

-

Returns: Promise‹void›

-
-

refresh#

-

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

-

Defined in src/main/cluster.ts:419

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
optsClusterRefreshOptions{}refresh options
-

Returns: Promise‹void›

-
-

refreshAllowedResources#

-

▸ refreshAllowedResources(): Promise‹void›

-

Defined in src/main/cluster.ts:473

-

internal

-

Returns: Promise‹void›

-
-

refreshConnectionStatus#

-

▸ refreshConnectionStatus(): Promise‹void›

-

Defined in src/main/cluster.ts:462

-

internal

-

Returns: Promise‹void›

-
-

refreshMetadata#

-

▸ refreshMetadata(): Promise‹void›

-

Defined in src/main/cluster.ts:438

-

internal

-

Returns: Promise‹void›

-
-

setState#

-

▸ setState(state: ClusterState): void

-

Defined in src/main/cluster.ts:655

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
stateClusterStatecluster state
-

Returns: void

-
-

toJSON#

-

▸ toJSON(): ClusterModel

-

Defined in src/main/cluster.ts:610

-

Returns: ClusterModel

-
-

Protected unbindEvents#

-

▸ unbindEvents(): void

-

Defined in src/main/cluster.ts:341

-

internal

-

Returns: void

-
-

updateModel#

-

▸ updateModel(model: ClusterModel): void

-

Defined in src/main/cluster.ts:285

-

Update cluster data model

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModel
-

Returns: void

- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html deleted file mode 100644 index e9b9248ef3..0000000000 --- a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ /dev/null @@ -1,1346 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ClusterStore - Lens Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ClusterStore#

-

Store for all added clusters

-

beta

-

Hierarchy#

- -

↳ ClusterStore

-

Index#

-

Accessors#

- -

Methods#

- -

Accessors#

-

activeCluster#

-

• get activeCluster(): Cluster | null

-

Defined in src/extensions/stores/cluster-store.ts:41

-

Get active cluster (a cluster which is currently visible)

-

Returns: Cluster | null

-
-

activeClusterId#

-

• get activeClusterId(): string

-

Defined in src/extensions/stores/cluster-store.ts:20

-

Active cluster id

-

Returns: string

-

• set activeClusterId(id: ClusterId): void

-

Defined in src/extensions/stores/cluster-store.ts:27

-

Set active cluster id

-

Parameters:

- - - - - - - - - - - - - -
NameType
idClusterId
-

Returns: void

-
-

clusters#

-

• get clusters(): ObservableMap‹string, Cluster›

-

Defined in src/extensions/stores/cluster-store.ts:34

-

Map of all clusters

-

Returns: ObservableMap‹string, Cluster›

-
-

clustersList#

-

• get clustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:48

-

Array of all clusters

-

Returns: Cluster[]

-
-

connectedClustersList#

-

• get connectedClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:62

-

Array of all clusters that have active connection to a Kubernetes cluster

-

Returns: Cluster[]

-
-

enabledClustersList#

-

• get enabledClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:55

-

Array of all enabled clusters

-

Returns: Cluster[]

-

Methods#

-

addCluster#

-

▸ addCluster(model: ClusterModel | Cluster): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:94

-

Add a cluster to store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModel | Clustercluster
-

Returns: Cluster

-
-

addClusters#

-

▸ addClusters(...models: ClusterModel[]): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:86

-

Add clusters to store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
...modelsClusterModel[]list of cluster models
-

Returns: Cluster[]

-
-

getById#

-

▸ getById(id: ClusterId): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:70

-

Get cluster object by cluster id

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
idClusterIdcluster id
-

Returns: Cluster

-
-

getByWorkspaceId#

-

▸ getByWorkspaceId(workspaceId: string): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:78

-

Get all clusters belonging to a workspace

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
workspaceIdstringworkspace id
-

Returns: Cluster[]

-
-

removeById#

-

▸ removeById(clusterId: ClusterId): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:110

-

Remove a cluster from store by id

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
clusterIdClusterIdcluster id
-

Returns: Promise‹void›

-
-

removeByWorkspaceId#

-

▸ removeByWorkspaceId(workspaceId: string): void

-

Defined in src/extensions/stores/cluster-store.ts:118

-

Remove all clusters belonging to a workspaces

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
workspaceIdstringworkspace id
-

Returns: void

-
-

removeCluster#

-

▸ removeCluster(model: ClusterModel): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:102

-

Remove a cluster from store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModelcluster
-

Returns: Promise‹void›

-
-

Static getInstance#

-

▸ getInstance‹T›(...args: ConstructorParameters‹Constructor‹T››): T

-

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:15

-

Type parameters:

-

▪ T

-

Parameters:

- - - - - - - - - - - - - -
NameType
...argsConstructorParameters‹Constructor‹T››
-

Returns: T

-
-

Static resetInstance#

-

▸ resetInstance(): void

-

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:23

-

Returns: void

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html index 6e993973ab..0976eb372e 100644 --- a/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -1175,7 +1175,7 @@

Protected constructor#

+ new ExtensionStore(params: BaseStoreParams): ExtensionStore

Inherited from ExtensionStore.constructor

-

Defined in src/common/base-store.ts:26

+

Defined in src/common/base-store.ts:26

Parameters:

@@ -1195,61 +1195,61 @@

Properties#

Protected extension#

• extension: LensExtension

-

Defined in src/extensions/extension-store.ts:6

+

Defined in src/extensions/extension-store.ts:6

isLoaded#

• isLoaded: boolean = false

Inherited from ExtensionStore.isLoaded

-

Defined in src/common/base-store.ts:26

+

Defined in src/common/base-store.ts:26

Protected params#

• params: BaseStoreParams

Inherited from ExtensionStore.params

-

Defined in src/common/base-store.ts:28

+

Defined in src/common/base-store.ts:28

Protected Optional storeConfig#

• storeConfig? : Config‹T›

Inherited from ExtensionStore.storeConfig

-

Defined in src/common/base-store.ts:22

+

Defined in src/common/base-store.ts:22

Protected syncDisposers#

• syncDisposers: Function[] = []

Inherited from ExtensionStore.syncDisposers

-

Defined in src/common/base-store.ts:23

+

Defined in src/common/base-store.ts:23

whenLoaded#

• whenLoaded: Promise‹void› & object = when(() => this.isLoaded)

Inherited from ExtensionStore.whenLoaded

-

Defined in src/common/base-store.ts:25

+

Defined in src/common/base-store.ts:25

Accessors#

name#

• get name(): string

Inherited from ExtensionStore.name

-

Defined in src/common/base-store.ts:38

+

Defined in src/common/base-store.ts:38

Returns: string

path#

• get path(): string

Inherited from ExtensionStore.path

-

Defined in src/common/base-store.ts:50

+

Defined in src/common/base-store.ts:50

Returns: string

Protected syncMainChannel#

• get syncMainChannel(): string

Inherited from ExtensionStore.syncMainChannel

-

Defined in src/common/base-store.ts:46

+

Defined in src/common/base-store.ts:46

Returns: string

Protected syncRendererChannel#

• get syncRendererChannel(): string

Inherited from ExtensionStore.syncRendererChannel

-

Defined in src/common/base-store.ts:42

+

Defined in src/common/base-store.ts:42

Returns: string

Methods#

Protected applyWithoutSync#

▸ applyWithoutSync(callback: function): void

Inherited from ExtensionStore.applyWithoutSync

-

Defined in src/common/base-store.ts:136

+

Defined in src/common/base-store.ts:136

Parameters:

▪ callback: function

▸ (): void

@@ -1258,25 +1258,25 @@

Protected cwd#

▸ cwd(): string

Overrides void

-

Defined in src/extensions/extension-store.ts:20

+

Defined in src/extensions/extension-store.ts:20

Returns: string

disableSync#

▸ disableSync(): void

Inherited from ExtensionStore.disableSync

-

Defined in src/common/base-store.ts:131

+

Defined in src/common/base-store.ts:131

Returns: void

enableSync#

▸ enableSync(): void

Inherited from ExtensionStore.enableSync

-

Defined in src/common/base-store.ts:94

+

Defined in src/common/base-store.ts:94

Returns: void

Protected Abstract fromStore#

▸ fromStore(data: T): void

Inherited from ExtensionStore.fromStore

-

Defined in src/common/base-store.ts:166

+

Defined in src/common/base-store.ts:166

fromStore is called internally when a child class syncs with the file system.

Parameters:

@@ -1301,18 +1301,18 @@ system.

Protected init#

▸ init(): Promise‹void›

Inherited from ExtensionStore.init

-

Defined in src/common/base-store.ts:54

+

Defined in src/common/base-store.ts:54

Returns: Promise‹void›

load#

▸ load(): Promise‹void›

Overrides void

-

Defined in src/extensions/extension-store.ts:14

+

Defined in src/extensions/extension-store.ts:14

Returns: Promise‹void›

loadExtension#

▸ loadExtension(extension: LensExtension): Promise‹void›

-

Defined in src/extensions/extension-store.ts:8

+

Defined in src/extensions/extension-store.ts:8

Parameters:

@@ -1333,7 +1333,7 @@ system.

Protected onModelChange#

▸ onModelChange(model: T): Promise‹void›

Inherited from ExtensionStore.onModelChange

-

Defined in src/common/base-store.ts:152

+

Defined in src/common/base-store.ts:152

Parameters:

@@ -1354,7 +1354,7 @@ system.

Protected onSync#

▸ onSync(model: T): void

Inherited from ExtensionStore.onSync

-

Defined in src/common/base-store.ts:145

+

Defined in src/common/base-store.ts:145

Parameters:

@@ -1375,7 +1375,7 @@ system.

Protected onSyncFromMain#

▸ onSyncFromMain(model: T): void

Inherited from ExtensionStore.onSyncFromMain

-

Defined in src/common/base-store.ts:120

+

Defined in src/common/base-store.ts:120

Parameters:

@@ -1396,7 +1396,7 @@ system.

Protected saveToFile#

▸ saveToFile(model: T): Promise‹void›

Inherited from ExtensionStore.saveToFile

-

Defined in src/common/base-store.ts:83

+

Defined in src/common/base-store.ts:83

Parameters:

@@ -1417,7 +1417,7 @@ system.

Abstract toJSON#

▸ toJSON(): T

Inherited from ExtensionStore.toJSON

-

Defined in src/common/base-store.ts:175

+

Defined in src/common/base-store.ts:175

toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representaion of the current state.

It is recommended that a round trip is valid. Namely, calling @@ -1427,13 +1427,13 @@ produce a JSON serializable object representaion of the current state.

unregisterIpcListener#

▸ unregisterIpcListener(): void

Inherited from ExtensionStore.unregisterIpcListener

-

Defined in src/common/base-store.ts:126

+

Defined in src/common/base-store.ts:126

Returns: void

Static getInstance#

▸ getInstance‹T›(...args: ConstructorParameters‹Constructor‹T››): T

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:15

+

Defined in src/common/utils/singleton.ts:15

Type parameters:

▪ T

Parameters:

@@ -1456,7 +1456,7 @@ produce a JSON serializable object representaion of the current state.

Static resetInstance#

▸ resetInstance(): void

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:23

+

Defined in src/common/utils/singleton.ts:23

Returns: void

diff --git a/master/extensions/api/classes/_core_api_stores_.workspace/index.html b/master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html similarity index 76% rename from master/extensions/api/classes/_core_api_stores_.workspace/index.html rename to master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html index eac1d5dd5c..fcf358fc18 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: Workspace - Lens Documentation + Class: KubernetesCluster - Lens Documentation @@ -75,7 +75,7 @@
- + Skip to content @@ -106,7 +106,7 @@
- Class: Workspace + Class: KubernetesCluster
@@ -847,13 +847,6 @@ Properties - - -
  • - - Accessors - -
  • @@ -897,70 +890,36 @@ - - -
    • - -
  • - - Accessors - - -
    • @@ -1078,146 +1036,91 @@ - +
    dataWorkspaceModelCatalogEntityData
    -

    Returns: Workspace

    +

    Returns: KubernetesCluster

    Properties#

    -

    [updateFromModel]#

    -

    • [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { - Object.assign(this, model); - })

    -

    Defined in src/common/workspace-store.ts:135

    +

    apiVersion#

    +

    • apiVersion: "entity.k8slens.dev/v1alpha1" = "entity.k8slens.dev/v1alpha1"

    +

    Implementation of CatalogEntity.apiVersion

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:19

    -

    Optional description#

    -

    • description? : string

    -

    Implementation of WorkspaceModel.description

    -

    Defined in src/common/workspace-store.ts:54

    -

    Workspace description

    -

    observable

    +

    kind#

    +

    • kind: "KubernetesCluster" = "KubernetesCluster"

    +

    Implementation of CatalogEntity.kind

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:20

    -

    id#

    -

    • id: WorkspaceId

    -

    Implementation of WorkspaceModel.id

    -

    Defined in src/common/workspace-store.ts:42

    -

    Unique id for workspace

    -

    observable

    +

    metadata#

    +

    • metadata: CatalogEntityMetadata

    +

    Implementation of CatalogEntity.metadata

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:21

    -

    Optional lastActiveClusterId#

    -

    • lastActiveClusterId? : ClusterId

    -

    Implementation of WorkspaceModel.lastActiveClusterId

    -

    Defined in src/common/workspace-store.ts:69

    -

    Last active cluster id

    -

    observable

    +

    spec#

    +

    • spec: KubernetesClusterSpec

    +

    Implementation of CatalogEntity.spec

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:23

    -

    name#

    -

    • name: string

    -

    Implementation of WorkspaceModel.name

    -

    Defined in src/common/workspace-store.ts:48

    -

    Workspace name

    -

    observable

    -
    -

    Optional ownerRef#

    -

    • ownerRef? : string

    -

    Implementation of WorkspaceModel.ownerRef

    -

    Defined in src/common/workspace-store.ts:62

    -

    Workspace owner reference

    -

    If extension sets ownerRef then it needs to explicitly mark workspace as enabled onActivate (or when workspace is saved)

    -

    observable

    -

    Accessors#

    -

    enabled#

    -

    • get enabled(): boolean

    -

    Defined in src/common/workspace-store.ts:91

    -

    Is workspace enabled

    -

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    -

    observable

    -

    Returns: boolean

    -

    • set enabled(enabled: boolean): void

    -

    Defined in src/common/workspace-store.ts:95

    -

    Is workspace enabled

    -

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    -

    Parameters:

    - - - - - - - - - - - - - -
    NameType
    enabledboolean
    -

    Returns: void

    -
    -

    isManaged#

    -

    • get isManaged(): boolean

    -

    Defined in src/common/workspace-store.ts:102

    -

    Is workspace managed by an extension

    -

    Returns: boolean

    +

    status#

    +

    • status: KubernetesClusterStatus

    +

    Implementation of CatalogEntity.status

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:22

    Methods#

    -

    getState#

    -

    ▸ getState(): WorkspaceState

    -

    Defined in src/common/workspace-store.ts:110

    -

    Get workspace state

    -

    Returns: WorkspaceState

    +

    getId#

    +

    ▸ getId(): string

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:31

    +

    Returns: string

    -

    pushState#

    -

    ▸ pushState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:122

    -

    Push state

    -

    internal

    +

    getName#

    +

    ▸ getName(): string

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:35

    +

    Returns: string

    +
    +

    onContextMenuOpen#

    +

    ▸ onContextMenuOpen(context: CatalogEntityContextMenuContext): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:47

    Parameters:

    - - - - - - + +
    Name TypeDefaultDescription
    stateWorkspaceStatethis.getState()workspace statecontextCatalogEntityContextMenuContext
    -

    Returns: void

    +

    Returns: Promise‹void›

    -

    setState#

    -

    ▸ setState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:131

    +

    onDetailsOpen#

    +

    ▸ onDetailsOpen(): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:43

    +

    Returns: Promise‹void›

    +
    +

    onRun#

    +

    ▸ onRun(context: CatalogEntityActionContext): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:39

    Parameters:

    - - - - + +
    Name TypeDescription
    stateWorkspaceStateworkspace statecontextCatalogEntityActionContext
    -

    Returns: void

    -
    -

    toJSON#

    -

    ▸ toJSON(): WorkspaceModel

    -

    Defined in src/common/workspace-store.ts:139

    -

    Returns: WorkspaceModel

    +

    Returns: Promise‹void›

    diff --git a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html similarity index 62% rename from master/extensions/api/classes/_core_api_stores_.workspacestore/index.html rename to master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html index f2999aaf2d..1117f7f466 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: WorkspaceStore - Lens Documentation + Class: KubernetesClusterCategory - Lens Documentation @@ -75,7 +75,7 @@
    - + Skip to content @@ -106,7 +106,7 @@
    - Class: WorkspaceStore + Class: KubernetesClusterCategory
    @@ -818,6 +818,13 @@ Hierarchy + + +
  • + + Implements + +
  • @@ -836,15 +843,15 @@
  • - - Accessors + + Methods
  • - - Methods + + Object literals
    • @@ -863,56 +870,22 @@ - - - - -
  • - - Accessors - - - + +
    • + +
  • + + Object literals + + +
    • + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html similarity index 83% rename from master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html rename to master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html index 4656931218..418a3085b7 100644 --- a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Interface: ClusterModel - Lens Documentation + Interface: CatalogEntityActionContext - Lens Documentation @@ -75,7 +75,7 @@
    - + Skip to content @@ -106,7 +106,7 @@
    - Interface: ClusterModel + Interface: CatalogEntityActionContext
    @@ -818,13 +818,6 @@ Hierarchy - - -
  • - - Implemented by - -
  • @@ -856,64 +849,15 @@