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 b8748ce03c..9e7c3eba86 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:29

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

+

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

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

Parameters:

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


Abstract install#

install(cluster: Cluster): Promise‹void›

-

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

+

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

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:

@@ -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:109

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:

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

Abstract uninstall#

uninstall(cluster: Cluster): Promise‹void›

-

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

+

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

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:

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

Abstract updateStatus#

updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus

-

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

+

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

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 @@ -1158,7 +1158,7 @@ can be upgraded so the implementation should set the canUpgrade field according


Abstract upgrade#

upgrade(cluster: Cluster): Promise‹void›

-

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

+

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

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:

@@ -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:34

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

currentVersion#

currentVersion: null = null

-

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

+

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

installed#

installed: false = false

-

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

+

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

latestVersion#

latestVersion: null = null

-

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

+

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

diff --git a/master/extensions/api/classes/_core_api_stores_.cluster/index.html b/master/extensions/api/classes/_core_api_stores_.cluster/index.html index dd33ce304c..693b555965 100644 --- a/master/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/master/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -1450,7 +1450,7 @@

Constructors#

constructor#

+ new Cluster(model: ClusterModel): Cluster

-

Defined in src/main/cluster.ts:241

+

Defined in src/main/cluster.ts:241

Parameters:

@@ -1470,194 +1470,194 @@

Properties#

accessible#

accessible: boolean = false

-

Defined in src/main/cluster.ts:141

+

Defined in src/main/cluster.ts:141

Can user access cluster resources

observable


accessibleNamespaces#

accessibleNamespaces: string[] = []

Implementation of ClusterModel.accessibleNamespaces

-

Defined in src/main/cluster.ts:202

+

Defined in src/main/cluster.ts:202

List of accessible namespaces

observable


Protected activated#

activated: boolean = false

-

Defined in src/main/cluster.ts:81

+

Defined in src/main/cluster.ts:81


allowedNamespaces#

allowedNamespaces: string[] = []

-

Defined in src/main/cluster.ts:189

+

Defined in src/main/cluster.ts:189

List of allowed namespaces

observable


allowedResources#

allowedResources: string[] = []

-

Defined in src/main/cluster.ts:196

+

Defined in src/main/cluster.ts:196

List of allowed resources

observable

internal


apiUrl#

apiUrl: string

-

Defined in src/main/cluster.ts:116

+

Defined in src/main/cluster.ts:116

Kubernetes API server URL

observable


contextHandler#

contextHandler: ContextHandler

-

Defined in src/main/cluster.ts:72

+

Defined in src/main/cluster.ts:72

Context handler

internal


contextName#

contextName: string

Implementation of ClusterModel.contextName

-

Defined in src/main/cluster.ts:98

+

Defined in src/main/cluster.ts:98

Kubeconfig context name

observable


disconnected#

disconnected: boolean = true

-

Defined in src/main/cluster.ts:159

+

Defined in src/main/cluster.ts:159

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

observable


enabled#

enabled: boolean = false

-

Defined in src/main/cluster.ts:129

+

Defined in src/main/cluster.ts:129

Is cluster instance enabled (disabled clusters are currently hidden)

observable


Protected eventDisposers#

eventDisposers: Function[] = []

-

Defined in src/main/cluster.ts:80

+

Defined in src/main/cluster.ts:80


failureReason#

failureReason: string

-

Defined in src/main/cluster.ts:165

+

Defined in src/main/cluster.ts:165

Connection failure reason

observable


id#

id: ClusterId

Implementation of ClusterModel.id

-

Defined in src/main/cluster.ts:60

+

Defined in src/main/cluster.ts:60

Unique id for a cluster


initialized#

initialized: boolean = false

-

Defined in src/main/cluster.ts:92

+

Defined in src/main/cluster.ts:92

Is cluster object initialized

observable


isAdmin#

isAdmin: boolean = false

-

Defined in src/main/cluster.ts:171

+

Defined in src/main/cluster.ts:171

Does user have admin like access

observable


kubeConfigPath#

kubeConfigPath: string

Implementation of ClusterModel.kubeConfigPath

-

Defined in src/main/cluster.ts:110

+

Defined in src/main/cluster.ts:110

Path to kubeconfig

observable


kubeCtl#

kubeCtl: Kubectl

-

Defined in src/main/cluster.ts:66

+

Defined in src/main/cluster.ts:66

Kubectl

internal


kubeProxyUrl#

kubeProxyUrl: string

-

Defined in src/main/cluster.ts:123

+

Defined in src/main/cluster.ts:123

Internal authentication proxy URL

observable

internal


Protected kubeconfigManager#

kubeconfigManager: KubeconfigManager

-

Defined in src/main/cluster.ts:79

+

Defined in src/main/cluster.ts:79


metadata#

metadata: ClusterMetadata

Implementation of ClusterModel.metadata

-

Defined in src/main/cluster.ts:183

+

Defined in src/main/cluster.ts:183

Metadata

observable


online#

online: boolean = false

-

Defined in src/main/cluster.ts:135

+

Defined in src/main/cluster.ts:135

Is cluster online

observable


ownerRef#

ownerRef: string

Implementation of ClusterModel.ownerRef

-

Defined in src/main/cluster.ts:78

+

Defined in src/main/cluster.ts:78

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

+

Defined in src/main/cluster.ts:177

Preferences

observable


ready#

ready: boolean = false

-

Defined in src/main/cluster.ts:147

+

Defined in src/main/cluster.ts:147

Is cluster instance in usable state

observable


reconnecting#

reconnecting: boolean = false

-

Defined in src/main/cluster.ts:153

+

Defined in src/main/cluster.ts:153

Is cluster currently reconnecting

observable


whenInitialized#

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

-

Defined in src/main/cluster.ts:84

+

Defined in src/main/cluster.ts:84


whenReady#

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

-

Defined in src/main/cluster.ts:85

+

Defined in src/main/cluster.ts:85


workspace#

workspace: WorkspaceId

Implementation of ClusterModel.workspace

-

Defined in src/main/cluster.ts:104

+

Defined in src/main/cluster.ts:104

Workspace id

observable

Accessors#

available#

get available(): boolean

-

Defined in src/main/cluster.ts:209

+

Defined in src/main/cluster.ts:209

Is cluster available

computed

Returns: boolean


isManaged#

get isManaged(): boolean

-

Defined in src/main/cluster.ts:255

+

Defined in src/main/cluster.ts:255

Is cluster managed by an extension

Returns: boolean


name#

get name(): string

-

Defined in src/main/cluster.ts:218

+

Defined in src/main/cluster.ts:218

Cluster name

computed

Returns: string


prometheusPreferences#

get prometheusPreferences(): ClusterPrometheusPreferences

-

Defined in src/main/cluster.ts:228

+

Defined in src/main/cluster.ts:228

Prometheus preferences

computed

internal

@@ -1665,13 +1665,13 @@

version#

get version(): string

-

Defined in src/main/cluster.ts:239

+

Defined in src/main/cluster.ts:239

Kubernetes version

Returns: string

Methods#

activate#

activate(force: boolean): Promise‹void›

-

Defined in src/main/cluster.ts:326

+

Defined in src/main/cluster.ts:326

internal

Parameters:

@@ -1696,13 +1696,13 @@

Protected bindEvents#

bindEvents(): void

-

Defined in src/main/cluster.ts:296

+

Defined in src/main/cluster.ts:296

internal

Returns: void


canI#

canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:527

+

Defined in src/main/cluster.ts:527

internal

Parameters:

@@ -1725,39 +1725,39 @@

disconnect#

disconnect(): void

-

Defined in src/main/cluster.ts:375

+

Defined in src/main/cluster.ts:375

internal

Returns: void


Protected ensureKubectl#

ensureKubectl(): Promise‹boolean›

-

Defined in src/main/cluster.ts:356

+

Defined in src/main/cluster.ts:356

internal

Returns: Promise‹boolean›


Protected getAllowedNamespaces#

getAllowedNamespaces(): Promise‹string[]›

-

Defined in src/main/cluster.ts:626

+

Defined in src/main/cluster.ts:626

Returns: Promise‹string[]›


Protected getAllowedResources#

getAllowedResources(): Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "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:646

+

Defined in src/main/cluster.ts:646

Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "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:483

+

Defined in src/main/cluster.ts:483

Returns: Promise‹ClusterStatus›


Protected getKubeconfig#

getKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:438

+

Defined in src/main/cluster.ts:438

Returns: KubeConfig


getMeta#

getMeta(): object

-

Defined in src/main/cluster.ts:614

+

Defined in src/main/cluster.ts:614

Returns: object

@@ -1813,25 +1813,25 @@

getProxyKubeconfig#

getProxyKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:445

+

Defined in src/main/cluster.ts:445

internal

Returns: KubeConfig


getProxyKubeconfigPath#

getProxyKubeconfigPath(): string

-

Defined in src/main/cluster.ts:452

+

Defined in src/main/cluster.ts:452

internal

Returns: string


getState#

getState(): ClusterState

-

Defined in src/main/cluster.ts:576

+

Defined in src/main/cluster.ts:576

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

Returns: ClusterState


init#

init(port: number): Promise‹void›

-

Defined in src/main/cluster.ts:274

+

Defined in src/main/cluster.ts:274

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

internal

Parameters:

@@ -1855,13 +1855,13 @@

isClusterAdmin#

isClusterAdmin(): Promise‹boolean›

-

Defined in src/main/cluster.ts:548

+

Defined in src/main/cluster.ts:548

internal

Returns: Promise‹boolean›


Protected k8sRequest#

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

-

Defined in src/main/cluster.ts:456

+

Defined in src/main/cluster.ts:456

Type parameters:

T

Parameters:

@@ -1890,7 +1890,7 @@

pushState#

pushState(state: ClusterState): void

-

Defined in src/main/cluster.ts:608

+

Defined in src/main/cluster.ts:608

internal

Parameters:

@@ -1915,13 +1915,13 @@

reconnect#

reconnect(): Promise‹void›

-

Defined in src/main/cluster.ts:365

+

Defined in src/main/cluster.ts:365

internal

Returns: Promise‹void›


refresh#

refresh(opts: ClusterRefreshOptions): Promise‹void›

-

Defined in src/main/cluster.ts:392

+

Defined in src/main/cluster.ts:392

internal

Parameters:

@@ -1946,25 +1946,25 @@

refreshAllowedResources#

refreshAllowedResources(): Promise‹void›

-

Defined in src/main/cluster.ts:433

+

Defined in src/main/cluster.ts:433

internal

Returns: Promise‹void›


refreshConnectionStatus#

refreshConnectionStatus(): Promise‹void›

-

Defined in src/main/cluster.ts:423

+

Defined in src/main/cluster.ts:423

internal

Returns: Promise‹void›


refreshMetadata#

refreshMetadata(): Promise‹void›

-

Defined in src/main/cluster.ts:412

+

Defined in src/main/cluster.ts:412

internal

Returns: Promise‹void›


setState#

setState(state: ClusterState): void

-

Defined in src/main/cluster.ts:600

+

Defined in src/main/cluster.ts:600

internal

Parameters:

@@ -1987,18 +1987,18 @@

toJSON#

toJSON(): ClusterModel

-

Defined in src/main/cluster.ts:556

+

Defined in src/main/cluster.ts:556

Returns: ClusterModel


Protected unbindEvents#

unbindEvents(): void

-

Defined in src/main/cluster.ts:316

+

Defined in src/main/cluster.ts:316

internal

Returns: void


updateModel#

updateModel(model: ClusterModel): void

-

Defined in src/main/cluster.ts:264

+

Defined in src/main/cluster.ts:264

Update cluster data model

Parameters:

diff --git a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html index 9eec8214ef..36ae9ab1e4 100644 --- a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -1025,17 +1025,17 @@

Accessors#

activeCluster#

get activeCluster(): Cluster

-

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

+

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

Get active cluster (a cluster which is currently visible)

Returns: Cluster


activeClusterId#

get activeClusterId(): string

-

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

+

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

+

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

Set active cluster id

Parameters:

@@ -1056,31 +1056,31 @@

clusters#

get clusters(): ObservableMap‹string, Cluster

-

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

+

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

+

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

Array of all clusters

Returns: Cluster[]


connectedClustersList#

get connectedClustersList(): Cluster[]

-

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

+

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

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

+

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

Array of all enabled clusters

Returns: Cluster[]

Methods#

addCluster#

addCluster(model: ClusterModel | Cluster): Cluster

-

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

+

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

Add a cluster to store

Parameters:

@@ -1103,7 +1103,7 @@

addClusters#

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

-

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

+

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

Add clusters to store

Parameters:

@@ -1126,7 +1126,7 @@

getById#

getById(id: ClusterId): Cluster

-

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

+

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

Get cluster object by cluster id

Parameters:

@@ -1149,7 +1149,7 @@

getByWorkspaceId#

getByWorkspaceId(workspaceId: string): Cluster[]

-

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

+

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

Get all clusters belonging to a workspace

Parameters:

@@ -1172,7 +1172,7 @@

removeById#

removeById(clusterId: ClusterId): Promise‹void›

-

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

+

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

Remove a cluster from store by id

Parameters:

@@ -1195,7 +1195,7 @@

removeByWorkspaceId#

removeByWorkspaceId(workspaceId: string): void

-

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

+

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

Remove all clusters belonging to a workspaces

Parameters:

@@ -1218,7 +1218,7 @@

removeCluster#

removeCluster(model: ClusterModel): Promise‹void›

-

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

+

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

Remove a cluster from store

Parameters:

@@ -1242,7 +1242,7 @@

Static getInstance#

getInstanceT›(...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:

@@ -1265,7 +1265,7 @@

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_.extensionstore/index.html b/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html index 6aa199d022..fdf55ac351 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 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:133

+

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

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

+

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

Returns: void


enableSync#

enableSync(): void

Inherited from ExtensionStore.enableSync

-

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

+

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

Returns: void


Protected Abstract fromStore#

fromStore(data: T): void

Inherited from ExtensionStore.fromStore

-

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

+

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

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

+

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

Parameters:

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

Protected onSync#

onSync(model: T): void

Inherited from ExtensionStore.onSync

-

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

+

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

Parameters:

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

Protected onSyncFromMain#

onSyncFromMain(model: T): void

Inherited from ExtensionStore.onSyncFromMain

-

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

+

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

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

+

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

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

+

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

Returns: void


Static getInstance#

getInstanceT›(...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_.workspace/index.html index 76c9170d41..a24f35f1e4 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/master/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -1058,7 +1058,7 @@

Constructors#

constructor#

+ new Workspace(data: WorkspaceModel): Workspace

-

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

+

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

Parameters:

@@ -1079,13 +1079,13 @@

Optional description#

description? : string

Implementation of WorkspaceModel.description

-

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

+

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

Workspace description

observable


enabled#

enabled: boolean

-

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

+

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

Is workspace enabled

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

observable

@@ -1093,47 +1093,47 @@

id#

id: WorkspaceId

Implementation of WorkspaceModel.id

-

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

+

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

Unique id for workspace

observable


Optional lastActiveClusterId#

lastActiveClusterId? : ClusterId

Implementation of WorkspaceModel.lastActiveClusterId

-

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

+

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

Last active cluster id

observable


name#

name: string

Implementation of WorkspaceModel.name

-

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

+

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

Workspace name

observable


Optional ownerRef#

ownerRef? : string

Implementation of WorkspaceModel.ownerRef

-

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

+

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

Workspace owner reference

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

observable

Accessors#

isManaged#

get isManaged(): boolean

-

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

+

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

Is workspace managed by an extension

Returns: boolean

Methods#

getState#

getState(): WorkspaceState

-

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

+

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

Get workspace state

Returns: WorkspaceState


pushState#

pushState(state: WorkspaceState): void

-

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

+

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

Push state

interal

Parameters:

@@ -1159,7 +1159,7 @@

setState#

setState(state: WorkspaceState): void

-

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

+

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

Parameters:

@@ -1181,7 +1181,7 @@

toJSON#

toJSON(): WorkspaceModel

-

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

+

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

Returns: WorkspaceModel

diff --git a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html index 0f09eed0b3..4074bdb698 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -1048,22 +1048,22 @@

Properties#

Static defaultId#

defaultId: WorkspaceId = InternalWorkspaceStore.defaultId

-

Defined in src/extensions/stores/workspace-store.ts:17

+

Defined in src/extensions/stores/workspace-store.ts:17

Default workspace id, this workspace is always present

Accessors#

currentWorkspace#

get currentWorkspace(): Workspace

-

Defined in src/extensions/stores/workspace-store.ts:43

+

Defined in src/extensions/stores/workspace-store.ts:43

Currently active workspace

Returns: Workspace


currentWorkspaceId#

get currentWorkspaceId(): string

-

Defined in src/extensions/stores/workspace-store.ts:22

+

Defined in src/extensions/stores/workspace-store.ts:22

Currently active workspace id

Returns: string

set currentWorkspaceId(id: string): void

-

Defined in src/extensions/stores/workspace-store.ts:29

+

Defined in src/extensions/stores/workspace-store.ts:29

Set active workspace id

Parameters:

@@ -1084,25 +1084,25 @@

enabledWorkspacesList#

get enabledWorkspacesList(): Workspace[]

-

Defined in src/extensions/stores/workspace-store.ts:57

+

Defined in src/extensions/stores/workspace-store.ts:57

Array of all enabled (visible) workspaces

Returns: Workspace[]


workspaces#

get workspaces(): ObservableMap‹string, Workspace

-

Defined in src/extensions/stores/workspace-store.ts:36

+

Defined in src/extensions/stores/workspace-store.ts:36

Map of all workspaces

Returns: ObservableMap‹string, Workspace


workspacesList#

get workspacesList(): Workspace[]

-

Defined in src/extensions/stores/workspace-store.ts:50

+

Defined in src/extensions/stores/workspace-store.ts:50

Array of all workspaces

Returns: Workspace[]

Methods#

addWorkspace#

addWorkspace(workspace: Workspace): Workspace‹›

-

Defined in src/extensions/stores/workspace-store.ts:89

+

Defined in src/extensions/stores/workspace-store.ts:89

Add a workspace to store

Parameters:

@@ -1125,7 +1125,7 @@

getById#

getById(id: WorkspaceId): Workspace

-

Defined in src/extensions/stores/workspace-store.ts:65

+

Defined in src/extensions/stores/workspace-store.ts:65

Get workspace by id

Parameters:

@@ -1148,7 +1148,7 @@

getByName#

getByName(name: string): Workspace

-

Defined in src/extensions/stores/workspace-store.ts:73

+

Defined in src/extensions/stores/workspace-store.ts:73

Get workspace by name

Parameters:

@@ -1171,7 +1171,7 @@

removeWorkspace#

removeWorkspace(workspace: Workspace): void

-

Defined in src/extensions/stores/workspace-store.ts:105

+

Defined in src/extensions/stores/workspace-store.ts:105

Remove workspace from store

Parameters:

@@ -1194,7 +1194,7 @@

removeWorkspaceById#

removeWorkspaceById(id: WorkspaceId): void

-

Defined in src/extensions/stores/workspace-store.ts:113

+

Defined in src/extensions/stores/workspace-store.ts:113

Remove workspace by id

Parameters:

@@ -1217,7 +1217,7 @@

setActive#

setActive(id: string): void

-

Defined in src/extensions/stores/workspace-store.ts:81

+

Defined in src/extensions/stores/workspace-store.ts:81

Set active workspace

Parameters:

@@ -1242,7 +1242,7 @@

updateWorkspace#

updateWorkspace(workspace: Workspace): void

-

Defined in src/extensions/stores/workspace-store.ts:97

+

Defined in src/extensions/stores/workspace-store.ts:97

Update a workspace in store

Parameters:

@@ -1266,7 +1266,7 @@

Static getInstance#

getInstanceT›(...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:

@@ -1289,7 +1289,7 @@

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_utils_.singleton/index.html b/master/extensions/api/classes/_core_api_utils_.singleton/index.html index 1b1884bff5..5c48ee89b0 100644 --- a/master/extensions/api/classes/_core_api_utils_.singleton/index.html +++ b/master/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -897,7 +897,7 @@

Methods#

Static getInstance#

getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

-

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

+

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

Type parameters:

T

Parameters:

@@ -919,7 +919,7 @@

Static resetInstance#

resetInstance(): void

-

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/_renderer_api_components_.badge/index.html b/master/extensions/api/classes/_renderer_api_components_.badge/index.html index b1eebf131a..5e61a3dbf1 100644 --- a/master/extensions/api/classes/_renderer_api_components_.badge/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/badge/badge.tsx:15

+

Defined in src/renderer/components/badge/badge.tsx:15

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.button/index.html b/master/extensions/api/classes/_renderer_api_components_.button/index.html index 302fdbc5a0..cf557a67d5 100644 --- a/master/extensions/api/classes/_renderer_api_components_.button/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.button/index.html @@ -1265,7 +1265,7 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/button/button.tsx:26

+

Defined in src/renderer/components/button/button.tsx:26

Returns: Element‹›


Optional shouldComponentUpdate#

diff --git a/master/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/master/extensions/api/classes/_renderer_api_components_.checkbox/index.html index a11072140a..91b1223173 100644 --- a/master/extensions/api/classes/_renderer_api_components_.checkbox/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -1282,12 +1282,12 @@ lifecycle events from running.


getValue#

getValue(): boolean

-

Defined in src/renderer/components/checkbox/checkbox.tsx:25

+

Defined in src/renderer/components/checkbox/checkbox.tsx:25

Returns: boolean


onChange#

onChange(evt: ChangeEvent‹HTMLInputElement›): void

-

Defined in src/renderer/components/checkbox/checkbox.tsx:19

+

Defined in src/renderer/components/checkbox/checkbox.tsx:19

Parameters:

@@ -1307,7 +1307,7 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/checkbox/checkbox.tsx:31

+

Defined in src/renderer/components/checkbox/checkbox.tsx:31

Returns: Element‹›


Optional shouldComponentUpdate#

diff --git a/master/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/master/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html index 485cca6ce3..4a086eba1e 100644 --- a/master/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -1317,7 +1317,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1327,7 +1327,7 @@ Should be used with type annotation or static contextType.


isSaving#

isSaving: boolean = false

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:29

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:29


props#

props: Readonly‹ConfirmDialogProps› & Readonly‹object›

@@ -1356,11 +1356,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1371,15 +1371,15 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static isOpen#

isOpen: boolean = false

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:26

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:26


Static params#

params: ConfirmDialogParams

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

Accessors#

params#

get params(): ConfirmDialogParams

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

Returns: ConfirmDialogParams

Methods#

Optional UNSAFE_componentWillMount#

@@ -1470,7 +1470,7 @@ prevents this from being invoked.


close#

close(): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:65

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:65

Returns: void


Optional componentDidCatch#

@@ -1670,18 +1670,18 @@ lifecycle events from running.


ok#

ok(): Promise‹void›

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:51

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:51

Returns: Promise‹void›


onClose#

onClose(): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

Returns: void


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

Returns: Element‹›


setState#

@@ -1733,12 +1733,12 @@ and componentDidUpdate will not be called.


Static close#

close(): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:36

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:36

Returns: void


Static open#

open(params: ConfirmDialogParams): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

Parameters:

@@ -1758,19 +1758,19 @@ and componentDidUpdate will not be called.

Object literals#

defaultParams#

defaultParams: object#

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

icon#

icon: Element‹› =

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

labelCancel#

labelCancel: string = "Cancel"

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

labelOk#

labelOk: string = "Ok"

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

ok#

ok: any = noop

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

diff --git a/master/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/master/extensions/api/classes/_renderer_api_components_.cubespinner/index.html index 959f22262b..dae0cb0731 100644 --- a/master/extensions/api/classes/_renderer_api_components_.cubespinner/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/spinner/cube-spinner.tsx:11

+

Defined in src/renderer/components/spinner/cube-spinner.tsx:11

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.dialog/index.html b/master/extensions/api/classes/_renderer_api_components_.dialog/index.html index 43dd4fd906..92e84834a9 100644 --- a/master/extensions/api/classes/_renderer_api_components_.dialog/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -1235,16 +1235,16 @@

Properties#

closeOnNavigate#

closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

-

Defined in src/renderer/components/dialog/dialog.tsx:45

+

Defined in src/renderer/components/dialog/dialog.tsx:45

Accessors#

elem#

get elem(): HTMLElement

-

Defined in src/renderer/components/dialog/dialog.tsx:51

+

Defined in src/renderer/components/dialog/dialog.tsx:51

Returns: HTMLElement


isOpen#

get isOpen(): boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:56

+

Defined in src/renderer/components/dialog/dialog.tsx:56

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1335,7 +1335,7 @@ prevents this from being invoked.


close#

close(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:87

+

Defined in src/renderer/components/dialog/dialog.tsx:87

Returns: void


Optional componentDidCatch#

@@ -1368,13 +1368,13 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/dialog/dialog.tsx:60

+

Defined in src/renderer/components/dialog/dialog.tsx:60

Returns: void


componentDidUpdate#

componentDidUpdate(prevProps: DialogProps): void

Overrides PageLayout.componentDidUpdate

-

Defined in src/renderer/components/dialog/dialog.tsx:64

+

Defined in src/renderer/components/dialog/dialog.tsx:64

Parameters:

@@ -1442,7 +1442,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/dialog/dialog.tsx:72

+

Defined in src/renderer/components/dialog/dialog.tsx:72

Returns: void


Optional componentWillUpdate#

@@ -1513,7 +1513,7 @@ lifecycle events from running.


onClickOutside#

onClickOutside(evt: MouseEvent): void

-

Defined in src/renderer/components/dialog/dialog.tsx:121

+

Defined in src/renderer/components/dialog/dialog.tsx:121

Parameters:

@@ -1533,12 +1533,12 @@ lifecycle events from running.


onClose#

onClose(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:103

+

Defined in src/renderer/components/dialog/dialog.tsx:103

Returns: void


onEscapeKey#

onEscapeKey(evt: KeyboardEvent): void

-

Defined in src/renderer/components/dialog/dialog.tsx:112

+

Defined in src/renderer/components/dialog/dialog.tsx:112

Parameters:

@@ -1558,17 +1558,17 @@ lifecycle events from running.


onOpen#

onOpen(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:93

+

Defined in src/renderer/components/dialog/dialog.tsx:93

Returns: void


open#

open(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:81

+

Defined in src/renderer/components/dialog/dialog.tsx:81

Returns: void


render#

render(): ReactPortal‹›

-

Defined in src/renderer/components/dialog/dialog.tsx:130

+

Defined in src/renderer/components/dialog/dialog.tsx:130

Returns: ReactPortal‹›


Optional shouldComponentUpdate#

@@ -1608,7 +1608,7 @@ and componentDidUpdate will not be called.


toggle#

toggle(isOpen: boolean): void

-

Defined in src/renderer/components/dialog/dialog.tsx:76

+

Defined in src/renderer/components/dialog/dialog.tsx:76

Parameters:

@@ -1628,38 +1628,38 @@ and componentDidUpdate will not be called.

Object literals#

state#

state: object#

-

Defined in src/renderer/components/dialog/dialog.tsx:47

+

Defined in src/renderer/components/dialog/dialog.tsx:47

isOpen#

isOpen: boolean = this.props.isOpen

-

Defined in src/renderer/components/dialog/dialog.tsx:48

+

Defined in src/renderer/components/dialog/dialog.tsx:48


Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/dialog/dialog.tsx:33

+

Defined in src/renderer/components/dialog/dialog.tsx:33

animated#

animated: true = true

-

Defined in src/renderer/components/dialog/dialog.tsx:40

+

Defined in src/renderer/components/dialog/dialog.tsx:40

close#

close: any = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:36

+

Defined in src/renderer/components/dialog/dialog.tsx:36

isOpen#

isOpen: false = false

-

Defined in src/renderer/components/dialog/dialog.tsx:34

+

Defined in src/renderer/components/dialog/dialog.tsx:34

modal: true = true

-

Defined in src/renderer/components/dialog/dialog.tsx:39

+

Defined in src/renderer/components/dialog/dialog.tsx:39

onClose#

onClose: any = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:38

+

Defined in src/renderer/components/dialog/dialog.tsx:38

onOpen#

onOpen: any = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:37

+

Defined in src/renderer/components/dialog/dialog.tsx:37

open#

open: any = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:35

+

Defined in src/renderer/components/dialog/dialog.tsx:35

pinned#

pinned: false = false

-

Defined in src/renderer/components/dialog/dialog.tsx:41

+

Defined in src/renderer/components/dialog/dialog.tsx:41

diff --git a/master/extensions/api/classes/_renderer_api_components_.drawer/index.html b/master/extensions/api/classes/_renderer_api_components_.drawer/index.html index 486da33e88..de59723efe 100644 --- a/master/extensions/api/classes/_renderer_api_components_.drawer/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -1212,7 +1212,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1247,11 +1247,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1262,7 +1262,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/drawer/drawer.tsx:31

+

Defined in src/renderer/components/drawer/drawer.tsx:31

Methods#

Optional UNSAFE_componentWillMount#

UNSAFE_componentWillMount(): void

@@ -1352,7 +1352,7 @@ prevents this from being invoked.


close#

close(): void

-

Defined in src/renderer/components/drawer/drawer.tsx:101

+

Defined in src/renderer/components/drawer/drawer.tsx:101

Returns: void


Optional componentDidCatch#

@@ -1385,7 +1385,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/drawer/drawer.tsx:42

+

Defined in src/renderer/components/drawer/drawer.tsx:42

Returns: void


Optional componentDidUpdate#

@@ -1469,7 +1469,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/drawer/drawer.tsx:49

+

Defined in src/renderer/components/drawer/drawer.tsx:49

Returns: void


Optional componentWillUpdate#

@@ -1549,7 +1549,7 @@ lifecycle events from running.


onClickOutside#

onClickOutside(evt: MouseEvent): void

-

Defined in src/renderer/components/drawer/drawer.tsx:80

+

Defined in src/renderer/components/drawer/drawer.tsx:80

Parameters:

@@ -1569,7 +1569,7 @@ lifecycle events from running.


onEscapeKey#

onEscapeKey(evt: KeyboardEvent): void

-

Defined in src/renderer/components/drawer/drawer.tsx:70

+

Defined in src/renderer/components/drawer/drawer.tsx:70

Parameters:

@@ -1589,7 +1589,7 @@ lifecycle events from running.


onMouseDown#

onMouseDown(evt: MouseEvent): void

-

Defined in src/renderer/components/drawer/drawer.tsx:95

+

Defined in src/renderer/components/drawer/drawer.tsx:95

Parameters:

@@ -1610,17 +1610,17 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/drawer/drawer.tsx:107

+

Defined in src/renderer/components/drawer/drawer.tsx:107

Returns: Element‹›


restoreScrollPos#

restoreScrollPos(): void

-

Defined in src/renderer/components/drawer/drawer.tsx:63

+

Defined in src/renderer/components/drawer/drawer.tsx:63

Returns: void


saveScrollPos#

saveScrollPos(): void

-

Defined in src/renderer/components/drawer/drawer.tsx:56

+

Defined in src/renderer/components/drawer/drawer.tsx:56

Returns: void


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/master/extensions/api/classes/_renderer_api_components_.draweritem/index.html index 8367350f0b..9e249d81f7 100644 --- a/master/extensions/api/classes/_renderer_api_components_.draweritem/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/drawer/drawer-item.tsx:15

+

Defined in src/renderer/components/drawer/drawer-item.tsx:15

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/master/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html index 254d81cb40..ca5ff9adec 100644 --- a/master/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -1162,7 +1162,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1189,7 +1189,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

state#

state: State

Overrides PageLayout.state

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:14

+

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:14


Static Optional contextType#

contextType? : Context‹any›

@@ -1197,11 +1197,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1494,7 +1494,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:20

+

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:20

Returns: Element‹›


setState#

@@ -1546,7 +1546,7 @@ and componentDidUpdate will not be called.


toggle#

toggle(): void

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:16

+

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:16

Returns: void

diff --git a/master/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/master/extensions/api/classes/_renderer_api_components_.drawertitle/index.html index 83ea123ac5..b639775ac9 100644 --- a/master/extensions/api/classes/_renderer_api_components_.drawertitle/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/drawer/drawer-title.tsx:11

+

Defined in src/renderer/components/drawer/drawer-title.tsx:11

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.icon/index.html b/master/extensions/api/classes/_renderer_api_components_.icon/index.html index b59faabd05..4725cf8e5a 100644 --- a/master/extensions/api/classes/_renderer_api_components_.icon/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -1086,7 +1086,7 @@

Accessors#

isInteractive#

get isInteractive(): boolean

-

Defined in src/renderer/components/icon/icon.tsx:33

+

Defined in src/renderer/components/icon/icon.tsx:33

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1363,7 +1363,7 @@ lifecycle events from running.


onClick#

onClick(evt: MouseEvent): void

-

Defined in src/renderer/components/icon/icon.tsx:40

+

Defined in src/renderer/components/icon/icon.tsx:40

Parameters:

@@ -1383,7 +1383,7 @@ lifecycle events from running.


onKeyDown#

onKeyDown(evt: KeyboardEvent‹any›): void

-

Defined in src/renderer/components/icon/icon.tsx:51

+

Defined in src/renderer/components/icon/icon.tsx:51

Parameters:

@@ -1403,7 +1403,7 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/icon/icon.tsx:70

+

Defined in src/renderer/components/icon/icon.tsx:70

Returns: Element‹›


Optional shouldComponentUpdate#

@@ -1443,10 +1443,10 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/icon/icon.tsx:29

+

Defined in src/renderer/components/icon/icon.tsx:29

focusable#

focusable: true = true

-

Defined in src/renderer/components/icon/icon.tsx:30

+

Defined in src/renderer/components/icon/icon.tsx:30

diff --git a/master/extensions/api/classes/_renderer_api_components_.input/index.html b/master/extensions/api/classes/_renderer_api_components_.input/index.html index 3ba94e0429..b2821a92d4 100644 --- a/master/extensions/api/classes/_renderer_api_components_.input/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.input/index.html @@ -1380,7 +1380,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1390,7 +1390,7 @@ Should be used with type annotation or static contextType.


input#

input: InputElement

-

Defined in src/renderer/components/input/input.tsx:58

+

Defined in src/renderer/components/input/input.tsx:58


props#

props: Readonly‹InputProps› & Readonly‹object›

@@ -1410,7 +1410,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


validators#

validators: InputValidator[] = []

-

Defined in src/renderer/components/input/input.tsx:59

+

Defined in src/renderer/components/input/input.tsx:59


Static Optional contextType#

contextType? : Context‹any›

@@ -1418,11 +1418,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1433,16 +1433,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/input/input.tsx:56

+

Defined in src/renderer/components/input/input.tsx:56

Accessors#

isUncontrolled#

get isUncontrolled(): boolean

-

Defined in src/renderer/components/input/input.tsx:258

+

Defined in src/renderer/components/input/input.tsx:258

Returns: boolean


showMaxLenIndicator#

get showMaxLenIndicator(): boolean

-

Defined in src/renderer/components/input/input.tsx:252

+

Defined in src/renderer/components/input/input.tsx:252

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1533,7 +1533,7 @@ prevents this from being invoked.


bindRef#

bindRef(elem: InputElement): void

-

Defined in src/renderer/components/input/input.tsx:285

+

Defined in src/renderer/components/input/input.tsx:285

Parameters:

@@ -1553,7 +1553,7 @@ prevents this from being invoked.


blur#

blur(): void

-

Defined in src/renderer/components/input/input.tsx:95

+

Defined in src/renderer/components/input/input.tsx:95

Returns: void


Optional componentDidCatch#

@@ -1586,13 +1586,13 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/input/input.tsx:262

+

Defined in src/renderer/components/input/input.tsx:262

Returns: void


componentDidUpdate#

componentDidUpdate(prevProps: InputProps): void

Overrides PageLayout.componentDidUpdate

-

Defined in src/renderer/components/input/input.tsx:267

+

Defined in src/renderer/components/input/input.tsx:267

Parameters:

@@ -1703,7 +1703,7 @@ prevents this from being invoked.


focus#

focus(): void

-

Defined in src/renderer/components/input/input.tsx:91

+

Defined in src/renderer/components/input/input.tsx:91

Returns: void


forceUpdate#

@@ -1747,17 +1747,17 @@ lifecycle events from running.


getValue#

getValue(): string

-

Defined in src/renderer/components/input/input.tsx:82

+

Defined in src/renderer/components/input/input.tsx:82

Returns: string


isValid#

isValid(): boolean

-

Defined in src/renderer/components/input/input.tsx:67

+

Defined in src/renderer/components/input/input.tsx:67

Returns: boolean


onBlur#

onBlur(evt: FocusEvent‹InputElement›): void

-

Defined in src/renderer/components/input/input.tsx:208

+

Defined in src/renderer/components/input/input.tsx:208

Parameters:

@@ -1777,7 +1777,7 @@ lifecycle events from running.


onChange#

onChange(evt: ChangeEvent‹any›): void

-

Defined in src/renderer/components/input/input.tsx:217

+

Defined in src/renderer/components/input/input.tsx:217

Parameters:

@@ -1797,7 +1797,7 @@ lifecycle events from running.


onFocus#

onFocus(evt: FocusEvent‹InputElement›): void

-

Defined in src/renderer/components/input/input.tsx:199

+

Defined in src/renderer/components/input/input.tsx:199

Parameters:

@@ -1817,7 +1817,7 @@ lifecycle events from running.


onKeyDown#

onKeyDown(evt: KeyboardEvent‹any›): void

-

Defined in src/renderer/components/input/input.tsx:236

+

Defined in src/renderer/components/input/input.tsx:236

Parameters:

@@ -1838,17 +1838,17 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/input/input.tsx:289

+

Defined in src/renderer/components/input/input.tsx:289

Returns: Element‹›


select#

select(): void

-

Defined in src/renderer/components/input/input.tsx:99

+

Defined in src/renderer/components/input/input.tsx:99

Returns: void


setDirty#

setDirty(dirty: boolean): void

-

Defined in src/renderer/components/input/input.tsx:193

+

Defined in src/renderer/components/input/input.tsx:193

Parameters:

@@ -1882,7 +1882,7 @@ lifecycle events from running.


setValidation#

setValidation(errors: React.ReactNode[]): void

-

Defined in src/renderer/components/input/input.tsx:163

+

Defined in src/renderer/components/input/input.tsx:163

Parameters:

@@ -1902,7 +1902,7 @@ lifecycle events from running.


setValue#

setValue(value: string): void

-

Defined in src/renderer/components/input/input.tsx:71

+

Defined in src/renderer/components/input/input.tsx:71

Parameters:

@@ -1957,7 +1957,7 @@ and componentDidUpdate will not be called.


validate#

validate(value: string): Promise‹void›

-

Defined in src/renderer/components/input/input.tsx:119

+

Defined in src/renderer/components/input/input.tsx:119

Parameters:

@@ -1980,16 +1980,16 @@ and componentDidUpdate will not be called.

state#

state: object#

Overrides PageLayout.state

-

Defined in src/renderer/components/input/input.tsx:61

+

Defined in src/renderer/components/input/input.tsx:61

dirty#

dirty: boolean = !!this.props.dirty

-

Defined in src/renderer/components/input/input.tsx:62

+

Defined in src/renderer/components/input/input.tsx:62

errors#

errors: undefined[] = []

-

Defined in src/renderer/components/input/input.tsx:64

+

Defined in src/renderer/components/input/input.tsx:64

valid#

valid: true = true

-

Defined in src/renderer/components/input/input.tsx:63

+

Defined in src/renderer/components/input/input.tsx:63

diff --git a/master/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/master/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html index 097599d962..4ab2f43846 100644 --- a/master/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1320,7 +1320,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): Promise‹void›

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/+events/kube-event-details.tsx:16

+

Defined in src/renderer/components/+events/kube-event-details.tsx:16

Returns: Promise‹void›


Optional componentDidUpdate#

@@ -1487,7 +1487,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/+events/kube-event-details.tsx:20

+

Defined in src/renderer/components/+events/kube-event-details.tsx:20

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/master/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html index 2bf6bbc7e3..327f2c9c19 100644 --- a/master/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -1229,7 +1229,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1239,7 +1239,7 @@ Should be used with type annotation or static contextType.


isLoading#

isLoading: boolean = false

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:60

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:60


loader#

loader: IReactionDisposer = reaction(() => [ @@ -1266,11 +1266,11 @@ Should be used with type annotation or static contextType.

}

})

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:80

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:80


loadingError#

loadingError: React.ReactNode

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:61

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:61


props#

props: Readonly‹P› & Readonly‹object›

@@ -1299,11 +1299,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1314,17 +1314,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

isCrdInstance#

get isCrdInstance(): boolean

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:75

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:75

Returns: boolean


object#

get object(): any

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:67

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:67

Returns: any


path#

get path(): string

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:63

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:63

Returns: string

Methods#

Optional UNSAFE_componentWillMount#

@@ -1611,7 +1611,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:105

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:105

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/master/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html index 995d10c0c0..09416f2a39 100644 --- a/master/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -1195,7 +1195,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1230,11 +1230,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1245,7 +1245,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

selectedItem#

get selectedItem(): any

-

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:17

+

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:17

Returns: any

Methods#

Optional UNSAFE_componentWillMount#

@@ -1531,7 +1531,7 @@ lifecycle events from running.


onDetails#

onDetails(item: KubeObject): void

-

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:21

+

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:21

Parameters:

@@ -1552,7 +1552,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:29

+

Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:29

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/master/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html index 15403c785a..f44d15a328 100644 --- a/master/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -1227,7 +1227,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1262,11 +1262,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1277,17 +1277,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

isEditable#

get isEditable(): boolean

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:25

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:25

Returns: boolean


isRemovable#

get isRemovable(): boolean

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

Returns: boolean


store#

get store(): KubeObjectStore‹any›

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

Returns: KubeObjectStore‹any›

Methods#

Optional UNSAFE_componentWillMount#

@@ -1573,18 +1573,18 @@ lifecycle events from running.


remove#

remove(): Promise‹void›

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:44

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:44

Returns: Promise‹void›


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

Returns: Element‹›


renderRemoveMessage#

renderRemoveMessage(): Element‹›

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

Returns: Element‹›


setState#

@@ -1636,7 +1636,7 @@ and componentDidUpdate will not be called.


update#

update(): Promise‹void›

-

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:38

+

Defined in src/renderer/components/kube-object/kube-object-menu.tsx:38

Returns: Promise‹void›

diff --git a/master/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/master/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html index f21d1865c3..0d36b431fe 100644 --- a/master/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -1172,7 +1172,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1207,11 +1207,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1224,7 +1224,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

defaultHiddenFields: IKubeMetaField[] = [ "uid", "resourceVersion", "selfLink" ]

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:15

+

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:15

Methods#

Optional UNSAFE_componentWillMount#

UNSAFE_componentWillMount(): void

@@ -1509,7 +1509,7 @@ lifecycle events from running.


isHidden#

isHidden(field: IKubeMetaField): boolean

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:19

+

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:19

Parameters:

@@ -1530,7 +1530,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

+

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/master/extensions/api/classes/_renderer_api_components_.lineprogress/index.html index e7e43e27aa..19d2efe4a9 100644 --- a/master/extensions/api/classes/_renderer_api_components_.lineprogress/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -1332,7 +1332,7 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/line-progress/line-progress.tsx:23

+

Defined in src/renderer/components/line-progress/line-progress.tsx:23

Returns: Element‹›


Optional shouldComponentUpdate#

@@ -1372,19 +1372,19 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/line-progress/line-progress.tsx:16

+

Defined in src/renderer/components/line-progress/line-progress.tsx:16

max#

max: number = 100

-

Defined in src/renderer/components/line-progress/line-progress.tsx:19

+

Defined in src/renderer/components/line-progress/line-progress.tsx:19

min#

min: number = 0

-

Defined in src/renderer/components/line-progress/line-progress.tsx:18

+

Defined in src/renderer/components/line-progress/line-progress.tsx:18

precise#

precise: number = 2

-

Defined in src/renderer/components/line-progress/line-progress.tsx:20

+

Defined in src/renderer/components/line-progress/line-progress.tsx:20

value#

value: number = 0

-

Defined in src/renderer/components/line-progress/line-progress.tsx:17

+

Defined in src/renderer/components/line-progress/line-progress.tsx:17

diff --git a/master/extensions/api/classes/_renderer_api_components_.menu/index.html b/master/extensions/api/classes/_renderer_api_components_.menu/index.html index 2fb807d42c..e2705feed7 100644 --- a/master/extensions/api/classes/_renderer_api_components_.menu/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -1329,7 +1329,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1339,11 +1339,11 @@ Should be used with type annotation or static contextType.


elem#

elem: HTMLUListElement

-

Defined in src/renderer/components/menu/menu.tsx:56

+

Defined in src/renderer/components/menu/menu.tsx:56


Protected items#

items: object

-

Defined in src/renderer/components/menu/menu.tsx:57

+

Defined in src/renderer/components/menu/menu.tsx:57

Type declaration:

}, Animate.VISIBILITY_DELAY_MS)

-

Defined in src/renderer/components/menu/menu.tsx:124

+

Defined in src/renderer/components/menu/menu.tsx:124


refs#

refs: object

@@ -1411,7 +1411,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

state#

state: State

Overrides PageLayout.state

-

Defined in src/renderer/components/menu/menu.tsx:59

+

Defined in src/renderer/components/menu/menu.tsx:59


Static Optional contextType#

contextType? : Context‹any›

@@ -1419,11 +1419,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1434,21 +1434,21 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultPropsMenu as object

-

Defined in src/renderer/components/menu/menu.tsx:53

+

Defined in src/renderer/components/menu/menu.tsx:53

Accessors#

Protected focusableItems#

get focusableItems(): MenuItem‹›[]

-

Defined in src/renderer/components/menu/menu.tsx:98

+

Defined in src/renderer/components/menu/menu.tsx:98

Returns: MenuItem‹›[]


Protected focusedItem#

get focusedItem(): MenuItem‹›

-

Defined in src/renderer/components/menu/menu.tsx:102

+

Defined in src/renderer/components/menu/menu.tsx:102

Returns: MenuItem‹›


isOpen#

get isOpen(): boolean

-

Defined in src/renderer/components/menu/menu.tsx:61

+

Defined in src/renderer/components/menu/menu.tsx:61

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1539,7 +1539,7 @@ prevents this from being invoked.


Protected bindItemRef#

bindItemRef(item: MenuItem, index: number): void

-

Defined in src/renderer/components/menu/menu.tsx:239

+

Defined in src/renderer/components/menu/menu.tsx:239

Parameters:

@@ -1563,7 +1563,7 @@ prevents this from being invoked.


Protected bindRef#

bindRef(elem: HTMLUListElement): void

-

Defined in src/renderer/components/menu/menu.tsx:235

+

Defined in src/renderer/components/menu/menu.tsx:235

Parameters:

@@ -1583,7 +1583,7 @@ prevents this from being invoked.


close#

close(): void

-

Defined in src/renderer/components/menu/menu.tsx:168

+

Defined in src/renderer/components/menu/menu.tsx:168

Returns: void


Optional componentDidCatch#

@@ -1616,7 +1616,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/menu/menu.tsx:65

+

Defined in src/renderer/components/menu/menu.tsx:65

Returns: void


Optional componentDidUpdate#

@@ -1700,7 +1700,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/menu/menu.tsx:87

+

Defined in src/renderer/components/menu/menu.tsx:87

Returns: void


Optional componentWillUpdate#

@@ -1741,7 +1741,7 @@ prevents this from being invoked.


Protected focusNextItem#

focusNextItem(reverse: boolean): void

-

Defined in src/renderer/components/menu/menu.tsx:106

+

Defined in src/renderer/components/menu/menu.tsx:106

Parameters:

@@ -1802,7 +1802,7 @@ lifecycle events from running.


onClickOutside#

onClickOutside(evt: MouseEvent): void

-

Defined in src/renderer/components/menu/menu.tsx:223

+

Defined in src/renderer/components/menu/menu.tsx:223

Parameters:

@@ -1822,12 +1822,12 @@ lifecycle events from running.


onContextMenu#

onContextMenu(): void

-

Defined in src/renderer/components/menu/menu.tsx:204

+

Defined in src/renderer/components/menu/menu.tsx:204

Returns: void


onKeyDown#

onKeyDown(evt: KeyboardEvent): void

-

Defined in src/renderer/components/menu/menu.tsx:177

+

Defined in src/renderer/components/menu/menu.tsx:177

Parameters:

@@ -1847,7 +1847,7 @@ lifecycle events from running.


onScrollOutside#

onScrollOutside(evt: UIEvent): void

-

Defined in src/renderer/components/menu/menu.tsx:213

+

Defined in src/renderer/components/menu/menu.tsx:213

Parameters:

@@ -1867,18 +1867,18 @@ lifecycle events from running.


onWindowResize#

onWindowResize(): void

-

Defined in src/renderer/components/menu/menu.tsx:208

+

Defined in src/renderer/components/menu/menu.tsx:208

Returns: void


open#

open(): void

-

Defined in src/renderer/components/menu/menu.tsx:161

+

Defined in src/renderer/components/menu/menu.tsx:161

Returns: void


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/menu/menu.tsx:243

+

Defined in src/renderer/components/menu/menu.tsx:243

Returns: Element‹›


setState#

@@ -1930,7 +1930,7 @@ and componentDidUpdate will not be called.


toggle#

toggle(): void

-

Defined in src/renderer/components/menu/menu.tsx:173

+

Defined in src/renderer/components/menu/menu.tsx:173

Returns: void

diff --git a/master/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/master/extensions/api/classes/_renderer_api_components_.menuactions/index.html index 447018d45e..3069bd755d 100644 --- a/master/extensions/api/classes/_renderer_api_components_.menuactions/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -1241,7 +1241,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1251,11 +1251,11 @@ Should be used with type annotation or static contextType.


id#

id: string = uniqueId("menu_actions_")

-

Defined in src/renderer/components/menu/menu-actions.tsx:30

+

Defined in src/renderer/components/menu/menu-actions.tsx:30


isOpen#

isOpen: boolean = !!this.props.toolbar

-

Defined in src/renderer/components/menu/menu-actions.tsx:32

+

Defined in src/renderer/components/menu/menu-actions.tsx:32


props#

props: Readonly‹MenuActionsProps› & Readonly‹object›

@@ -1284,11 +1284,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1580,18 +1580,18 @@ lifecycle events from running.


remove#

remove(): void

-

Defined in src/renderer/components/menu/menu-actions.tsx:40

+

Defined in src/renderer/components/menu/menu-actions.tsx:40

Returns: void


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/menu/menu-actions.tsx:81

+

Defined in src/renderer/components/menu/menu-actions.tsx:81

Returns: Element‹›


renderTriggerIcon#

renderTriggerIcon(): Element‹›

-

Defined in src/renderer/components/menu/menu-actions.tsx:54

+

Defined in src/renderer/components/menu/menu-actions.tsx:54

Returns: Element‹›


setState#

@@ -1643,15 +1643,15 @@ and componentDidUpdate will not be called.


toggle#

toggle(): void

-

Defined in src/renderer/components/menu/menu-actions.tsx:34

+

Defined in src/renderer/components/menu/menu-actions.tsx:34

Returns: void

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/menu/menu-actions.tsx:24

+

Defined in src/renderer/components/menu/menu-actions.tsx:24

removeConfirmationMessage#

removeConfirmationMessage:

-

Defined in src/renderer/components/menu/menu-actions.tsx:25

+

Defined in src/renderer/components/menu/menu-actions.tsx:25

diff --git a/master/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/master/extensions/api/classes/_renderer_api_components_.menuitem/index.html index 6c4c90a03e..bd92b68ad5 100644 --- a/master/extensions/api/classes/_renderer_api_components_.menuitem/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -1223,11 +1223,11 @@

context#

context: MenuContextValue

Overrides PageLayout.context

-

Defined in src/renderer/components/menu/menu.tsx:314

+

Defined in src/renderer/components/menu/menu.tsx:314


elem#

elem: HTMLElement

-

Defined in src/renderer/components/menu/menu.tsx:315

+

Defined in src/renderer/components/menu/menu.tsx:315


props#

props: Readonly‹MenuItemProps› & Readonly‹object›

@@ -1253,20 +1253,20 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Static contextType#

contextType: Context‹Menu‹›› = MenuContext

Overrides PageLayout.contextType

-

Defined in src/renderer/components/menu/menu.tsx:312

+

Defined in src/renderer/components/menu/menu.tsx:312


Static defaultProps#

defaultProps: object = defaultPropsMenuItem as object

-

Defined in src/renderer/components/menu/menu.tsx:311

+

Defined in src/renderer/components/menu/menu.tsx:311

Accessors#

isFocusable#

get isFocusable(): boolean

-

Defined in src/renderer/components/menu/menu.tsx:317

+

Defined in src/renderer/components/menu/menu.tsx:317

Returns: boolean


get isLink(): boolean

-

Defined in src/renderer/components/menu/menu.tsx:323

+

Defined in src/renderer/components/menu/menu.tsx:323

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1357,7 +1357,7 @@ prevents this from being invoked.


Protected bindRef#

bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/menu/menu.tsx:339

+

Defined in src/renderer/components/menu/menu.tsx:339

Parameters:

@@ -1572,7 +1572,7 @@ lifecycle events from running.


onClick#

onClick(evt: MouseEvent): void

-

Defined in src/renderer/components/menu/menu.tsx:327

+

Defined in src/renderer/components/menu/menu.tsx:327

Parameters:

@@ -1593,7 +1593,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/menu/menu.tsx:343

+

Defined in src/renderer/components/menu/menu.tsx:343

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/master/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html index c4c43fc0b1..1826bc2aec 100644 --- a/master/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -1203,7 +1203,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1238,11 +1238,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1253,11 +1253,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:30

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:30

Accessors#

options#

get options(): SelectOption[]

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:44

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:44

Returns: SelectOption[]

Methods#

Optional UNSAFE_componentWillMount#

@@ -1376,7 +1376,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): Promise‹void›

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:33

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:33

Returns: Promise‹void›


Optional componentDidUpdate#

@@ -1460,7 +1460,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:40

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:40

Returns: void


Optional componentWillUpdate#

@@ -1510,7 +1510,7 @@ prevents this from being invoked.


formatOptionLabel#

formatOptionLabel(option: SelectOption): object

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:57

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:57

Parameters:

@@ -1561,7 +1561,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:69

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:69

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.namespaceselectfilter/index.html b/master/extensions/api/classes/_renderer_api_components_.namespaceselectfilter/index.html index 08d585e18c..46b1bfb52f 100644 --- a/master/extensions/api/classes/_renderer_api_components_.namespaceselectfilter/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.namespaceselectfilter/index.html @@ -1158,7 +1158,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1193,11 +1193,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1490,7 +1490,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/+namespaces/namespace-select.tsx:86

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:86

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.notifications/index.html b/master/extensions/api/classes/_renderer_api_components_.notifications/index.html index 62d3b12323..eb411f74b8 100644 --- a/master/extensions/api/classes/_renderer_api_components_.notifications/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -1206,7 +1206,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1216,7 +1216,7 @@ Should be used with type annotation or static contextType.


elem#

elem: HTMLElement

-

Defined in src/renderer/components/notifications/notifications.tsx:14

+

Defined in src/renderer/components/notifications/notifications.tsx:14


props#

props: Readonly‹P› & Readonly‹object›

@@ -1245,11 +1245,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1374,7 +1374,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/notifications/notifications.tsx:41

+

Defined in src/renderer/components/notifications/notifications.tsx:41

Returns: void


Optional componentDidUpdate#

@@ -1510,7 +1510,7 @@ prevents this from being invoked.


getMessage#

getMessage(notification: Notification): (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

-

Defined in src/renderer/components/notifications/notifications.tsx:59

+

Defined in src/renderer/components/notifications/notifications.tsx:59

Parameters:

@@ -1561,12 +1561,12 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/notifications/notifications.tsx:69

+

Defined in src/renderer/components/notifications/notifications.tsx:69

Returns: Element‹›


scrollToLastNotification#

scrollToLastNotification(): void

-

Defined in src/renderer/components/notifications/notifications.tsx:49

+

Defined in src/renderer/components/notifications/notifications.tsx:49

Returns: void


setState#

@@ -1618,7 +1618,7 @@ and componentDidUpdate will not be called.


Static error#

error(message: NotificationMessage): void

-

Defined in src/renderer/components/notifications/notifications.tsx:24

+

Defined in src/renderer/components/notifications/notifications.tsx:24

Parameters:

@@ -1638,7 +1638,7 @@ and componentDidUpdate will not be called.


Static info#

info(message: NotificationMessage, customOpts: Partial‹Notification›): function

-

Defined in src/renderer/components/notifications/notifications.tsx:32

+

Defined in src/renderer/components/notifications/notifications.tsx:32

Parameters:

@@ -1666,7 +1666,7 @@ and componentDidUpdate will not be called.


Static ok#

ok(message: NotificationMessage): void

-

Defined in src/renderer/components/notifications/notifications.tsx:16

+

Defined in src/renderer/components/notifications/notifications.tsx:16

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/master/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html index 6977d343f0..0a17537105 100644 --- a/master/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -958,15 +958,15 @@

Properties#

Protected autoHideTimers#

autoHideTimers: Map‹string | number, number› = new Map()

-

Defined in src/renderer/components/notifications/notifications.store.ts:27

+

Defined in src/renderer/components/notifications/notifications.store.ts:27


notifications#

notifications: IObservableArray‹Notification = observable.array([], { deep: false })

-

Defined in src/renderer/components/notifications/notifications.store.ts:25

+

Defined in src/renderer/components/notifications/notifications.store.ts:25

Methods#

add#

add(notification: Notification): function

-

Defined in src/renderer/components/notifications/notifications.store.ts:54

+

Defined in src/renderer/components/notifications/notifications.store.ts:54

Parameters:

@@ -987,7 +987,7 @@

addAutoHideTimer#

addAutoHideTimer(id: NotificationId): void

-

Defined in src/renderer/components/notifications/notifications.store.ts:33

+

Defined in src/renderer/components/notifications/notifications.store.ts:33

Parameters:

@@ -1007,7 +1007,7 @@

getById#

getById(id: NotificationId): Notification | null

-

Defined in src/renderer/components/notifications/notifications.store.ts:29

+

Defined in src/renderer/components/notifications/notifications.store.ts:29

Parameters:

@@ -1027,7 +1027,7 @@

remove#

remove(id: NotificationId): void

-

Defined in src/renderer/components/notifications/notifications.store.ts:71

+

Defined in src/renderer/components/notifications/notifications.store.ts:71

Parameters:

@@ -1047,7 +1047,7 @@

removeAutoHideTimer#

removeAutoHideTimer(id: NotificationId): void

-

Defined in src/renderer/components/notifications/notifications.store.ts:46

+

Defined in src/renderer/components/notifications/notifications.store.ts:46

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/master/extensions/api/classes/_renderer_api_components_.pagelayout/index.html index d85c14e550..3fe3118c76 100644 --- a/master/extensions/api/classes/_renderer_api_components_.pagelayout/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -1180,7 +1180,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1215,11 +1215,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1230,7 +1230,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/layout/page-layout.tsx:27

+

Defined in src/renderer/components/layout/page-layout.tsx:27

Methods#

Optional UNSAFE_componentWillMount#

UNSAFE_componentWillMount(): void

@@ -1320,7 +1320,7 @@ prevents this from being invoked.


back#

back(evt?: MouseEvent | KeyboardEvent): void

-

Defined in src/renderer/components/layout/page-layout.tsx:30

+

Defined in src/renderer/components/layout/page-layout.tsx:30

Parameters:

@@ -1368,7 +1368,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): Promise‹void›

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/layout/page-layout.tsx:38

+

Defined in src/renderer/components/layout/page-layout.tsx:38

Returns: Promise‹void›


Optional componentDidUpdate#

@@ -1452,7 +1452,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/layout/page-layout.tsx:42

+

Defined in src/renderer/components/layout/page-layout.tsx:42

Returns: void


Optional componentWillUpdate#

@@ -1532,7 +1532,7 @@ lifecycle events from running.


onEscapeKey#

onEscapeKey(evt: KeyboardEvent): void

-

Defined in src/renderer/components/layout/page-layout.tsx:46

+

Defined in src/renderer/components/layout/page-layout.tsx:46

Parameters:

@@ -1553,7 +1553,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/layout/page-layout.tsx:57

+

Defined in src/renderer/components/layout/page-layout.tsx:57

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/master/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html index d740c6bcfe..9e03c26398 100644 --- a/master/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -1225,7 +1225,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1260,11 +1260,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1389,7 +1389,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:53

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:53

Returns: void


Optional componentDidUpdate#

@@ -1473,7 +1473,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

Returns: void


Optional componentWillUpdate#

@@ -1553,7 +1553,7 @@ lifecycle events from running.


getTableRow#

getTableRow(uid: string): Element‹›

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

Parameters:

@@ -1574,12 +1574,12 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

Returns: Element‹›


renderCpuUsage#

renderCpuUsage(id: string, usage: number): string | 0 | Element‹›

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

Parameters:

@@ -1603,7 +1603,7 @@ lifecycle events from running.


renderMemoryUsage#

renderMemoryUsage(id: string, usage: number): string | 0 | Element‹›

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

Parameters:

@@ -1674,10 +1674,10 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

showTitle#

showTitle: true = true

-

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

+

Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

diff --git a/master/extensions/api/classes/_renderer_api_components_.radio/index.html b/master/extensions/api/classes/_renderer_api_components_.radio/index.html index 3e857b2da5..5b98e6c59e 100644 --- a/master/extensions/api/classes/_renderer_api_components_.radio/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -1172,7 +1172,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1207,11 +1207,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1503,12 +1503,12 @@ lifecycle events from running.


onChange#

onChange(): void

-

Defined in src/renderer/components/radio/radio.tsx:52

+

Defined in src/renderer/components/radio/radio.tsx:52

Returns: void


onKeyDown#

onKeyDown(e: KeyboardEvent‹any›): void

-

Defined in src/renderer/components/radio/radio.tsx:60

+

Defined in src/renderer/components/radio/radio.tsx:60

Parameters:

@@ -1529,7 +1529,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/radio/radio.tsx:70

+

Defined in src/renderer/components/radio/radio.tsx:70

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/master/extensions/api/classes/_renderer_api_components_.radiogroup/index.html index 675ac856e3..3cd4c70761 100644 --- a/master/extensions/api/classes/_renderer_api_components_.radiogroup/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -1154,7 +1154,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1189,11 +1189,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1486,7 +1486,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/radio/radio.tsx:17

+

Defined in src/renderer/components/radio/radio.tsx:17

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.select/index.html b/master/extensions/api/classes/_renderer_api_components_.select/index.html index 451a52f94d..4f74df454a 100644 --- a/master/extensions/api/classes/_renderer_api_components_.select/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.select/index.html @@ -1286,7 +1286,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1321,11 +1321,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1336,17 +1336,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

options#

get options(): SelectOption[]

-

Defined in src/renderer/components/select/select.tsx:71

+

Defined in src/renderer/components/select/select.tsx:71

Returns: SelectOption[]


selectedOption#

get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

-

Defined in src/renderer/components/select/select.tsx:57

+

Defined in src/renderer/components/select/select.tsx:57

Returns: SelectOption‹any› | SelectOption‹any›[]


theme#

get theme(): "dark" | "light" | "outlined"

-

Defined in src/renderer/components/select/select.tsx:42

+

Defined in src/renderer/components/select/select.tsx:42

Returns: "dark" | "light" | "outlined"

Methods#

Optional UNSAFE_componentWillMount#

@@ -1632,7 +1632,7 @@ lifecycle events from running.


Protected isValidOption#

isValidOption(opt: SelectOption | any): boolean

-

Defined in src/renderer/components/select/select.tsx:53

+

Defined in src/renderer/components/select/select.tsx:53

Parameters:

@@ -1652,7 +1652,7 @@ lifecycle events from running.


onChange#

onChange(value: SelectOption, meta: ActionMeta‹any›): void

-

Defined in src/renderer/components/select/select.tsx:84

+

Defined in src/renderer/components/select/select.tsx:84

Parameters:

@@ -1676,7 +1676,7 @@ lifecycle events from running.


onKeyDown#

onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

-

Defined in src/renderer/components/select/select.tsx:91

+

Defined in src/renderer/components/select/select.tsx:91

Parameters:

@@ -1697,7 +1697,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/select/select.tsx:100

+

Defined in src/renderer/components/select/select.tsx:100

Returns: Element‹›


setState#

@@ -1749,16 +1749,16 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/select/select.tsx:36

+

Defined in src/renderer/components/select/select.tsx:36

autoConvertOptions#

autoConvertOptions: true = true

-

Defined in src/renderer/components/select/select.tsx:37

+

Defined in src/renderer/components/select/select.tsx:37

menuPlacement: "auto" = "auto"

-

Defined in src/renderer/components/select/select.tsx:39

+

Defined in src/renderer/components/select/select.tsx:39

menuPortalTarget: HTMLElement = document.body

-

Defined in src/renderer/components/select/select.tsx:38

+

Defined in src/renderer/components/select/select.tsx:38

diff --git a/master/extensions/api/classes/_renderer_api_components_.slider/index.html b/master/extensions/api/classes/_renderer_api_components_.slider/index.html index 915b13f16a..29149e0573 100644 --- a/master/extensions/api/classes/_renderer_api_components_.slider/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -1164,7 +1164,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1199,11 +1199,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1214,7 +1214,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/slider/slider.tsx:21

+

Defined in src/renderer/components/slider/slider.tsx:21

Methods#

Optional UNSAFE_componentWillMount#

UNSAFE_componentWillMount(): void

@@ -1500,7 +1500,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/slider/slider.tsx:30

+

Defined in src/renderer/components/slider/slider.tsx:30

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.spinner/index.html b/master/extensions/api/classes/_renderer_api_components_.spinner/index.html index 061efc71b9..cd7a169e25 100644 --- a/master/extensions/api/classes/_renderer_api_components_.spinner/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -1206,7 +1206,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1241,11 +1241,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1538,7 +1538,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/spinner/spinner.tsx:18

+

Defined in src/renderer/components/spinner/spinner.tsx:18

Returns: Element‹›


setState#

@@ -1590,13 +1590,13 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/spinner/spinner.tsx:13

+

Defined in src/renderer/components/spinner/spinner.tsx:13

center#

center: boolean = false

-

Defined in src/renderer/components/spinner/spinner.tsx:15

+

Defined in src/renderer/components/spinner/spinner.tsx:15

singleColor#

singleColor: boolean = true

-

Defined in src/renderer/components/spinner/spinner.tsx:14

+

Defined in src/renderer/components/spinner/spinner.tsx:14

diff --git a/master/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/master/extensions/api/classes/_renderer_api_components_.statusbrick/index.html index 6cb801362b..ad62429d49 100644 --- a/master/extensions/api/classes/_renderer_api_components_.statusbrick/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/status-brick/status-brick.tsx:12

+

Defined in src/renderer/components/status-brick/status-brick.tsx:12

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.stepper/index.html b/master/extensions/api/classes/_renderer_api_components_.stepper/index.html index bcfac95651..8a7db6e306 100644 --- a/master/extensions/api/classes/_renderer_api_components_.stepper/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -1154,7 +1154,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1189,11 +1189,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1486,7 +1486,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/stepper/stepper.tsx:15

+

Defined in src/renderer/components/stepper/stepper.tsx:15

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.tab/index.html b/master/extensions/api/classes/_renderer_api_components_.tab/index.html index 16d04999a4..24c5d7ae07 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tab/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -1120,19 +1120,19 @@

Properties#

context#

context: TabsContextValue

-

Defined in src/renderer/components/tabs/tabs.tsx:65

+

Defined in src/renderer/components/tabs/tabs.tsx:65


elem#

elem: HTMLElement

-

Defined in src/renderer/components/tabs/tabs.tsx:66

+

Defined in src/renderer/components/tabs/tabs.tsx:66


Static contextType#

contextType: Context‹TabsContextValue‹any›› = TabsContext

-

Defined in src/renderer/components/tabs/tabs.tsx:64

+

Defined in src/renderer/components/tabs/tabs.tsx:64

Accessors#

isActive#

get isActive(): boolean

-

Defined in src/renderer/components/tabs/tabs.tsx:68

+

Defined in src/renderer/components/tabs/tabs.tsx:68

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1223,7 +1223,7 @@ prevents this from being invoked.


Protected bindRef#

bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/tabs/tabs.tsx:121

+

Defined in src/renderer/components/tabs/tabs.tsx:121

Parameters:

@@ -1271,7 +1271,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/tabs/tabs.tsx:114

+

Defined in src/renderer/components/tabs/tabs.tsx:114

Returns: void


Optional componentDidUpdate#

@@ -1398,7 +1398,7 @@ prevents this from being invoked.


focus#

focus(): void

-

Defined in src/renderer/components/tabs/tabs.tsx:74

+

Defined in src/renderer/components/tabs/tabs.tsx:74

Returns: void


Optional getSnapshotBeforeUpdate#

@@ -1433,7 +1433,7 @@ lifecycle events from running.


onClick#

onClick(evt: MouseEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:86

+

Defined in src/renderer/components/tabs/tabs.tsx:86

Parameters:

@@ -1453,7 +1453,7 @@ lifecycle events from running.


onFocus#

onFocus(evt: FocusEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:96

+

Defined in src/renderer/components/tabs/tabs.tsx:96

Parameters:

@@ -1473,7 +1473,7 @@ lifecycle events from running.


onKeyDown#

onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:104

+

Defined in src/renderer/components/tabs/tabs.tsx:104

Parameters:

@@ -1493,12 +1493,12 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/tabs/tabs.tsx:125

+

Defined in src/renderer/components/tabs/tabs.tsx:125

Returns: Element‹›


scrollIntoView#

scrollIntoView(): void

-

Defined in src/renderer/components/tabs/tabs.tsx:78

+

Defined in src/renderer/components/tabs/tabs.tsx:78

Returns: void


Optional shouldComponentUpdate#

diff --git a/master/extensions/api/classes/_renderer_api_components_.table/index.html b/master/extensions/api/classes/_renderer_api_components_.table/index.html index 60f828e0c7..7e63e415f3 100644 --- a/master/extensions/api/classes/_renderer_api_components_.table/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.table/index.html @@ -1277,7 +1277,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1309,7 +1309,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

} : {}, this.props.sortByDefault, )

-

Defined in src/renderer/components/table/table.tsx:64

+

Defined in src/renderer/components/table/table.tsx:64


state#

state: Readonly‹S›

@@ -1322,11 +1322,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1618,7 +1618,7 @@ lifecycle events from running.


getSorted#

getSorted(items: any[]): any[]

-

Defined in src/renderer/components/table/table.tsx:106

+

Defined in src/renderer/components/table/table.tsx:106

Parameters:

@@ -1638,7 +1638,7 @@ lifecycle events from running.


Protected onSort#

onSort(__namedParameters: object): void

-

Defined in src/renderer/components/table/table.tsx:114

+

Defined in src/renderer/components/table/table.tsx:114

Parameters:

__namedParameters: object

@@ -1664,17 +1664,17 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/table/table.tsx:186

+

Defined in src/renderer/components/table/table.tsx:186

Returns: Element‹›


renderHead#

renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

-

Defined in src/renderer/components/table/table.tsx:72

+

Defined in src/renderer/components/table/table.tsx:72

Returns: ReactElement‹TableHeadProps‹›, string | function | object›


renderRows#

renderRows(): object

-

Defined in src/renderer/components/table/table.tsx:141

+

Defined in src/renderer/components/table/table.tsx:141

Returns: object


setState#

@@ -1726,7 +1726,7 @@ and componentDidUpdate will not be called.


sort#

sort(colName: TableSortBy): void

-

Defined in src/renderer/components/table/table.tsx:129

+

Defined in src/renderer/components/table/table.tsx:129

Parameters:

@@ -1746,22 +1746,22 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/table/table.tsx:56

+

Defined in src/renderer/components/table/table.tsx:56

autoSize#

autoSize: true = true

-

Defined in src/renderer/components/table/table.tsx:58

+

Defined in src/renderer/components/table/table.tsx:58

rowLineHeight#

rowLineHeight: string = "17px"

-

Defined in src/renderer/components/table/table.tsx:60

+

Defined in src/renderer/components/table/table.tsx:60

rowPadding#

rowPadding: string = "8px"

-

Defined in src/renderer/components/table/table.tsx:59

+

Defined in src/renderer/components/table/table.tsx:59

scrollable#

scrollable: true = true

-

Defined in src/renderer/components/table/table.tsx:57

+

Defined in src/renderer/components/table/table.tsx:57

sortSyncWithUrl#

sortSyncWithUrl: true = true

-

Defined in src/renderer/components/table/table.tsx:61

+

Defined in src/renderer/components/table/table.tsx:61

diff --git a/master/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/master/extensions/api/classes/_renderer_api_components_.tablecell/index.html index 1674a8b65e..10e7614655 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tablecell/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -1211,7 +1211,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1246,11 +1246,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1261,7 +1261,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

isSortable#

get isSortable(): boolean

-

Defined in src/renderer/components/table/table-cell.tsx:35

+

Defined in src/renderer/components/table/table-cell.tsx:35

Returns: boolean

Methods#

Optional UNSAFE_componentWillMount#

@@ -1547,7 +1547,7 @@ lifecycle events from running.


onClick#

onClick(evt: MouseEvent‹HTMLDivElement›): void

-

Defined in src/renderer/components/table/table-cell.tsx:25

+

Defined in src/renderer/components/table/table-cell.tsx:25

Parameters:

@@ -1568,17 +1568,17 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/table/table-cell.tsx:65

+

Defined in src/renderer/components/table/table-cell.tsx:65

Returns: Element‹›


renderCheckbox#

renderCheckbox(): Element‹›

-

Defined in src/renderer/components/table/table-cell.tsx:56

+

Defined in src/renderer/components/table/table-cell.tsx:56

Returns: Element‹›


renderSortIcon#

renderSortIcon(): Element‹›

-

Defined in src/renderer/components/table/table-cell.tsx:41

+

Defined in src/renderer/components/table/table-cell.tsx:41

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/master/extensions/api/classes/_renderer_api_components_.tablehead/index.html index c4295f6972..e6fa43934f 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tablehead/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -1201,7 +1201,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1236,11 +1236,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1533,7 +1533,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/table/table-head.tsx:20

+

Defined in src/renderer/components/table/table-head.tsx:20

Returns: Element‹›


setState#

@@ -1585,10 +1585,10 @@ and componentDidUpdate will not be called.

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/table/table-head.tsx:16

+

Defined in src/renderer/components/table/table-head.tsx:16

sticky#

sticky: true = true

-

Defined in src/renderer/components/table/table-head.tsx:17

+

Defined in src/renderer/components/table/table-head.tsx:17

diff --git a/master/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/master/extensions/api/classes/_renderer_api_components_.tablerow/index.html index 086006d083..12daa3d0a1 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tablerow/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/table/table-row.tsx:20

+

Defined in src/renderer/components/table/table-row.tsx:20

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.tabs/index.html b/master/extensions/api/classes/_renderer_api_components_.tabs/index.html index 976e224726..55ed837b3f 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tabs/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -1033,7 +1033,7 @@

Properties#

elem#

elem: HTMLElement

-

Defined in src/renderer/components/tabs/tabs.tsx:25

+

Defined in src/renderer/components/tabs/tabs.tsx:25

Methods#

Optional UNSAFE_componentWillMount#

UNSAFE_componentWillMount(): void

@@ -1123,7 +1123,7 @@ prevents this from being invoked.


Protected bindRef#

bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/tabs/tabs.tsx:28

+

Defined in src/renderer/components/tabs/tabs.tsx:28

Parameters:

@@ -1329,7 +1329,7 @@ lifecycle events from running.


render#

render(): Element‹›

-

Defined in src/renderer/components/tabs/tabs.tsx:32

+

Defined in src/renderer/components/tabs/tabs.tsx:32

Returns: Element‹›


Optional shouldComponentUpdate#

diff --git a/master/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/master/extensions/api/classes/_renderer_api_components_.tooltip/index.html index b3c19d288d..b9a3c11949 100644 --- a/master/extensions/api/classes/_renderer_api_components_.tooltip/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -1270,7 +1270,7 @@

Properties#

activePosition#

activePosition: TooltipPosition

-

Defined in src/renderer/components/tooltip/tooltip.tsx:51

+

Defined in src/renderer/components/tooltip/tooltip.tsx:51


context#

context: any

@@ -1279,7 +1279,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1289,11 +1289,11 @@ Should be used with type annotation or static contextType.


elem#

elem: HTMLElement

-

Defined in src/renderer/components/tooltip/tooltip.tsx:50

+

Defined in src/renderer/components/tooltip/tooltip.tsx:50


isVisible#

isVisible: boolean = !!this.props.visible

-

Defined in src/renderer/components/tooltip/tooltip.tsx:52

+

Defined in src/renderer/components/tooltip/tooltip.tsx:52


props#

props: Readonly‹TooltipProps› & Readonly‹object›

@@ -1322,11 +1322,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1337,16 +1337,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


Static defaultProps#

defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/tooltip/tooltip.tsx:48

+

Defined in src/renderer/components/tooltip/tooltip.tsx:48

Accessors#

hoverTarget#

get hoverTarget(): HTMLElement

-

Defined in src/renderer/components/tooltip/tooltip.tsx:58

+

Defined in src/renderer/components/tooltip/tooltip.tsx:58

Returns: HTMLElement


targetElem#

get targetElem(): HTMLElement

-

Defined in src/renderer/components/tooltip/tooltip.tsx:54

+

Defined in src/renderer/components/tooltip/tooltip.tsx:54

Returns: HTMLElement

Methods#

Optional UNSAFE_componentWillMount#

@@ -1437,7 +1437,7 @@ prevents this from being invoked.


bindRef#

bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:198

+

Defined in src/renderer/components/tooltip/tooltip.tsx:198

Parameters:

@@ -1485,7 +1485,7 @@ the entire component tree to unmount.

componentDidMount#

componentDidMount(): void

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/tooltip/tooltip.tsx:66

+

Defined in src/renderer/components/tooltip/tooltip.tsx:66

Returns: void


Optional componentDidUpdate#

@@ -1569,7 +1569,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/tooltip/tooltip.tsx:71

+

Defined in src/renderer/components/tooltip/tooltip.tsx:71

Returns: void


Optional componentWillUpdate#

@@ -1619,7 +1619,7 @@ prevents this from being invoked.


Protected getPosition#

getPosition(position: TooltipPosition, tooltipBounds: DOMRect, targetBounds: DOMRect): object

-

Defined in src/renderer/components/tooltip/tooltip.tsx:145

+

Defined in src/renderer/components/tooltip/tooltip.tsx:145

Parameters:

@@ -1691,28 +1691,28 @@ lifecycle events from running.


Protected onEnterTarget#

onEnterTarget(): void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:77

+

Defined in src/renderer/components/tooltip/tooltip.tsx:77

Returns: void


Protected onLeaveTarget#

onLeaveTarget(): void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:83

+

Defined in src/renderer/components/tooltip/tooltip.tsx:83

Returns: void


refreshPosition#

refreshPosition(): void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:88

+

Defined in src/renderer/components/tooltip/tooltip.tsx:88

Returns: void


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:202

+

Defined in src/renderer/components/tooltip/tooltip.tsx:202

Returns: Element‹›


Protected setPosition#

setPosition(pos: object): void

-

Defined in src/renderer/components/tooltip/tooltip.tsx:138

+

Defined in src/renderer/components/tooltip/tooltip.tsx:138

Parameters:

pos: object

diff --git a/master/extensions/api/classes/_renderer_api_components_.wizard/index.html b/master/extensions/api/classes/_renderer_api_components_.wizard/index.html index 24c2aaa301..7e7fb2a2a4 100644 --- a/master/extensions/api/classes/_renderer_api_components_.wizard/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -1286,7 +1286,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1316,11 +1316,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1331,10 +1331,10 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Accessors#

step#

get step(): number

-

Defined in src/renderer/components/wizard/wizard.tsx:56

+

Defined in src/renderer/components/wizard/wizard.tsx:56

Returns: number

set step(step: number): void

-

Defined in src/renderer/components/wizard/wizard.tsx:60

+

Defined in src/renderer/components/wizard/wizard.tsx:60

Parameters:

@@ -1354,7 +1354,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


steps#

get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

-

Defined in src/renderer/components/wizard/wizard.tsx:34

+

Defined in src/renderer/components/wizard/wizard.tsx:34

Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

Methods#

Optional UNSAFE_componentWillMount#

@@ -1601,7 +1601,7 @@ prevents this from being invoked.


firstStep#

firstStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:77

+

Defined in src/renderer/components/wizard/wizard.tsx:77

Returns: any


forceUpdate#

@@ -1645,7 +1645,7 @@ lifecycle events from running.


Protected getValidStep#

getValidStep(step: number): number

-

Defined in src/renderer/components/wizard/wizard.tsx:71

+

Defined in src/renderer/components/wizard/wizard.tsx:71

Parameters:

@@ -1665,33 +1665,33 @@ lifecycle events from running.


isFirstStep#

isFirstStep(): boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:75

+

Defined in src/renderer/components/wizard/wizard.tsx:75

Returns: boolean


isLastStep#

isLastStep(): boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:76

+

Defined in src/renderer/components/wizard/wizard.tsx:76

Returns: boolean


lastStep#

lastStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:80

+

Defined in src/renderer/components/wizard/wizard.tsx:80

Returns: any


nextStep#

nextStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:78

+

Defined in src/renderer/components/wizard/wizard.tsx:78

Returns: any


prevStep#

prevStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:79

+

Defined in src/renderer/components/wizard/wizard.tsx:79

Returns: any


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/wizard/wizard.tsx:82

+

Defined in src/renderer/components/wizard/wizard.tsx:82

Returns: Element‹›


setState#

@@ -1744,10 +1744,10 @@ and componentDidUpdate will not be called.

state#

state: object#

Overrides PageLayout.state

-

Defined in src/renderer/components/wizard/wizard.tsx:30

+

Defined in src/renderer/components/wizard/wizard.tsx:30

step#

step: number = this.getValidStep(this.props.step)

-

Defined in src/renderer/components/wizard/wizard.tsx:31

+

Defined in src/renderer/components/wizard/wizard.tsx:31

diff --git a/master/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/master/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html index 09f6a52877..006aa68166 100644 --- a/master/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -1156,7 +1156,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1191,11 +1191,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1488,7 +1488,7 @@ lifecycle events from running.

render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/layout/wizard-layout.tsx:18

+

Defined in src/renderer/components/layout/wizard-layout.tsx:18

Returns: Element‹›


setState#

diff --git a/master/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/master/extensions/api/classes/_renderer_api_components_.wizardstep/index.html index b03d8bc9c8..17ddeeef77 100644 --- a/master/extensions/api/classes/_renderer_api_components_.wizardstep/index.html +++ b/master/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -1231,7 +1231,7 @@

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

-
static contextType = MyContext
+
static contextType = MyContext
 // For TS pre-3.7:
 context!: React.ContextType<typeof MyContext>
 // For TS 3.7 and above:
@@ -1258,7 +1258,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

state#

state: WizardStepState

Overrides PageLayout.state

-

Defined in src/renderer/components/wizard/wizard.tsx:136

+

Defined in src/renderer/components/wizard/wizard.tsx:136


Static Optional contextType#

contextType? : Context‹any›

@@ -1266,11 +1266,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Defined in node_modules/@types/react/index.d.ts:455

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
+
type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
 
-class Foo extends React.Component {
-  static contextType = Ctx
+class Foo extends React.Component {
+  static contextType = Ctx
   context!: React.ContextType<typeof Ctx>
   render () {
     return <>My context's value: {this.context}</>;
@@ -1480,7 +1480,7 @@ prevents this from being invoked.

componentWillUnmount#

componentWillUnmount(): void

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/wizard/wizard.tsx:143

+

Defined in src/renderer/components/wizard/wizard.tsx:143

Returns: void


Optional componentWillUpdate#

@@ -1560,23 +1560,23 @@ lifecycle events from running.


next#

next(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:154

+

Defined in src/renderer/components/wizard/wizard.tsx:154

Returns: void


prev#

prev(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:147

+

Defined in src/renderer/components/wizard/wizard.tsx:147

Returns: void


render#

render(): Element‹›

Overrides void

-

Defined in src/renderer/components/wizard/wizard.tsx:194

+

Defined in src/renderer/components/wizard/wizard.tsx:194

Returns: Element‹›


renderLoading#

renderLoading(): Element‹›

-

Defined in src/renderer/components/wizard/wizard.tsx:186

+

Defined in src/renderer/components/wizard/wizard.tsx:186

Returns: Element‹›


setState#

@@ -1628,15 +1628,15 @@ and componentDidUpdate will not be called.


submit#

submit(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:177

+

Defined in src/renderer/components/wizard/wizard.tsx:177

Returns: void

Object literals#

Static defaultProps#

defaultProps: object#

-

Defined in src/renderer/components/wizard/wizard.tsx:139

+

Defined in src/renderer/components/wizard/wizard.tsx:139

scrollable#

scrollable: true = true

-

Defined in src/renderer/components/wizard/wizard.tsx:140

+

Defined in src/renderer/components/wizard/wizard.tsx:140

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html index 8c8448f055..2bcf4f9bcc 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -1191,7 +1191,7 @@

constructor#

+ new ClusterRole(data: KubeJsonApiData): ClusterRole

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1212,53 +1212,53 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


rules#

rules: object[]

Inherited from Role.rules

-

Defined in src/renderer/api/endpoints/role.api.ts:9

+

Defined in src/renderer/api/endpoints/role.api.ts:9


Optional status#

status? : any

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:79

+

Defined in src/renderer/api/kube-object.ts:79


Static apiBase#

apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

Overrides Role.apiBase

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

+

Defined in src/renderer/api/endpoints/cluster-role.api.ts:9


Static kind#

kind: string = "ClusterRole"

Overrides Role.kind

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

+

Defined in src/renderer/api/endpoints/cluster-role.api.ts:7


Static namespaced#

namespaced: boolean = false

Overrides Role.namespaced

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

+

Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

Accessors#

get selfLink(): string

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:81

+

Defined in src/renderer/api/kube-object.ts:81

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:167

+

Defined in src/renderer/api/kube-object.ts:167

Parameters:

@@ -1279,7 +1279,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1312,7 +1312,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1335,67 +1335,67 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getRules#

getRules(): object[]

Inherited from Role.getRules

-

Defined in src/renderer/api/endpoints/role.api.ts:16

+

Defined in src/renderer/api/endpoints/role.api.ts:16

Returns: object[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1418,7 +1418,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1439,7 +1439,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1460,7 +1460,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1481,7 +1481,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1502,7 +1502,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html index 829601a82f..e049879d94 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -1207,7 +1207,7 @@

constructor#

+ new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1228,22 +1228,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


roleRef#

roleRef: object

Inherited from RoleBinding.roleRef

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:19

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:19

Type declaration:

@@ -1312,7 +1312,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1345,7 +1345,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1368,73 +1368,73 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSubjectNames#

getSubjectNames(): string

Inherited from RoleBinding.getSubjectNames

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:29

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:29

Returns: string


getSubjects#

getSubjects(): IRoleBindingSubject[]

Inherited from RoleBinding.getSubjects

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:25

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:25

Returns: IRoleBindingSubject[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1457,7 +1457,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1478,7 +1478,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1499,7 +1499,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1520,7 +1520,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1541,7 +1541,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html index 5f09040690..089f44dc50 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -1193,7 +1193,7 @@

constructor#

+ new ConfigMap(data: KubeJsonApiData): ConfigMap

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/configmap.api.ts:10

+

Defined in src/renderer/api/endpoints/configmap.api.ts:10

Parameters:

@@ -1214,11 +1214,11 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


data#

data: object

-

Defined in src/renderer/api/endpoints/configmap.api.ts:17

+

Defined in src/renderer/api/endpoints/configmap.api.ts:17

Type declaration:

@@ -1283,7 +1283,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1316,7 +1316,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1339,66 +1339,66 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getKeys#

getKeys(): string[]

-

Defined in src/renderer/api/endpoints/configmap.api.ts:21

+

Defined in src/renderer/api/endpoints/configmap.api.ts:21

Returns: string[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1421,7 +1421,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1442,7 +1442,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1463,7 +1463,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1484,7 +1484,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1505,7 +1505,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html index 6d8ae97c62..9e80c3e919 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new ConfigMapsStore(): ConfigMapsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: ConfigMapsStore

Properties#

api#

api: KubeApiConfigMap‹›› = configMapApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

+

Defined in src/renderer/components/+config-maps/config-maps.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): ConfigMap[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: ConfigMap[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: ConfigMap): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: ConfigMap[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): ConfigMap[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): ConfigMap[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): ConfigMap

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): ConfigMap

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: ConfigMap[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: ConfigMap): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: ConfigMap[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹ConfigMap

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹ConfigMap

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹ConfigMap[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: ConfigMap): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: ConfigMap, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: ConfigMap

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: ConfigMap): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: ConfigMap[], sorting?: function[], order?: "asc" | "desc"): ConfigMap[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: ConfigMap): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: ConfigMap[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: ConfigMap): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: ConfigMap, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: ConfigMap

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html index 1093311304..b91fb45b6e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -1309,7 +1309,7 @@

constructor#

+ new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

+

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

Parameters:

@@ -1330,65 +1330,65 @@

api#

api: KubeApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

+

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): T[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: T[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1411,7 +1411,7 @@

create#

create(params: object, data?: Partial‹T›): Promise‹T›

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1439,7 +1439,7 @@

createItem(params: object, data?: Partial‹T›): Promise‹T›

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1466,7 +1466,7 @@

Protected defaultSorting#

defaultSorting(item: T): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1487,7 +1487,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: T[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1508,7 +1508,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): T[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1536,7 +1536,7 @@

getByLabel#

getByLabel(labels: string[] | object): T[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1558,7 +1558,7 @@

getByName(name: string, namespace?: string): T

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1583,7 +1583,7 @@

getByPath#

getByPath(path: string): T

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1604,7 +1604,7 @@

Optional getStatuses#

getStatuses(items: T[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1625,7 +1625,7 @@

isSelected#

isSelected(item: T): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1646,7 +1646,7 @@

isSelectedAll#

isSelectedAll(visibleItems: T[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1669,7 +1669,7 @@

load#

load(params: object): Promise‹T›

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1696,13 +1696,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1724,7 +1724,7 @@

loadItem(params: object): Promise‹T›

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1751,7 +1751,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹T[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1772,7 +1772,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1793,7 +1793,7 @@

remove#

remove(item: T): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1814,7 +1814,7 @@

Protected removeItem#

removeItem(item: T, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: T

request: function

@@ -1825,25 +1825,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: T): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1864,7 +1864,7 @@

Protected sortItems#

sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1898,7 +1898,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1921,7 +1921,7 @@

toggleSelection#

toggleSelection(item: T): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1942,7 +1942,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: T[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1965,7 +1965,7 @@

unselect#

unselect(item: T): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1986,7 +1986,7 @@

update#

update(item: T, data: Partial‹T›): Promise‹T›

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2011,13 +2011,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: T, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: T

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html index e7eb4353b0..9b6aeb78e3 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -1324,76 +1324,76 @@

constructor#

+ new CRDStore(): CRDStore

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:23

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:23

Returns: CRDStore

Properties#

api#

api: KubeApiCustomResourceDefinition‹›› = crdApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:23

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:23


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

groups#

get groups(): object

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:39

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:39

Returns: object


query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): CustomResourceDefinition[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: CustomResourceDefinition[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1416,7 +1416,7 @@

create#

create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1444,7 +1444,7 @@

createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1471,7 +1471,7 @@

Protected defaultSorting#

defaultSorting(item: CustomResourceDefinition): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1492,7 +1492,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1513,7 +1513,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): CustomResourceDefinition[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1540,7 +1540,7 @@

getByGroup#

getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:52

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:52

Parameters:

@@ -1565,7 +1565,7 @@

getByLabel#

getByLabel(labels: string[] | object): CustomResourceDefinition[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1587,7 +1587,7 @@

getByName(name: string, namespace?: string): CustomResourceDefinition

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1611,7 +1611,7 @@

getByObject#

getByObject(obj: KubeObject): CustomResourceDefinition‹›

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:60

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:60

Parameters:

@@ -1632,7 +1632,7 @@

getByPath#

getByPath(path: string): CustomResourceDefinition

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1653,7 +1653,7 @@

Optional getStatuses#

getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1674,7 +1674,7 @@

isSelected#

isSelected(item: CustomResourceDefinition): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1695,7 +1695,7 @@

isSelectedAll#

isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1718,7 +1718,7 @@

load#

load(params: object): Promise‹CustomResourceDefinition

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1745,13 +1745,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1773,7 +1773,7 @@

loadItem(params: object): Promise‹CustomResourceDefinition

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1800,7 +1800,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹CustomResourceDefinition[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1821,7 +1821,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1842,7 +1842,7 @@

remove#

remove(item: CustomResourceDefinition): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1863,7 +1863,7 @@

Protected removeItem#

removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: CustomResourceDefinition

request: function

@@ -1874,25 +1874,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: CustomResourceDefinition): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1913,7 +1913,7 @@

Protected sortItems#

sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:32

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:32

Parameters:

@@ -1935,7 +1935,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1958,7 +1958,7 @@

toggleSelection#

toggleSelection(item: CustomResourceDefinition): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1979,7 +1979,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2002,7 +2002,7 @@

unselect#

unselect(item: CustomResourceDefinition): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2023,7 +2023,7 @@

update#

update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2048,13 +2048,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: CustomResourceDefinition

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html index 9d6d36f8b5..2481563134 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -1225,7 +1225,7 @@

constructor#

+ new CronJob(data: KubeJsonApiData): CronJob

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1246,17 +1246,17 @@

apiVersion#

apiVersion: string

Overrides KubeObject.apiVersion

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:47

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:47


kind#

kind: string

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:46

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:46


metadata#

metadata: object

Overrides KubeObject.metadata

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:48

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:48

Type declaration:

@@ -1414,7 +1414,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1447,7 +1447,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1470,86 +1470,86 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getLastScheduleTime#

getLastScheduleTime(): string

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:103

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:103

Returns: string


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSchedule#

getSchedule(): string

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:110

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:110

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSuspendFlag#

getSuspendFlag(): string

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:99

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:99

Returns: string


isNeverRun#

isNeverRun(): boolean

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:114

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:114

Returns: boolean


isSuspend#

isSuspend(): boolean

-

Defined in src/renderer/api/endpoints/cron-job.api.ts:126

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:126

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1572,7 +1572,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1593,7 +1593,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1614,7 +1614,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1635,7 +1635,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1656,7 +1656,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html index 9d31a5ee1e..d92db66c43 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -1308,71 +1308,71 @@

constructor#

+ new CronJobStore(): CronJobStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: CronJobStore

Properties#

api#

api: CronJobApi‹› = cronJobApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

+

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): CronJob[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: CronJob[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1395,7 +1395,7 @@

create#

create(params: object, data?: Partial‹CronJob›): Promise‹CronJob

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1423,7 +1423,7 @@

createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1450,7 +1450,7 @@

Protected defaultSorting#

defaultSorting(item: CronJob): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1471,7 +1471,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: CronJob[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1491,7 +1491,7 @@

getActiveJobsNum#

getActiveJobsNum(cronJob: CronJob): number

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

+

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

Parameters:

@@ -1512,7 +1512,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): CronJob[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1540,7 +1540,7 @@

getByLabel#

getByLabel(labels: string[] | object): CronJob[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1562,7 +1562,7 @@

getByName(name: string, namespace?: string): CronJob

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1587,7 +1587,7 @@

getByPath#

getByPath(path: string): CronJob

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1608,7 +1608,7 @@

getStatuses#

getStatuses(cronJobs?: CronJob[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

+

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

Parameters:

@@ -1637,7 +1637,7 @@

isSelected#

isSelected(item: CronJob): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1658,7 +1658,7 @@

isSelectedAll#

isSelectedAll(visibleItems: CronJob[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1681,7 +1681,7 @@

load#

load(params: object): Promise‹CronJob

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1708,13 +1708,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1736,7 +1736,7 @@

loadItem(params: object): Promise‹CronJob

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1763,7 +1763,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹CronJob[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1784,7 +1784,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1805,7 +1805,7 @@

remove#

remove(item: CronJob): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1826,7 +1826,7 @@

Protected removeItem#

removeItem(item: CronJob, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: CronJob

request: function

@@ -1837,25 +1837,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: CronJob): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1876,7 +1876,7 @@

Protected sortItems#

sortItems(items: CronJob[], sorting?: function[], order?: "asc" | "desc"): CronJob[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1910,7 +1910,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1933,7 +1933,7 @@

toggleSelection#

toggleSelection(item: CronJob): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1954,7 +1954,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: CronJob[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1977,7 +1977,7 @@

unselect#

unselect(item: CronJob): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1998,7 +1998,7 @@

update#

update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2023,13 +2023,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: CronJob, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: CronJob

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html index 7ca6102893..48172f8653 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -1305,7 +1305,7 @@

constructor#

+ new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1326,21 +1326,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/crd.api.ts:25

+

Defined in src/renderer/api/endpoints/crd.api.ts:25

Type declaration:

@@ -1463,7 +1463,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1496,7 +1496,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1518,46 +1518,46 @@

getConditions#

getConditions(): object[]

-

Defined in src/renderer/api/endpoints/crd.api.ts:139

+

Defined in src/renderer/api/endpoints/crd.api.ts:139

Returns: object[]


getConversion#

getConversion(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:121

+

Defined in src/renderer/api/endpoints/crd.api.ts:121

Returns: string


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getGroup#

getGroup(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:96

+

Defined in src/renderer/api/endpoints/crd.api.ts:96

Returns: string


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNames#

getNames(): object

-

Defined in src/renderer/api/endpoints/crd.api.ts:117

+

Defined in src/renderer/api/endpoints/crd.api.ts:117

Returns: object

@@ -1615,71 +1615,71 @@

getResourceApiBase#

getResourceApiBase(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:76

+

Defined in src/renderer/api/endpoints/crd.api.ts:76

Returns: string


getResourceKind#

getResourceKind(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:86

+

Defined in src/renderer/api/endpoints/crd.api.ts:86

Returns: string


getResourceTitle#

getResourceTitle(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:90

+

Defined in src/renderer/api/endpoints/crd.api.ts:90

Returns: string


getResourceUrl#

getResourceUrl(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:67

+

Defined in src/renderer/api/endpoints/crd.api.ts:67

Returns: string


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getScope#

getScope(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:100

+

Defined in src/renderer/api/endpoints/crd.api.ts:100

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getStoredVersions#

getStoredVersions(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:113

+

Defined in src/renderer/api/endpoints/crd.api.ts:113

Returns: string


getValidation#

getValidation(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:135

+

Defined in src/renderer/api/endpoints/crd.api.ts:135

Returns: string


getVersion#

getVersion(): string

-

Defined in src/renderer/api/endpoints/crd.api.ts:104

+

Defined in src/renderer/api/endpoints/crd.api.ts:104

Returns: string


isNamespaced#

isNamespaced(): boolean

-

Defined in src/renderer/api/endpoints/crd.api.ts:109

+

Defined in src/renderer/api/endpoints/crd.api.ts:109

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1702,7 +1702,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1723,7 +1723,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1744,7 +1744,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1765,7 +1765,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1786,7 +1786,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html index 928919024c..59f12ebab3 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -1241,7 +1241,7 @@

constructor#

+ new DaemonSet(data: KubeJsonApiData): DaemonSet

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1262,22 +1262,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

+

Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

Type declaration:

@@ -1434,19 +1434,19 @@

getAffinity#

getAffinity(): IAffinity

Inherited from Deployment.getAffinity

-

Defined in src/renderer/api/workload-kube-object.ts:74

+

Defined in src/renderer/api/workload-kube-object.ts:74

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:78

+

Defined in src/renderer/api/workload-kube-object.ts:78

Returns: number


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1479,7 +1479,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1502,90 +1502,90 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getImages#

getImages(): string[]

-

Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

+

Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

Returns: string[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Inherited from Deployment.getNodeSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:58

+

Defined in src/renderer/api/workload-kube-object.ts:58

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSelectors#

getSelectors(): string[]

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:52

+

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:64

+

Defined in src/renderer/api/workload-kube-object.ts:64

Returns: string[]


getTolerations#

getTolerations(): IToleration[]

Inherited from Deployment.getTolerations

-

Defined in src/renderer/api/workload-kube-object.ts:70

+

Defined in src/renderer/api/workload-kube-object.ts:70

Returns: IToleration[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1608,7 +1608,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1629,7 +1629,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1650,7 +1650,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1671,7 +1671,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1692,7 +1692,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html index d19bc9c75b..6dfa9b9d42 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -1324,75 +1324,75 @@

constructor#

+ new DaemonSetStore(): DaemonSetStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: DaemonSetStore

Properties#

api#

api: KubeApiDaemonSet‹›› = daemonSetApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): DaemonSet[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: DaemonSet[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1415,7 +1415,7 @@

create#

create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1443,7 +1443,7 @@

createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1470,7 +1470,7 @@

Protected defaultSorting#

defaultSorting(item: DaemonSet): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1491,7 +1491,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: DaemonSet[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1512,7 +1512,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): DaemonSet[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1540,7 +1540,7 @@

getByLabel#

getByLabel(labels: string[] | object): DaemonSet[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1562,7 +1562,7 @@

getByName(name: string, namespace?: string): DaemonSet

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1587,7 +1587,7 @@

getByPath#

getByPath(path: string): DaemonSet

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1607,7 +1607,7 @@

getChildPods#

getChildPods(daemonSet: DaemonSet): Pod[]

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

Parameters:

@@ -1628,7 +1628,7 @@

getStatuses#

getStatuses(daemonSets?: DaemonSet[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

Parameters:

@@ -1660,7 +1660,7 @@

isSelected#

isSelected(item: DaemonSet): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1681,7 +1681,7 @@

isSelectedAll#

isSelectedAll(visibleItems: DaemonSet[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1704,7 +1704,7 @@

load#

load(params: object): Promise‹DaemonSet

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1731,13 +1731,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1759,7 +1759,7 @@

loadItem(params: object): Promise‹DaemonSet

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1786,7 +1786,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹DaemonSet[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1806,7 +1806,7 @@

loadMetrics#

loadMetrics(daemonSet: DaemonSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

Parameters:

@@ -1827,7 +1827,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1848,7 +1848,7 @@

remove#

remove(item: DaemonSet): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1869,7 +1869,7 @@

Protected removeItem#

removeItem(item: DaemonSet, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: DaemonSet

request: function

@@ -1880,25 +1880,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: DaemonSet): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1919,7 +1919,7 @@

Protected sortItems#

sortItems(items: DaemonSet[], sorting?: function[], order?: "asc" | "desc"): DaemonSet[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1953,7 +1953,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1976,7 +1976,7 @@

toggleSelection#

toggleSelection(item: DaemonSet): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1997,7 +1997,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: DaemonSet[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2020,7 +2020,7 @@

unselect#

unselect(item: DaemonSet): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2041,7 +2041,7 @@

update#

update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2066,13 +2066,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: DaemonSet, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: DaemonSet

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html index 7fc7ae11f4..b0269a63fa 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -1257,7 +1257,7 @@

constructor#

+ new Deployment(data: KubeJsonApiData): Deployment

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1278,22 +1278,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/deployment.api.ts:75

+

Defined in src/renderer/api/endpoints/deployment.api.ts:75

Type declaration:

@@ -1455,19 +1455,19 @@

getAffinity#

getAffinity(): IAffinity

Inherited from Deployment.getAffinity

-

Defined in src/renderer/api/workload-kube-object.ts:74

+

Defined in src/renderer/api/workload-kube-object.ts:74

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:78

+

Defined in src/renderer/api/workload-kube-object.ts:78

Returns: number


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1500,7 +1500,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1522,7 +1522,7 @@

getConditions#

getConditions(activeOnly: boolean): object[]

-

Defined in src/renderer/api/endpoints/deployment.api.ts:171

+

Defined in src/renderer/api/endpoints/deployment.api.ts:171

Parameters:

@@ -1544,7 +1544,7 @@

getConditionsText#

getConditionsText(activeOnly: boolean): string

-

Defined in src/renderer/api/endpoints/deployment.api.ts:183

+

Defined in src/renderer/api/endpoints/deployment.api.ts:183

Parameters:

@@ -1567,90 +1567,90 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Inherited from Deployment.getNodeSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:58

+

Defined in src/renderer/api/workload-kube-object.ts:58

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getReplicas#

getReplicas(): number

-

Defined in src/renderer/api/endpoints/deployment.api.ts:187

+

Defined in src/renderer/api/endpoints/deployment.api.ts:187

Returns: number


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSelectors#

getSelectors(): string[]

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:52

+

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:64

+

Defined in src/renderer/api/workload-kube-object.ts:64

Returns: string[]


getTolerations#

getTolerations(): IToleration[]

Inherited from Deployment.getTolerations

-

Defined in src/renderer/api/workload-kube-object.ts:70

+

Defined in src/renderer/api/workload-kube-object.ts:70

Returns: IToleration[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1673,7 +1673,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1694,7 +1694,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1715,7 +1715,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1736,7 +1736,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1757,7 +1757,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html index 3149d5f2da..afc700f586 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -1222,7 +1222,7 @@

constructor#

+ new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

Inherited from KubeApi.constructor

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1243,84 +1243,84 @@

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

Inherited from KubeApi.kind

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹Deployment

Inherited from KubeApi.objectConstructor

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹Deployment

Inherited from KubeApi.options

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

Inherited from KubeApi.create

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1350,7 +1350,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1379,7 +1379,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment

Inherited from KubeApi.get

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1408,7 +1408,7 @@

getReplicas#

getReplicas(params: object): Promise‹number›

-

Defined in src/renderer/api/endpoints/deployment.api.ts:12

+

Defined in src/renderer/api/endpoints/deployment.api.ts:12

Parameters:

params: object

@@ -1434,7 +1434,7 @@

getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1456,7 +1456,7 @@

Protected getScaleApiUrl#

getScaleApiUrl(params: object): string

-

Defined in src/renderer/api/endpoints/deployment.api.ts:8

+

Defined in src/renderer/api/endpoints/deployment.api.ts:8

Parameters:

params: object

@@ -1482,7 +1482,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1512,7 +1512,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1540,7 +1540,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

Inherited from KubeApi.list

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1565,7 +1565,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1588,7 +1588,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1613,7 +1613,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1634,7 +1634,7 @@

restart#

restart(params: object): CancelablePromise‹KubeJsonApiData›

-

Defined in src/renderer/api/endpoints/deployment.api.ts:29

+

Defined in src/renderer/api/endpoints/deployment.api.ts:29

Parameters:

params: object

@@ -1659,7 +1659,7 @@

scale#

scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

-

Defined in src/renderer/api/endpoints/deployment.api.ts:18

+

Defined in src/renderer/api/endpoints/deployment.api.ts:18

Parameters:

params: object

@@ -1686,7 +1686,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1714,7 +1714,7 @@

update#

update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

Inherited from KubeApi.update

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1744,14 +1744,14 @@

watch#

watch(): function

Inherited from KubeApi.watch

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html index 9fa7cb8c59..f5529622ec 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -1324,75 +1324,75 @@

constructor#

+ new DeploymentStore(): DeploymentStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: DeploymentStore

Properties#

api#

api: DeploymentApi‹› = deploymentApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Deployment[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Deployment[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1415,7 +1415,7 @@

create#

create(params: object, data?: Partial‹Deployment›): Promise‹Deployment

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1443,7 +1443,7 @@

createItem(params: object, data?: Partial‹Deployment›): Promise‹Deployment

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1470,7 +1470,7 @@

Protected defaultSorting#

defaultSorting(item: Deployment): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1491,7 +1491,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Deployment[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1512,7 +1512,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Deployment[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1540,7 +1540,7 @@

getByLabel#

getByLabel(labels: string[] | object): Deployment[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1562,7 +1562,7 @@

getByName(name: string, namespace?: string): Deployment

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1587,7 +1587,7 @@

getByPath#

getByPath(path: string): Deployment

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1607,7 +1607,7 @@

getChildPods#

getChildPods(deployment: Deployment): Pod‹›[]

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

Parameters:

@@ -1628,7 +1628,7 @@

getStatuses#

getStatuses(deployments?: Deployment[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

Parameters:

@@ -1660,7 +1660,7 @@

isSelected#

isSelected(item: Deployment): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1681,7 +1681,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Deployment[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1704,7 +1704,7 @@

load#

load(params: object): Promise‹Deployment

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1731,13 +1731,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1759,7 +1759,7 @@

loadItem(params: object): Promise‹Deployment

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1786,7 +1786,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Deployment[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1806,7 +1806,7 @@

loadMetrics#

loadMetrics(deployment: Deployment): Promise‹void›

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

Parameters:

@@ -1827,7 +1827,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1848,7 +1848,7 @@

remove#

remove(item: Deployment): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1869,7 +1869,7 @@

Protected removeItem#

removeItem(item: Deployment, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Deployment

request: function

@@ -1880,25 +1880,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Deployment): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1919,7 +1919,7 @@

Protected sortItems#

sortItems(items: Deployment[]): Deployment‹›[]

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

+

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

Parameters:

@@ -1941,7 +1941,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1964,7 +1964,7 @@

toggleSelection#

toggleSelection(item: Deployment): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1985,7 +1985,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Deployment[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2008,7 +2008,7 @@

unselect#

unselect(item: Deployment): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2029,7 +2029,7 @@

update#

update(item: Deployment, data: Partial‹Deployment›): Promise‹Deployment

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2054,13 +2054,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Deployment, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Deployment

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html index d13675e05d..6158a8b721 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -1201,7 +1201,7 @@

constructor#

+ new Endpoint(data: KubeJsonApiData): Endpoint

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1222,51 +1222,51 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


Optional status#

status? : any

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:79

+

Defined in src/renderer/api/kube-object.ts:79


subsets#

subsets: IEndpointSubset[]

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:109

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:109


Static apiBase#

apiBase: string = "/api/v1/endpoints"

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:107

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:107


Static kind#

kind: string = "Endpoints"

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:105

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:105


Static namespaced#

namespaced: boolean = true

Overrides KubeObject.namespaced

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:106

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:106

Accessors#

get selfLink(): string

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:81

+

Defined in src/renderer/api/kube-object.ts:81

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:167

+

Defined in src/renderer/api/kube-object.ts:167

Parameters:

@@ -1287,7 +1287,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1320,7 +1320,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1342,72 +1342,72 @@

getEndpointSubsets#

getEndpointSubsets(): EndpointSubset[]

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:111

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:111

Returns: EndpointSubset[]


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


toString#

toString(): string

-

Defined in src/renderer/api/endpoints/endpoint.api.ts:117

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:117

Returns: string


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1430,7 +1430,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1451,7 +1451,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1472,7 +1472,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1493,7 +1493,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1514,7 +1514,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html index 1f71545abc..3ee3aa7686 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new EndpointStore(): EndpointStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: EndpointStore

Properties#

api#

api: KubeApiEndpoint‹›› = endpointApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

+

Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Endpoint[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Endpoint[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: Endpoint): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Endpoint[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Endpoint[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): Endpoint[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): Endpoint

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): Endpoint

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: Endpoint[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: Endpoint): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Endpoint[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹Endpoint

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹Endpoint

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Endpoint[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: Endpoint): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: Endpoint, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Endpoint

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Endpoint): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: Endpoint[], sorting?: function[], order?: "asc" | "desc"): Endpoint[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: Endpoint): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Endpoint[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: Endpoint): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: Endpoint, data: Partial‹Endpoint›): Promise‹Endpoint

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Endpoint, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Endpoint

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html index 0f99f4e43d..9b557aa959 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -1324,81 +1324,81 @@

constructor#

+ new EventStore(): EventStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: EventStore

Properties#

api#

api: KubeApiKubeEvent‹›› = eventApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+events/event.store.ts:13

+

Defined in src/renderer/components/+events/event.store.ts:13


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


limit#

limit: number = 1000

Overrides KubeObjectStore.limit

-

Defined in src/renderer/components/+events/event.store.ts:14

+

Defined in src/renderer/components/+events/event.store.ts:14


saveLimit#

saveLimit: number = 50000

-

Defined in src/renderer/components/+events/event.store.ts:15

+

Defined in src/renderer/components/+events/event.store.ts:15


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): KubeEvent[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: KubeEvent[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(): IReactionDisposer

Overrides KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/components/+events/event.store.ts:17

+

Defined in src/renderer/components/+events/event.store.ts:17

Returns: IReactionDisposer


create#

create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1426,7 +1426,7 @@

createItem(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1453,7 +1453,7 @@

Protected defaultSorting#

defaultSorting(item: KubeEvent): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1474,7 +1474,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: KubeEvent[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1495,7 +1495,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): KubeEvent[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1523,7 +1523,7 @@

getByLabel#

getByLabel(labels: string[] | object): KubeEvent[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1545,7 +1545,7 @@

getByName(name: string, namespace?: string): KubeEvent

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1570,7 +1570,7 @@

getByPath#

getByPath(path: string): KubeEvent

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1590,7 +1590,7 @@

getEventsByObject#

getEventsByObject(obj: KubeObject): KubeEvent[]

-

Defined in src/renderer/components/+events/event.store.ts:27

+

Defined in src/renderer/components/+events/event.store.ts:27

Parameters:

@@ -1611,7 +1611,7 @@

Optional getStatuses#

getStatuses(items: KubeEvent[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1631,13 +1631,13 @@

getWarnings#

getWarnings(): KubeEvent‹›[]

-

Defined in src/renderer/components/+events/event.store.ts:37

+

Defined in src/renderer/components/+events/event.store.ts:37

Returns: KubeEvent‹›[]


isSelected#

isSelected(item: KubeEvent): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1658,7 +1658,7 @@

isSelectedAll#

isSelectedAll(visibleItems: KubeEvent[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1681,7 +1681,7 @@

load#

load(params: object): Promise‹KubeEvent

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1708,13 +1708,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1736,7 +1736,7 @@

loadItem(params: object): Promise‹KubeEvent

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1763,7 +1763,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹KubeEvent[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1784,7 +1784,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1805,7 +1805,7 @@

remove#

remove(item: KubeEvent): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1826,7 +1826,7 @@

Protected removeItem#

removeItem(item: KubeEvent, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: KubeEvent

request: function

@@ -1837,25 +1837,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: KubeEvent): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1876,7 +1876,7 @@

Protected sortItems#

sortItems(items: KubeEvent[]): KubeEvent‹›[]

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+events/event.store.ts:21

+

Defined in src/renderer/components/+events/event.store.ts:21

Parameters:

@@ -1898,7 +1898,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1921,7 +1921,7 @@

toggleSelection#

toggleSelection(item: KubeEvent): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1942,7 +1942,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: KubeEvent[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1965,7 +1965,7 @@

unselect#

unselect(item: KubeEvent): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1986,7 +1986,7 @@

update#

update(item: KubeEvent, data: Partial‹KubeEvent›): Promise‹KubeEvent

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2011,13 +2011,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: KubeEvent, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: KubeEvent

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html index 7fd2b33873..369f67e964 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -1249,7 +1249,7 @@

constructor#

+ new HorizontalPodAutoscaler(data: KubeJsonApiData): HorizontalPodAutoscaler

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1270,21 +1270,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/hpa.api.ts:46

+

Defined in src/renderer/api/endpoints/hpa.api.ts:46

Type declaration:

@@ -1374,7 +1374,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1407,7 +1407,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1429,40 +1429,40 @@

getConditions#

getConditions(): object[]

-

Defined in src/renderer/api/endpoints/hpa.api.ts:81

+

Defined in src/renderer/api/endpoints/hpa.api.ts:81

Returns: object[]


getCurrentMetrics#

getCurrentMetrics(): IHpaMetric[]

-

Defined in src/renderer/api/endpoints/hpa.api.ts:99

+

Defined in src/renderer/api/endpoints/hpa.api.ts:99

Returns: IHpaMetric[]


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getMaxPods#

getMaxPods(): number

-

Defined in src/renderer/api/endpoints/hpa.api.ts:69

+

Defined in src/renderer/api/endpoints/hpa.api.ts:69

Returns: number


Protected getMetricName#

getMetricName(metric: IHpaMetric): string

-

Defined in src/renderer/api/endpoints/hpa.api.ts:103

+

Defined in src/renderer/api/endpoints/hpa.api.ts:103

Parameters:

@@ -1482,7 +1482,7 @@

getMetricValues#

getMetricValues(metric: IHpaMetric): string

-

Defined in src/renderer/api/endpoints/hpa.api.ts:119

+

Defined in src/renderer/api/endpoints/hpa.api.ts:119

Parameters:

@@ -1502,59 +1502,59 @@

getMetrics#

getMetrics(): IHpaMetric[]

-

Defined in src/renderer/api/endpoints/hpa.api.ts:95

+

Defined in src/renderer/api/endpoints/hpa.api.ts:95

Returns: IHpaMetric[]


getMinPods#

getMinPods(): number

-

Defined in src/renderer/api/endpoints/hpa.api.ts:73

+

Defined in src/renderer/api/endpoints/hpa.api.ts:73

Returns: number


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getReplicas#

getReplicas(): number

-

Defined in src/renderer/api/endpoints/hpa.api.ts:77

+

Defined in src/renderer/api/endpoints/hpa.api.ts:77

Returns: number


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1577,7 +1577,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1598,7 +1598,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1619,7 +1619,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1640,7 +1640,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1661,7 +1661,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html index 7b74774913..0f5a8a4d1d 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new HPAStore(): HPAStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: HPAStore

Properties#

api#

api: KubeApiHorizontalPodAutoscaler‹›› = hpaApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

+

Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): HorizontalPodAutoscaler[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: HorizontalPodAutoscaler[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: HorizontalPodAutoscaler): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: HorizontalPodAutoscaler[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): HorizontalPodAutoscaler[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): HorizontalPodAutoscaler

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): HorizontalPodAutoscaler

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: HorizontalPodAutoscaler): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹HorizontalPodAutoscaler

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹HorizontalPodAutoscaler

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹HorizontalPodAutoscaler[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: HorizontalPodAutoscaler): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: HorizontalPodAutoscaler, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: HorizontalPodAutoscaler

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: HorizontalPodAutoscaler): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: HorizontalPodAutoscaler[], sorting?: function[], order?: "asc" | "desc"): HorizontalPodAutoscaler[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: HorizontalPodAutoscaler): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: HorizontalPodAutoscaler): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: HorizontalPodAutoscaler, data: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: HorizontalPodAutoscaler

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html index 0520724bc9..0fb389630d 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -1225,7 +1225,7 @@

constructor#

+ new Ingress(data: KubeJsonApiData): Ingress

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1246,21 +1246,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/ingress.api.ts:70

+

Defined in src/renderer/api/endpoints/ingress.api.ts:70

Type declaration:

@@ -1335,7 +1335,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1368,7 +1368,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1391,74 +1391,74 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getHosts#

getHosts(): string[]

-

Defined in src/renderer/api/endpoints/ingress.api.ts:137

+

Defined in src/renderer/api/endpoints/ingress.api.ts:137

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getLoadBalancers#

getLoadBalancers(): string[]

-

Defined in src/renderer/api/endpoints/ingress.api.ts:168

+

Defined in src/renderer/api/endpoints/ingress.api.ts:168

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getPorts#

getPorts(): string

-

Defined in src/renderer/api/endpoints/ingress.api.ts:145

+

Defined in src/renderer/api/endpoints/ingress.api.ts:145

Returns: string


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getRoutes#

getRoutes(): string[]

-

Defined in src/renderer/api/endpoints/ingress.api.ts:100

+

Defined in src/renderer/api/endpoints/ingress.api.ts:100

Returns: string[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getServiceNamePort#

getServiceNamePort(): object

-

Defined in src/renderer/api/endpoints/ingress.api.ts:126

+

Defined in src/renderer/api/endpoints/ingress.api.ts:126

Returns: object

@@ -1522,7 +1522,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1543,7 +1543,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1564,7 +1564,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1585,7 +1585,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html index 6341f4fa7c..6ecc44cac0 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -1198,7 +1198,7 @@

constructor#

+ new IngressApi(options: IKubeApiOptions‹Ingress›): IngressApi

Inherited from KubeApi.constructor

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1219,84 +1219,84 @@

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

Inherited from KubeApi.kind

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹Ingress

Inherited from KubeApi.objectConstructor

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹Ingress

Inherited from KubeApi.options

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

Inherited from KubeApi.create

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1326,7 +1326,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1355,7 +1355,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress

Inherited from KubeApi.get

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1384,7 +1384,7 @@

getMetrics#

getMetrics(ingress: string, namespace: string): Promise‹IIngressMetrics›

-

Defined in src/renderer/api/endpoints/ingress.api.ts:7

+

Defined in src/renderer/api/endpoints/ingress.api.ts:7

Parameters:

@@ -1409,7 +1409,7 @@

getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1432,7 +1432,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1462,7 +1462,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1490,7 +1490,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[]›

Inherited from KubeApi.list

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1515,7 +1515,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1538,7 +1538,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1563,7 +1563,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1585,7 +1585,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1613,7 +1613,7 @@

update#

update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

Inherited from KubeApi.update

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1643,14 +1643,14 @@

watch#

watch(): function

Inherited from KubeApi.watch

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html index 52b7c12a28..10c8fbaca4 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -1316,75 +1316,75 @@

constructor#

+ new IngressStore(): IngressStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: IngressStore

Properties#

api#

api: IngressApi‹› = ingressApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

+

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IIngressMetrics = null

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

+

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Ingress[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Ingress[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1407,7 +1407,7 @@

create#

create(params: object, data?: Partial‹Ingress›): Promise‹Ingress

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1435,7 +1435,7 @@

createItem(params: object, data?: Partial‹Ingress›): Promise‹Ingress

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1462,7 +1462,7 @@

Protected defaultSorting#

defaultSorting(item: Ingress): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1483,7 +1483,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Ingress[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1504,7 +1504,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Ingress[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1532,7 +1532,7 @@

getByLabel#

getByLabel(labels: string[] | object): Ingress[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1554,7 +1554,7 @@

getByName(name: string, namespace?: string): Ingress

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1579,7 +1579,7 @@

getByPath#

getByPath(path: string): Ingress

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1600,7 +1600,7 @@

Optional getStatuses#

getStatuses(items: Ingress[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1621,7 +1621,7 @@

isSelected#

isSelected(item: Ingress): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1642,7 +1642,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Ingress[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1665,7 +1665,7 @@

load#

load(params: object): Promise‹Ingress

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1692,13 +1692,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1720,7 +1720,7 @@

loadItem(params: object): Promise‹Ingress

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1747,7 +1747,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Ingress[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1767,7 +1767,7 @@

loadMetrics#

loadMetrics(ingress: Ingress): Promise‹void›

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

+

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

Parameters:

@@ -1788,7 +1788,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1809,7 +1809,7 @@

remove#

remove(item: Ingress): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1830,7 +1830,7 @@

Protected removeItem#

removeItem(item: Ingress, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Ingress

request: function

@@ -1841,25 +1841,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

+

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Ingress): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1880,7 +1880,7 @@

Protected sortItems#

sortItems(items: Ingress[], sorting?: function[], order?: "asc" | "desc"): Ingress[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1914,7 +1914,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1937,7 +1937,7 @@

toggleSelection#

toggleSelection(item: Ingress): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1958,7 +1958,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Ingress[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1981,7 +1981,7 @@

unselect#

unselect(item: Ingress): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2002,7 +2002,7 @@

update#

update(item: Ingress, data: Partial‹Ingress›): Promise‹Ingress

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2027,13 +2027,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Ingress, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Ingress

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.job/index.html index 8e96ecb8de..4434c080b1 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.job/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -1273,7 +1273,7 @@

constructor#

+ new Job(data: KubeJsonApiData): Job

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1294,22 +1294,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/job.api.ts:14

+

Defined in src/renderer/api/endpoints/job.api.ts:14

Type declaration:

@@ -1493,7 +1493,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1515,12 +1515,12 @@

getCompletions#

getCompletions(): number

-

Defined in src/renderer/api/endpoints/job.api.ts:77

+

Defined in src/renderer/api/endpoints/job.api.ts:77

Returns: number


getCondition#

getCondition(): object

-

Defined in src/renderer/api/endpoints/job.api.ts:85

+

Defined in src/renderer/api/endpoints/job.api.ts:85

Returns: object

@@ -1680,7 +1680,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1701,7 +1701,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1722,7 +1722,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1743,7 +1743,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html index 780a0e0d34..f6d0e954f5 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -1316,71 +1316,71 @@

constructor#

+ new JobStore(): JobStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: JobStore

Properties#

api#

api: KubeApiJob‹›› = jobApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

+

Defined in src/renderer/components/+workloads-jobs/job.store.ts:10


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Job[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Job[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1403,7 +1403,7 @@

create#

create(params: object, data?: Partial‹Job›): Promise‹Job

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1431,7 +1431,7 @@

createItem(params: object, data?: Partial‹Job›): Promise‹Job

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1458,7 +1458,7 @@

Protected defaultSorting#

defaultSorting(item: Job): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1479,7 +1479,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Job[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1500,7 +1500,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Job[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1528,7 +1528,7 @@

getByLabel#

getByLabel(labels: string[] | object): Job[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1550,7 +1550,7 @@

getByName(name: string, namespace?: string): Job

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1575,7 +1575,7 @@

getByPath#

getByPath(path: string): Job

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1595,7 +1595,7 @@

getChildPods#

getChildPods(job: Job): Pod[]

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

+

Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

Parameters:

@@ -1615,7 +1615,7 @@

getJobsByOwner#

getJobsByOwner(cronJob: CronJob): Job‹›[]

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

+

Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

Parameters:

@@ -1636,7 +1636,7 @@

getStatuses#

getStatuses(jobs?: Job[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

+

Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

Parameters:

@@ -1671,7 +1671,7 @@

isSelected#

isSelected(item: Job): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1692,7 +1692,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Job[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1715,7 +1715,7 @@

load#

load(params: object): Promise‹Job

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1742,13 +1742,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1770,7 +1770,7 @@

loadItem(params: object): Promise‹Job

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1797,7 +1797,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Job[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1818,7 +1818,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1839,7 +1839,7 @@

remove#

remove(item: Job): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1860,7 +1860,7 @@

Protected removeItem#

removeItem(item: Job, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Job

request: function

@@ -1871,25 +1871,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Job): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1910,7 +1910,7 @@

Protected sortItems#

sortItems(items: Job[], sorting?: function[], order?: "asc" | "desc"): Job[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1944,7 +1944,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1967,7 +1967,7 @@

toggleSelection#

toggleSelection(item: Job): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1988,7 +1988,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Job[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2011,7 +2011,7 @@

unselect#

unselect(item: Job): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2032,7 +2032,7 @@

update#

update(item: Job, data: Partial‹Job›): Promise‹Job

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2057,13 +2057,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Job, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Job

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html index 2a9690ad3d..76a327934b 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -1202,7 +1202,7 @@

Constructors#

constructor#

+ new KubeApi(options: IKubeApiOptions‹T›): KubeApi

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1222,69 +1222,69 @@

Properties#

apiBase#

apiBase: string

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹T›

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹T›

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1313,7 +1313,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1341,7 +1341,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1370,7 +1370,7 @@

getResourceVersion#

getResourceVersion(namespace: string): string

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1392,7 +1392,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1421,7 +1421,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1448,7 +1448,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1472,7 +1472,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1494,7 +1494,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1518,7 +1518,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1539,7 +1539,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1566,7 +1566,7 @@

update#

update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1595,13 +1595,13 @@

watch#

watch(): function

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html index 7856b5f7d4..f6ea5463f7 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -1297,7 +1297,7 @@

constructor#

+ new KubeEvent(data: KubeJsonApiData): KubeEvent

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1318,23 +1318,23 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


count#

count: number

-

Defined in src/renderer/api/endpoints/events.api.ts:30

+

Defined in src/renderer/api/endpoints/events.api.ts:30


eventTime#

eventTime: null

-

Defined in src/renderer/api/endpoints/events.api.ts:32

+

Defined in src/renderer/api/endpoints/events.api.ts:32


firstTimestamp#

firstTimestamp: string

-

Defined in src/renderer/api/endpoints/events.api.ts:28

+

Defined in src/renderer/api/endpoints/events.api.ts:28


involvedObject#

involvedObject: object

-

Defined in src/renderer/api/endpoints/events.api.ts:13

+

Defined in src/renderer/api/endpoints/events.api.ts:13

Type declaration:

@@ -1456,7 +1456,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1489,7 +1489,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1512,81 +1512,81 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getFirstSeenTime#

getFirstSeenTime(): string

-

Defined in src/renderer/api/endpoints/events.api.ts:46

+

Defined in src/renderer/api/endpoints/events.api.ts:46

Returns: string


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getLastSeenTime#

getLastSeenTime(): string

-

Defined in src/renderer/api/endpoints/events.api.ts:52

+

Defined in src/renderer/api/endpoints/events.api.ts:52

Returns: string


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSource#

getSource(): string

-

Defined in src/renderer/api/endpoints/events.api.ts:40

+

Defined in src/renderer/api/endpoints/events.api.ts:40

Returns: string


isWarning#

isWarning(): boolean

-

Defined in src/renderer/api/endpoints/events.api.ts:36

+

Defined in src/renderer/api/endpoints/events.api.ts:36

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1609,7 +1609,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1630,7 +1630,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1651,7 +1651,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1672,7 +1672,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1693,7 +1693,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html index 7bf22bc681..9c5b85bd48 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -1187,7 +1187,7 @@

Constructors#

constructor#

+ new KubeObject(data: KubeJsonApiData): KubeObject

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1207,36 +1207,36 @@

Properties#

apiVersion#

apiVersion: string

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


Optional status#

status? : any

-

Defined in src/renderer/api/kube-object.ts:79

+

Defined in src/renderer/api/kube-object.ts:79


Static kind#

kind: string

-

Defined in src/renderer/api/kube-object.ts:47

+

Defined in src/renderer/api/kube-object.ts:47


Static namespaced#

namespaced: boolean

-

Defined in src/renderer/api/kube-object.ts:48

+

Defined in src/renderer/api/kube-object.ts:48

Accessors#

get selfLink(): string

-

Defined in src/renderer/api/kube-object.ts:81

+

Defined in src/renderer/api/kube-object.ts:81

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

-

Defined in src/renderer/api/kube-object.ts:167

+

Defined in src/renderer/api/kube-object.ts:167

Parameters:

@@ -1256,7 +1256,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1288,7 +1288,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1310,52 +1310,52 @@

getFinalizers#

getFinalizers(): string[]

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1377,7 +1377,7 @@

Static create#

create(data: any): KubeObject‹›

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1397,7 +1397,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1417,7 +1417,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1437,7 +1437,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1457,7 +1457,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html index 4cbfa743e1..13a336845b 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -1337,65 +1337,65 @@

Constructors#

constructor#

+ new KubeObjectStore(): KubeObjectStore

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: KubeObjectStore

Properties#

Abstract api#

api: KubeApi‹T›

-

Defined in src/renderer/kube-object.store.ts:13

+

Defined in src/renderer/kube-object.store.ts:13


bufferSize#

bufferSize: number = 50000

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): T[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: T[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1417,7 +1417,7 @@

create#

create(params: object, data?: Partial‹T›): Promise‹T›

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1444,7 +1444,7 @@

Protected createItem#

createItem(params: object, data?: Partial‹T›): Promise‹T›

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1471,7 +1471,7 @@

Protected defaultSorting#

defaultSorting(item: T): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1491,7 +1491,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: T[]): T[]

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1511,7 +1511,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): T[]

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1538,7 +1538,7 @@

getByLabel#

getByLabel(labels: string[] | object): T[]

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1559,7 +1559,7 @@

getByName#

getByName(name: string, namespace?: string): T

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1583,7 +1583,7 @@

getByPath#

getByPath(path: string): T

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1603,7 +1603,7 @@

Optional getStatuses#

getStatuses(items: T[]): Record‹string, number›

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1624,7 +1624,7 @@

isSelected#

isSelected(item: T): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1645,7 +1645,7 @@

isSelectedAll#

isSelectedAll(visibleItems: T[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1667,7 +1667,7 @@

load#

load(params: object): Promise‹T›

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1693,12 +1693,12 @@

loadAll#

loadAll(): Promise‹void›

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1719,7 +1719,7 @@

Protected loadItem#

loadItem(params: object): Promise‹T›

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1745,7 +1745,7 @@

Protected loadItems#

loadItems(allowedNamespaces?: string[]): Promise‹T[]›

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1765,7 +1765,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1785,7 +1785,7 @@

remove#

remove(item: T): Promise‹void›

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1806,7 +1806,7 @@

Protected removeItem#

removeItem(item: T, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: T

request: function

@@ -1816,25 +1816,25 @@

removeSelectedItems#

removeSelectedItems(): Promise‹void[]›

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: T): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1855,7 +1855,7 @@

Protected sortItems#

sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1888,7 +1888,7 @@

subscribe#

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1911,7 +1911,7 @@

toggleSelection#

toggleSelection(item: T): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1932,7 +1932,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: T[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1955,7 +1955,7 @@

unselect#

unselect(item: T): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1975,7 +1975,7 @@

update#

update(item: T, data: Partial‹T›): Promise‹T›

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1999,13 +1999,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: T, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: T

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html index 8e44f0506b..f4ec0f0e05 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -1185,7 +1185,7 @@

constructor#

+ new Namespace(data: KubeJsonApiData): Namespace

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1206,22 +1206,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


Optional status#

status? : object

Overrides KubeObject.status

-

Defined in src/renderer/api/endpoints/namespaces.api.ts:16

+

Defined in src/renderer/api/endpoints/namespaces.api.ts:16

Type declaration:

@@ -1271,7 +1271,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1304,7 +1304,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1327,66 +1327,66 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getStatus#

getStatus(): string

-

Defined in src/renderer/api/endpoints/namespaces.api.ts:20

+

Defined in src/renderer/api/endpoints/namespaces.api.ts:20

Returns: string


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1409,7 +1409,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1430,7 +1430,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1451,7 +1451,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1472,7 +1472,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1493,7 +1493,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html index c6298c366b..665eeaf71e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -1356,80 +1356,80 @@

constructor#

+ new NamespaceStore(): NamespaceStore

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:24

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:24

Returns: NamespaceStore

Properties#

api#

api: KubeApiNamespace‹›› = namespacesApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:23

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:23


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


contextNs#

contextNs: IObservableArray‹string› = observable.array()

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:24

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:24


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

initNamespaces#

get initNamespaces(): string[]

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:43

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:43

Returns: string[]


query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Namespace[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Namespace[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1452,7 +1452,7 @@

create#

create(params: object, data?: Partial‹Namespace›): Promise‹Namespace

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1480,7 +1480,7 @@

createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1507,7 +1507,7 @@

Protected defaultSorting#

defaultSorting(item: Namespace): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1528,7 +1528,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Namespace[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1549,7 +1549,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Namespace[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1577,7 +1577,7 @@

getByLabel#

getByLabel(labels: string[] | object): Namespace[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1599,7 +1599,7 @@

getByName(name: string, namespace?: string): Namespace

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1624,7 +1624,7 @@

getByPath#

getByPath(path: string): Namespace

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1644,7 +1644,7 @@

getContextParams#

getContextParams(): object

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:47

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:47

Returns: object

@@ -1673,7 +1673,7 @@

Optional getStatuses#

getStatuses(items: Namespace[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1693,7 +1693,7 @@

hasContext#

hasContext(namespace: string | string[]): boolean

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:96

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:96

Parameters:

@@ -1714,7 +1714,7 @@

isSelected#

isSelected(item: Namespace): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1735,7 +1735,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Namespace[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1758,7 +1758,7 @@

load#

load(params: object): Promise‹Namespace

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1785,13 +1785,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1813,7 +1813,7 @@

loadItem(params: object): Promise‹Namespace

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1839,7 +1839,7 @@

Protected loadItems#

loadItems(namespaces?: string[]): Promise‹Namespace‹›[]›

Overrides KubeObjectStore.loadItems

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:64

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:64

Parameters:

@@ -1860,7 +1860,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1881,7 +1881,7 @@

remove#

remove(item: Namespace): Promise‹void›

Overrides KubeObjectStore.remove

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:115

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:115

Parameters:

@@ -1902,7 +1902,7 @@

Protected removeItem#

removeItem(item: Namespace, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Namespace

request: function

@@ -1913,25 +1913,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:109

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:109

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Namespace): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1951,7 +1951,7 @@

setContext#

setContext(namespaces: string[]): void

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:92

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:92

Parameters:

@@ -1972,7 +1972,7 @@

Protected sortItems#

sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -2005,7 +2005,7 @@

subscribe#

subscribe(apis: KubeApiNamespace‹››[]): (Anonymous function) | FunctionConstructor

Overrides KubeObjectStore.subscribe

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:53

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:53

Parameters:

@@ -2027,7 +2027,7 @@

toggleContext#

toggleContext(namespace: string): void

-

Defined in src/renderer/components/+namespaces/namespace.store.ts:103

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:103

Parameters:

@@ -2048,7 +2048,7 @@

toggleSelection#

toggleSelection(item: Namespace): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -2069,7 +2069,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Namespace[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2092,7 +2092,7 @@

unselect#

unselect(item: Namespace): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2113,7 +2113,7 @@

update#

update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2138,13 +2138,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Namespace, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Namespace

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html index d90635cdf0..88f9ba88e2 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -1201,7 +1201,7 @@

constructor#

+ new NetworkPolicy(data: KubeJsonApiData): NetworkPolicy

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1222,21 +1222,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/network-policy.api.ts:44

+

Defined in src/renderer/api/endpoints/network-policy.api.ts:44

Type declaration:

@@ -1308,7 +1308,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1341,7 +1341,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1364,71 +1364,71 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getMatchLabels#

getMatchLabels(): string[]

-

Defined in src/renderer/api/endpoints/network-policy.api.ts:56

+

Defined in src/renderer/api/endpoints/network-policy.api.ts:56

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getTypes#

getTypes(): string[]

-

Defined in src/renderer/api/endpoints/network-policy.api.ts:64

+

Defined in src/renderer/api/endpoints/network-policy.api.ts:64

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1451,7 +1451,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1472,7 +1472,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1493,7 +1493,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1514,7 +1514,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1535,7 +1535,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html index 49bc13abbf..2cb1927373 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new NetworkPolicyStore(): NetworkPolicyStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: NetworkPolicyStore

Properties#

api#

api: KubeApiNetworkPolicy‹›› = networkPolicyApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

+

Defined in src/renderer/components/+network-policies/network-policy.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): NetworkPolicy[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: NetworkPolicy[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: NetworkPolicy): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: NetworkPolicy[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): NetworkPolicy[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): NetworkPolicy[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): NetworkPolicy

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): NetworkPolicy

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: NetworkPolicy[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: NetworkPolicy): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: NetworkPolicy[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹NetworkPolicy

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹NetworkPolicy

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹NetworkPolicy[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: NetworkPolicy): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: NetworkPolicy, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: NetworkPolicy

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: NetworkPolicy): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: NetworkPolicy[], sorting?: function[], order?: "asc" | "desc"): NetworkPolicy[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: NetworkPolicy): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: NetworkPolicy[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: NetworkPolicy): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: NetworkPolicy, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: NetworkPolicy

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.node/index.html index e370129689..b3e787f5fa 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.node/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -1273,7 +1273,7 @@

constructor#

+ new Node(data: KubeJsonApiData): Node

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1294,21 +1294,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/nodes.api.ts:37

+

Defined in src/renderer/api/endpoints/nodes.api.ts:37

Type declaration:

@@ -1442,13 +1442,13 @@

getActiveConditions#

getActiveConditions(): object[]

-

Defined in src/renderer/api/endpoints/nodes.api.ts:138

+

Defined in src/renderer/api/endpoints/nodes.api.ts:138

Returns: object[]


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1481,7 +1481,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1503,112 +1503,112 @@

getConditions#

getConditions(): object[]

-

Defined in src/renderer/api/endpoints/nodes.api.ts:128

+

Defined in src/renderer/api/endpoints/nodes.api.ts:128

Returns: object[]


getCpuCapacity#

getCpuCapacity(): number

-

Defined in src/renderer/api/endpoints/nodes.api.ts:116

+

Defined in src/renderer/api/endpoints/nodes.api.ts:116

Returns: number


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getKubeletVersion#

getKubeletVersion(): string

-

Defined in src/renderer/api/endpoints/nodes.api.ts:150

+

Defined in src/renderer/api/endpoints/nodes.api.ts:150

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getMemoryCapacity#

getMemoryCapacity(): number

-

Defined in src/renderer/api/endpoints/nodes.api.ts:122

+

Defined in src/renderer/api/endpoints/nodes.api.ts:122

Returns: number


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeConditionText#

getNodeConditionText(): string

-

Defined in src/renderer/api/endpoints/nodes.api.ts:88

+

Defined in src/renderer/api/endpoints/nodes.api.ts:88

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOperatingSystem#

getOperatingSystem(): string

-

Defined in src/renderer/api/endpoints/nodes.api.ts:154

+

Defined in src/renderer/api/endpoints/nodes.api.ts:154

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getRoleLabels#

getRoleLabels(): string

-

Defined in src/renderer/api/endpoints/nodes.api.ts:104

+

Defined in src/renderer/api/endpoints/nodes.api.ts:104

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getTaints#

getTaints(): object[]

-

Defined in src/renderer/api/endpoints/nodes.api.ts:100

+

Defined in src/renderer/api/endpoints/nodes.api.ts:100

Returns: object[]


getWarningConditions#

getWarningConditions(): object[]

-

Defined in src/renderer/api/endpoints/nodes.api.ts:142

+

Defined in src/renderer/api/endpoints/nodes.api.ts:142

Returns: object[]


isUnschedulable#

isUnschedulable(): boolean

-

Defined in src/renderer/api/endpoints/nodes.api.ts:164

+

Defined in src/renderer/api/endpoints/nodes.api.ts:164

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1631,7 +1631,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1652,7 +1652,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1673,7 +1673,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1694,7 +1694,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1715,7 +1715,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html index edf9ca7978..d3a0798aaa 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -1198,7 +1198,7 @@

constructor#

+ new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

Inherited from KubeApi.constructor

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1219,84 +1219,84 @@

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

Inherited from KubeApi.kind

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹Node

Inherited from KubeApi.objectConstructor

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹Node

Inherited from KubeApi.options

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

Inherited from KubeApi.create

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1326,7 +1326,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1355,7 +1355,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node

Inherited from KubeApi.get

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1384,13 +1384,13 @@

getMetrics#

getMetrics(): Promise‹INodeMetrics›

-

Defined in src/renderer/api/endpoints/nodes.api.ts:7

+

Defined in src/renderer/api/endpoints/nodes.api.ts:7

Returns: Promise‹INodeMetrics›


getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1413,7 +1413,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1443,7 +1443,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1471,7 +1471,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

Inherited from KubeApi.list

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1496,7 +1496,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1519,7 +1519,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1544,7 +1544,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1566,7 +1566,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1594,7 +1594,7 @@

update#

update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

Inherited from KubeApi.update

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1624,14 +1624,14 @@

watch#

watch(): function

Inherited from KubeApi.watch

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html index c24a5f4e99..40ee93a386 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -1372,97 +1372,97 @@

constructor#

+ new NodesStore(): NodesStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: NodesStore

Properties#

api#

api: NodesApi‹› = nodesApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+nodes/nodes.store.ts:9

+

Defined in src/renderer/components/+nodes/nodes.store.ts:9


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: Partial‹INodeMetrics›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:11

+

Defined in src/renderer/components/+nodes/nodes.store.ts:11


metricsLoaded#

metricsLoaded: boolean = false

-

Defined in src/renderer/components/+nodes/nodes.store.ts:14

+

Defined in src/renderer/components/+nodes/nodes.store.ts:14


metricsLoading#

metricsLoading: boolean = false

-

Defined in src/renderer/components/+nodes/nodes.store.ts:13

+

Defined in src/renderer/components/+nodes/nodes.store.ts:13


nodeMetrics#

nodeMetrics: Partial‹IClusterMetrics› = null

-

Defined in src/renderer/components/+nodes/nodes.store.ts:12

+

Defined in src/renderer/components/+nodes/nodes.store.ts:12


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

masterNodes#

get masterNodes(): Node‹›[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:33

+

Defined in src/renderer/components/+nodes/nodes.store.ts:33

Returns: Node‹›[]


query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Node[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Node[]


workerNodes#

get workerNodes(): Node‹›[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:37

+

Defined in src/renderer/components/+nodes/nodes.store.ts:37

Returns: Node‹›[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1485,7 +1485,7 @@

create#

create(params: object, data?: Partial‹Node›): Promise‹Node

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1513,7 +1513,7 @@

createItem(params: object, data?: Partial‹Node›): Promise‹Node

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1540,7 +1540,7 @@

Protected defaultSorting#

defaultSorting(item: Node): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1561,7 +1561,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Node[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1582,7 +1582,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Node[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1610,7 +1610,7 @@

getByLabel#

getByLabel(labels: string[] | object): Node[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1632,7 +1632,7 @@

getByName(name: string, namespace?: string): Node

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1657,7 +1657,7 @@

getByPath#

getByPath(path: string): Node

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1677,7 +1677,7 @@

getLastMetricValues#

getLastMetricValues(node: Node, metricNames: string[]): number[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:41

+

Defined in src/renderer/components/+nodes/nodes.store.ts:41

Parameters:

@@ -1702,7 +1702,7 @@

Optional getStatuses#

getStatuses(items: Node[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1723,7 +1723,7 @@

isSelected#

isSelected(item: Node): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1744,7 +1744,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Node[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1767,7 +1767,7 @@

load#

load(params: object): Promise‹Node

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1794,13 +1794,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1822,7 +1822,7 @@

loadItem(params: object): Promise‹Node

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1849,7 +1849,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Node[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1869,7 +1869,7 @@

loadMetrics#

loadMetrics(nodeName: string): Promise‹void›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:29

+

Defined in src/renderer/components/+nodes/nodes.store.ts:29

Parameters:

@@ -1889,13 +1889,13 @@

loadUsageMetrics#

loadUsageMetrics(): Promise‹void›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:17

+

Defined in src/renderer/components/+nodes/nodes.store.ts:17

Returns: Promise‹void›


Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1916,7 +1916,7 @@

remove#

remove(item: Node): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1937,7 +1937,7 @@

Protected removeItem#

removeItem(item: Node, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Node

request: function

@@ -1948,25 +1948,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+nodes/nodes.store.ts:65

+

Defined in src/renderer/components/+nodes/nodes.store.ts:65

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Node): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1987,7 +1987,7 @@

Protected sortItems#

sortItems(items: Node[], sorting?: function[], order?: "asc" | "desc"): Node[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -2021,7 +2021,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -2044,7 +2044,7 @@

toggleSelection#

toggleSelection(item: Node): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -2065,7 +2065,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Node[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2088,7 +2088,7 @@

unselect#

unselect(item: Node): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2109,7 +2109,7 @@

update#

update(item: Node, data: Partial‹Node›): Promise‹Node

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2134,13 +2134,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Node, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Node

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html index 768d4866d3..0f944be212 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -1209,7 +1209,7 @@

constructor#

+ new PersistentVolume(data: KubeJsonApiData): PersistentVolume

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1230,21 +1230,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

Type declaration:

@@ -1378,7 +1378,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1411,7 +1411,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1433,7 +1433,7 @@

getCapacity#

getCapacity(inBytes: boolean): string | number

-

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

Parameters:

@@ -1455,72 +1455,72 @@

getClaimRefName#

getClaimRefName(): string

-

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

Returns: string


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getStatus#

getStatus(): string

-

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

Returns: string


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1543,7 +1543,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1564,7 +1564,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1585,7 +1585,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1606,7 +1606,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1627,7 +1627,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html index e7e7a01a93..5c70834e1e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -1225,7 +1225,7 @@

constructor#

+ new PersistentVolumeClaim(data: KubeJsonApiData): PersistentVolumeClaim

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1246,21 +1246,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

Type declaration:

@@ -1345,7 +1345,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1378,7 +1378,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1401,52 +1401,52 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getMatchExpressions#

getMatchExpressions(): object[]

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

Returns: object[]


getMatchLabels#

getMatchLabels(): string[]

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getPods#

getPods(allPods: Pod[]): Pod[]

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

Parameters:

@@ -1467,35 +1467,35 @@

getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getStatus#

getStatus(): string

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

Returns: string


getStorage#

getStorage(): string

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

Returns: string


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1518,7 +1518,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1539,7 +1539,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1560,7 +1560,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1581,7 +1581,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1602,7 +1602,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html index 891ec62bb5..a7c94dcb48 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -1198,7 +1198,7 @@

constructor#

+ new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

Inherited from KubeApi.constructor

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1219,84 +1219,84 @@

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

Inherited from KubeApi.kind

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim

Inherited from KubeApi.objectConstructor

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹PersistentVolumeClaim

Inherited from KubeApi.options

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

Inherited from KubeApi.create

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1326,7 +1326,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1355,7 +1355,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim

Inherited from KubeApi.get

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1384,7 +1384,7 @@

getMetrics#

getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

-

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

+

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

Parameters:

@@ -1409,7 +1409,7 @@

getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1432,7 +1432,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1462,7 +1462,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1490,7 +1490,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[]›

Inherited from KubeApi.list

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1515,7 +1515,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1538,7 +1538,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1563,7 +1563,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1585,7 +1585,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1613,7 +1613,7 @@

update#

update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

Inherited from KubeApi.update

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1643,14 +1643,14 @@

watch#

watch(): function

Inherited from KubeApi.watch

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html index b0dfab407e..c7d423c23a 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new PersistentVolumesStore(): PersistentVolumesStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: PersistentVolumesStore

Properties#

api#

api: KubeApiPersistentVolume‹›› = persistentVolumeApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-volumes/volumes.store.ts:8

+

Defined in src/renderer/components/+storage-volumes/volumes.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): PersistentVolume[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: PersistentVolume[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: PersistentVolume): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: PersistentVolume[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): PersistentVolume[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): PersistentVolume

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): PersistentVolume

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: PersistentVolume[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: PersistentVolume): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: PersistentVolume[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹PersistentVolume

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹PersistentVolume

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolume[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: PersistentVolume): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: PersistentVolume, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: PersistentVolume

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: PersistentVolume): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: PersistentVolume[], sorting?: function[], order?: "asc" | "desc"): PersistentVolume[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: PersistentVolume): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: PersistentVolume[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: PersistentVolume): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: PersistentVolume, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: PersistentVolume

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html index 7850516ea6..dcd760d485 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -1409,7 +1409,7 @@

constructor#

+ new Pod(data: KubeJsonApiData): Pod

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1430,22 +1430,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/pods.api.ts:187

+

Defined in src/renderer/api/endpoints/pods.api.ts:187

Type declaration:

@@ -1613,19 +1613,19 @@

getAffinity#

getAffinity(): IAffinity

Overrides Deployment.getAffinity

-

Defined in src/renderer/api/endpoints/pods.api.ts:404

+

Defined in src/renderer/api/endpoints/pods.api.ts:404

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:78

+

Defined in src/renderer/api/workload-kube-object.ts:78

Returns: number


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1657,13 +1657,13 @@

getAllContainers#

getAllContainers(): IPodContainer[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:269

+

Defined in src/renderer/api/endpoints/pods.api.ts:269

Returns: IPodContainer[]


getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1685,12 +1685,12 @@

getConditions#

getConditions(): object[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:378

+

Defined in src/renderer/api/endpoints/pods.api.ts:378

Returns: object[]


getContainerStatuses#

getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:282

+

Defined in src/renderer/api/endpoints/pods.api.ts:282

Parameters:

@@ -1712,35 +1712,35 @@

getContainers#

getContainers(): IPodContainer[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:265

+

Defined in src/renderer/api/endpoints/pods.api.ts:265

Returns: IPodContainer[]


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getInitContainers#

getInitContainers(): IPodContainer[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:261

+

Defined in src/renderer/api/endpoints/pods.api.ts:261

Returns: IPodContainer[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getLivenessProbe#

getLivenessProbe(container: IPodContainer): string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:425

+

Defined in src/renderer/api/endpoints/pods.api.ts:425

Parameters:

@@ -1761,40 +1761,40 @@

getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeName#

getNodeName(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:475

+

Defined in src/renderer/api/endpoints/pods.api.ts:475

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Overrides Deployment.getNodeSelectors

-

Defined in src/renderer/api/endpoints/pods.api.ts:392

+

Defined in src/renderer/api/endpoints/pods.api.ts:392

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getPriorityClassName#

getPriorityClassName(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:313

+

Defined in src/renderer/api/endpoints/pods.api.ts:313

Returns: string


getProbe#

getProbe(probeData: IContainerProbe): string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:437

+

Defined in src/renderer/api/endpoints/pods.api.ts:437

Parameters:

@@ -1814,12 +1814,12 @@

getQosClass#

getQosClass(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:305

+

Defined in src/renderer/api/endpoints/pods.api.ts:305

Returns: string


getReadinessProbe#

getReadinessProbe(container: IPodContainer): string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:429

+

Defined in src/renderer/api/endpoints/pods.api.ts:429

Parameters:

@@ -1839,50 +1839,50 @@

getReason#

getReason(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:309

+

Defined in src/renderer/api/endpoints/pods.api.ts:309

Returns: string


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getRestartsCount#

getRestartsCount(): number

-

Defined in src/renderer/api/endpoints/pods.api.ts:297

+

Defined in src/renderer/api/endpoints/pods.api.ts:297

Returns: number


getRunningContainers#

getRunningContainers(): IPodContainer[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:273

+

Defined in src/renderer/api/endpoints/pods.api.ts:273

Returns: IPodContainer[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSecrets#

getSecrets(): string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:386

+

Defined in src/renderer/api/endpoints/pods.api.ts:386

Returns: string[]


getSelectedNodeOs#

getSelectedNodeOs(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:479

+

Defined in src/renderer/api/endpoints/pods.api.ts:479

Returns: string


getSelectors#

getSelectors(): string[]

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:52

+

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getStartupProbe#

getStartupProbe(container: IPodContainer): string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:433

+

Defined in src/renderer/api/endpoints/pods.api.ts:433

Parameters:

@@ -1902,51 +1902,51 @@

getStatus#

getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

-

Defined in src/renderer/api/endpoints/pods.api.ts:318

+

Defined in src/renderer/api/endpoints/pods.api.ts:318

Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED


getStatusMessage#

getStatusMessage(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:345

+

Defined in src/renderer/api/endpoints/pods.api.ts:345

Returns: string


getStatusPhase#

getStatusPhase(): string

-

Defined in src/renderer/api/endpoints/pods.api.ts:374

+

Defined in src/renderer/api/endpoints/pods.api.ts:374

Returns: string


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:64

+

Defined in src/renderer/api/workload-kube-object.ts:64

Returns: string[]


getTolerations#

getTolerations(): object[]

Overrides Deployment.getTolerations

-

Defined in src/renderer/api/endpoints/pods.api.ts:400

+

Defined in src/renderer/api/endpoints/pods.api.ts:400

Returns: object[]


getVolumes#

getVolumes(): object[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:382

+

Defined in src/renderer/api/endpoints/pods.api.ts:382

Returns: object[]


hasIssues#

hasIssues(): boolean

-

Defined in src/renderer/api/endpoints/pods.api.ts:408

+

Defined in src/renderer/api/endpoints/pods.api.ts:408

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1969,7 +1969,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1990,7 +1990,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -2011,7 +2011,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -2032,7 +2032,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -2053,7 +2053,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html index daab326a98..8593e2936c 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -1225,7 +1225,7 @@

constructor#

+ new PodDisruptionBudget(data: KubeJsonApiData): PodDisruptionBudget

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1246,21 +1246,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

Type declaration:

@@ -1341,7 +1341,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1374,7 +1374,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1396,87 +1396,87 @@

getCurrentHealthy#

getCurrentHealthy(): number

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

Returns: number


getDesiredHealthy#

getDesiredHealthy(): number

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

Returns: number


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getMaxUnavailable#

getMaxUnavailable(): string

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

Returns: string


getMinAvailable#

getMinAvailable(): string

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

Returns: string


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSelectors#

getSelectors(): string[]

-

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1499,7 +1499,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1520,7 +1520,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1541,7 +1541,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1562,7 +1562,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1583,7 +1583,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html index e7d51dfcaf..fd42faada2 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: PodDisruptionBudgetsStore

Properties#

api#

api: KubeApiPodDisruptionBudget‹›› = pdbApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

+

Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): PodDisruptionBudget[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: PodDisruptionBudget[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: PodDisruptionBudget): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): PodDisruptionBudget[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): PodDisruptionBudget

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): PodDisruptionBudget

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: PodDisruptionBudget): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹PodDisruptionBudget

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹PodDisruptionBudget

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹PodDisruptionBudget[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: PodDisruptionBudget): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: PodDisruptionBudget

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: PodDisruptionBudget): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: PodDisruptionBudget[], sorting?: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: PodDisruptionBudget): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: PodDisruptionBudget): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: PodDisruptionBudget

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html index db8271b549..5cf9cc37fa 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -1206,7 +1206,7 @@

constructor#

+ new PodsApi(options: IKubeApiOptions‹Pod›): PodsApi

Inherited from KubeApi.constructor

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114

Parameters:

@@ -1227,84 +1227,84 @@

apiBase#

apiBase: string

Inherited from KubeApi.apiBase

-

Defined in src/renderer/api/kube-api.ts:104

+

Defined in src/renderer/api/kube-api.ts:104


apiGroup#

apiGroup: string

Inherited from KubeApi.apiGroup

-

Defined in src/renderer/api/kube-api.ts:106

+

Defined in src/renderer/api/kube-api.ts:106


apiPrefix#

apiPrefix: string

Inherited from KubeApi.apiPrefix

-

Defined in src/renderer/api/kube-api.ts:105

+

Defined in src/renderer/api/kube-api.ts:105


apiResource#

apiResource: string

Inherited from KubeApi.apiResource

-

Defined in src/renderer/api/kube-api.ts:109

+

Defined in src/renderer/api/kube-api.ts:109


apiVersion#

apiVersion: string

Inherited from KubeApi.apiVersion

-

Defined in src/renderer/api/kube-api.ts:107

+

Defined in src/renderer/api/kube-api.ts:107


Optional apiVersionPreferred#

apiVersionPreferred? : string

Inherited from KubeApi.apiVersionPreferred

-

Defined in src/renderer/api/kube-api.ts:108

+

Defined in src/renderer/api/kube-api.ts:108


isNamespaced#

isNamespaced: boolean

Inherited from KubeApi.isNamespaced

-

Defined in src/renderer/api/kube-api.ts:110

+

Defined in src/renderer/api/kube-api.ts:110


kind#

kind: string

Inherited from KubeApi.kind

-

Defined in src/renderer/api/kube-api.ts:103

+

Defined in src/renderer/api/kube-api.ts:103


objectConstructor#

objectConstructor: IKubeObjectConstructor‹Pod

Inherited from KubeApi.objectConstructor

-

Defined in src/renderer/api/kube-api.ts:112

+

Defined in src/renderer/api/kube-api.ts:112


Protected options#

options: IKubeApiOptions‹Pod

Inherited from KubeApi.options

-

Defined in src/renderer/api/kube-api.ts:116

+

Defined in src/renderer/api/kube-api.ts:116


Protected request#

request: KubeJsonApi

Inherited from KubeApi.request

-

Defined in src/renderer/api/kube-api.ts:113

+

Defined in src/renderer/api/kube-api.ts:113


Protected resourceVersions#

resourceVersions: Map‹string, string› = new Map()

Inherited from KubeApi.resourceVersions

-

Defined in src/renderer/api/kube-api.ts:114

+

Defined in src/renderer/api/kube-api.ts:114


Static parseApi#

parseApi: parseKubeApi = parseKubeApi

Inherited from KubeApi.parseApi

-

Defined in src/renderer/api/kube-api.ts:95

+

Defined in src/renderer/api/kube-api.ts:95

Accessors#

apiVersionWithGroup#

get apiVersionWithGroup(): string

Inherited from KubeApi.apiVersionWithGroup

-

Defined in src/renderer/api/kube-api.ts:144

+

Defined in src/renderer/api/kube-api.ts:144

Returns: string

Methods#

Protected checkPreferredVersion#

checkPreferredVersion(): Promise‹void›

Inherited from KubeApi.checkPreferredVersion

-

Defined in src/renderer/api/kube-api.ts:206

+

Defined in src/renderer/api/kube-api.ts:206

Returns: Promise‹void›


create#

create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

Inherited from KubeApi.create

-

Defined in src/renderer/api/kube-api.ts:326

+

Defined in src/renderer/api/kube-api.ts:326

Parameters:

Default value __namedParameters: object= {}

@@ -1334,7 +1334,7 @@

delete#

delete(__namedParameters: object): Promise‹KubeJsonApiData›

Inherited from KubeApi.delete

-

Defined in src/renderer/api/kube-api.ts:353

+

Defined in src/renderer/api/kube-api.ts:353

Parameters:

__namedParameters: object

@@ -1363,7 +1363,7 @@

get#

get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod

Inherited from KubeApi.get

-

Defined in src/renderer/api/kube-api.ts:318

+

Defined in src/renderer/api/kube-api.ts:318

Parameters:

Default value __namedParameters: object= {}

@@ -1392,7 +1392,7 @@

getLogs#

getLogs(params: object, query?: IPodLogsQuery): Promise‹string›

-

Defined in src/renderer/api/endpoints/pods.api.ts:7

+

Defined in src/renderer/api/endpoints/pods.api.ts:7

Parameters:

params: object

@@ -1418,7 +1418,7 @@

getMetrics#

getMetrics(pods: Pod[], namespace: string, selector: string): Promise‹IPodMetrics›

-

Defined in src/renderer/api/endpoints/pods.api.ts:13

+

Defined in src/renderer/api/endpoints/pods.api.ts:13

Parameters:

@@ -1451,7 +1451,7 @@

getResourceVersion#

getResourceVersion(namespace: string): string

Inherited from KubeApi.getResourceVersion

-

Defined in src/renderer/api/kube-api.ts:239

+

Defined in src/renderer/api/kube-api.ts:239

Parameters:

@@ -1474,7 +1474,7 @@

getUrl#

getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

Inherited from KubeApi.getUrl

-

Defined in src/renderer/api/kube-api.ts:247

+

Defined in src/renderer/api/kube-api.ts:247

Parameters:

Default value __namedParameters: object= {}

@@ -1504,7 +1504,7 @@

getWatchUrl#

getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

Inherited from KubeApi.getWatchUrl

-

Defined in src/renderer/api/kube-api.ts:360

+

Defined in src/renderer/api/kube-api.ts:360

Parameters:

@@ -1532,7 +1532,7 @@

list#

list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[]›

Inherited from KubeApi.list

-

Defined in src/renderer/api/kube-api.ts:310

+

Defined in src/renderer/api/kube-api.ts:310

Parameters:

Default value __namedParameters: object= {}

@@ -1557,7 +1557,7 @@

Protected normalizeQuery#

normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

Inherited from KubeApi.normalizeQuery

-

Defined in src/renderer/api/kube-api.ts:259

+

Defined in src/renderer/api/kube-api.ts:259

Parameters:

@@ -1580,7 +1580,7 @@

Protected parseResponse#

parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

Inherited from KubeApi.parseResponse

-

Defined in src/renderer/api/kube-api.ts:271

+

Defined in src/renderer/api/kube-api.ts:271

Parameters:

@@ -1605,7 +1605,7 @@

refreshResourceVersion#

refreshResourceVersion(params?: object): Promise‹T[]›

Inherited from KubeApi.refreshResourceVersion

-

Defined in src/renderer/api/kube-api.ts:243

+

Defined in src/renderer/api/kube-api.ts:243

Parameters:

Optional params: object

@@ -1627,7 +1627,7 @@

setResourceVersion#

setResourceVersion(namespace: string, newVersion: string): void

Inherited from KubeApi.setResourceVersion

-

Defined in src/renderer/api/kube-api.ts:235

+

Defined in src/renderer/api/kube-api.ts:235

Parameters:

@@ -1655,7 +1655,7 @@

update#

update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

Inherited from KubeApi.update

-

Defined in src/renderer/api/kube-api.ts:344

+

Defined in src/renderer/api/kube-api.ts:344

Parameters:

Default value __namedParameters: object= {}

@@ -1685,14 +1685,14 @@

watch#

watch(): function

Inherited from KubeApi.watch

-

Defined in src/renderer/api/kube-api.ts:368

+

Defined in src/renderer/api/kube-api.ts:368

Returns: function

▸ (): void


Static watchAll#

watchAll(...apis: KubeApi[]): (Anonymous function)

Inherited from KubeApi.watchAll

-

Defined in src/renderer/api/kube-api.ts:97

+

Defined in src/renderer/api/kube-api.ts:97

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html index 655b1f2cbb..e88dbd3ecf 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -1364,79 +1364,79 @@

constructor#

+ new PodsStore(): PodsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: PodsStore

Properties#

api#

api: PodsApi‹› = podsApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:11


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


kubeMetrics#

kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:14


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:13


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Pod[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Pod[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1459,7 +1459,7 @@

create#

create(params: object, data?: Partial‹Pod›): Promise‹Pod

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1487,7 +1487,7 @@

createItem(params: object, data?: Partial‹Pod›): Promise‹Pod

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1514,7 +1514,7 @@

Protected defaultSorting#

defaultSorting(item: Pod): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1535,7 +1535,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Pod[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1556,7 +1556,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Pod[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1584,7 +1584,7 @@

getByLabel#

getByLabel(labels: string[] | object): Pod[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1606,7 +1606,7 @@

getByName(name: string, namespace?: string): Pod

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1631,7 +1631,7 @@

getByPath#

getByPath(path: string): Pod

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1651,7 +1651,7 @@

getPodKubeMetrics#

getPodKubeMetrics(pod: Pod): object

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:57

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:57

Parameters:

@@ -1679,7 +1679,7 @@

getPodsByNode#

getPodsByNode(node: string): Pod‹›[]

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

Parameters:

@@ -1699,7 +1699,7 @@

getPodsByOwner#

getPodsByOwner(workload: WorkloadKubeObject): Pod[]

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

Parameters:

@@ -1720,7 +1720,7 @@

getStatuses#

getStatuses(pods: Pod[]): Dictionary‹number›

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

Parameters:

@@ -1741,7 +1741,7 @@

isSelected#

isSelected(item: Pod): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1762,7 +1762,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Pod[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1785,7 +1785,7 @@

load#

load(params: object): Promise‹Pod

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1812,12 +1812,12 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadContainerMetrics#

loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

Parameters:

@@ -1838,7 +1838,7 @@

loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1860,7 +1860,7 @@

loadItem(params: object): Promise‹Pod

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1887,7 +1887,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Pod[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1907,7 +1907,7 @@

loadKubeMetrics#

loadKubeMetrics(namespace?: string): Promise‹void›

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

Parameters:

@@ -1927,7 +1927,7 @@

loadMetrics#

loadMetrics(pod: Pod): Promise‹void›

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

Parameters:

@@ -1948,7 +1948,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1969,7 +1969,7 @@

remove#

remove(item: Pod): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1990,7 +1990,7 @@

Protected removeItem#

removeItem(item: Pod, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Pod

request: function

@@ -2001,25 +2001,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:86

+

Defined in src/renderer/components/+workloads-pods/pods.store.ts:86

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Pod): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -2040,7 +2040,7 @@

Protected sortItems#

sortItems(items: Pod[], sorting?: function[], order?: "asc" | "desc"): Pod[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -2074,7 +2074,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -2097,7 +2097,7 @@

toggleSelection#

toggleSelection(item: Pod): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -2118,7 +2118,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Pod[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2141,7 +2141,7 @@

unselect#

unselect(item: Pod): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2162,7 +2162,7 @@

update#

update(item: Pod, data: Partial‹Pod›): Promise‹Pod

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2187,13 +2187,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Pod, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Pod

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html index 7c061bdc8c..18c515042d 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -1265,7 +1265,7 @@

constructor#

+ new ReplicaSet(data: KubeJsonApiData): ReplicaSet

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1286,22 +1286,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/replica-set.api.ts:35

+

Defined in src/renderer/api/endpoints/replica-set.api.ts:35

Type declaration:

@@ -1405,19 +1405,19 @@

getAffinity#

getAffinity(): IAffinity

Inherited from Deployment.getAffinity

-

Defined in src/renderer/api/workload-kube-object.ts:74

+

Defined in src/renderer/api/workload-kube-object.ts:74

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:78

+

Defined in src/renderer/api/workload-kube-object.ts:78

Returns: number


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1450,7 +1450,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1472,106 +1472,106 @@

getCurrent#

getCurrent(): number

-

Defined in src/renderer/api/endpoints/replica-set.api.ts:68

+

Defined in src/renderer/api/endpoints/replica-set.api.ts:68

Returns: number


getDesired#

getDesired(): number

-

Defined in src/renderer/api/endpoints/replica-set.api.ts:64

+

Defined in src/renderer/api/endpoints/replica-set.api.ts:64

Returns: number


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getImages#

getImages(): string[]

-

Defined in src/renderer/api/endpoints/replica-set.api.ts:76

+

Defined in src/renderer/api/endpoints/replica-set.api.ts:76

Returns: string[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Inherited from Deployment.getNodeSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:58

+

Defined in src/renderer/api/workload-kube-object.ts:58

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getReady#

getReady(): number

-

Defined in src/renderer/api/endpoints/replica-set.api.ts:72

+

Defined in src/renderer/api/endpoints/replica-set.api.ts:72

Returns: number


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSelectors#

getSelectors(): string[]

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:52

+

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:64

+

Defined in src/renderer/api/workload-kube-object.ts:64

Returns: string[]


getTolerations#

getTolerations(): IToleration[]

Inherited from Deployment.getTolerations

-

Defined in src/renderer/api/workload-kube-object.ts:70

+

Defined in src/renderer/api/workload-kube-object.ts:70

Returns: IToleration[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1594,7 +1594,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1615,7 +1615,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1636,7 +1636,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1657,7 +1657,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1678,7 +1678,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html index 856c0804a1..1413561525 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -1332,75 +1332,75 @@

constructor#

+ new ReplicaSetStore(): ReplicaSetStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: ReplicaSetStore

Properties#

api#

api: ReplicaSetApi‹› = replicaSetApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): ReplicaSet[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: ReplicaSet[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1423,7 +1423,7 @@

create#

create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1451,7 +1451,7 @@

createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1478,7 +1478,7 @@

Protected defaultSorting#

defaultSorting(item: ReplicaSet): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1499,7 +1499,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: ReplicaSet[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1520,7 +1520,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1548,7 +1548,7 @@

getByLabel#

getByLabel(labels: string[] | object): ReplicaSet[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1570,7 +1570,7 @@

getByName(name: string, namespace?: string): ReplicaSet

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1595,7 +1595,7 @@

getByPath#

getByPath(path: string): ReplicaSet

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1615,7 +1615,7 @@

getChildPods#

getChildPods(replicaSet: ReplicaSet): Pod‹›[]

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

Parameters:

@@ -1635,7 +1635,7 @@

getReplicaSetsByOwner#

getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

Parameters:

@@ -1656,7 +1656,7 @@

getStatuses#

getStatuses(replicaSets: ReplicaSet[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

Parameters:

@@ -1688,7 +1688,7 @@

isSelected#

isSelected(item: ReplicaSet): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1709,7 +1709,7 @@

isSelectedAll#

isSelectedAll(visibleItems: ReplicaSet[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1732,7 +1732,7 @@

load#

load(params: object): Promise‹ReplicaSet

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1759,13 +1759,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1787,7 +1787,7 @@

loadItem(params: object): Promise‹ReplicaSet

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1814,7 +1814,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹ReplicaSet[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1834,7 +1834,7 @@

loadMetrics#

loadMetrics(replicaSet: ReplicaSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

Parameters:

@@ -1855,7 +1855,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1876,7 +1876,7 @@

remove#

remove(item: ReplicaSet): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1897,7 +1897,7 @@

Protected removeItem#

removeItem(item: ReplicaSet, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: ReplicaSet

request: function

@@ -1908,25 +1908,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

+

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: ReplicaSet): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1947,7 +1947,7 @@

Protected sortItems#

sortItems(items: ReplicaSet[], sorting?: function[], order?: "asc" | "desc"): ReplicaSet[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1981,7 +1981,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -2004,7 +2004,7 @@

toggleSelection#

toggleSelection(item: ReplicaSet): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -2025,7 +2025,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: ReplicaSet[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2048,7 +2048,7 @@

unselect#

unselect(item: ReplicaSet): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2069,7 +2069,7 @@

update#

update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2094,13 +2094,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: ReplicaSet, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: ReplicaSet

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html index 2c0731e395..b132958585 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -1193,7 +1193,7 @@

constructor#

+ new ResourceQuota(data: KubeJsonApiData): ResourceQuota

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

+

Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

Parameters:

@@ -1214,21 +1214,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

+

Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

Type declaration:

@@ -1300,7 +1300,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1333,7 +1333,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1356,66 +1356,66 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getScopeSelector#

getScopeSelector(): object[]

-

Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

+

Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

Returns: object[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1438,7 +1438,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1459,7 +1459,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1480,7 +1480,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1501,7 +1501,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1522,7 +1522,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html index b4fc949eae..0598030c06 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new ResourceQuotasStore(): ResourceQuotasStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: ResourceQuotasStore

Properties#

api#

api: KubeApiResourceQuota‹›› = resourceQuotaApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

+

Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): ResourceQuota[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: ResourceQuota[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: ResourceQuota): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: ResourceQuota[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): ResourceQuota[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): ResourceQuota

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): ResourceQuota

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: ResourceQuota[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: ResourceQuota): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: ResourceQuota[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹ResourceQuota

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹ResourceQuota

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹ResourceQuota[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: ResourceQuota): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: ResourceQuota, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: ResourceQuota

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: ResourceQuota): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: ResourceQuota[], sorting?: function[], order?: "asc" | "desc"): ResourceQuota[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: ResourceQuota): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: ResourceQuota[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: ResourceQuota): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: ResourceQuota, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: ResourceQuota

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.role/index.html index daf7707e46..1e74aad91e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.role/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -1194,7 +1194,7 @@

constructor#

+ new Role(data: KubeJsonApiData): Role

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1215,51 +1215,51 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


rules#

rules: object[]

-

Defined in src/renderer/api/endpoints/role.api.ts:9

+

Defined in src/renderer/api/endpoints/role.api.ts:9


Optional status#

status? : any

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:79

+

Defined in src/renderer/api/kube-object.ts:79


Static apiBase#

apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

-

Defined in src/renderer/api/endpoints/role.api.ts:7

+

Defined in src/renderer/api/endpoints/role.api.ts:7


Static kind#

kind: string = "Role"

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/role.api.ts:5

+

Defined in src/renderer/api/endpoints/role.api.ts:5


Static namespaced#

namespaced: boolean = true

Overrides KubeObject.namespaced

-

Defined in src/renderer/api/endpoints/role.api.ts:6

+

Defined in src/renderer/api/endpoints/role.api.ts:6

Accessors#

get selfLink(): string

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:81

+

Defined in src/renderer/api/kube-object.ts:81

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:167

+

Defined in src/renderer/api/kube-object.ts:167

Parameters:

@@ -1280,7 +1280,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1313,7 +1313,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1336,66 +1336,66 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getRules#

getRules(): object[]

-

Defined in src/renderer/api/endpoints/role.api.ts:16

+

Defined in src/renderer/api/endpoints/role.api.ts:16

Returns: object[]


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1418,7 +1418,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1439,7 +1439,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1460,7 +1460,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1481,7 +1481,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1502,7 +1502,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html index c6ed12615e..9b925c82d0 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -1210,7 +1210,7 @@

constructor#

+ new RoleBinding(data: KubeJsonApiData): RoleBinding

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1231,21 +1231,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


roleRef#

roleRef: object

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:19

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:19

Type declaration:

@@ -1312,7 +1312,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1345,7 +1345,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1368,71 +1368,71 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSubjectNames#

getSubjectNames(): string

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:29

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:29

Returns: string


getSubjects#

getSubjects(): IRoleBindingSubject[]

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:25

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:25

Returns: IRoleBindingSubject[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1455,7 +1455,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1476,7 +1476,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1497,7 +1497,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1518,7 +1518,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1539,7 +1539,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html index bc67421ac2..5c6c651a97 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -1308,71 +1308,71 @@

constructor#

+ new RoleBindingsStore(): RoleBindingsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: RoleBindingsStore

Properties#

api#

api: KubeApiClusterRoleBinding‹›› = clusterRoleBindingApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): RoleBinding[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: RoleBinding[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1395,7 +1395,7 @@

create#

create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1422,7 +1422,7 @@

Protected createItem#

createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

Overrides KubeObjectStore.createItem

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:40

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:40

Parameters:

params: object

@@ -1449,7 +1449,7 @@

Protected defaultSorting#

defaultSorting(item: RoleBinding): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1470,7 +1470,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: RoleBinding[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1491,7 +1491,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1519,7 +1519,7 @@

getByLabel#

getByLabel(labels: string[] | object): RoleBinding[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1541,7 +1541,7 @@

getByName(name: string, namespace?: string): RoleBinding

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1566,7 +1566,7 @@

getByPath#

getByPath(path: string): RoleBinding

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1587,7 +1587,7 @@

Optional getStatuses#

getStatuses(items: RoleBinding[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1608,7 +1608,7 @@

isSelected#

isSelected(item: RoleBinding): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1629,7 +1629,7 @@

isSelectedAll#

isSelectedAll(visibleItems: RoleBinding[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1652,7 +1652,7 @@

load#

load(params: object): Promise‹RoleBinding

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1679,13 +1679,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1706,7 +1706,7 @@

Protected loadItem#

loadItem(params: object): Promise‹RoleBinding‹››

Overrides KubeObjectStore.loadItem

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

Parameters:

params: object

@@ -1732,7 +1732,7 @@

Protected loadItems#

loadItems(namespaces?: string[]): Promise‹RoleBinding‹›[]›

Overrides KubeObjectStore.loadItems

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

Parameters:

@@ -1753,7 +1753,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1774,7 +1774,7 @@

remove#

remove(item: RoleBinding): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1795,7 +1795,7 @@

Protected removeItem#

removeItem(item: RoleBinding, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: RoleBinding

request: function

@@ -1806,25 +1806,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: RoleBinding): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1845,7 +1845,7 @@

Protected sortItems#

sortItems(items: RoleBinding[]): RoleBinding‹›[]

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

Parameters:

@@ -1866,13 +1866,13 @@

subscribe#

subscribe(): (Anonymous function)

Overrides KubeObjectStore.subscribe

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

Returns: (Anonymous function)


toggleSelection#

toggleSelection(item: RoleBinding): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1893,7 +1893,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: RoleBinding[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1916,7 +1916,7 @@

unselect#

unselect(item: RoleBinding): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1937,7 +1937,7 @@

update#

update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1962,13 +1962,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: RoleBinding, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: RoleBinding

request: function

@@ -1977,7 +1977,7 @@

updateSubjects#

updateSubjects(params: object): Promise‹RoleBinding‹››

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

Parameters:

params: object

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html index aca953d8ef..cb15ac904e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new RolesStore(): RolesStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: RolesStore

Properties#

api#

api: KubeApiClusterRole‹›› = clusterRoleApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Role[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Role[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹Role›): Promise‹Role

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1414,7 +1414,7 @@

Protected createItem#

createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››

Overrides KubeObjectStore.createItem

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:38

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:38

Parameters:

params: object

@@ -1441,7 +1441,7 @@

Protected defaultSorting#

defaultSorting(item: Role): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1462,7 +1462,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Role[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1483,7 +1483,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Role[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1511,7 +1511,7 @@

getByLabel#

getByLabel(labels: string[] | object): Role[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1533,7 +1533,7 @@

getByName(name: string, namespace?: string): Role

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1558,7 +1558,7 @@

getByPath#

getByPath(path: string): Role

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1579,7 +1579,7 @@

Optional getStatuses#

getStatuses(items: Role[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1600,7 +1600,7 @@

isSelected#

isSelected(item: Role): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1621,7 +1621,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Role[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1644,7 +1644,7 @@

load#

load(params: object): Promise‹Role

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1671,13 +1671,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1698,7 +1698,7 @@

Protected loadItem#

loadItem(params: object): Promise‹Role‹››

Overrides KubeObjectStore.loadItem

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

Parameters:

params: object

@@ -1724,7 +1724,7 @@

Protected loadItems#

loadItems(namespaces?: string[]): Promise‹Role[]›

Overrides KubeObjectStore.loadItems

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

Parameters:

@@ -1745,7 +1745,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1766,7 +1766,7 @@

remove#

remove(item: Role): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1787,7 +1787,7 @@

Protected removeItem#

removeItem(item: Role, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Role

request: function

@@ -1798,25 +1798,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Role): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1837,7 +1837,7 @@

Protected sortItems#

sortItems(items: Role[]): Role‹›[]

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

Parameters:

@@ -1858,13 +1858,13 @@

subscribe#

subscribe(): (Anonymous function)

Overrides KubeObjectStore.subscribe

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

Returns: (Anonymous function)


toggleSelection#

toggleSelection(item: Role): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1885,7 +1885,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Role[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1908,7 +1908,7 @@

unselect#

unselect(item: Role): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1929,7 +1929,7 @@

update#

update(item: Role, data: Partial‹Role›): Promise‹Role

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1954,13 +1954,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Role, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Role

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html index f97574047e..75571ef481 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -1209,7 +1209,7 @@

constructor#

+ new Secret(data: KubeJsonApiData): Secret

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/secret.api.ts:32

+

Defined in src/renderer/api/endpoints/secret.api.ts:32

Parameters:

@@ -1230,11 +1230,11 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


data#

data: object

-

Defined in src/renderer/api/endpoints/secret.api.ts:29

+

Defined in src/renderer/api/endpoints/secret.api.ts:29

Type declaration:

@@ -1308,7 +1308,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1341,7 +1341,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1364,71 +1364,71 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getKeys#

getKeys(): string[]

-

Defined in src/renderer/api/endpoints/secret.api.ts:39

+

Defined in src/renderer/api/endpoints/secret.api.ts:39

Returns: string[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getToken#

getToken(): string

-

Defined in src/renderer/api/endpoints/secret.api.ts:43

+

Defined in src/renderer/api/endpoints/secret.api.ts:43

Returns: string


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1451,7 +1451,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1472,7 +1472,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1493,7 +1493,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1514,7 +1514,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1535,7 +1535,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html index 63f284022b..8add668fbe 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new SecretsStore(): SecretsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: SecretsStore

Properties#

api#

api: KubeApiSecret‹›› = secretsApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

+

Defined in src/renderer/components/+config-secrets/secrets.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Secret[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Secret[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹Secret›): Promise‹Secret

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹Secret›): Promise‹Secret

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: Secret): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Secret[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Secret[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): Secret[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): Secret

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): Secret

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: Secret[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: Secret): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Secret[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹Secret

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹Secret

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Secret[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: Secret): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: Secret, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Secret

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Secret): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: Secret[], sorting?: function[], order?: "asc" | "desc"): Secret[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: Secret): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Secret[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: Secret): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: Secret, data: Partial‹Secret›): Promise‹Secret

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Secret, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Secret

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.service/index.html index c80e23ebdb..dcf2bc4dc9 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.service/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -1249,7 +1249,7 @@

constructor#

+ new Service(data: KubeJsonApiData): Service

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1270,21 +1270,21 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

-

Defined in src/renderer/api/endpoints/service.api.ts:38

+

Defined in src/renderer/api/endpoints/service.api.ts:38

Type declaration:

@@ -1371,7 +1371,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1404,7 +1404,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1426,35 +1426,35 @@

getClusterIp#

getClusterIp(): string

-

Defined in src/renderer/api/endpoints/service.api.ts:58

+

Defined in src/renderer/api/endpoints/service.api.ts:58

Returns: string


getExternalIps#

getExternalIps(): string[]

-

Defined in src/renderer/api/endpoints/service.api.ts:62

+

Defined in src/renderer/api/endpoints/service.api.ts:62

Returns: string[]


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getLoadBalancer#

getLoadBalancer(): object

-

Defined in src/renderer/api/endpoints/service.api.ts:88

+

Defined in src/renderer/api/endpoints/service.api.ts:88

Returns: object

@@ -1568,7 +1568,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1589,7 +1589,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1610,7 +1610,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1631,7 +1631,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html index a8772dc7e5..7eb3048314 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -1209,7 +1209,7 @@

constructor#

+ new ServiceAccount(data: KubeJsonApiData): ServiceAccount

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1230,55 +1230,55 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


Optional imagePullSecrets#

imagePullSecrets? : object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:14


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


Optional secrets#

secrets? : object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:11


Optional status#

status? : any

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:79

+

Defined in src/renderer/api/kube-object.ts:79


Static apiBase#

apiBase: string = "/api/v1/serviceaccounts"

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:9


Static kind#

kind: string = "ServiceAccount"

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:7


Static namespaced#

namespaced: boolean = true

Overrides KubeObject.namespaced

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

Accessors#

get selfLink(): string

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:81

+

Defined in src/renderer/api/kube-object.ts:81

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:167

+

Defined in src/renderer/api/kube-object.ts:167

Parameters:

@@ -1299,7 +1299,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1332,7 +1332,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1355,71 +1355,71 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getImagePullSecrets#

getImagePullSecrets(): object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

Returns: object[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSecrets#

getSecrets(): object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

Returns: object[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1442,7 +1442,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1463,7 +1463,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1484,7 +1484,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1505,7 +1505,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1526,7 +1526,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html index 27c84d4759..0f355df002 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new ServiceAccountsStore(): ServiceAccountsStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: ServiceAccountsStore

Properties#

api#

api: KubeApiServiceAccount‹›› = serviceAccountsApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

+

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): ServiceAccount[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: ServiceAccount[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1414,7 +1414,7 @@

Protected createItem#

createItem(params: object): Promise‹ServiceAccount‹››

Overrides KubeObjectStore.createItem

-

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

+

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

Parameters:

params: object

@@ -1440,7 +1440,7 @@

Protected defaultSorting#

defaultSorting(item: ServiceAccount): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1461,7 +1461,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: ServiceAccount[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1482,7 +1482,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1510,7 +1510,7 @@

getByLabel#

getByLabel(labels: string[] | object): ServiceAccount[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1532,7 +1532,7 @@

getByName(name: string, namespace?: string): ServiceAccount

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1557,7 +1557,7 @@

getByPath#

getByPath(path: string): ServiceAccount

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1578,7 +1578,7 @@

Optional getStatuses#

getStatuses(items: ServiceAccount[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1599,7 +1599,7 @@

isSelected#

isSelected(item: ServiceAccount): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1620,7 +1620,7 @@

isSelectedAll#

isSelectedAll(visibleItems: ServiceAccount[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1643,7 +1643,7 @@

load#

load(params: object): Promise‹ServiceAccount

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1670,13 +1670,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1698,7 +1698,7 @@

loadItem(params: object): Promise‹ServiceAccount

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1725,7 +1725,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹ServiceAccount[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1746,7 +1746,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1767,7 +1767,7 @@

remove#

remove(item: ServiceAccount): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1788,7 +1788,7 @@

Protected removeItem#

removeItem(item: ServiceAccount, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: ServiceAccount

request: function

@@ -1799,25 +1799,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: ServiceAccount): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1838,7 +1838,7 @@

Protected sortItems#

sortItems(items: ServiceAccount[], sorting?: function[], order?: "asc" | "desc"): ServiceAccount[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1872,7 +1872,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1895,7 +1895,7 @@

toggleSelection#

toggleSelection(item: ServiceAccount): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1916,7 +1916,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: ServiceAccount[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1939,7 +1939,7 @@

unselect#

unselect(item: ServiceAccount): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1960,7 +1960,7 @@

update#

update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1985,13 +1985,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: ServiceAccount, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: ServiceAccount

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html index 38ee15019f..509a7efc08 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new ServiceStore(): ServiceStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: ServiceStore

Properties#

api#

api: KubeApiService‹›› = serviceApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-services/services.store.ts:8

+

Defined in src/renderer/components/+network-services/services.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): Service[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: Service[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹Service›): Promise‹Service

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹Service›): Promise‹Service

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: Service): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: Service[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): Service[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): Service[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): Service

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): Service

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: Service[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: Service): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: Service[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹Service

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹Service

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹Service[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: Service): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: Service, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: Service

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: Service): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: Service[], sorting?: function[], order?: "asc" | "desc"): Service[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: Service): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: Service[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: Service): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: Service, data: Partial‹Service›): Promise‹Service

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: Service, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: Service

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html index 1eb8721fb6..12fab5a348 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -1249,7 +1249,7 @@

constructor#

+ new StatefulSet(data: KubeJsonApiData): StatefulSet

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1270,22 +1270,22 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


spec#

spec: object

Overrides void

-

Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

+

Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

Type declaration:

@@ -1409,19 +1409,19 @@

getAffinity#

getAffinity(): IAffinity

Inherited from Deployment.getAffinity

-

Defined in src/renderer/api/workload-kube-object.ts:74

+

Defined in src/renderer/api/workload-kube-object.ts:74

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:78

+

Defined in src/renderer/api/workload-kube-object.ts:78

Returns: number


getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1454,7 +1454,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1477,95 +1477,95 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getImages#

getImages(): string[]

-

Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

+

Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

Returns: string[]


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Inherited from Deployment.getNodeSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:58

+

Defined in src/renderer/api/workload-kube-object.ts:58

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getReplicas#

getReplicas(): number

-

Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

+

Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

Returns: number


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getSelectors#

getSelectors(): string[]

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:52

+

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:64

+

Defined in src/renderer/api/workload-kube-object.ts:64

Returns: string[]


getTolerations#

getTolerations(): IToleration[]

Inherited from Deployment.getTolerations

-

Defined in src/renderer/api/workload-kube-object.ts:70

+

Defined in src/renderer/api/workload-kube-object.ts:70

Returns: IToleration[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1588,7 +1588,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1609,7 +1609,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1630,7 +1630,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1651,7 +1651,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1672,7 +1672,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html index bfc531268f..c317388f7d 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -1324,75 +1324,75 @@

constructor#

+ new StatefulSetStore(): StatefulSetStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: StatefulSetStore

Properties#

api#

api: StatefulSetApi‹› = statefulSetApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): StatefulSet[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: StatefulSet[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1415,7 +1415,7 @@

create#

create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1443,7 +1443,7 @@

createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1470,7 +1470,7 @@

Protected defaultSorting#

defaultSorting(item: StatefulSet): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1491,7 +1491,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: StatefulSet[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1512,7 +1512,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1540,7 +1540,7 @@

getByLabel#

getByLabel(labels: string[] | object): StatefulSet[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1562,7 +1562,7 @@

getByName(name: string, namespace?: string): StatefulSet

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1587,7 +1587,7 @@

getByPath#

getByPath(path: string): StatefulSet

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1607,7 +1607,7 @@

getChildPods#

getChildPods(statefulSet: StatefulSet): Pod‹›[]

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

Parameters:

@@ -1628,7 +1628,7 @@

getStatuses#

getStatuses(statefulSets: StatefulSet[]): object

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

Parameters:

@@ -1660,7 +1660,7 @@

isSelected#

isSelected(item: StatefulSet): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1681,7 +1681,7 @@

isSelectedAll#

isSelectedAll(visibleItems: StatefulSet[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1704,7 +1704,7 @@

load#

load(params: object): Promise‹StatefulSet

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1731,13 +1731,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1759,7 +1759,7 @@

loadItem(params: object): Promise‹StatefulSet

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1786,7 +1786,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹StatefulSet[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1806,7 +1806,7 @@

loadMetrics#

loadMetrics(statefulSet: StatefulSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

Parameters:

@@ -1827,7 +1827,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1848,7 +1848,7 @@

remove#

remove(item: StatefulSet): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1869,7 +1869,7 @@

Protected removeItem#

removeItem(item: StatefulSet, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: StatefulSet

request: function

@@ -1880,25 +1880,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

+

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: StatefulSet): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1919,7 +1919,7 @@

Protected sortItems#

sortItems(items: StatefulSet[], sorting?: function[], order?: "asc" | "desc"): StatefulSet[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1953,7 +1953,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1976,7 +1976,7 @@

toggleSelection#

toggleSelection(item: StatefulSet): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1997,7 +1997,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: StatefulSet[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -2020,7 +2020,7 @@

unselect#

unselect(item: StatefulSet): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2041,7 +2041,7 @@

update#

update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2066,13 +2066,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: StatefulSet, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: StatefulSet

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html index 1728694089..8512e13915 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -1241,7 +1241,7 @@

constructor#

+ new StorageClass(data: KubeJsonApiData): StorageClass

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:70

+

Defined in src/renderer/api/kube-object.ts:70

Parameters:

@@ -1262,25 +1262,25 @@

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:76

+

Defined in src/renderer/api/kube-object.ts:76


kind#

kind: string

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:77

+

Defined in src/renderer/api/kube-object.ts:77


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:78

+

Defined in src/renderer/api/kube-object.ts:78


Optional mountOptions#

mountOptions? : string[]

-

Defined in src/renderer/api/endpoints/storage-class.api.ts:12

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:12


parameters#

parameters: object

-

Defined in src/renderer/api/endpoints/storage-class.api.ts:15

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:15

Type declaration:

@@ -1347,7 +1347,7 @@

getAge#

getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:103

+

Defined in src/renderer/api/kube-object.ts:103

Parameters:

@@ -1380,7 +1380,7 @@

getAnnotations#

getAnnotations(filter: boolean): string[]

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:124

+

Defined in src/renderer/api/kube-object.ts:124

Parameters:

@@ -1403,76 +1403,76 @@

getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:116

+

Defined in src/renderer/api/kube-object.ts:116

Returns: string[]


getId#

getId(): string

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:85

+

Defined in src/renderer/api/kube-object.ts:85

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:120

+

Defined in src/renderer/api/kube-object.ts:120

Returns: string[]


getName#

getName(): string

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:93

+

Defined in src/renderer/api/kube-object.ts:93

Returns: string


getNs#

getNs(): string

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:97

+

Defined in src/renderer/api/kube-object.ts:97

Returns: string


getOwnerRefs#

getOwnerRefs(): object[]

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:134

+

Defined in src/renderer/api/kube-object.ts:134

Returns: object[]


getReclaimPolicy#

getReclaimPolicy(): string

-

Defined in src/renderer/api/endpoints/storage-class.api.ts:32

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:32

Returns: string


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:89

+

Defined in src/renderer/api/kube-object.ts:89

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:143

+

Defined in src/renderer/api/kube-object.ts:143

Returns: string[]


getVolumeBindingMode#

getVolumeBindingMode(): string

-

Defined in src/renderer/api/endpoints/storage-class.api.ts:28

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:28

Returns: string


isDefault#

isDefault(): boolean

-

Defined in src/renderer/api/endpoints/storage-class.api.ts:19

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:19

Returns: boolean


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:155

+

Defined in src/renderer/api/kube-object.ts:155

Returns: object


update#

updateT›(data: Partial‹T›): Promise‹T›

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:160

+

Defined in src/renderer/api/kube-object.ts:160

Type parameters:

T: KubeObject

Parameters:

@@ -1495,7 +1495,7 @@

Static create#

create(data: any): KubeObject‹›

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:50

+

Defined in src/renderer/api/kube-object.ts:50

Parameters:

@@ -1516,7 +1516,7 @@

Static isJsonApiData#

isJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:58

+

Defined in src/renderer/api/kube-object.ts:58

Parameters:

@@ -1537,7 +1537,7 @@

Static isJsonApiDataList#

isJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:62

+

Defined in src/renderer/api/kube-object.ts:62

Parameters:

@@ -1558,7 +1558,7 @@

Static isNonSystem#

isNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:54

+

Defined in src/renderer/api/kube-object.ts:54

Parameters:

@@ -1579,7 +1579,7 @@

Static stringifyLabels#

stringifyLabels(labels: object): string[]

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:66

+

Defined in src/renderer/api/kube-object.ts:66

Parameters:

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html index ef8b119d4d..a2b317353e 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -1300,71 +1300,71 @@

constructor#

+ new StorageClassStore(): StorageClassStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: StorageClassStore

Properties#

api#

api: KubeApiStorageClass‹›› = storageClassApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-classes/storage-class.store.ts:8

+

Defined in src/renderer/components/+storage-classes/storage-class.store.ts:8


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): StorageClass[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: StorageClass[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1387,7 +1387,7 @@

create#

create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1415,7 +1415,7 @@

createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1442,7 +1442,7 @@

Protected defaultSorting#

defaultSorting(item: StorageClass): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1463,7 +1463,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: StorageClass[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1484,7 +1484,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1512,7 +1512,7 @@

getByLabel#

getByLabel(labels: string[] | object): StorageClass[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1534,7 +1534,7 @@

getByName(name: string, namespace?: string): StorageClass

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1559,7 +1559,7 @@

getByPath#

getByPath(path: string): StorageClass

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1580,7 +1580,7 @@

Optional getStatuses#

getStatuses(items: StorageClass[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1601,7 +1601,7 @@

isSelected#

isSelected(item: StorageClass): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1622,7 +1622,7 @@

isSelectedAll#

isSelectedAll(visibleItems: StorageClass[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1645,7 +1645,7 @@

load#

load(params: object): Promise‹StorageClass

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1672,13 +1672,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1700,7 +1700,7 @@

loadItem(params: object): Promise‹StorageClass

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1727,7 +1727,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹StorageClass[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1748,7 +1748,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1769,7 +1769,7 @@

remove#

remove(item: StorageClass): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1790,7 +1790,7 @@

Protected removeItem#

removeItem(item: StorageClass, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: StorageClass

request: function

@@ -1801,25 +1801,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Inherited from KubeObjectStore.reset

-

Defined in src/renderer/item.store.ts:163

+

Defined in src/renderer/item.store.ts:163

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: StorageClass): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1840,7 +1840,7 @@

Protected sortItems#

sortItems(items: StorageClass[], sorting?: function[], order?: "asc" | "desc"): StorageClass[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1874,7 +1874,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1897,7 +1897,7 @@

toggleSelection#

toggleSelection(item: StorageClass): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1918,7 +1918,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: StorageClass[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1941,7 +1941,7 @@

unselect#

unselect(item: StorageClass): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -1962,7 +1962,7 @@

update#

update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -1987,13 +1987,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: StorageClass, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: StorageClass

request: function

diff --git a/master/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/master/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html index b8fcc890aa..355db3e2a4 100644 --- a/master/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html +++ b/master/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -1316,75 +1316,75 @@

constructor#

+ new VolumeClaimStore(): VolumeClaimStore

Inherited from KubeObjectStore.constructor

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15

Returns: VolumeClaimStore

Properties#

api#

api: PersistentVolumeClaimsApi‹› = pvcApi

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

+

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9


bufferSize#

bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

-

Defined in src/renderer/kube-object.store.ts:15

+

Defined in src/renderer/kube-object.store.ts:15


Protected eventsBuffer#

eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:172

+

Defined in src/renderer/kube-object.store.ts:172


isLoaded#

isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

-

Defined in src/renderer/item.store.ts:17

+

Defined in src/renderer/item.store.ts:17


isLoading#

isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

-

Defined in src/renderer/item.store.ts:16

+

Defined in src/renderer/item.store.ts:16


items#

items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

-

Defined in src/renderer/item.store.ts:18

+

Defined in src/renderer/item.store.ts:18


Optional limit#

limit? : number

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:14

+

Defined in src/renderer/kube-object.store.ts:14


metrics#

metrics: IPvcMetrics = null

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

+

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10


selectedItemsIds#

selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

-

Defined in src/renderer/item.store.ts:19

+

Defined in src/renderer/item.store.ts:19

Accessors#

query#

get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

-

Defined in src/renderer/kube-object.store.ts:23

+

Defined in src/renderer/kube-object.store.ts:23

Returns: IKubeApiQueryParams


selectedItems#

get selectedItems(): PersistentVolumeClaim[]

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:21

+

Defined in src/renderer/item.store.ts:21

Returns: PersistentVolumeClaim[]

Methods#

[Symbol.iterator]#

[Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

-

Defined in src/renderer/item.store.ts:178

+

Defined in src/renderer/item.store.ts:178

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

bindWatchEventsUpdater(delay: number): IReactionDisposer

Inherited from KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/kube-object.store.ts:174

+

Defined in src/renderer/kube-object.store.ts:174

Parameters:

@@ -1407,7 +1407,7 @@

create#

create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:143

+

Defined in src/renderer/kube-object.store.ts:143

Parameters:

params: object

@@ -1435,7 +1435,7 @@

createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

Inherited from KubeObjectStore.createItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:139

+

Defined in src/renderer/kube-object.store.ts:139

Parameters:

params: object

@@ -1462,7 +1462,7 @@

Protected defaultSorting#

defaultSorting(item: PersistentVolumeClaim): string

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:14

+

Defined in src/renderer/item.store.ts:14

Parameters:

@@ -1483,7 +1483,7 @@

Protected filterItemsOnLoad#

filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:84

+

Defined in src/renderer/kube-object.store.ts:84

Parameters:

@@ -1504,7 +1504,7 @@

getAllByNs#

getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:35

+

Defined in src/renderer/kube-object.store.ts:35

Parameters:

@@ -1532,7 +1532,7 @@

getByLabel#

getByLabel(labels: string[] | object): PersistentVolumeClaim[]

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:57

+

Defined in src/renderer/kube-object.store.ts:57

Parameters:

@@ -1554,7 +1554,7 @@

getByName(name: string, namespace?: string): PersistentVolumeClaim

Inherited from KubeObjectStore.getByName

Overrides void

-

Defined in src/renderer/kube-object.store.ts:45

+

Defined in src/renderer/kube-object.store.ts:45

Parameters:

@@ -1579,7 +1579,7 @@

getByPath#

getByPath(path: string): PersistentVolumeClaim

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:53

+

Defined in src/renderer/kube-object.store.ts:53

Parameters:

@@ -1600,7 +1600,7 @@

Optional getStatuses#

getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:33

+

Defined in src/renderer/kube-object.store.ts:33

Parameters:

@@ -1621,7 +1621,7 @@

isSelected#

isSelected(item: PersistentVolumeClaim): boolean

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:115

+

Defined in src/renderer/item.store.ts:115

Parameters:

@@ -1642,7 +1642,7 @@

isSelectedAll#

isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:151

+

Defined in src/renderer/item.store.ts:151

Parameters:

@@ -1665,7 +1665,7 @@

load#

load(params: object): Promise‹PersistentVolumeClaim

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:118

+

Defined in src/renderer/kube-object.store.ts:118

Parameters:

params: object

@@ -1692,13 +1692,13 @@

loadAll(): Promise‹void›

Inherited from KubeObjectStore.loadAll

Overrides void

-

Defined in src/renderer/kube-object.store.ts:89

+

Defined in src/renderer/kube-object.store.ts:89

Returns: Promise‹void›


loadFromPath#

loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:133

+

Defined in src/renderer/kube-object.store.ts:133

Parameters:

@@ -1720,7 +1720,7 @@

loadItem(params: object): Promise‹PersistentVolumeClaim

Inherited from KubeObjectStore.loadItem

Overrides void

-

Defined in src/renderer/kube-object.store.ts:113

+

Defined in src/renderer/kube-object.store.ts:113

Parameters:

params: object

@@ -1747,7 +1747,7 @@

loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolumeClaim[]›

Inherited from KubeObjectStore.loadItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:74

+

Defined in src/renderer/kube-object.store.ts:74

Parameters:

@@ -1767,7 +1767,7 @@

loadMetrics#

loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

+

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

Parameters:

@@ -1788,7 +1788,7 @@

Protected onWatchApiEvent#

onWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

-

Defined in src/renderer/kube-object.store.ts:184

+

Defined in src/renderer/kube-object.store.ts:184

Parameters:

@@ -1809,7 +1809,7 @@

remove#

remove(item: PersistentVolumeClaim): Promise‹void›

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:161

+

Defined in src/renderer/kube-object.store.ts:161

Parameters:

@@ -1830,7 +1830,7 @@

Protected removeItem#

removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:109

+

Defined in src/renderer/item.store.ts:109

Parameters:

item: PersistentVolumeClaim

request: function

@@ -1841,25 +1841,25 @@

removeSelectedItems(): Promise‹void[]›

Inherited from KubeObjectStore.removeSelectedItems

Overrides void

-

Defined in src/renderer/kube-object.store.ts:167

+

Defined in src/renderer/kube-object.store.ts:167

Returns: Promise‹void[]›


reset#

reset(): void

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

+

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

Returns: void


resetSelection#

resetSelection(): void

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:158

+

Defined in src/renderer/item.store.ts:158

Returns: void


select#

select(item: PersistentVolumeClaim): void

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:120

+

Defined in src/renderer/item.store.ts:120

Parameters:

@@ -1880,7 +1880,7 @@

Protected sortItems#

sortItems(items: PersistentVolumeClaim[], sorting?: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

Inherited from KubeObjectStore.sortItems

-

Defined in src/renderer/item.store.ts:31

+

Defined in src/renderer/item.store.ts:31

Parameters:

@@ -1914,7 +1914,7 @@

subscribe(apis: KubeApi‹T›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

-

Defined in src/renderer/kube-object.store.ts:180

+

Defined in src/renderer/kube-object.store.ts:180

Parameters:

@@ -1937,7 +1937,7 @@

toggleSelection#

toggleSelection(item: PersistentVolumeClaim): void

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:130

+

Defined in src/renderer/item.store.ts:130

Parameters:

@@ -1958,7 +1958,7 @@

toggleSelectionAll#

toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:140

+

Defined in src/renderer/item.store.ts:140

Parameters:

@@ -1981,7 +1981,7 @@

unselect#

unselect(item: PersistentVolumeClaim): void

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:125

+

Defined in src/renderer/item.store.ts:125

Parameters:

@@ -2002,7 +2002,7 @@

update#

update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:152

+

Defined in src/renderer/kube-object.store.ts:152

Parameters:

@@ -2027,13 +2027,13 @@

Protected updateFromEventsBuffer#

updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:190

+

Defined in src/renderer/kube-object.store.ts:190

Returns: void


Protected updateItem#

updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:99

+

Defined in src/renderer/item.store.ts:99

Parameters:

item: PersistentVolumeClaim

request: function

diff --git a/master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html index 371f78de07..96941908ba 100644 --- a/master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html +++ b/master/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -1070,7 +1070,7 @@

Constructors#

constructor#

+ new PageParam(init: PageParamInit‹V› | PageSystemParamInit‹V›, history: IObservableHistory): PageParam

-

Defined in src/renderer/navigation/page-param.ts:23

+

Defined in src/renderer/navigation/page-param.ts:23

Parameters:

@@ -1094,47 +1094,47 @@

Properties#

Protected history#

history: IObservableHistory

-

Defined in src/renderer/navigation/page-param.ts:25

+

Defined in src/renderer/navigation/page-param.ts:25


init#

init: PageParamInit‹V› | PageSystemParamInit‹V›

-

Defined in src/renderer/navigation/page-param.ts:25

+

Defined in src/renderer/navigation/page-param.ts:25


name#

name: string

-

Defined in src/renderer/navigation/page-param.ts:22

+

Defined in src/renderer/navigation/page-param.ts:22


Protected urlName#

urlName: string

-

Defined in src/renderer/navigation/page-param.ts:23

+

Defined in src/renderer/navigation/page-param.ts:23


Static SYSTEM_PREFIX#

SYSTEM_PREFIX: string = "lens-"

-

Defined in src/renderer/navigation/page-param.ts:20

+

Defined in src/renderer/navigation/page-param.ts:20

Methods#

clear#

clear(): void

-

Defined in src/renderer/navigation/page-param.ts:107

+

Defined in src/renderer/navigation/page-param.ts:107

Returns: void


get#

get(): V

-

Defined in src/renderer/navigation/page-param.ts:66

+

Defined in src/renderer/navigation/page-param.ts:66

Returns: V


getDefaultValue#

getDefaultValue(): V

-

Defined in src/renderer/navigation/page-param.ts:101

+

Defined in src/renderer/navigation/page-param.ts:101

Returns: V


getRaw#

getRaw(): string[]

-

Defined in src/renderer/navigation/page-param.ts:94

+

Defined in src/renderer/navigation/page-param.ts:94

Returns: string[]


isEmpty#

isEmpty(value: V | any): boolean

-

Defined in src/renderer/navigation/page-param.ts:36

+

Defined in src/renderer/navigation/page-param.ts:36

Parameters:

@@ -1154,7 +1154,7 @@

parse#

parse(values: string[]): V

-

Defined in src/renderer/navigation/page-param.ts:40

+

Defined in src/renderer/navigation/page-param.ts:40

Parameters:

@@ -1174,7 +1174,7 @@

set#

set(value: V, __namedParameters: object): void

-

Defined in src/renderer/navigation/page-param.ts:76

+

Defined in src/renderer/navigation/page-param.ts:76

Parameters:

value: V

Default value __namedParameters: object= {}

@@ -1203,7 +1203,7 @@

setRaw#

setRaw(value: string | string[]): void

-

Defined in src/renderer/navigation/page-param.ts:82

+

Defined in src/renderer/navigation/page-param.ts:82

Parameters:

@@ -1223,7 +1223,7 @@

stringify#

stringify(value: V): string

-

Defined in src/renderer/navigation/page-param.ts:49

+

Defined in src/renderer/navigation/page-param.ts:49

Parameters:

@@ -1245,7 +1245,7 @@

toObjectParam#

toObjectParam(value: V): Record‹string, V›

-

Defined in src/renderer/navigation/page-param.ts:130

+

Defined in src/renderer/navigation/page-param.ts:130

Parameters:

@@ -1267,7 +1267,7 @@

toSearchString#

toSearchString(__namedParameters: object): string

-

Defined in src/renderer/navigation/page-param.ts:111

+

Defined in src/renderer/navigation/page-param.ts:111

Parameters:

Default value __namedParameters: object= {}

diff --git a/master/extensions/api/classes/lensmainextension/index.html b/master/extensions/api/classes/lensmainextension/index.html index 410ae07e4e..05e0e3b4e6 100644 --- a/master/extensions/api/classes/lensmainextension/index.html +++ b/master/extensions/api/classes/lensmainextension/index.html @@ -1086,7 +1086,7 @@

constructor#

+ new LensMainExtension(__namedParameters: object): LensMainExtension

Inherited from LensMainExtension.constructor

-

Defined in src/extensions/lens-extension.ts:24

+

Defined in src/extensions/lens-extension.ts:24

Parameters:

__namedParameters: object

@@ -1119,62 +1119,62 @@

Properties#

appMenus#

appMenus: MenuRegistration[] = []

-

Defined in src/extensions/lens-main-extension.ts:7

+

Defined in src/extensions/lens-main-extension.ts:7


id#

id: LensExtensionId

Inherited from LensMainExtension.id

-

Defined in src/extensions/lens-extension.ts:19

+

Defined in src/extensions/lens-extension.ts:19


isBundled#

isBundled: boolean

Inherited from LensMainExtension.isBundled

-

Defined in src/extensions/lens-extension.ts:22

+

Defined in src/extensions/lens-extension.ts:22


manifest#

manifest: LensExtensionManifest

Inherited from LensMainExtension.manifest

-

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

+

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


manifestPath#

manifestPath: string

Inherited from LensMainExtension.manifestPath

-

Defined in src/extensions/lens-extension.ts:21

+

Defined in src/extensions/lens-extension.ts:21

Accessors#

description#

get description(): string

Inherited from LensMainExtension.description

-

Defined in src/extensions/lens-extension.ts:52

+

Defined in src/extensions/lens-extension.ts:52

Returns: string


name#

get name(): string

Inherited from LensMainExtension.name

-

Defined in src/extensions/lens-extension.ts:33

+

Defined in src/extensions/lens-extension.ts:33

Returns: string


version#

get version(): string

Inherited from LensMainExtension.version

-

Defined in src/extensions/lens-extension.ts:37

+

Defined in src/extensions/lens-extension.ts:37

Returns: string

Methods#

disable#

disable(): Promise‹void›

Inherited from LensMainExtension.disable

-

Defined in src/extensions/lens-extension.ts:65

+

Defined in src/extensions/lens-extension.ts:65

Returns: Promise‹void›


enable#

enable(): Promise‹void›

Inherited from LensMainExtension.enable

-

Defined in src/extensions/lens-extension.ts:57

+

Defined in src/extensions/lens-extension.ts:57

Returns: Promise‹void›


getExtensionFileFolder#

getExtensionFileFolder(): Promise‹string›

Inherited from LensMainExtension.getExtensionFileFolder

-

Defined in src/extensions/lens-extension.ts:48

+

Defined in src/extensions/lens-extension.ts:48

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfiscation of the @@ -1183,7 +1183,7 @@ folder name.


navigateP›(pageId?: string, params?: P, frameId?: number): Promise‹void›

-

Defined in src/extensions/lens-main-extension.ts:9

+

Defined in src/extensions/lens-main-extension.ts:9

Type parameters:

P: object

Parameters:

@@ -1214,19 +1214,19 @@ folder name.

Protected onActivate#

onActivate(): void

Inherited from LensMainExtension.onActivate

-

Defined in src/extensions/lens-extension.ts:104

+

Defined in src/extensions/lens-extension.ts:104

Returns: void


Protected onDeactivate#

onDeactivate(): void

Inherited from LensMainExtension.onDeactivate

-

Defined in src/extensions/lens-extension.ts:108

+

Defined in src/extensions/lens-extension.ts:108

Returns: void


toggle#

toggle(enable?: boolean): void

Inherited from LensMainExtension.toggle

-

Defined in src/extensions/lens-extension.ts:72

+

Defined in src/extensions/lens-extension.ts:72

Parameters:

@@ -1247,7 +1247,7 @@ folder name.

whenEnabled#

whenEnabled(handlers: function): Promise‹(Anonymous function)›

Inherited from LensMainExtension.whenEnabled

-

Defined in src/extensions/lens-extension.ts:80

+

Defined in src/extensions/lens-extension.ts:80

Parameters:

handlers: function

▸ (): Promise‹Function[]›

diff --git a/master/extensions/api/classes/lensrendererextension/index.html b/master/extensions/api/classes/lensrendererextension/index.html index 142743e45d..28f50c3a99 100644 --- a/master/extensions/api/classes/lensrendererextension/index.html +++ b/master/extensions/api/classes/lensrendererextension/index.html @@ -1166,7 +1166,7 @@

constructor#

+ new LensRendererExtension(__namedParameters: object): LensRendererExtension

Inherited from LensMainExtension.constructor

-

Defined in src/extensions/lens-extension.ts:24

+

Defined in src/extensions/lens-extension.ts:24

Parameters:

__namedParameters: object

@@ -1199,98 +1199,98 @@

Properties#

appPreferences#

appPreferences: AppPreferenceRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:12

+

Defined in src/extensions/lens-renderer-extension.ts:12


clusterFeatures#

clusterFeatures: ClusterFeatureRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:13

+

Defined in src/extensions/lens-renderer-extension.ts:13


clusterPageMenus#

clusterPageMenus: ClusterPageMenuRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:10

+

Defined in src/extensions/lens-renderer-extension.ts:10


clusterPages#

clusterPages: PageRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:8

+

Defined in src/extensions/lens-renderer-extension.ts:8


globalPageMenus#

globalPageMenus: PageMenuRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:9

+

Defined in src/extensions/lens-renderer-extension.ts:9


globalPages#

globalPages: PageRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:7

+

Defined in src/extensions/lens-renderer-extension.ts:7


id#

id: LensExtensionId

Inherited from LensMainExtension.id

-

Defined in src/extensions/lens-extension.ts:19

+

Defined in src/extensions/lens-extension.ts:19


isBundled#

isBundled: boolean

Inherited from LensMainExtension.isBundled

-

Defined in src/extensions/lens-extension.ts:22

+

Defined in src/extensions/lens-extension.ts:22


kubeObjectDetailItems#

kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:15

+

Defined in src/extensions/lens-renderer-extension.ts:15


kubeObjectMenuItems#

kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:16

+

Defined in src/extensions/lens-renderer-extension.ts:16


kubeObjectStatusTexts#

kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:11

+

Defined in src/extensions/lens-renderer-extension.ts:11


manifest#

manifest: LensExtensionManifest

Inherited from LensMainExtension.manifest

-

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

+

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


manifestPath#

manifestPath: string

Inherited from LensMainExtension.manifestPath

-

Defined in src/extensions/lens-extension.ts:21

+

Defined in src/extensions/lens-extension.ts:21


statusBarItems#

statusBarItems: StatusBarRegistration[] = []

-

Defined in src/extensions/lens-renderer-extension.ts:14

+

Defined in src/extensions/lens-renderer-extension.ts:14

Accessors#

description#

get description(): string

Inherited from LensMainExtension.description

-

Defined in src/extensions/lens-extension.ts:52

+

Defined in src/extensions/lens-extension.ts:52

Returns: string


name#

get name(): string

Inherited from LensMainExtension.name

-

Defined in src/extensions/lens-extension.ts:33

+

Defined in src/extensions/lens-extension.ts:33

Returns: string


version#

get version(): string

Inherited from LensMainExtension.version

-

Defined in src/extensions/lens-extension.ts:37

+

Defined in src/extensions/lens-extension.ts:37

Returns: string

Methods#

disable#

disable(): Promise‹void›

Inherited from LensMainExtension.disable

-

Defined in src/extensions/lens-extension.ts:65

+

Defined in src/extensions/lens-extension.ts:65

Returns: Promise‹void›


enable#

enable(): Promise‹void›

Inherited from LensMainExtension.enable

-

Defined in src/extensions/lens-extension.ts:57

+

Defined in src/extensions/lens-extension.ts:57

Returns: Promise‹void›


getExtensionFileFolder#

getExtensionFileFolder(): Promise‹string›

Inherited from LensMainExtension.getExtensionFileFolder

-

Defined in src/extensions/lens-extension.ts:48

+

Defined in src/extensions/lens-extension.ts:48

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfiscation of the @@ -1299,7 +1299,7 @@ folder name.


isEnabledForCluster#

isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

-

Defined in src/extensions/lens-renderer-extension.ts:33

+

Defined in src/extensions/lens-renderer-extension.ts:33

Defines if extension is enabled for a given cluster. Defaults to true.

Parameters:

@@ -1320,7 +1320,7 @@ folder name.


navigateP›(pageId?: string, params?: P): Promise‹void›

-

Defined in src/extensions/lens-renderer-extension.ts:18

+

Defined in src/extensions/lens-renderer-extension.ts:18

Type parameters:

P: object

Parameters:

@@ -1347,19 +1347,19 @@ folder name.

Protected onActivate#

onActivate(): void

Inherited from LensMainExtension.onActivate

-

Defined in src/extensions/lens-extension.ts:104

+

Defined in src/extensions/lens-extension.ts:104

Returns: void


Protected onDeactivate#

onDeactivate(): void

Inherited from LensMainExtension.onDeactivate

-

Defined in src/extensions/lens-extension.ts:108

+

Defined in src/extensions/lens-extension.ts:108

Returns: void


toggle#

toggle(enable?: boolean): void

Inherited from LensMainExtension.toggle

-

Defined in src/extensions/lens-extension.ts:72

+

Defined in src/extensions/lens-extension.ts:72

Parameters:

@@ -1380,7 +1380,7 @@ folder name.

whenEnabled#

whenEnabled(handlers: function): Promise‹(Anonymous function)›

Inherited from LensMainExtension.whenEnabled

-

Defined in src/extensions/lens-extension.ts:80

+

Defined in src/extensions/lens-extension.ts:80

Parameters:

handlers: function

▸ (): Promise‹Function[]›

diff --git a/master/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/master/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html index 5d2b8cb5f3..541c493beb 100644 --- a/master/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html +++ b/master/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -892,15 +892,15 @@

Enumeration members#

ERROR#

ERROR: = "error"

-

Defined in src/renderer/components/notifications/notifications.store.ts:12

+

Defined in src/renderer/components/notifications/notifications.store.ts:12


INFO#

INFO: = "info"

-

Defined in src/renderer/components/notifications/notifications.store.ts:13

+

Defined in src/renderer/components/notifications/notifications.store.ts:13


OK#

OK: = "ok"

-

Defined in src/renderer/components/notifications/notifications.store.ts:11

+

Defined in src/renderer/components/notifications/notifications.store.ts:11

diff --git a/master/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/master/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html index fc58287612..1dc3aebb81 100644 --- a/master/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html +++ b/master/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -932,35 +932,35 @@

Enumeration members#

BOTTOM#

BOTTOM: = "bottom"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:11

+

Defined in src/renderer/components/tooltip/tooltip.tsx:11


BOTTOM_LEFT#

BOTTOM_LEFT: = "bottom_left"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:16

+

Defined in src/renderer/components/tooltip/tooltip.tsx:16


BOTTOM_RIGHT#

BOTTOM_RIGHT: = "bottom_right"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:17

+

Defined in src/renderer/components/tooltip/tooltip.tsx:17


LEFT#

LEFT: = "left"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:12

+

Defined in src/renderer/components/tooltip/tooltip.tsx:12


RIGHT: = "right"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:13

+

Defined in src/renderer/components/tooltip/tooltip.tsx:13


TOP#

TOP: = "top"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:10

+

Defined in src/renderer/components/tooltip/tooltip.tsx:10


TOP_LEFT#

TOP_LEFT: = "top_left"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:14

+

Defined in src/renderer/components/tooltip/tooltip.tsx:14


TOP_RIGHT#

TOP_RIGHT: = "top_right"

-

Defined in src/renderer/components/tooltip/tooltip.tsx:15

+

Defined in src/renderer/components/tooltip/tooltip.tsx:15

diff --git a/master/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/master/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html index 76f5d32654..9d4ba3e8f0 100644 --- a/master/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html +++ b/master/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -892,15 +892,15 @@

Enumeration members#

CRITICAL#

CRITICAL: = 3

-

Defined in src/extensions/renderer-api/kube-object-status.ts:10

+

Defined in src/extensions/renderer-api/kube-object-status.ts:10


INFO#

INFO: = 1

-

Defined in src/extensions/renderer-api/kube-object-status.ts:8

+

Defined in src/extensions/renderer-api/kube-object-status.ts:8


WARNING#

WARNING: = 2

-

Defined in src/extensions/renderer-api/kube-object-status.ts:9

+

Defined in src/extensions/renderer-api/kube-object-status.ts:9

diff --git a/master/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/master/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html index 5e0eac446e..37903b3684 100644 --- a/master/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html +++ b/master/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -911,22 +911,22 @@

Properties#

canUpgrade#

canUpgrade: boolean

-

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

+

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

whether the feature can be upgraded or not, as set by the implementation


currentVersion#

currentVersion: string

-

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

+

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

feature's current version, as set by the implementation


installed#

installed: boolean

-

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

+

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

whether the feature is installed or not, as set by the implementation


latestVersion#

latestVersion: string

-

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

+

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

feature's latest version, as set by the implementation

diff --git a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html index 48a42df71e..8d5682ace1 100644 --- a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -962,47 +962,47 @@

Properties#

Optional accessibleNamespaces#

accessibleNamespaces? : string[]

-

Defined in src/common/cluster-store.ts:67

+

Defined in src/common/cluster-store.ts:67

List of accessible namespaces


Optional contextName#

contextName? : string

-

Defined in src/common/cluster-store.ts:53

+

Defined in src/common/cluster-store.ts:53

User context in kubeconfig


id#

id: ClusterId

-

Defined in src/common/cluster-store.ts:44

+

Defined in src/common/cluster-store.ts:44

Unique id for a cluster


Optional kubeConfig#

kubeConfig? : string

-

Defined in src/common/cluster-store.ts:70

+

Defined in src/common/cluster-store.ts:70

deprecated


kubeConfigPath#

kubeConfigPath: string

-

Defined in src/common/cluster-store.ts:47

+

Defined in src/common/cluster-store.ts:47

Path to cluster kubeconfig


Optional metadata#

metadata? : ClusterMetadata

-

Defined in src/common/cluster-store.ts:59

+

Defined in src/common/cluster-store.ts:59

Metadata


Optional ownerRef#

ownerRef? : string

-

Defined in src/common/cluster-store.ts:64

+

Defined in src/common/cluster-store.ts:64

If extension sets ownerRef it has to explicitly mark a cluster as enabled during onActive (or when cluster is saved)


Optional preferences#

preferences? : ClusterPreferences

-

Defined in src/common/cluster-store.ts:56

+

Defined in src/common/cluster-store.ts:56

Preferences


Optional workspace#

workspace? : WorkspaceId

-

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

+

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

Workspace id

diff --git a/master/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/master/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html index 3ed1f27361..5a6ebef3a4 100644 --- a/master/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html +++ b/master/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -930,23 +930,23 @@

Properties#

Optional description#

description? : string

-

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

+

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


id#

id: WorkspaceId

-

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

+

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


Optional lastActiveClusterId#

lastActiveClusterId? : ClusterId

-

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

+

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


name#

name: string

-

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

+

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


Optional ownerRef#

ownerRef? : string

-

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

+

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

diff --git a/master/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html index f413726b0d..598a4a8546 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -895,11 +895,11 @@

Properties#

Hint#

Hint: React.ComponentType‹any›

-

Defined in src/extensions/registries/app-preference-registry.ts:5

+

Defined in src/extensions/registries/app-preference-registry.ts:5


Input#

Input: React.ComponentType‹any›

-

Defined in src/extensions/registries/app-preference-registry.ts:6

+

Defined in src/extensions/registries/app-preference-registry.ts:6

diff --git a/master/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html index 2b18a28518..0c14278e4e 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -895,11 +895,11 @@

Properties#

components#

components: AppPreferenceComponents

-

Defined in src/extensions/registries/app-preference-registry.ts:11

+

Defined in src/extensions/registries/app-preference-registry.ts:11


title#

title: string

-

Defined in src/extensions/registries/app-preference-registry.ts:10

+

Defined in src/extensions/registries/app-preference-registry.ts:10

diff --git a/master/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html index 707517f6a3..9b0e290e07 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -887,7 +887,7 @@

Properties#

Description#

Description: React.ComponentType‹any›

-

Defined in src/extensions/registries/cluster-feature-registry.ts:6

+

Defined in src/extensions/registries/cluster-feature-registry.ts:6

diff --git a/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html index e117f8c31c..4e63156c93 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -903,15 +903,15 @@

Properties#

components#

components: ClusterFeatureComponents

-

Defined in src/extensions/registries/cluster-feature-registry.ts:11

+

Defined in src/extensions/registries/cluster-feature-registry.ts:11


feature#

feature: ClusterFeature

-

Defined in src/extensions/registries/cluster-feature-registry.ts:12

+

Defined in src/extensions/registries/cluster-feature-registry.ts:12


title#

title: string

-

Defined in src/extensions/registries/cluster-feature-registry.ts:10

+

Defined in src/extensions/registries/cluster-feature-registry.ts:10

diff --git a/master/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html index 20d2ac25c6..25368ae8a7 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -921,25 +921,25 @@

components#

components: PageMenuComponents

Inherited from PageMenuRegistration.components

-

Defined in src/extensions/registries/page-menu-registry.ts:12

+

Defined in src/extensions/registries/page-menu-registry.ts:12


Optional id#

id? : string

-

Defined in src/extensions/registries/page-menu-registry.ts:16

+

Defined in src/extensions/registries/page-menu-registry.ts:16


Optional parentId#

parentId? : string

-

Defined in src/extensions/registries/page-menu-registry.ts:17

+

Defined in src/extensions/registries/page-menu-registry.ts:17


Optional target#

target? : PageTarget

Inherited from PageMenuRegistration.target

-

Defined in src/extensions/registries/page-menu-registry.ts:10

+

Defined in src/extensions/registries/page-menu-registry.ts:10


title#

title: React.ReactNode

Inherited from PageMenuRegistration.title

-

Defined in src/extensions/registries/page-menu-registry.ts:11

+

Defined in src/extensions/registries/page-menu-registry.ts:11

diff --git a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html index a5b22e3832..c76610b477 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -887,7 +887,7 @@

Properties#

Details#

Details: React.ComponentType‹any›

-

Defined in src/extensions/registries/kube-object-detail-registry.ts:5

+

Defined in src/extensions/registries/kube-object-detail-registry.ts:5

diff --git a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html index cc4e8e1174..adef168f59 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -911,19 +911,19 @@

Properties#

apiVersions#

apiVersions: string[]

-

Defined in src/extensions/registries/kube-object-detail-registry.ts:10

+

Defined in src/extensions/registries/kube-object-detail-registry.ts:10


components#

components: KubeObjectDetailComponents

-

Defined in src/extensions/registries/kube-object-detail-registry.ts:11

+

Defined in src/extensions/registries/kube-object-detail-registry.ts:11


kind#

kind: string

-

Defined in src/extensions/registries/kube-object-detail-registry.ts:9

+

Defined in src/extensions/registries/kube-object-detail-registry.ts:9


Optional priority#

priority? : number

-

Defined in src/extensions/registries/kube-object-detail-registry.ts:12

+

Defined in src/extensions/registries/kube-object-detail-registry.ts:12

diff --git a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html index 8c5cb71465..3583aa8f80 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -887,7 +887,7 @@

Properties#

MenuItem: React.ComponentType‹any›

-

Defined in src/extensions/registries/kube-object-menu-registry.ts:5

+

Defined in src/extensions/registries/kube-object-menu-registry.ts:5

diff --git a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html index d8e1de0417..bd2dda81d9 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -903,15 +903,15 @@

Properties#

apiVersions#

apiVersions: string[]

-

Defined in src/extensions/registries/kube-object-menu-registry.ts:10

+

Defined in src/extensions/registries/kube-object-menu-registry.ts:10


components#

components: KubeObjectMenuComponents

-

Defined in src/extensions/registries/kube-object-menu-registry.ts:11

+

Defined in src/extensions/registries/kube-object-menu-registry.ts:11


kind#

kind: string

-

Defined in src/extensions/registries/kube-object-menu-registry.ts:9

+

Defined in src/extensions/registries/kube-object-menu-registry.ts:9

diff --git a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html index 50e2089795..cfb84376c1 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -903,15 +903,15 @@

Properties#

apiVersions#

apiVersions: string[]

-

Defined in src/extensions/registries/kube-object-status-registry.ts:6

+

Defined in src/extensions/registries/kube-object-status-registry.ts:6


kind#

kind: string

-

Defined in src/extensions/registries/kube-object-status-registry.ts:5

+

Defined in src/extensions/registries/kube-object-status-registry.ts:5


resolve#

resolve: function

-

Defined in src/extensions/registries/kube-object-status-registry.ts:7

+

Defined in src/extensions/registries/kube-object-status-registry.ts:7

Type declaration:

▸ (object: KubeObject): KubeObjectStatus

Parameters:

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/master/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html index 2be18d0a66..93af7c2366 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -896,7 +896,7 @@

Properties#

Optional params#

params? : object

-

Defined in src/extensions/registries/page-registry.ts:38

+

Defined in src/extensions/registries/page-registry.ts:38

Type declaration:

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html index ec11e6d693..77199d67be 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -887,7 +887,7 @@

Properties#

Page#

Page: React.ComponentType‹any›

-

Defined in src/extensions/registries/page-registry.ts:24

+

Defined in src/extensions/registries/page-registry.ts:24

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/master/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html index 2cd450703f..05ee88f67f 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -887,7 +887,7 @@

Properties#

Icon#

Icon: React.ComponentType‹IconProps

-

Defined in src/extensions/registries/page-menu-registry.ts:21

+

Defined in src/extensions/registries/page-menu-registry.ts:21

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html index 1a7c4cfc73..df052f2127 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -904,15 +904,15 @@

Properties#

components#

components: PageMenuComponents

-

Defined in src/extensions/registries/page-menu-registry.ts:12

+

Defined in src/extensions/registries/page-menu-registry.ts:12


Optional target#

target? : PageTarget

-

Defined in src/extensions/registries/page-menu-registry.ts:10

+

Defined in src/extensions/registries/page-menu-registry.ts:10


title#

title: React.ReactNode

-

Defined in src/extensions/registries/page-menu-registry.ts:11

+

Defined in src/extensions/registries/page-menu-registry.ts:11

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html index f8d5c8ba51..f473b740bc 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -903,17 +903,17 @@

Properties#

components#

components: PageComponents

-

Defined in src/extensions/registries/page-registry.ts:17

+

Defined in src/extensions/registries/page-registry.ts:17


Optional id#

id? : string

-

Defined in src/extensions/registries/page-registry.ts:15

+

Defined in src/extensions/registries/page-registry.ts:15

Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension


Optional params#

params? : PageParams‹string | ExtensionPageParamInit›

-

Defined in src/extensions/registries/page-registry.ts:16

+

Defined in src/extensions/registries/page-registry.ts:16

diff --git a/master/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/master/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html index 4d9c677991..7e3c59db9f 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -912,15 +912,15 @@

Properties#

Optional extensionId#

extensionId? : string

-

Defined in src/extensions/registries/page-registry.ts:28

+

Defined in src/extensions/registries/page-registry.ts:28


Optional pageId#

pageId? : string

-

Defined in src/extensions/registries/page-registry.ts:29

+

Defined in src/extensions/registries/page-registry.ts:29


Optional params#

params? : P

-

Defined in src/extensions/registries/page-registry.ts:30

+

Defined in src/extensions/registries/page-registry.ts:30

diff --git a/master/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/master/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html index 9517feb0fb..9fa06dd4e5 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -919,23 +919,23 @@

Properties#

components#

components: PageComponents

-

Defined in src/extensions/registries/page-registry.ts:48

+

Defined in src/extensions/registries/page-registry.ts:48


extensionId#

extensionId: string

-

Defined in src/extensions/registries/page-registry.ts:45

+

Defined in src/extensions/registries/page-registry.ts:45


id#

id: string

-

Defined in src/extensions/registries/page-registry.ts:44

+

Defined in src/extensions/registries/page-registry.ts:44


params#

params: PageParamsPageParam

-

Defined in src/extensions/registries/page-registry.ts:47

+

Defined in src/extensions/registries/page-registry.ts:47


url#

url: string

-

Defined in src/extensions/registries/page-registry.ts:46

+

Defined in src/extensions/registries/page-registry.ts:46

diff --git a/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html index 11cbfa267f..5cc80cc6ce 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -887,7 +887,7 @@

Properties#

Optional item#

item? : React.ReactNode

-

Defined in src/extensions/registries/status-bar-registry.ts:7

+

Defined in src/extensions/registries/status-bar-registry.ts:7

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html index 7b6b80584c..aec3e02332 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -3359,7 +3359,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional flat#

flat? : boolean

-

Defined in src/renderer/components/badge/badge.tsx:9

+

Defined in src/renderer/components/badge/badge.tsx:9


Optional hidden#

hidden? : boolean

@@ -3417,7 +3417,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional label#

label? : React.ReactNode

-

Defined in src/renderer/components/badge/badge.tsx:10

+

Defined in src/renderer/components/badge/badge.tsx:10


Optional lang#

lang? : string

@@ -4271,7 +4271,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional small#

small? : boolean

-

Defined in src/renderer/components/badge/badge.tsx:8

+

Defined in src/renderer/components/badge/badge.tsx:8


Optional spellCheck#

spellCheck? : Booleanish

@@ -4306,12 +4306,12 @@ A hint could be a sample value or a brief description of the expected format.

Optional tooltip#

tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

Inherited from ButtonProps.tooltip

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:10

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:10


Optional tooltipOverrideDisabled#

tooltipOverrideDisabled? : boolean

Inherited from ButtonProps.tooltipOverrideDisabled

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


diff --git a/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html index fba66e9fba..767be3566d 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -3114,7 +3114,7 @@

Optional accent#

accent? : boolean

-

Defined in src/renderer/components/button/button.tsx:10

+

Defined in src/renderer/components/button/button.tsx:10


Optional accessKey#

accessKey? : string

@@ -3123,7 +3123,7 @@

Optional active#

active? : boolean

-

Defined in src/renderer/components/button/button.tsx:14

+

Defined in src/renderer/components/button/button.tsx:14


Optional aria-activedescendant#

aria-activedescendant? : string

@@ -3465,7 +3465,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional big#

big? : boolean

-

Defined in src/renderer/components/button/button.tsx:15

+

Defined in src/renderer/components/button/button.tsx:15


Optional children#

children? : ReactNode

@@ -3564,11 +3564,11 @@ A hint could be a sample value or a brief description of the expected format.

Optional hidden#

hidden? : boolean

Overrides IconProps.hidden

-

Defined in src/renderer/components/button/button.tsx:13

+

Defined in src/renderer/components/button/button.tsx:13


Optional href#

href? : string

-

Defined in src/renderer/components/button/button.tsx:17

+

Defined in src/renderer/components/button/button.tsx:17


Optional id#

id? : string

@@ -3621,7 +3621,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional label#

label? : React.ReactNode

-

Defined in src/renderer/components/button/button.tsx:7

+

Defined in src/renderer/components/button/button.tsx:7


Optional lang#

lang? : string

@@ -4435,7 +4435,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional outlined#

outlined? : boolean

-

Defined in src/renderer/components/button/button.tsx:12

+

Defined in src/renderer/components/button/button.tsx:12


Optional placeholder#

placeholder? : string

@@ -4444,7 +4444,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional plain#

plain? : boolean

-

Defined in src/renderer/components/button/button.tsx:11

+

Defined in src/renderer/components/button/button.tsx:11


Optional prefix#

prefix? : string

@@ -4453,7 +4453,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional primary#

primary? : boolean

-

Defined in src/renderer/components/button/button.tsx:9

+

Defined in src/renderer/components/button/button.tsx:9


Optional property#

property? : string

@@ -4482,7 +4482,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional round#

round? : boolean

-

Defined in src/renderer/components/button/button.tsx:16

+

Defined in src/renderer/components/button/button.tsx:16


Optional security#

security? : string

@@ -4521,7 +4521,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional target#

target? : "_blank"

-

Defined in src/renderer/components/button/button.tsx:18

+

Defined in src/renderer/components/button/button.tsx:18


Optional title#

title? : string

@@ -4531,12 +4531,12 @@ A hint could be a sample value or a brief description of the expected format.

Optional tooltip#

tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

Inherited from ButtonProps.tooltip

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:10

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:10


Optional tooltipOverrideDisabled#

tooltipOverrideDisabled? : boolean

Inherited from ButtonProps.tooltipOverrideDisabled

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


@@ -4572,7 +4572,7 @@ useful for displaying tooltips even when the target is "disabled"


Optional waiting#

waiting? : boolean

-

Defined in src/renderer/components/button/button.tsx:8

+

Defined in src/renderer/components/button/button.tsx:8

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html index 2da22810c7..90db686dae 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -967,31 +967,31 @@

Properties#

Optional className#

className? : string

-

Defined in src/renderer/components/checkbox/checkbox.tsx:7

+

Defined in src/renderer/components/checkbox/checkbox.tsx:7


Optional disabled#

disabled? : boolean

-

Defined in src/renderer/components/checkbox/checkbox.tsx:10

+

Defined in src/renderer/components/checkbox/checkbox.tsx:10


Optional inline#

inline? : boolean

-

Defined in src/renderer/components/checkbox/checkbox.tsx:9

+

Defined in src/renderer/components/checkbox/checkbox.tsx:9


Optional label#

label? : React.ReactNode

-

Defined in src/renderer/components/checkbox/checkbox.tsx:8

+

Defined in src/renderer/components/checkbox/checkbox.tsx:8


Optional theme#

theme? : "dark" | "light"

-

Defined in src/renderer/components/checkbox/checkbox.tsx:6

+

Defined in src/renderer/components/checkbox/checkbox.tsx:6


Optional value#

value? : T

-

Defined in src/renderer/components/checkbox/checkbox.tsx:11

+

Defined in src/renderer/components/checkbox/checkbox.tsx:11

Methods#

Optional onChange#

onChange(value: T, evt: ChangeEvent‹HTMLInputElement›): void

-

Defined in src/renderer/components/checkbox/checkbox.tsx:12

+

Defined in src/renderer/components/checkbox/checkbox.tsx:12

Parameters:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html index 5260b85b89..1f0e2e085a 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -935,33 +935,33 @@

Properties#

Optional cancelButtonProps#

cancelButtonProps? : Partial‹ButtonProps

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21


Optional icon#

icon? : ReactNode

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19


Optional labelCancel#

labelCancel? : ReactNode

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17


Optional labelOk#

labelOk? : ReactNode

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16


Optional message#

message? : ReactNode

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18


Optional ok#

ok? : function

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

Type declaration:

▸ (): void


Optional okButtonProps#

okButtonProps? : Partial‹ButtonProps

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html index d102926fb9..104bb93df1 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -895,11 +895,11 @@

Properties#

Optional center#

center? : boolean

-

Defined in src/renderer/components/spinner/cube-spinner.tsx:7

+

Defined in src/renderer/components/spinner/cube-spinner.tsx:7


Optional className#

className? : string

-

Defined in src/renderer/components/spinner/cube-spinner.tsx:6

+

Defined in src/renderer/components/spinner/cube-spinner.tsx:6

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html index 6170136ca0..efa675e072 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -951,47 +951,47 @@

Properties#

Optional animated#

animated? : boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:22

+

Defined in src/renderer/components/dialog/dialog.tsx:22


Optional className#

className? : string

-

Defined in src/renderer/components/dialog/dialog.tsx:14

+

Defined in src/renderer/components/dialog/dialog.tsx:14


Optional close#

close? : function

-

Defined in src/renderer/components/dialog/dialog.tsx:17

+

Defined in src/renderer/components/dialog/dialog.tsx:17

Type declaration:

▸ (): void


Optional isOpen#

isOpen? : boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:15

+

Defined in src/renderer/components/dialog/dialog.tsx:15


Optional modal#

modal? : boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:20

+

Defined in src/renderer/components/dialog/dialog.tsx:20


Optional onClose#

onClose? : function

-

Defined in src/renderer/components/dialog/dialog.tsx:19

+

Defined in src/renderer/components/dialog/dialog.tsx:19

Type declaration:

▸ (): void


Optional onOpen#

onOpen? : function

-

Defined in src/renderer/components/dialog/dialog.tsx:18

+

Defined in src/renderer/components/dialog/dialog.tsx:18

Type declaration:

▸ (): void


Optional open#

open? : function

-

Defined in src/renderer/components/dialog/dialog.tsx:16

+

Defined in src/renderer/components/dialog/dialog.tsx:16

Type declaration:

▸ (): void


Optional pinned#

pinned? : boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:21

+

Defined in src/renderer/components/dialog/dialog.tsx:21

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html index a9d05cf9e7..f420083c1e 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -3292,7 +3292,7 @@ A hint could be a sample value or a brief description of the expected format.

className? : string

Inherited from DrawerItemProps.className

Overrides ButtonProps.className

-

Defined in src/renderer/components/drawer/drawer-item.tsx:7

+

Defined in src/renderer/components/drawer/drawer-item.tsx:7


Optional color#

color? : string

@@ -3347,7 +3347,7 @@ A hint could be a sample value or a brief description of the expected format.

hidden? : boolean

Inherited from DrawerItemProps.hidden

Overrides IconProps.hidden

-

Defined in src/renderer/components/drawer/drawer-item.tsx:10

+

Defined in src/renderer/components/drawer/drawer-item.tsx:10


Optional id#

id? : string

@@ -3400,12 +3400,12 @@ A hint could be a sample value or a brief description of the expected format.

labels#

labels: string[]

-

Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6

+

Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6


Optional labelsOnly#

labelsOnly? : boolean

Inherited from DrawerItemProps.labelsOnly

-

Defined in src/renderer/components/drawer/drawer-item.tsx:9

+

Defined in src/renderer/components/drawer/drawer-item.tsx:9


Optional lang#

lang? : string

@@ -3415,7 +3415,7 @@ A hint could be a sample value or a brief description of the expected format.

name#

name: React.ReactNode

Inherited from DrawerItemProps.name

-

Defined in src/renderer/components/drawer/drawer-item.tsx:6

+

Defined in src/renderer/components/drawer/drawer-item.tsx:6


Optional onAbort#

onAbort? : ReactEventHandler‹any›

@@ -4240,7 +4240,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional renderBoolean#

renderBoolean? : boolean

Inherited from DrawerItemProps.renderBoolean

-

Defined in src/renderer/components/drawer/drawer-item.tsx:11

+

Defined in src/renderer/components/drawer/drawer-item.tsx:11


Optional resource#

resource? : string

@@ -4296,7 +4296,7 @@ A hint could be a sample value or a brief description of the expected format.

title? : string

Inherited from DrawerItemProps.title

Overrides ButtonProps.title

-

Defined in src/renderer/components/drawer/drawer-item.tsx:8

+

Defined in src/renderer/components/drawer/drawer-item.tsx:8


Optional translate#

translate? : "yes" | "no"

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html index fb0b69bd8b..891f2aa917 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -3286,7 +3286,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional className#

className? : string

Overrides ButtonProps.className

-

Defined in src/renderer/components/drawer/drawer-item.tsx:7

+

Defined in src/renderer/components/drawer/drawer-item.tsx:7


Optional color#

color? : string

@@ -3340,7 +3340,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional hidden#

hidden? : boolean

Overrides IconProps.hidden

-

Defined in src/renderer/components/drawer/drawer-item.tsx:10

+

Defined in src/renderer/components/drawer/drawer-item.tsx:10


Optional id#

id? : string

@@ -3393,7 +3393,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional labelsOnly#

labelsOnly? : boolean

-

Defined in src/renderer/components/drawer/drawer-item.tsx:9

+

Defined in src/renderer/components/drawer/drawer-item.tsx:9


Optional lang#

lang? : string

@@ -3402,7 +3402,7 @@ A hint could be a sample value or a brief description of the expected format.

name#

name: React.ReactNode

-

Defined in src/renderer/components/drawer/drawer-item.tsx:6

+

Defined in src/renderer/components/drawer/drawer-item.tsx:6


Optional onAbort#

onAbort? : ReactEventHandler‹any›

@@ -4226,7 +4226,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional renderBoolean#

renderBoolean? : boolean

-

Defined in src/renderer/components/drawer/drawer-item.tsx:11

+

Defined in src/renderer/components/drawer/drawer-item.tsx:11


Optional resource#

resource? : string

@@ -4281,7 +4281,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional title#

title? : string

Overrides ButtonProps.title

-

Defined in src/renderer/components/drawer/drawer-item.tsx:8

+

Defined in src/renderer/components/drawer/drawer-item.tsx:8


Optional translate#

translate? : "yes" | "no"

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html index f211e3d92d..ea3520d358 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -887,7 +887,7 @@

Properties#

label#

label: string | number

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

+

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html index 02d5143ca7..9cd57ee60b 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -959,45 +959,45 @@

Properties#

Optional animation#

animation? : AnimateName

-

Defined in src/renderer/components/drawer/drawer.tsx:18

+

Defined in src/renderer/components/drawer/drawer.tsx:18


Optional className#

className? : string | object

-

Defined in src/renderer/components/drawer/drawer.tsx:15

+

Defined in src/renderer/components/drawer/drawer.tsx:15


Optional contentClass#

contentClass? : string | object

-

Defined in src/renderer/components/drawer/drawer.tsx:16

+

Defined in src/renderer/components/drawer/drawer.tsx:16


Optional onClose#

onClose? : function

-

Defined in src/renderer/components/drawer/drawer.tsx:19

+

Defined in src/renderer/components/drawer/drawer.tsx:19

Type declaration:

▸ (): void


open#

open: boolean

-

Defined in src/renderer/components/drawer/drawer.tsx:11

+

Defined in src/renderer/components/drawer/drawer.tsx:11


Optional position#

position? : "top" | "left" | "right" | "bottom"

-

Defined in src/renderer/components/drawer/drawer.tsx:17

+

Defined in src/renderer/components/drawer/drawer.tsx:17


Optional size#

size? : string

-

Defined in src/renderer/components/drawer/drawer.tsx:13

+

Defined in src/renderer/components/drawer/drawer.tsx:13


title#

title: React.ReactNode

-

Defined in src/renderer/components/drawer/drawer.tsx:12

+

Defined in src/renderer/components/drawer/drawer.tsx:12


Optional toolbar#

toolbar? : React.ReactNode

-

Defined in src/renderer/components/drawer/drawer.tsx:20

+

Defined in src/renderer/components/drawer/drawer.tsx:20


Optional usePortal#

usePortal? : boolean

-

Defined in src/renderer/components/drawer/drawer.tsx:14

+

Defined in src/renderer/components/drawer/drawer.tsx:14

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html index 40f1951b2a..6d84239e5e 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -895,11 +895,11 @@

Properties#

Optional className#

className? : string

-

Defined in src/renderer/components/drawer/drawer-title.tsx:6

+

Defined in src/renderer/components/drawer/drawer-title.tsx:6


Optional title#

title? : React.ReactNode

-

Defined in src/renderer/components/drawer/drawer-title.tsx:7

+

Defined in src/renderer/components/drawer/drawer-title.tsx:7

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html index 035907b024..999f50dfb6 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -904,11 +904,11 @@

Properties#

label#

label: ReactNode

-

Defined in src/renderer/components/select/select.tsx:16

+

Defined in src/renderer/components/select/select.tsx:16


options#

options: T[]

-

Defined in src/renderer/components/select/select.tsx:17

+

Defined in src/renderer/components/select/select.tsx:17

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html index 44a2b38b4a..ee4655559a 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -3047,7 +3047,7 @@

Optional active#

active? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:20

+

Defined in src/renderer/components/icon/icon.tsx:20


Optional aria-activedescendant#

aria-activedescendant? : string

@@ -3384,7 +3384,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional big#

big? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:19

+

Defined in src/renderer/components/icon/icon.tsx:19


Optional children#

children? : ReactNode

@@ -3442,7 +3442,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional disabled#

disabled? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:24

+

Defined in src/renderer/components/icon/icon.tsx:24


Optional draggable#

draggable? : Booleanish

@@ -3451,7 +3451,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional focusable#

focusable? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:22

+

Defined in src/renderer/components/icon/icon.tsx:22


Optional hidden#

hidden? : boolean

@@ -3460,7 +3460,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional href#

href? : string

-

Defined in src/renderer/components/icon/icon.tsx:15

+

Defined in src/renderer/components/icon/icon.tsx:15


Optional id#

id? : string

@@ -3481,7 +3481,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional interactive#

interactive? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:21

+

Defined in src/renderer/components/icon/icon.tsx:21


Optional is#

is? : string

@@ -3522,11 +3522,11 @@ A hint could be a sample value or a brief description of the expected format.

link? : LocationDescriptor

-

Defined in src/renderer/components/icon/icon.tsx:14

+

Defined in src/renderer/components/icon/icon.tsx:14


Optional material#

material? : string

-

Defined in src/renderer/components/icon/icon.tsx:12

+

Defined in src/renderer/components/icon/icon.tsx:12


Optional onAbort#

onAbort? : ReactEventHandler‹any›

@@ -4370,7 +4370,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional size#

size? : string | number

-

Defined in src/renderer/components/icon/icon.tsx:16

+

Defined in src/renderer/components/icon/icon.tsx:16


Optional slot#

slot? : string

@@ -4379,11 +4379,11 @@ A hint could be a sample value or a brief description of the expected format.

Optional small#

small? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:17

+

Defined in src/renderer/components/icon/icon.tsx:17


Optional smallest#

smallest? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:18

+

Defined in src/renderer/components/icon/icon.tsx:18


Optional spellCheck#

spellCheck? : Booleanish

@@ -4392,7 +4392,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional sticker#

sticker? : boolean

-

Defined in src/renderer/components/icon/icon.tsx:23

+

Defined in src/renderer/components/icon/icon.tsx:23


Optional style#

style? : CSSProperties

@@ -4411,7 +4411,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional svg#

svg? : string

-

Defined in src/renderer/components/icon/icon.tsx:13

+

Defined in src/renderer/components/icon/icon.tsx:13


Optional tabIndex#

tabIndex? : number

@@ -4426,12 +4426,12 @@ A hint could be a sample value or a brief description of the expected format.

Optional tooltip#

tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

Inherited from ButtonProps.tooltip

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:10

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:10


Optional tooltipOverrideDisabled#

tooltipOverrideDisabled? : boolean

Inherited from ButtonProps.tooltipOverrideDisabled

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


diff --git a/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html index 6bc5f6108e..a256a3d0c4 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -934,15 +934,15 @@

Properties#

Optional debounce#

debounce? : number

-

Defined in src/renderer/components/input/input_validators.ts:6

+

Defined in src/renderer/components/input/input_validators.ts:6


Optional message#

message? : ReactNode | function

-

Defined in src/renderer/components/input/input_validators.ts:8

+

Defined in src/renderer/components/input/input_validators.ts:8

Methods#

Optional condition#

condition(props: InputProps): boolean

-

Defined in src/renderer/components/input/input_validators.ts:7

+

Defined in src/renderer/components/input/input_validators.ts:7

Parameters:

@@ -962,7 +962,7 @@

validate#

validate(value: string, props?: InputProps): boolean | Promise‹any›

-

Defined in src/renderer/components/input/input_validators.ts:9

+

Defined in src/renderer/components/input/input_validators.ts:9

Parameters:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html index c28668c3e5..9eeed1150c 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -887,7 +887,7 @@

Properties#

object#

object: KubeObject

-

Defined in src/renderer/components/+events/kube-event-details.tsx:11

+

Defined in src/renderer/components/+events/kube-event-details.tsx:11

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html index a0a29d7f15..08fce51185 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -904,11 +904,11 @@

Properties#

Optional className#

className? : string

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:54

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:54


object#

object: T

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:55

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:55

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html index f8e8f93d25..4c67878d2f 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -1114,22 +1114,22 @@

Optional addRemoveButtons#

addRemoveButtons? : Partial‹AddRemoveButtonsProps›

Inherited from KubeObjectListLayoutProps.addRemoveButtons

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60


className#

className: IClassName

Inherited from KubeObjectListLayoutProps.className

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:35

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:35


Optional copyClassNameFromHeadCells#

copyClassNameFromHeadCells? : boolean

Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53


Optional customizeHeader#

customizeHeader? : function

Inherited from KubeObjectListLayoutProps.customizeHeader

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

Type declaration:

▸ (placeholders: IHeaderPlaceholders, content: ReactNode): Partial‹IHeaderPlaceholders› | ReactNode

Parameters:

@@ -1155,7 +1155,7 @@

Optional customizeRemoveDialog#

customizeRemoveDialog? : function

Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

Type declaration:

▸ (selectedItems: T[]): Partial‹ConfirmDialogParams

Parameters:

@@ -1177,7 +1177,7 @@

Optional customizeTableRowProps#

customizeTableRowProps? : function

Inherited from KubeObjectListLayoutProps.customizeTableRowProps

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

Type declaration:

▸ (item: T): Partial‹TableRowProps

Parameters:

@@ -1199,57 +1199,57 @@

Optional dependentStores#

dependentStores? : ItemStore[]

Inherited from KubeObjectListLayoutProps.dependentStores

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:37

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:37


Optional detailsItem#

detailsItem? : T

Inherited from KubeObjectListLayoutProps.detailsItem

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65


Optional filterItems#

filterItems? : ItemsFilter‹T›[]

Inherited from KubeObjectListLayoutProps.filterItems

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41


Optional hasDetailsView#

hasDetailsView? : boolean

Inherited from KubeObjectListLayoutProps.hasDetailsView

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:64

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:64


Optional headerClassName#

headerClassName? : IClassName

Inherited from KubeObjectListLayoutProps.headerClassName

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45


Optional hideFilters#

hideFilters? : boolean

Inherited from KubeObjectListLayoutProps.hideFilters

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:39

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:39


Optional isClusterScoped#

isClusterScoped? : boolean

Inherited from KubeObjectListLayoutProps.isClusterScoped

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:38

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:38


Optional isReady#

isReady? : boolean

Inherited from KubeObjectListLayoutProps.isReady

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:50

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:50


Optional isSearchable#

isSearchable? : boolean

Inherited from KubeObjectListLayoutProps.isSearchable

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52


Optional isSelectable#

isSelectable? : boolean

Inherited from KubeObjectListLayoutProps.isSelectable

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:51

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:51


Optional onDetails#

onDetails? : function

Inherited from KubeObjectListLayoutProps.onDetails

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

Type declaration:

▸ (item: T): void

Parameters:

@@ -1271,7 +1271,7 @@

Optional renderFooter#

renderFooter? : function

Inherited from KubeObjectListLayoutProps.renderFooter

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:70

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:70

Type declaration:

▸ (parent: ItemListLayout): React.ReactNode

Parameters:

@@ -1293,12 +1293,12 @@

Optional renderHeaderTitle#

renderHeaderTitle? : ReactNode | function

Inherited from KubeObjectListLayoutProps.renderHeaderTitle

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46


Optional renderItemMenu#

renderItemMenu? : function

Inherited from KubeObjectListLayoutProps.renderItemMenu

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

Type declaration:

▸ (item: T, store: ItemStore‹T›): ReactNode

Parameters:

@@ -1324,7 +1324,7 @@

renderTableContents#

renderTableContents: function

Inherited from KubeObjectListLayoutProps.renderTableContents

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:57

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:57

Type declaration:

▸ (item: T): (string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹› | TableCellProps‹›)[]

Parameters:

@@ -1346,22 +1346,22 @@

renderTableHeader#

renderTableHeader: TableCellProps[] | null

Inherited from KubeObjectListLayoutProps.renderTableHeader

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:56

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:56


Optional searchFilters#

searchFilters? : SearchFilter‹T›[]

Inherited from KubeObjectListLayoutProps.searchFilters

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40


Optional showHeader#

showHeader? : boolean

Inherited from KubeObjectListLayoutProps.showHeader

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44


Optional sortingCallbacks#

sortingCallbacks? : object

Inherited from KubeObjectListLayoutProps.sortingCallbacks

-

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

Type declaration:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html index e25fa26bc5..89aecacad8 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -904,11 +904,11 @@

Properties#

Optional label#

label? : React.ReactNode

-

Defined in src/renderer/components/select/select.tsx:22

+

Defined in src/renderer/components/select/select.tsx:22


value#

value: T

-

Defined in src/renderer/components/select/select.tsx:21

+

Defined in src/renderer/components/select/select.tsx:21

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html index e0240a9c4b..eef7cf17a0 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -1540,7 +1540,7 @@

Optional autoConvertOptions#

autoConvertOptions? : boolean

-

Defined in src/renderer/components/select/select.tsx:30

+

Defined in src/renderer/components/select/select.tsx:30


Optional autoFocus#

autoFocus? : boolean

@@ -1748,7 +1748,7 @@

Optional isCreatable#

isCreatable? : boolean

-

Defined in src/renderer/components/select/select.tsx:29

+

Defined in src/renderer/components/select/select.tsx:29


Optional isDisabled#

isDisabled? : boolean

@@ -1887,7 +1887,7 @@

Optional menuClass#

menuClass? : string

-

Defined in src/renderer/components/select/select.tsx:28

+

Defined in src/renderer/components/select/select.tsx:28


Optional menuIsOpen#

menuIsOpen? : boolean

@@ -2143,17 +2143,17 @@

Optional themeName#

themeName? : "dark" | "light" | "outlined"

-

Defined in src/renderer/components/select/select.tsx:27

+

Defined in src/renderer/components/select/select.tsx:27


Optional value#

value? : T

Overrides void

-

Defined in src/renderer/components/select/select.tsx:26

+

Defined in src/renderer/components/select/select.tsx:26

Methods#

Optional onChange#

onChange(option: T, meta?: ActionMeta‹any›): void

Overrides void

-

Defined in src/renderer/components/select/select.tsx:31

+

Defined in src/renderer/components/select/select.tsx:31

Parameters:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html index 130c97b18f..d14b2bb949 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -919,11 +919,11 @@

Properties#

Optional className#

className? : string

-

Defined in src/renderer/components/slider/slider.tsx:10

+

Defined in src/renderer/components/slider/slider.tsx:10

Methods#

Optional onChange#

onChange(evt: FormEvent‹any›, value: number): void

-

Defined in src/renderer/components/slider/slider.tsx:11

+

Defined in src/renderer/components/slider/slider.tsx:11

Parameters:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html index 64bee9def0..3b9ff5c1a8 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -4205,11 +4205,11 @@ A hint could be a sample value or a brief description of the expected format.

Optional center#

center? : boolean

-

Defined in src/renderer/components/spinner/spinner.tsx:8

+

Defined in src/renderer/components/spinner/spinner.tsx:8


Optional centerHorizontal#

centerHorizontal? : boolean

-

Defined in src/renderer/components/spinner/spinner.tsx:9

+

Defined in src/renderer/components/spinner/spinner.tsx:9


Optional challenge#

challenge? : string

@@ -5552,7 +5552,7 @@ A hint could be a sample value or a brief description of the expected format.

Optional singleColor#

singleColor? : boolean

-

Defined in src/renderer/components/spinner/spinner.tsx:7

+

Defined in src/renderer/components/spinner/spinner.tsx:7


Optional size#

size? : number

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html index d9d47be867..035ad66660 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -4270,12 +4270,12 @@ A hint could be a sample value or a brief description of the expected format.

Optional tooltip#

tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

Inherited from ButtonProps.tooltip

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:10

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:10


Optional tooltipOverrideDisabled#

tooltipOverrideDisabled? : boolean

Inherited from ButtonProps.tooltipOverrideDisabled

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


diff --git a/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html index b7da3aa192..2350526681 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -5579,11 +5579,11 @@ A hint could be a sample value or a brief description of the expected format.

step#

step: number

Overrides LineProgressProps.step

-

Defined in src/renderer/components/stepper/stepper.tsx:6

+

Defined in src/renderer/components/stepper/stepper.tsx:6


steps#

steps: Step[]

-

Defined in src/renderer/components/stepper/stepper.tsx:7

+

Defined in src/renderer/components/stepper/stepper.tsx:7


Optional style#

style? : CSSProperties

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html index b9d8313618..74eca48b1c 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -911,19 +911,19 @@

Properties#

Optional children#

children? : ReactNode

-

Defined in src/renderer/components/layout/tab-layout.tsx:15

+

Defined in src/renderer/components/layout/tab-layout.tsx:15


Optional className#

className? : IClassName

-

Defined in src/renderer/components/layout/tab-layout.tsx:12

+

Defined in src/renderer/components/layout/tab-layout.tsx:12


Optional contentClass#

contentClass? : IClassName

-

Defined in src/renderer/components/layout/tab-layout.tsx:13

+

Defined in src/renderer/components/layout/tab-layout.tsx:13


Optional tabs#

tabs? : TabLayoutRoute[]

-

Defined in src/renderer/components/layout/tab-layout.tsx:14

+

Defined in src/renderer/components/layout/tab-layout.tsx:14

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html index cdb0525c94..683a768b47 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -927,27 +927,27 @@

Properties#

component#

component: React.ComponentType‹any›

-

Defined in src/renderer/components/layout/tab-layout.tsx:21

+

Defined in src/renderer/components/layout/tab-layout.tsx:21


Optional default#

default? : boolean

-

Defined in src/renderer/components/layout/tab-layout.tsx:24

+

Defined in src/renderer/components/layout/tab-layout.tsx:24


Optional exact#

exact? : boolean

-

Defined in src/renderer/components/layout/tab-layout.tsx:23

+

Defined in src/renderer/components/layout/tab-layout.tsx:23


routePath#

routePath: string

-

Defined in src/renderer/components/layout/tab-layout.tsx:19

+

Defined in src/renderer/components/layout/tab-layout.tsx:19


title#

title: React.ReactNode

-

Defined in src/renderer/components/layout/tab-layout.tsx:20

+

Defined in src/renderer/components/layout/tab-layout.tsx:20


Optional url#

url? : string

-

Defined in src/renderer/components/layout/tab-layout.tsx:22

+

Defined in src/renderer/components/layout/tab-layout.tsx:22

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html index f45b3d64cc..1e72eadb73 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -2271,15 +2271,15 @@

Properties#

Optional _nowrap#

_nowrap? : boolean

-

Defined in src/renderer/components/table/table-cell.tsx:20

+

Defined in src/renderer/components/table/table-cell.tsx:20


Optional _sorting#

_sorting? : Partial‹TableSortParams

-

Defined in src/renderer/components/table/table-cell.tsx:18

+

Defined in src/renderer/components/table/table-cell.tsx:18


Optional checkbox#

checkbox? : boolean

-

Defined in src/renderer/components/table/table-cell.tsx:14

+

Defined in src/renderer/components/table/table-cell.tsx:14


Optional children#

children? : ReactNode

@@ -2288,7 +2288,7 @@

Optional className#

className? : string

-

Defined in src/renderer/components/table/table-cell.tsx:12

+

Defined in src/renderer/components/table/table-cell.tsx:12


Optional dangerouslySetInnerHTML#

dangerouslySetInnerHTML? : object

@@ -2301,7 +2301,7 @@

Optional isChecked#

isChecked? : boolean

-

Defined in src/renderer/components/table/table-cell.tsx:15

+

Defined in src/renderer/components/table/table-cell.tsx:15


Optional onAbort#

onAbort? : ReactEventHandler‹HTMLDivElement›

@@ -3105,19 +3105,19 @@

Optional renderBoolean#

renderBoolean? : boolean

-

Defined in src/renderer/components/table/table-cell.tsx:16

+

Defined in src/renderer/components/table/table-cell.tsx:16


Optional sortBy#

sortBy? : TableSortBy

-

Defined in src/renderer/components/table/table-cell.tsx:17

+

Defined in src/renderer/components/table/table-cell.tsx:17


Optional title#

title? : ReactNode

-

Defined in src/renderer/components/table/table-cell.tsx:13

+

Defined in src/renderer/components/table/table-cell.tsx:13

Methods#

Optional _sort#

_sort(sortBy: TableSortBy): void

-

Defined in src/renderer/components/table/table-cell.tsx:19

+

Defined in src/renderer/components/table/table-cell.tsx:19

Parameters:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html index 581cb9558c..1e91de20ff 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -2213,7 +2213,7 @@

Optional className#

className? : string

-

Defined in src/renderer/components/table/table-head.tsx:9

+

Defined in src/renderer/components/table/table-head.tsx:9


Optional dangerouslySetInnerHTML#

dangerouslySetInnerHTML? : object

@@ -2226,7 +2226,7 @@

Optional nowrap#

nowrap? : boolean

-

Defined in src/renderer/components/table/table-head.tsx:12

+

Defined in src/renderer/components/table/table-head.tsx:12


Optional onAbort#

onAbort? : ReactEventHandler‹HTMLDivElement›

@@ -3030,11 +3030,11 @@

Optional showTopLine#

showTopLine? : boolean

-

Defined in src/renderer/components/table/table-head.tsx:10

+

Defined in src/renderer/components/table/table-head.tsx:10


Optional sticky#

sticky? : boolean

-

Defined in src/renderer/components/table/table-head.tsx:11

+

Defined in src/renderer/components/table/table-head.tsx:11

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html index 4a45ba041b..f9cb53295f 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -2312,7 +2312,7 @@

Properties#

Optional autoSize#

autoSize? : boolean

-

Defined in src/renderer/components/table/table.tsx:23

+

Defined in src/renderer/components/table/table.tsx:23


Optional children#

children? : ReactNode

@@ -2321,11 +2321,11 @@

Optional className#

className? : string

-

Defined in src/renderer/components/table/table.tsx:22

+

Defined in src/renderer/components/table/table.tsx:22


Optional customRowHeights#

customRowHeights? : function

-

Defined in src/renderer/components/table/table.tsx:40

+

Defined in src/renderer/components/table/table.tsx:40

Type declaration:

▸ (item: object, lineHeight: number, paddings: number): number

Parameters:

@@ -2363,7 +2363,7 @@

Optional getTableRow#

getTableRow? : function

-

Defined in src/renderer/components/table/table.tsx:41

+

Defined in src/renderer/components/table/table.tsx:41

Type declaration:

▸ (uid: string): ReactElement‹TableRowProps

Parameters:

@@ -2384,11 +2384,11 @@

Optional items#

items? : ItemObject[]

-

Defined in src/renderer/components/table/table.tsx:21

+

Defined in src/renderer/components/table/table.tsx:21


Optional noItems#

noItems? : React.ReactNode

-

Defined in src/renderer/components/table/table.tsx:35

+

Defined in src/renderer/components/table/table.tsx:35


Optional onAbort#

onAbort? : ReactEventHandler‹HTMLDivElement›

@@ -3072,7 +3072,7 @@

Optional onSort#

onSort? : function

-

Defined in src/renderer/components/table/table.tsx:34

+

Defined in src/renderer/components/table/table.tsx:34

Type declaration:

▸ (params: TableSortParams): void

Parameters:

@@ -3213,35 +3213,35 @@

Optional rowLineHeight#

rowLineHeight? : string

-

Defined in src/renderer/components/table/table.tsx:39

+

Defined in src/renderer/components/table/table.tsx:39


Optional rowPadding#

rowPadding? : string

-

Defined in src/renderer/components/table/table.tsx:38

+

Defined in src/renderer/components/table/table.tsx:38


Optional scrollable#

scrollable? : boolean

-

Defined in src/renderer/components/table/table.tsx:25

+

Defined in src/renderer/components/table/table.tsx:25


Optional selectable#

selectable? : boolean

-

Defined in src/renderer/components/table/table.tsx:24

+

Defined in src/renderer/components/table/table.tsx:24


Optional selectedItemId#

selectedItemId? : string

-

Defined in src/renderer/components/table/table.tsx:36

+

Defined in src/renderer/components/table/table.tsx:36


Optional sortByDefault#

sortByDefault? : Partial‹TableSortParams

-

Defined in src/renderer/components/table/table.tsx:33

+

Defined in src/renderer/components/table/table.tsx:33


Optional sortSyncWithUrl#

sortSyncWithUrl? : boolean

-

Defined in src/renderer/components/table/table.tsx:32

+

Defined in src/renderer/components/table/table.tsx:32


Optional sortable#

sortable? : object

-

Defined in src/renderer/components/table/table.tsx:27

+

Defined in src/renderer/components/table/table.tsx:27

Type declaration:

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html index 39af5ad6b2..e45a355591 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -919,23 +919,23 @@

Properties#

Optional narrow#

narrow? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:34

+

Defined in src/renderer/components/tooltip/tooltip.tsx:34


Optional nowrap#

nowrap? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:37

+

Defined in src/renderer/components/tooltip/tooltip.tsx:37


Optional small#

small? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:36

+

Defined in src/renderer/components/tooltip/tooltip.tsx:36


Optional tableView#

tableView? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:38

+

Defined in src/renderer/components/tooltip/tooltip.tsx:38


Optional warning#

warning? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:35

+

Defined in src/renderer/components/tooltip/tooltip.tsx:35

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html index 3c65c75f2b..c929d39936 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -900,11 +900,11 @@

Properties#

Optional tooltip#

tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:10

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:10


Optional tooltipOverrideDisabled#

tooltipOverrideDisabled? : boolean

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:15

forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html index b805361d88..7a2993937e 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -959,43 +959,43 @@

Properties#

Optional children#

children? : React.ReactNode

-

Defined in src/renderer/components/tooltip/tooltip.tsx:30

+

Defined in src/renderer/components/tooltip/tooltip.tsx:30


Optional className#

className? : IClassName

-

Defined in src/renderer/components/tooltip/tooltip.tsx:27

+

Defined in src/renderer/components/tooltip/tooltip.tsx:27


Optional formatters#

formatters? : TooltipContentFormatters

-

Defined in src/renderer/components/tooltip/tooltip.tsx:28

+

Defined in src/renderer/components/tooltip/tooltip.tsx:28


Optional offset#

offset? : number

-

Defined in src/renderer/components/tooltip/tooltip.tsx:24

+

Defined in src/renderer/components/tooltip/tooltip.tsx:24


Optional preferredPositions#

preferredPositions? : TooltipPosition | TooltipPosition[]

-

Defined in src/renderer/components/tooltip/tooltip.tsx:26

+

Defined in src/renderer/components/tooltip/tooltip.tsx:26


Optional style#

style? : CSSProperties

-

Defined in src/renderer/components/tooltip/tooltip.tsx:29

+

Defined in src/renderer/components/tooltip/tooltip.tsx:29


targetId#

targetId: string

-

Defined in src/renderer/components/tooltip/tooltip.tsx:21

+

Defined in src/renderer/components/tooltip/tooltip.tsx:21


Optional tooltipOnParentHover#

tooltipOnParentHover? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:22

+

Defined in src/renderer/components/tooltip/tooltip.tsx:22


Optional usePortal#

usePortal? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:25

+

Defined in src/renderer/components/tooltip/tooltip.tsx:25


Optional visible#

visible? : boolean

-

Defined in src/renderer/components/tooltip/tooltip.tsx:23

+

Defined in src/renderer/components/tooltip/tooltip.tsx:23

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html index e39174c404..df8254321c 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -2232,7 +2232,7 @@

Properties#

Optional centered#

centered? : boolean

-

Defined in src/renderer/components/layout/wizard-layout.tsx:13

+

Defined in src/renderer/components/layout/wizard-layout.tsx:13


Optional children#

children? : ReactNode

@@ -2241,11 +2241,11 @@

Optional className#

className? : IClassName

-

Defined in src/renderer/components/layout/wizard-layout.tsx:7

+

Defined in src/renderer/components/layout/wizard-layout.tsx:7


Optional contentClass#

contentClass? : IClassName

-

Defined in src/renderer/components/layout/wizard-layout.tsx:10

+

Defined in src/renderer/components/layout/wizard-layout.tsx:10


Optional dangerouslySetInnerHTML#

dangerouslySetInnerHTML? : object

@@ -2258,19 +2258,19 @@

Optional header#

header? : React.ReactNode

-

Defined in src/renderer/components/layout/wizard-layout.tsx:8

+

Defined in src/renderer/components/layout/wizard-layout.tsx:8


Optional headerClass#

headerClass? : IClassName

-

Defined in src/renderer/components/layout/wizard-layout.tsx:9

+

Defined in src/renderer/components/layout/wizard-layout.tsx:9


Optional infoPanel#

infoPanel? : React.ReactNode

-

Defined in src/renderer/components/layout/wizard-layout.tsx:12

+

Defined in src/renderer/components/layout/wizard-layout.tsx:12


Optional infoPanelClass#

infoPanelClass? : IClassName

-

Defined in src/renderer/components/layout/wizard-layout.tsx:11

+

Defined in src/renderer/components/layout/wizard-layout.tsx:11


Optional onAbort#

onAbort? : ReactEventHandler‹any›

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html index 74d9c21af4..58b7139e22 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -969,32 +969,32 @@

Properties#

Optional className#

className? : string

-

Defined in src/renderer/components/wizard/wizard.tsx:18

+

Defined in src/renderer/components/wizard/wizard.tsx:18


Optional data#

data? : Partial‹D›

Inherited from WizardProps.data

-

Defined in src/renderer/components/wizard/wizard.tsx:10

+

Defined in src/renderer/components/wizard/wizard.tsx:10


Optional done#

done? : function

Inherited from WizardProps.done

-

Defined in src/renderer/components/wizard/wizard.tsx:13

+

Defined in src/renderer/components/wizard/wizard.tsx:13

Type declaration:

▸ (): void


Optional header#

header? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:21

+

Defined in src/renderer/components/wizard/wizard.tsx:21


Optional hideSteps#

hideSteps? : boolean

Inherited from WizardProps.hideSteps

-

Defined in src/renderer/components/wizard/wizard.tsx:14

+

Defined in src/renderer/components/wizard/wizard.tsx:14


Optional onChange#

onChange? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:22

+

Defined in src/renderer/components/wizard/wizard.tsx:22

Type declaration:

▸ (step: number): void

Parameters:

@@ -1016,14 +1016,14 @@

Optional reset#

reset? : function

Inherited from WizardProps.reset

-

Defined in src/renderer/components/wizard/wizard.tsx:12

+

Defined in src/renderer/components/wizard/wizard.tsx:12

Type declaration:

▸ (): void


Optional save#

save? : function

Inherited from WizardProps.save

-

Defined in src/renderer/components/wizard/wizard.tsx:11

+

Defined in src/renderer/components/wizard/wizard.tsx:11

Type declaration:

▸ (data: Partial‹D›, callback?: function): void

Parameters:

@@ -1033,11 +1033,11 @@

Optional step#

step? : number

-

Defined in src/renderer/components/wizard/wizard.tsx:19

+

Defined in src/renderer/components/wizard/wizard.tsx:19


Optional title#

title? : string

-

Defined in src/renderer/components/wizard/wizard.tsx:20

+

Defined in src/renderer/components/wizard/wizard.tsx:20

diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html index 7aa3b22d4f..bcd23b7488 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -1129,120 +1129,120 @@

Properties#

Optional afterContent#

afterContent? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:122

+

Defined in src/renderer/components/wizard/wizard.tsx:122


Optional beforeContent#

beforeContent? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:121

+

Defined in src/renderer/components/wizard/wizard.tsx:121


Optional className#

className? : string | object

-

Defined in src/renderer/components/wizard/wizard.tsx:103

+

Defined in src/renderer/components/wizard/wizard.tsx:103


Optional contentClass#

contentClass? : string | object

-

Defined in src/renderer/components/wizard/wizard.tsx:104

+

Defined in src/renderer/components/wizard/wizard.tsx:104


Optional customButtons#

customButtons? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:105

+

Defined in src/renderer/components/wizard/wizard.tsx:105


Optional data#

data? : Partial‹D›

Inherited from WizardProps.data

-

Defined in src/renderer/components/wizard/wizard.tsx:10

+

Defined in src/renderer/components/wizard/wizard.tsx:10


Optional disabledNext#

disabledNext? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:109

+

Defined in src/renderer/components/wizard/wizard.tsx:109


Optional done#

done? : function

Inherited from WizardProps.done

-

Defined in src/renderer/components/wizard/wizard.tsx:13

+

Defined in src/renderer/components/wizard/wizard.tsx:13

Type declaration:

▸ (): void


Optional first#

first? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:117

+

Defined in src/renderer/components/wizard/wizard.tsx:117

Type declaration:

▸ (): void


Optional hideBackBtn#

hideBackBtn? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:111

+

Defined in src/renderer/components/wizard/wizard.tsx:111


Optional hideNextBtn#

hideNextBtn? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:110

+

Defined in src/renderer/components/wizard/wizard.tsx:110


Optional hideSteps#

hideSteps? : boolean

Inherited from WizardProps.hideSteps

-

Defined in src/renderer/components/wizard/wizard.tsx:14

+

Defined in src/renderer/components/wizard/wizard.tsx:14


Optional isFirst#

isFirst? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:119

+

Defined in src/renderer/components/wizard/wizard.tsx:119

Type declaration:

▸ (): boolean


Optional isLast#

isLast? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:120

+

Defined in src/renderer/components/wizard/wizard.tsx:120

Type declaration:

▸ (): boolean


Optional last#

last? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:118

+

Defined in src/renderer/components/wizard/wizard.tsx:118

Type declaration:

▸ (): void


Optional loading#

loading? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:107

+

Defined in src/renderer/components/wizard/wizard.tsx:107


Optional moreButtons#

moreButtons? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:106

+

Defined in src/renderer/components/wizard/wizard.tsx:106


Optional next#

next? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:115

+

Defined in src/renderer/components/wizard/wizard.tsx:115

Type declaration:

▸ (): void | boolean | Promise‹any›


Optional nextLabel#

nextLabel? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:114

+

Defined in src/renderer/components/wizard/wizard.tsx:114


Optional noValidate#

noValidate? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:123

+

Defined in src/renderer/components/wizard/wizard.tsx:123


Optional prev#

prev? : function

-

Defined in src/renderer/components/wizard/wizard.tsx:116

+

Defined in src/renderer/components/wizard/wizard.tsx:116

Type declaration:

▸ (): void


Optional prevLabel#

prevLabel? : React.ReactNode

-

Defined in src/renderer/components/wizard/wizard.tsx:113

+

Defined in src/renderer/components/wizard/wizard.tsx:113


Optional reset#

reset? : function

Inherited from WizardProps.reset

-

Defined in src/renderer/components/wizard/wizard.tsx:12

+

Defined in src/renderer/components/wizard/wizard.tsx:12

Type declaration:

▸ (): void


Optional save#

save? : function

Inherited from WizardProps.save

-

Defined in src/renderer/components/wizard/wizard.tsx:11

+

Defined in src/renderer/components/wizard/wizard.tsx:11

Type declaration:

▸ (data: Partial‹D›, callback?: function): void

Parameters:

@@ -1252,27 +1252,27 @@

Optional scrollable#

scrollable? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:125

+

Defined in src/renderer/components/wizard/wizard.tsx:125


Optional skip#

skip? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:124

+

Defined in src/renderer/components/wizard/wizard.tsx:124


Optional step#

step? : number

-

Defined in src/renderer/components/wizard/wizard.tsx:112

+

Defined in src/renderer/components/wizard/wizard.tsx:112


Optional title#

title? : string

-

Defined in src/renderer/components/wizard/wizard.tsx:102

+

Defined in src/renderer/components/wizard/wizard.tsx:102


Optional waiting#

waiting? : boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:108

+

Defined in src/renderer/components/wizard/wizard.tsx:108


Optional wizard#

wizard? : Wizard

-

Defined in src/renderer/components/wizard/wizard.tsx:101

+

Defined in src/renderer/components/wizard/wizard.tsx:101

diff --git a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html index c75ed5e3fa..ca918083d8 100644 --- a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html +++ b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -887,7 +887,7 @@

Properties#

id#

id: string

-

Defined in src/renderer/api/kube-api.ts:63

+

Defined in src/renderer/api/kube-api.ts:63

diff --git a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html index 8d26a4460c..b1f3dedacd 100644 --- a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html +++ b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -983,47 +983,47 @@

Properties#

Optional args#

args? : string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:69

+

Defined in src/renderer/api/endpoints/pods.api.ts:69


Optional command#

command? : string[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:68

+

Defined in src/renderer/api/endpoints/pods.api.ts:68


Optional env#

env? : object[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:85

+

Defined in src/renderer/api/endpoints/pods.api.ts:85


Optional envFrom#

envFrom? : object[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:103

+

Defined in src/renderer/api/endpoints/pods.api.ts:103


image#

image: string

-

Defined in src/renderer/api/endpoints/pods.api.ts:67

+

Defined in src/renderer/api/endpoints/pods.api.ts:67


imagePullPolicy#

imagePullPolicy: string

-

Defined in src/renderer/api/endpoints/pods.api.ts:116

+

Defined in src/renderer/api/endpoints/pods.api.ts:116


Optional livenessProbe#

livenessProbe? : IContainerProbe

-

Defined in src/renderer/api/endpoints/pods.api.ts:113

+

Defined in src/renderer/api/endpoints/pods.api.ts:113


name#

name: string

-

Defined in src/renderer/api/endpoints/pods.api.ts:66

+

Defined in src/renderer/api/endpoints/pods.api.ts:66


Optional ports#

ports? : object[]

-

Defined in src/renderer/api/endpoints/pods.api.ts:70

+

Defined in src/renderer/api/endpoints/pods.api.ts:70


Optional readinessProbe#

readinessProbe? : IContainerProbe

-

Defined in src/renderer/api/endpoints/pods.api.ts:114

+

Defined in src/renderer/api/endpoints/pods.api.ts:114


Optional resources#

resources? : object

-

Defined in src/renderer/api/endpoints/pods.api.ts:75

+

Defined in src/renderer/api/endpoints/pods.api.ts:75

Type declaration:

@@ -1019,7 +1019,7 @@

Optional stringify#

stringify(value: V): string | string[]

-

Defined in src/renderer/navigation/page-param.ts:12

+

Defined in src/renderer/navigation/page-param.ts:12

Parameters:

diff --git a/master/extensions/api/modules/_core_api_app_/index.html b/master/extensions/api/modules/_core_api_app_/index.html index 15a4b3c804..c5c42b9f26 100644 --- a/master/extensions/api/modules/_core_api_app_/index.html +++ b/master/extensions/api/modules/_core_api_app_/index.html @@ -963,39 +963,39 @@

Variables#

Const appName#

appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

-

Defined in src/common/vars.ts:15

+

Defined in src/common/vars.ts:15


Const isLinux#

isLinux: boolean = process.platform === "linux"

-

Defined in src/common/vars.ts:8

+

Defined in src/common/vars.ts:8


Const isMac#

isMac: boolean = process.platform === "darwin"

-

Defined in src/common/vars.ts:6

+

Defined in src/common/vars.ts:6


Const isSnap#

isSnap: boolean = !!process.env.SNAP

-

Defined in src/common/vars.ts:10

+

Defined in src/common/vars.ts:10


Const isWindows#

isWindows: boolean = process.platform === "win32"

-

Defined in src/common/vars.ts:7

+

Defined in src/common/vars.ts:7


Const issuesTrackerUrl#

issuesTrackerUrl: "https://github.com/lensapp/lens/issues" = "https://github.com/lensapp/lens/issues"

-

Defined in src/common/vars.ts:43

+

Defined in src/common/vars.ts:43


Const slackUrl#

slackUrl: "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI" = "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI"

-

Defined in src/common/vars.ts:44

+

Defined in src/common/vars.ts:44


Const version#

version: string = getAppVersion()

-

Defined in src/extensions/core-api/app.ts:4

+

Defined in src/extensions/core-api/app.ts:4

Functions#

getEnabledExtensions#

getEnabledExtensions(): string[]

-

Defined in src/extensions/core-api/app.ts:7

+

Defined in src/extensions/core-api/app.ts:7

Returns: string[]

diff --git a/master/extensions/api/modules/_core_api_event_bus_/index.html b/master/extensions/api/modules/_core_api_event_bus_/index.html index 696b551508..74b45cf518 100644 --- a/master/extensions/api/modules/_core_api_event_bus_/index.html +++ b/master/extensions/api/modules/_core_api_event_bus_/index.html @@ -907,7 +907,7 @@

Type aliases#

AppEvent#

Ƭ AppEvent: object

-

Defined in src/common/event-bus.ts:3

+

Defined in src/common/event-bus.ts:3

Type declaration:

@@ -931,7 +931,7 @@

openExternal#

openExternal(url: string): Promise‹void›

-

Defined in src/common/utils/openExternal.ts:4

+

Defined in src/common/utils/openExternal.ts:4

Parameters:

@@ -951,7 +951,7 @@

prevDefault#

prevDefaultE›(callback: function): (Anonymous function)

-

Defined in src/renderer/utils/prevDefault.ts:15

+

Defined in src/renderer/utils/prevDefault.ts:15

Type parameters:

E: SyntheticEvent | Event

Parameters:

@@ -976,7 +976,7 @@

stopPropagation#

stopPropagation(evt: Event | SyntheticEvent): void

-

Defined in src/renderer/utils/prevDefault.ts:24

+

Defined in src/renderer/utils/prevDefault.ts:24

Parameters:

diff --git a/master/extensions/api/modules/_renderer_api_components_/index.html b/master/extensions/api/modules/_renderer_api_components_/index.html index cdcafe0827..7215278c32 100644 --- a/master/extensions/api/modules/_renderer_api_components_/index.html +++ b/master/extensions/api/modules/_renderer_api_components_/index.html @@ -1270,47 +1270,47 @@

Type aliases#

InputProps#

Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object

-

Defined in src/renderer/components/input/input.tsx:21

+

Defined in src/renderer/components/input/input.tsx:21


Ƭ MenuContextValue: Menu

-

Defined in src/renderer/components/menu/menu.tsx:11

+

Defined in src/renderer/components/menu/menu.tsx:11


NotificationId#

Ƭ NotificationId: string | number

-

Defined in src/renderer/components/notifications/notifications.store.ts:7

+

Defined in src/renderer/components/notifications/notifications.store.ts:7


NotificationMessage#

Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

-

Defined in src/renderer/components/notifications/notifications.store.ts:8

+

Defined in src/renderer/components/notifications/notifications.store.ts:8


RadioProps#

Ƭ RadioProps: HTMLProps‹any› & object

-

Defined in src/renderer/components/radio/radio.tsx:40

+

Defined in src/renderer/components/radio/radio.tsx:40


TableCellElem#

Ƭ TableCellElem: ReactElement‹TableCellProps

-

Defined in src/renderer/components/table/table-cell.tsx:9

+

Defined in src/renderer/components/table/table-cell.tsx:9


TableHeadElem#

Ƭ TableHeadElem: ReactElement‹TableHeadProps

-

Defined in src/renderer/components/table/table-head.tsx:6

+

Defined in src/renderer/components/table/table-head.tsx:6


TableOrderBy#

Ƭ TableOrderBy: "asc" | "desc" | string

-

Defined in src/renderer/components/table/table.tsx:16

+

Defined in src/renderer/components/table/table.tsx:16


TableRowElem#

Ƭ TableRowElem: ReactElement‹TableRowProps

-

Defined in src/renderer/components/table/table-row.tsx:7

+

Defined in src/renderer/components/table/table-row.tsx:7


TableSortBy#

Ƭ TableSortBy: string

-

Defined in src/renderer/components/table/table.tsx:15

+

Defined in src/renderer/components/table/table.tsx:15


TableSortCallback#

Ƭ TableSortCallback: function

-

Defined in src/renderer/components/table/table.tsx:18

+

Defined in src/renderer/components/table/table.tsx:18

Type declaration:

▸ (data: D): string | number | (string | number)[]

Parameters:

@@ -1331,7 +1331,7 @@

TableSortParams#

Ƭ TableSortParams: object

-

Defined in src/renderer/components/table/table.tsx:17

+

Defined in src/renderer/components/table/table.tsx:17

Type declaration:

@@ -1445,7 +1445,7 @@

SubMenu(props: Partial‹MenuProps›): Element‹›

-

Defined in src/renderer/components/menu/menu.tsx:282

+

Defined in src/renderer/components/menu/menu.tsx:282

Parameters:

@@ -1465,7 +1465,7 @@

createPodLogsTab#

createPodLogsTab(data: IPodLogsData, tabParams: Partial‹IDockTab›): IDockTab

-

Defined in src/renderer/components/dock/pod-logs.store.ts:208

+

Defined in src/renderer/components/dock/pod-logs.store.ts:208

Parameters:

@@ -1492,7 +1492,7 @@

createTerminalTab#

createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

-

Defined in src/renderer/components/dock/terminal.store.ts:16

+

Defined in src/renderer/components/dock/terminal.store.ts:16

Parameters:

@@ -1514,7 +1514,7 @@

getDetailsUrl#

getDetailsUrl(details: string, resetSelected: boolean): string

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

Parameters:

@@ -1541,12 +1541,12 @@

hideDetails#

hideDetails(): void

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

Returns: void


showDetails#

showDetails(details: string, resetSelected: boolean): void

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

Parameters:

@@ -1573,7 +1573,7 @@

withTooltip#

withTooltipT›(Target: T): T

-

Defined in src/renderer/components/tooltip/withTooltip.tsx:18

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:18

Type parameters:

T: React.ComponentType‹any›

Parameters:

diff --git a/master/extensions/api/modules/_renderer_api_k8s_api_/index.html b/master/extensions/api/modules/_renderer_api_k8s_api_/index.html index e191130e82..4cf8858d74 100644 --- a/master/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/master/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -1268,7 +1268,7 @@

Type aliases#

KubeObjectStatus#

Ƭ KubeObjectStatus: object

-

Defined in src/extensions/renderer-api/kube-object-status.ts:1

+

Defined in src/extensions/renderer-api/kube-object-status.ts:1

Type declaration:

diff --git a/master/extensions/api/modules/_renderer_api_navigation_/index.html b/master/extensions/api/modules/_renderer_api_navigation_/index.html index f3f28049e8..c6817de118 100644 --- a/master/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/master/extensions/api/modules/_renderer_api_navigation_/index.html @@ -939,7 +939,7 @@

Functions#

createPageParam#

createPageParamV›(init: PageParamInit‹V›): PageParam‹V›

-

Defined in src/extensions/renderer-api/navigation.ts:10

+

Defined in src/extensions/renderer-api/navigation.ts:10

Type parameters:

V

Parameters:

@@ -961,7 +961,7 @@

getDetailsUrl#

getDetailsUrl(details: string, resetSelected: boolean): string

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

Parameters:

@@ -988,12 +988,12 @@

hideDetails#

hideDetails(): void

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

Returns: void


isActiveRoute#

isActiveRoute(route: string | string[] | RouteProps): boolean

-

Defined in src/renderer/navigation/helpers.ts:25

+

Defined in src/renderer/navigation/helpers.ts:25

Parameters:

@@ -1013,7 +1013,7 @@

navigate(location: LocationDescriptor): void

-

Defined in src/renderer/navigation/helpers.ts:7

+

Defined in src/renderer/navigation/helpers.ts:7

Parameters:

@@ -1033,7 +1033,7 @@

showDetails#

showDetails(details: string, resetSelected: boolean): void

-

Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

Parameters:

diff --git a/master/extensions/api/modules/_renderer_api_theming_/index.html b/master/extensions/api/modules/_renderer_api_theming_/index.html index 3d119d28b4..1818961ad7 100644 --- a/master/extensions/api/modules/_renderer_api_theming_/index.html +++ b/master/extensions/api/modules/_renderer_api_theming_/index.html @@ -876,7 +876,7 @@

Functions#

getActiveTheme#

getActiveTheme(): Theme

-

Defined in src/extensions/renderer-api/theming.ts:3

+

Defined in src/extensions/renderer-api/theming.ts:3

Returns: Theme

diff --git a/master/extensions/capabilities/common-capabilities/index.html b/master/extensions/capabilities/common-capabilities/index.html index 215d21352e..5a370ea4f4 100644 --- a/master/extensions/capabilities/common-capabilities/index.html +++ b/master/extensions/capabilities/common-capabilities/index.html @@ -1088,9 +1088,9 @@

The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.

Activate#

This extension can register a custom callback that is executed when an extension is activated (started).

-
import { LensMainExtension } from "@k8slens/extensions"
+
import { LensMainExtension } from "@k8slens/extensions"
 
-export default class ExampleMainExtension extends LensMainExtension {
+export default class ExampleMainExtension extends LensMainExtension {
   async onActivate() {
     console.log("hello world")
   }
@@ -1098,9 +1098,9 @@
 

Deactivate#

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

-
import { LensMainExtension } from "@k8slens/extensions"
+
import { LensMainExtension } from "@k8slens/extensions"
 
-export default class ExampleMainExtension extends LensMainExtension {
+export default class ExampleMainExtension extends LensMainExtension {
   async onDeactivate() {
     console.log("bye bye")
   }
@@ -1109,14 +1109,14 @@
 

App Menus#

This extension can register custom app menus that will be displayed on OS native menus.

Example:

-
import { LensMainExtension, windowManager } from "@k8slens/extensions"
+
import { LensMainExtension, windowManager } from "@k8slens/extensions"
 
-export default class ExampleMainExtension extends LensMainExtension {
+export default class ExampleMainExtension extends LensMainExtension {
   appMenus = [
     {
       parentId: "help",
       label: "Example item",
-      click() {
+      click() {
         windowManager.navigate("https://k8slens.dev");
       }
     }
@@ -1127,9 +1127,9 @@
 

The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.

Activate#

This extension can register a custom callback that is executed when an extension is activated (started).

-
import { LensRendererExtension } from "@k8slens/extensions"
+
import { LensRendererExtension } from "@k8slens/extensions"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   async onActivate() {
     console.log("hello world")
   }
@@ -1137,9 +1137,9 @@
 

Deactivate#

This extension can register a custom callback that is executed when an extension is deactivated (stopped).

-
import { LensRendererExtension } from "@k8slens/extensions"
+
import { LensRendererExtension } from "@k8slens/extensions"
 
-export default class ExampleMainExtension extends LensRendererExtension {
+export default class ExampleMainExtension extends LensRendererExtension {
   async onDeactivate() {
     console.log("bye bye")
   }
@@ -1147,11 +1147,11 @@
 

Global Pages#

This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.

-
import React from "react"
-import { Component, LensRendererExtension } from "@k8slens/extensions"
-import { ExamplePage } from "./src/example-page"
+
import React from "react"
+import { Component, LensRendererExtension } from "@k8slens/extensions"
+import { ExamplePage } from "./src/example-page"
 
-export default class ExampleRendererExtension extends LensRendererExtension {
+export default class ExampleRendererExtension extends LensRendererExtension {
   globalPages = [
     {
       id: "example",
@@ -1174,13 +1174,13 @@
 

App Preferences#

This extension can register custom app preferences. It is responsible for storing a state for custom preferences.

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions"
-import { myCustomPreferencesStore } from "./src/my-custom-preferences-store"
-import { MyCustomPreferenceHint, MyCustomPreferenceInput } from "./src/my-custom-preference"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions"
+import { myCustomPreferencesStore } from "./src/my-custom-preferences-store"
+import { MyCustomPreferenceHint, MyCustomPreferenceInput } from "./src/my-custom-preference"
 
 
-export default class ExampleRendererExtension extends LensRendererExtension {
+export default class ExampleRendererExtension extends LensRendererExtension {
   appPreferences = [
     {
       title: "My Custom Preference",
@@ -1194,11 +1194,11 @@
 

Cluster Pages#

This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions";
-import { ExampleIcon, ExamplePage } from "./src/page"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./src/page"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterPages = [
     {
       id: "extension-example", // optional
@@ -1222,11 +1222,11 @@
 

Cluster Features#

This extension can register installable features for a cluster. These features are visible in the "Cluster Settings" page.

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions"
-import { MyCustomFeature } from "./src/my-custom-feature"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions"
+import { MyCustomFeature } from "./src/my-custom-feature"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterFeatures = [
     {
       title: "My Custom Feature",
@@ -1246,10 +1246,10 @@
 

Status Bar Items#

This extension can register custom icons and text to a status bar area.

-
import React from "react";
-import { Component, LensRendererExtension, Navigation } from "@k8slens/extensions";
+
import React from "react";
+import { Component, LensRendererExtension, Navigation } from "@k8slens/extensions";
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   statusBarItems = [
     {
       item: (
@@ -1263,11 +1263,11 @@
 

Kubernetes Object Menu Items#

This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions";
-import { CustomMenuItem, CustomMenuItemProps } from "./src/custom-menu-item"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { CustomMenuItem, CustomMenuItemProps } from "./src/custom-menu-item"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   kubeObjectMenuItems = [
     {
       kind: "Node",
@@ -1281,11 +1281,11 @@
 

Kubernetes Object Details#

This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions";
-import { CustomKindDetails, CustomKindDetailsProps } from "./src/custom-kind-details"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { CustomKindDetails, CustomKindDetailsProps } from "./src/custom-kind-details"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   kubeObjectDetailItems = [
     {
       kind: "CustomKind",
diff --git a/master/extensions/capabilities/styling/index.html b/master/extensions/capabilities/styling/index.html
index 5a13ad45cd..4d19b5aea4 100644
--- a/master/extensions/capabilities/styling/index.html
+++ b/master/extensions/capabilities/styling/index.html
@@ -1020,8 +1020,8 @@
 

These variables are intended to set consistent margins and paddings across components. For example:

.status {
-  padding-left: calc(var(--padding) * 2);
-  border-radius: var(--border-radius);
+  padding-left: calc(var(--padding) * 2);
+  border-radius: var(--border-radius);
 }
 

Themes#

@@ -1062,8 +1062,8 @@

These variables can be used in the following form: var(--magenta). For example:

.status {
-  font-size: var(--font-size-small);
-  background-color: var(--colorSuccess);
+  font-size: var(--font-size-small);
+  background-color: var(--colorSuccess);
 }
 

A complete list of themable colors can be found in the Color Reference.

@@ -1071,12 +1071,12 @@

When the light theme is active, the <body> element gets a "theme-light" class, or: <body class="theme-light">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: Color Theme

There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.

-
import React from "react"
-import { observer } from "mobx-react"
-import { App, Component, Theme } from "@k8slens/extensions";
+
import React from "react"
+import { observer } from "mobx-react"
+import { App, Component, Theme } from "@k8slens/extensions";
 
 @observer
-export class SupportPage extends React.Component {
+export class SupportPage extends React.Component {
   render() {
     return (
       <div className="SupportPage">
@@ -1100,7 +1100,7 @@
 

Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.

CSS-in-JS#

If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:

-
const Container = styled.div(() => ({
+
const Container = styled.div(() => ({
   backgroundColor: 'var(--mainBackground)'
 }));
 
diff --git a/master/extensions/get-started/anatomy/index.html b/master/extensions/get-started/anatomy/index.html index 79b070e3f4..ad3c40cdda 100644 --- a/master/extensions/get-started/anatomy/index.html +++ b/master/extensions/get-started/anatomy/index.html @@ -981,11 +981,11 @@

Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.

Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the "Hello World" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExampleIcon, ExamplePage } from "./page"
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterPages = [
     {
       id: "extension-example",
diff --git a/master/extensions/guides/kube-object-list-layout/index.html b/master/extensions/guides/kube-object-list-layout/index.html
index e0735a16c7..1543a96772 100644
--- a/master/extensions/guides/kube-object-list-layout/index.html
+++ b/master/extensions/guides/kube-object-list-layout/index.html
@@ -886,15 +886,15 @@
 
 

Register clusterPage and clusterPageMenu Objects#

First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

-
export default class CrdSampleExtension extends LensRendererExtension {
+
export default class CrdSampleExtension extends LensRendererExtension {
 }
 

To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with "Certificates" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

-
export function CertificateIcon(props: Component.IconProps) {
+
export function CertificateIcon(props: Component.IconProps) {
   return <Component.Icon {...props} material="security" tooltip="Certificates"/>
 }
 
-export default class CrdSampleExtension extends LensRendererExtension {
+export default class CrdSampleExtension extends LensRendererExtension {
 
   clusterPageMenus = [
     {
@@ -908,7 +908,7 @@
 }
 

Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

-
export default class CrdSampleExtension extends LensRendererExtension {
+
export default class CrdSampleExtension extends LensRendererExtension {
   ...
 
   clusterPages = [{
@@ -925,10 +925,10 @@
 

Get CRD objects#

In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject, CertificatesApiderived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore.

Certificate class defines properties found in the CRD object:

-
export class Certificate extends K8sApi.KubeObject {
-  static kind = "Certificate"
-  static namespaced = true
-  static apiBase = "/apis/cert-manager.io/v1alpha2/certificates"
+
export class Certificate extends K8sApi.KubeObject {
+  static kind = "Certificate"
+  static namespaced = true
+  static apiBase = "/apis/cert-manager.io/v1alpha2/certificates"
 
   kind: string
   apiVersion: string
@@ -961,24 +961,24 @@
       message: string;
       reason: string;
       status: string;
-      type?: string;
+      type?: string;
     }[];
   }
 }
 

With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

-
export class CertificatesApi extends K8sApi.KubeApi<Certificate> {
+
export class CertificatesApi extends K8sApi.KubeApi<Certificate> {
 }
-export const certificatesApi = new CertificatesApi({
+export const certificatesApi = new CertificatesApi({
   objectConstructor: Certificate
 });
 

CertificateStore defines storage for Certificate objects

-
export class CertificatesStore extends K8sApi.KubeObjectStore<Certificate> {
+
export class CertificatesStore extends K8sApi.KubeObjectStore<Certificate> {
   api = certificatesApi
 }
 
-export const certificatesStore = new CertificatesStore();
+export const certificatesStore = new CertificatesStore();
 

And, finally, we register this store to Lens's API manager.

K8sApi.apiManager.registerStore(certificatesStore);
@@ -986,26 +986,26 @@
 

Create CertificatePage component#

Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.

First we define CertificatePage class that extends React.Component.

-
import { Component, LensRendererExtension } from "@k8slens/extensions";
-import React from "react";
-import { certificatesStore } from "../certificate-store";
-import { Certificate } from "../certificate"
+
import { Component, LensRendererExtension } from "@k8slens/extensions";
+import React from "react";
+import { certificatesStore } from "../certificate-store";
+import { Certificate } from "../certificate"
 
-export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
 
 }
 

Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:

-
enum sortBy {
+
enum sortBy {
   name = "name",
   namespace = "namespace",
   issuer = "issuer"
 }
 
-export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
   // ...
 
-  render() {
+  render() {
     return (
       <Component.TabLayout>
         <Component.KubeObjectListLayout
@@ -1038,7 +1038,7 @@
 

Customize Details panel#

We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.

First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:

-
export default class CrdSampleExtension extends LensRendererExtension {
+
export default class CrdSampleExtension extends LensRendererExtension {
   //...
 
   kubeObjectDetailItems = [{
@@ -1051,17 +1051,17 @@
 }
 

Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

-
import { Component, K8sApi } from "@k8slens/extensions";
-import React from "react";
-import { Certificate } from "../certificate";
+
import { Component, K8sApi } from "@k8slens/extensions";
+import React from "react";
+import { Certificate } from "../certificate";
 
-export interface CertificateDetailsProps extends Component.KubeObjectDetailsProps<Certificate>{
+export interface CertificateDetailsProps extends Component.KubeObjectDetailsProps<Certificate>{
 }
 
-export class CertificateDetails extends React.Component<CertificateDetailsProps> {
+export class CertificateDetails extends React.Component<CertificateDetailsProps> {
 
-  render() {
-    const { object: certificate } = this.props;
+  render() {
+    const { object: certificate } = this.props;
     if (!certificate) return null;
     return (
       <div className="Certificate">
@@ -1076,8 +1076,8 @@
         </Component.DrawerItem>
         <Component.DrawerItem name="Status" className="status" labelsOnly>
           {certificate.status.conditions.map((condition, index) => {
-            const { type, reason, message, status } = condition;
-            const kind = type || reason;
+            const { type, reason, message, status } = condition;
+            const kind = type || reason;
             if (!kind) return null;
             return (
               <Component.Badge
diff --git a/master/extensions/guides/main-extension/index.html b/master/extensions/guides/main-extension/index.html
index ea900d3fd3..3471cae1ef 100644
--- a/master/extensions/guides/main-extension/index.html
+++ b/master/extensions/guides/main-extension/index.html
@@ -921,14 +921,14 @@
 

LensMainExtension Class#

onActivate() and onDeactivate() Methods#

To create a main extension simply extend the LensMainExtension class:

-
import { LensMainExtension } from "@k8slens/extensions";
+
import { LensMainExtension } from "@k8slens/extensions";
 
-export default class ExampleExtensionMain extends LensMainExtension {
-  onActivate() {
+export default class ExampleExtensionMain extends LensMainExtension {
+  onActivate() {
     console.log('custom main process extension code started');
   }
 
-  onDeactivate() {
+  onDeactivate() {
     console.log('custom main process extension de-activated');
   }
 }
@@ -941,15 +941,15 @@
 
 

The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.

The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens.

-
import { LensMainExtension, Store } from "@k8slens/extensions";
+
import { LensMainExtension, Store } from "@k8slens/extensions";
 
-const clusterStore = Store.clusterStore
+const clusterStore = Store.clusterStore
 
-export default class ActiveClusterExtensionMain extends LensMainExtension {
+export default class ActiveClusterExtensionMain extends LensMainExtension {
 
   timer: NodeJS.Timeout
 
-  onActivate() {
+  onActivate() {
     console.log("Cluster logger activated");
     this.timer = setInterval(() => {
       if (!clusterStore.active) {
@@ -957,10 +957,10 @@
         return;
       }
       console.log("active cluster is", clusterStore.active.contextName)
-    }, 5000)
+    }, 5000)
   }
 
-  onDeactivate() {
+  onDeactivate() {
       clearInterval(this.timer)
       console.log("Cluster logger deactivated");
   }
@@ -969,14 +969,14 @@
 

For more details on accessing Lens state data, please see the Stores guide.

appMenus#

The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu.

-
import { LensMainExtension } from "@k8slens/extensions";
+
import { LensMainExtension } from "@k8slens/extensions";
 
-export default class SamplePageMainExtension extends LensMainExtension {
+export default class SamplePageMainExtension extends LensMainExtension {
   appMenus = [
     {
       parentId: "help",
       label: "Sample",
-      click() {
+      click() {
         console.log("Sample clicked");
       }
     }
diff --git a/master/extensions/guides/renderer-extension/index.html b/master/extensions/guides/renderer-extension/index.html
index fdb605a5a9..2932ba54e7 100644
--- a/master/extensions/guides/renderer-extension/index.html
+++ b/master/extensions/guides/renderer-extension/index.html
@@ -1021,14 +1021,14 @@ The custom Lens UI elements that can be added include global pages, cluster page
 These UI elements are based on React components.

LensRendererExtension Class#

To create a renderer extension simply extend the LensRendererExtension class:

-
import { LensRendererExtension } from "@k8slens/extensions";
+
import { LensRendererExtension } from "@k8slens/extensions";
 
-export default class ExampleExtensionMain extends LensRendererExtension {
-  onActivate() {
+export default class ExampleExtensionMain extends LensRendererExtension {
+  onActivate() {
     console.log('custom renderer process extension code started');
   }
 
-  onDeactivate() {
+  onDeactivate() {
     console.log('custom renderer process extension de-activated');
   }
 }
@@ -1045,11 +1045,11 @@ It is conventional to use a cluster page to show information or provide function
 However, it is not limited to the active cluster.
 Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore.

The following example adds a cluster page definition to a LensRendererExtension subclass:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExampleIcon, ExamplePage } from "./page"
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterPages = [
     {
       id: "hello",
@@ -1066,11 +1066,11 @@ The 'id' field can also convey route path details, such as variable parameters p
 The components field matches the PageComponents interface for wich there is one field, Page.
 Page is of type React.ComponentType<any>, which gives you great flexibility in defining the appearance and behaviour of your page.
 For the example above ExamplePage can be defined in page.tsx:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import React from "react"
 
-export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
-  render() {
+export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
     return (
       <div>
         <p>Hello world!</p>
@@ -1085,11 +1085,11 @@ This allows the ExampleExtension object to be passed in React-style
 

The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExampleIcon, ExamplePage } from "./page"
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterPages = [
     {
       id: "hello",
@@ -1118,15 +1118,15 @@ The cluster page menu item's appearance is defined by setting the titlecomponents field is used to set an icon that appears to the left of the title text in the sidebar.
 Thus when the "Hello World" menu item is activated the cluster dashboard will show the contents of ExamplePage.
 This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx:

-
import { LensRendererExtension, Component } from "@k8slens/extensions";
-import React from "react"
+
import { LensRendererExtension, Component } from "@k8slens/extensions";
+import React from "react"
 
-export function ExampleIcon(props: Component.IconProps) {
+export function ExampleIcon(props: Component.IconProps) {
   return <Component.Icon {...props} material="pages" tooltip={"Hi!"}/>
 }
 
-export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
-  render() {
+export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
     return (
       <div>
         <p>Hello world!</p>
@@ -1142,11 +1142,11 @@ One can be selected by name via the material field.
 

A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExampleIcon, ExamplePage } from "./page"
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   clusterPages = [
     {
       id: "hello",
@@ -1206,11 +1206,11 @@ They can also be triggered by a custom app
 Global pages can appear even when there is no active cluster, unlike cluster pages.
 It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have.

The following example defines a LensRendererExtension subclass with a single global page definition:

-
import { LensRendererExtension } from '@k8slens/extensions';
-import { HelpPage } from './page';
-import React from 'react';
+
import { LensRendererExtension } from '@k8slens/extensions';
+import { HelpPage } from './page';
+import React from 'react';
 
-export default class HelpExtension extends LensRendererExtension {
+export default class HelpExtension extends LensRendererExtension {
   globalPages = [
     {
       id: "help",
@@ -1227,11 +1227,11 @@ The 'id' field can also convey route path details, such as variable parameters p
 The components field matches the PageComponents interface for which there is one field, Page.
 Page is of type React.ComponentType<any>, which gives you great flexibility in defining the appearance and behaviour of your page.
 For the example above HelpPage can be defined in page.tsx:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import React from "react"
 
-export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
-  render() {
+export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
     return (
       <div>
         <p>Help yourself</p>
@@ -1251,11 +1251,11 @@ Global page menu icons that are defined using g
 

globalPageMenus#

Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { HelpIcon, HelpPage } from "./page"
-import React from "react"
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { HelpIcon, HelpPage } from "./page"
+import React from "react"
 
-export default class HelpExtension extends LensRendererExtension {
+export default class HelpExtension extends LensRendererExtension {
   globalPages = [
     {
       id: "help",
@@ -1284,15 +1284,15 @@ The global page menu item's appearance is defined by setting the titlecomponents field is used to set an icon that appears in the cluster menu.
 Thus when the "Help" icon is activated the contents of ExamplePage will be shown.
 This example requires the definition of another React-based component, HelpIcon, which has been added to page.tsx:

-
import { LensRendererExtension, Component } from "@k8slens/extensions";
-import React from "react"
+
import { LensRendererExtension, Component } from "@k8slens/extensions";
+import React from "react"
 
-export function HelpIcon(props: Component.IconProps) {
+export function HelpIcon(props: Component.IconProps) {
   return <Component.Icon {...props} material="help"/>
 }
 
-export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
-  render() {
+export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
     return (
       <div>
         <p>Help</p>
@@ -1308,11 +1308,11 @@ One can be selected by name via the material field.

Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page.

The following example shows how to add a cluster feature as part of a LensRendererExtension:

-

import { LensRendererExtension } from "@k8slens/extensions"
-import { ExampleFeature } from "./src/example-feature"
-import React from "react"
+

import { LensRendererExtension } from "@k8slens/extensions"
+import { ExampleFeature } from "./src/example-feature"
+import React from "react"
 
-export default class ExampleFeatureExtension extends LensRendererExtension {
+export default class ExampleFeatureExtension extends LensRendererExtension {
   clusterFeatures = [
     {
       title: "Example Feature",
@@ -1332,10 +1332,10 @@ They can be installed/uninstalled by the Lens user from the cluster s
 
The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature, and specifically implement the following methods:

-
  abstract install(cluster: Cluster): Promise<void>;
-  abstract upgrade(cluster: Cluster): Promise<void>;
-  abstract uninstall(cluster: Cluster): Promise<void>;
-  abstract updateStatus(cluster: Cluster): Promise<ClusterFeatureStatus>;
+
  abstract install(cluster: Cluster): Promise<void>;
+  abstract upgrade(cluster: Cluster): Promise<void>;
+  abstract uninstall(cluster: Cluster): Promise<void>;
+  abstract updateStatus(cluster: Cluster): Promise<ClusterFeatureStatus>;
 

The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi).

@@ -1349,34 +1349,34 @@ The status.currentVersion and status.latestVersion fie The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant.

The following shows a very simple implementation of a ClusterFeature:

-
import { ClusterFeature, Store, K8sApi } from "@k8slens/extensions";
-import * as path from "path";
+
import { ClusterFeature, Store, K8sApi } from "@k8slens/extensions";
+import * as path from "path";
 
-export class ExampleFeature extends ClusterFeature.Feature {
+export class ExampleFeature extends ClusterFeature.Feature {
 
-  async install(cluster: Store.Cluster): Promise<void> {
+  async install(cluster: Store.Cluster): Promise<void> {
 
-    super.applyResources(cluster, path.join(__dirname, "../resources/"));
+    super.applyResources(cluster, path.join(__dirname, "../resources/"));
   }
 
-  async upgrade(cluster: Store.Cluster): Promise<void> {
+  async upgrade(cluster: Store.Cluster): Promise<void> {
     return this.install(cluster);
   }
 
-  async updateStatus(cluster: Store.Cluster): Promise<ClusterFeature.FeatureStatus> {
+  async updateStatus(cluster: Store.Cluster): Promise<ClusterFeature.FeatureStatus> {
     try {
-      const pod = K8sApi.forCluster(cluster, K8sApi.Pod);
-      const examplePod = await pod.get({name: "example-pod", namespace: "default"});
+      const pod = K8sApi.forCluster(cluster, K8sApi.Pod);
+      const examplePod = await pod.get({name: "example-pod", namespace: "default"});
       if (examplePod?.kind) {
         this.status.installed = true;
-        this.status.currentVersion = examplePod.spec.containers[0].image.split(":")[1];
+        this.status.currentVersion = examplePod.spec.containers[0].image.split(":")[1];
         this.status.canUpgrade = true;  // a real implementation would perform a check here that is relevant to the specific feature
       } else {
         this.status.installed = false;
         this.status.canUpgrade = false;
       }
     } catch(e) {
-      if (e?.error?.code === 404) {
+      if (e?.error?.code === 404) {
         this.status.installed = false;
         this.status.canUpgrade = false;
       }
@@ -1385,9 +1385,9 @@ Also, Lens relies on the status.canUpgrade field to determine if th
     return this.status;
   }
 
-  async uninstall(cluster: Store.Cluster): Promise<void> {
-    const podApi = K8sApi.forCluster(cluster, K8sApi.Pod);
-    await podApi.delete({name: "example-pod", namespace: "default"});
+  async uninstall(cluster: Store.Cluster): Promise<void> {
+    const podApi = K8sApi.forCluster(cluster, K8sApi.Pod);
+    await podApi.delete({name: "example-pod", namespace: "default"});
   }
 }
 
@@ -1413,12 +1413,12 @@ How the status is updated for a specific cluster feature is up to the implementa

The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
-import { observable } from "mobx";
-import React from "react";
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { observable } from "mobx";
+import React from "react";
 
-export default class ExampleRendererExtension extends LensRendererExtension {
+export default class ExampleRendererExtension extends LensRendererExtension {
 
   @observable preference = { enabled: false };
 
@@ -1440,21 +1440,21 @@ The components field specifies two React.Component obj
 ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input.
 ExampleRendererExtension has the field preference, which is provided to ExamplePreferenceInput when it is created.
 In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx:

-
import { Component } from "@k8slens/extensions";
-import { observer } from "mobx-react";
-import React from "react";
+
import { Component } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
 
-export class ExamplePreferenceProps {
+export class ExamplePreferenceProps {
   preference: {
     enabled: boolean;
   }
 }
 
 @observer
-export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
 
-  render() {
-    const { preference } = this.props;
+  render() {
+    const { preference } = this.props;
     return (
       <Component.Checkbox
         label="I understand appPreferences"
@@ -1465,8 +1465,8 @@ In this example ExamplePreferenceInput, ExamplePreferenceHint
   }
 }
 
-export class ExamplePreferenceHint extends React.Component {
-  render() {
+export class ExamplePreferenceHint extends React.Component {
+  render() {
     return (
       <span>This is an example of an appPreference for extensions.</span>
     );
@@ -1490,11 +1490,11 @@ The example above defined a preference field in the ExampleRe
 

The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page.

The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click):

-
import { LensRendererExtension } from '@k8slens/extensions';
-import { HelpIcon, HelpPage } from "./page"
-import React from 'react';
+
import { LensRendererExtension } from '@k8slens/extensions';
+import { HelpIcon, HelpPage } from "./page"
+import React from 'react';
 
-export default class HelpExtension extends LensRendererExtension {
+export default class HelpExtension extends LensRendererExtension {
   globalPages = [
     {
       id: "help",
@@ -1531,11 +1531,11 @@ These menu items appear under the ... for each listed resource in t
 

List

Details

The following example shows how to add a menu for Namespace resources, and associate an action with it:

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions";
-import { NamespaceMenuItem } from "./src/namespace-menu-item"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { NamespaceMenuItem } from "./src/namespace-menu-item"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   kubeObjectMenuItems = [
     {
       kind: "Namespace",
@@ -1554,16 +1554,16 @@ The components field defines the menu item's appearance and behavio
 The MenuItem field provides a function that returns a React.Component given a set of menu item properties.
 In this example a NamespaceMenuItem object is returned.
 NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:

-
import React from "react";
-import { Component, K8sApi, Navigation} from "@k8slens/extensions";
+
import React from "react";
+import { Component, K8sApi, Navigation} from "@k8slens/extensions";
 
-export function NamespaceMenuItem(props: Component.KubeObjectMenuProps<K8sApi.Namespace>) {
-  const { object: namespace, toolbar } = props;
+export function NamespaceMenuItem(props: Component.KubeObjectMenuProps<K8sApi.Namespace>) {
+  const { object: namespace, toolbar } = props;
   if (!namespace) return null;
 
-  const namespaceName = namespace.getName();
+  const namespaceName = namespace.getName();
 
-  const sendToTerminal = (command: string) => {
+  const sendToTerminal = (command: string) => {
     Component.terminalStore.sendCommand(command, {
       enter: true,
       newTab: true,
@@ -1571,7 +1571,7 @@ In this example a NamespaceMenuItem object is returned.
     Navigation.hideDetails();
   };
 
-  const getPods = () => {
+  const getPods = () => {
     sendToTerminal(`kubectl get pods -n ${namespaceName}`);
   };
 
@@ -1595,11 +1595,11 @@ Thus kube object menu items are afforded convenient access to the specific resou
 These custom details appear on the details page for a specific resource, such as a Namespace:

Details

The following example shows how to add a tabulated list of pods to the Namespace resource details page:

-
import React from "react"
-import { LensRendererExtension } from "@k8slens/extensions";
-import { NamespaceDetailsItem } from "./src/namespace-details-item"
+
import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { NamespaceDetailsItem } from "./src/namespace-details-item"
 
-export default class ExampleExtension extends LensRendererExtension {
+export default class ExampleExtension extends LensRendererExtension {
   kubeObjectDetailItems = [
     {
       kind: "Namespace",
@@ -1619,22 +1619,22 @@ The components field defines the detail item's appearance and behav
 The Details field provides a function that returns a React.Component given a set of detail item properties.
 In this example a NamespaceDetailsItem object is returned.
 NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:

-
import { Component, K8sApi } from "@k8slens/extensions";
-import { PodsDetailsList } from "./pods-details-list";
-import React from "react";
-import { observable } from "mobx";
-import { observer } from "mobx-react";
+
import { Component, K8sApi } from "@k8slens/extensions";
+import { PodsDetailsList } from "./pods-details-list";
+import React from "react";
+import { observable } from "mobx";
+import { observer } from "mobx-react";
 
 @observer
-export class NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>> {
+export class NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>> {
 
-  @observable private pods: K8sApi.Pod[];
+  @observable private pods: K8sApi.Pod[];
 
-  async componentDidMount() {
-    this.pods = await K8sApi.podsApi.list({namespace: this.props.object.getName()});
+  async componentDidMount() {
+    this.pods = await K8sApi.podsApi.list({namespace: this.props.object.getName()});
   }
 
-  render() {
+  render() {
     return (
       <div>
         <Component.DrawerTitle title="Pods" />
@@ -1660,17 +1660,17 @@ This is done simply by marking the pods field as an observabl
 Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one.
 Multiple details in a drawer can be placed in <Component.DrawerItem> elements for further separation, if desired.
 The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:

-
import React from "react";
-import { Component, K8sApi } from "@k8slens/extensions";
+
import React from "react";
+import { Component, K8sApi } from "@k8slens/extensions";
 
-interface Props {
+interface Props {
   pods: K8sApi.Pod[];
 }
 
-export class PodsDetailsList extends React.Component<Props> {
+export class PodsDetailsList extends React.Component<Props> {
 
   getTableRow(index: number) {
-      const {pods} = this.props;
+      const {pods} = this.props;
       return (
           <Component.TableRow key={index} nowrap>
               <Component.TableCell className="podName">{pods[index].getName()}</Component.TableCell>
@@ -1680,8 +1680,8 @@ The rest of this example's details are defined in PodsDetailsList,
       )
   }
 
-  render() {
-      const {pods} = this.props
+  render() {
+      const {pods} = this.props
       if (!pods?.length) {
           return null;
       }
diff --git a/master/extensions/guides/stores/index.html b/master/extensions/guides/stores/index.html
index 66233b2430..72700523a5 100644
--- a/master/extensions/guides/stores/index.html
+++ b/master/extensions/guides/stores/index.html
@@ -890,19 +890,19 @@ This guide shows how to create a store for the 
import { Store } from "@k8slens/extensions";
-import { observable, toJS } from "mobx";
+
import { Store } from "@k8slens/extensions";
+import { observable, toJS } from "mobx";
 
-export type ExamplePreferencesModel = {
+export type ExamplePreferencesModel = {
   enabled: boolean;
 };
 
-export class ExamplePreferencesStore extends Store.ExtensionStore<ExamplePreferencesModel> {
+export class ExamplePreferencesStore extends Store.ExtensionStore<ExamplePreferencesModel> {
 
   @observable  enabled = false;
 
-  private constructor() {
-    super({
+  private constructor() {
+    super({
       configName: "example-preferences-store",
       defaults: {
         enabled: false
@@ -910,7 +910,7 @@ The problem with that example is that the enabled state is not stored anywhere,
     });
   }
 
-  protected fromStore({ enabled }: ExamplePreferencesModel): void {
+  protected fromStore({ enabled }: ExamplePreferencesModel): void {
     this.enabled = enabled;
   }
 
@@ -923,7 +923,7 @@ The problem with that example is that the enabled state is not stored anywhere,
   }
 }
 
-export const examplePreferencesStore = ExamplePreferencesStore.getInstance<ExamplePreferencesStore>();
+export const examplePreferencesStore = ExamplePreferencesStore.getInstance<ExamplePreferencesStore>();
 

First the extension's data model is defined using a simple type, ExamplePreferencesModel, which has a single field, enabled, representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, based on the ExamplePreferencesModel. @@ -941,26 +941,26 @@ The toJS() function from Note that examplePreferencesStore is a singleton, calling this function again will not create a new store.

The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

-
import { LensMainExtension } from "@k8slens/extensions";
-import { examplePreferencesStore } from "./src/example-preference-store";
+
import { LensMainExtension } from "@k8slens/extensions";
+import { examplePreferencesStore } from "./src/example-preference-store";
 
-export default class ExampleMainExtension extends LensMainExtension {
-  async onActivate() {
-    await examplePreferencesStore.loadExtension(this);
+export default class ExampleMainExtension extends LensMainExtension {
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
   }
 }
 

Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

-
import { LensRendererExtension } from "@k8slens/extensions";
-import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
-import { examplePreferencesStore } from "./src/example-preference-store";
-import React from "react";
+
import { LensRendererExtension } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { examplePreferencesStore } from "./src/example-preference-store";
+import React from "react";
 
-export default class ExampleRendererExtension extends LensRendererExtension {
+export default class ExampleRendererExtension extends LensRendererExtension {
 
-  async onActivate() {
-    await examplePreferencesStore.loadExtension(this);
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
   }
 
   appPreferences = [
@@ -977,20 +977,20 @@ Similarly, examplePreferencesStore must be loaded in the renderer p
 

Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension. Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore. ExamplePreferenceInput is defined in ./src/example-preference.tsx:

-
import { Component } from "@k8slens/extensions";
-import { observer } from "mobx-react";
-import React from "react";
-import { ExamplePreferencesStore } from "./example-preference-store";
+
import { Component } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
+import { ExamplePreferencesStore } from "./example-preference-store";
 
-export class ExamplePreferenceProps {
+export class ExamplePreferenceProps {
   preference: ExamplePreferencesStore;
 }
 
 @observer
-export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
 
-  render() {
-    const { preference } = this.props;
+  render() {
+    const { preference } = this.props;
 
     return (
       <Component.Checkbox
@@ -1002,8 +1002,8 @@ Also, there is no longer the need for the preference field in the <
   }
 }
 
-export class ExamplePreferenceHint extends React.Component {
-  render() {
+export class ExamplePreferenceHint extends React.Component {
+  render() {
     return (
       <span>This is an example of an appPreference for extensions.</span>
     );
diff --git a/master/extensions/testing-and-publishing/testing/index.html b/master/extensions/testing-and-publishing/testing/index.html
index 98070834c8..e150e67960 100644
--- a/master/extensions/testing-and-publishing/testing/index.html
+++ b/master/extensions/testing-and-publishing/testing/index.html
@@ -976,13 +976,13 @@ const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Ele
 )
 

The test

-
import React from "react"
-import { render, screen, fireEvent } from "@testing-library/react";
+
import React from "react"
+import { render, screen, fireEvent } from "@testing-library/react";
 
-import GlobalPageMenuIcon from "./GlobalPageMenuIcon";
+import GlobalPageMenuIcon from "./GlobalPageMenuIcon";
 
 test("click called navigate()", () => {
-    const navigate = jest.fn();
+    const navigate = jest.fn();
     render(<GlobalPageMenuIcon navigate={navigate} />);
     fireEvent.click(screen.getByTestId("global-page-menu-icon"));
     expect(navigate).toHaveBeenCalled();
diff --git a/master/search/search_index.json b/master/search/search_index.json
index f8138925ed..10014ee4d4 100644
--- a/master/search/search_index.json
+++ b/master/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick  = use commit # r, reword  = use commit, but edit the commit message # e, edit  = use commit, but stop for amending # s, squash  = use commit, but meld into previous commit # f, fixup  = like \"squash\", but discard this commit's log message # x, exec  = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop  = remove commit # l, label 
); }) Defined in src/renderer/components/layout/tab-layout.tsx:27 Const kubeDetailsUrlParam # \u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16 Const kubeSelectedUrlParam # \u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21 Const notificationsStore # \u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77 Const orderByUrlParam # \u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49 Const sortByUrlParam # \u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44 Const terminalStore # \u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:122 Functions # DrawerItemLabels # \u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a SubMenu # \u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a createPodLogsTab # \u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:208 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab createTerminalTab # \u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void withTooltip # \u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#module-renderer-apicomponents","text":"","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_components_/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_components_/#classes","text":"Badge Button Checkbox ConfirmDialog CubeSpinner Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress Menu MenuActions MenuItem NamespaceSelect NamespaceSelectFilter Notifications NotificationsStore PageLayout PodDetailsList Radio RadioGroup Select Slider Spinner StatusBrick Stepper Tab Table TableCell TableHead TableRow Tabs Tooltip Wizard WizardLayout WizardStep","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_components_/#interfaces","text":"BadgeProps ButtonProps CheckboxProps ConfirmDialogParams ConfirmDialogProps CubeSpinnerProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification PageLayoutProps RadioGroupProps SelectOption SelectProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps WizardProps WizardStepProps","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases","text":"InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortParams","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#variables","text":"InputValidators MenuContext TabLayout kubeDetailsUrlParam kubeSelectedUrlParam notificationsStore orderByUrlParam sortByUrlParam terminalStore","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#functions","text":"DrawerItemLabels SubMenu createPodLogsTab createTerminalTab getDetailsUrl hideDetails showDetails withTooltip","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#inputprops","text":"\u01ac InputProps : Omit\u2039InputElementProps, \"onChange\" | \"onSubmit\"\u203a & object Defined in src/renderer/components/input/input.tsx:21","title":"InputProps"},{"location":"extensions/api/modules/_renderer_api_components_/#menucontextvalue","text":"\u01ac MenuContextValue : Menu Defined in src/renderer/components/menu/menu.tsx:11","title":"MenuContextValue"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationid","text":"\u01ac NotificationId : string | number Defined in src/renderer/components/notifications/notifications.store.ts:7","title":"NotificationId"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationmessage","text":"\u01ac NotificationMessage : React.ReactNode | React.ReactNode[] | JsonApiErrorParsed Defined in src/renderer/components/notifications/notifications.store.ts:8","title":"NotificationMessage"},{"location":"extensions/api/modules/_renderer_api_components_/#radioprops","text":"\u01ac RadioProps : HTMLProps\u2039any\u203a & object Defined in src/renderer/components/radio/radio.tsx:40","title":"RadioProps"},{"location":"extensions/api/modules/_renderer_api_components_/#tablecellelem","text":"\u01ac TableCellElem : ReactElement\u2039 TableCellProps \u203a Defined in src/renderer/components/table/table-cell.tsx:9","title":"TableCellElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableheadelem","text":"\u01ac TableHeadElem : ReactElement\u2039 TableHeadProps \u203a Defined in src/renderer/components/table/table-head.tsx:6","title":"TableHeadElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\" | string Defined in src/renderer/components/table/table.tsx:16","title":"TableOrderBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablerowelem","text":"\u01ac TableRowElem : ReactElement\u2039 TableRowProps \u203a Defined in src/renderer/components/table/table-row.tsx:7","title":"TableRowElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortby","text":"\u01ac TableSortBy : string Defined in src/renderer/components/table/table.tsx:15","title":"TableSortBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortcallback","text":"\u01ac TableSortCallback : function Defined in src/renderer/components/table/table.tsx:18","title":"TableSortCallback"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortparams","text":"\u01ac TableSortParams : object Defined in src/renderer/components/table/table.tsx:17","title":"TableSortParams"},{"location":"extensions/api/modules/_renderer_api_components_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#inputvalidators","text":"\u2022 InputValidators : InputValidators Defined in src/renderer/components/input/input.tsx:14","title":"InputValidators"},{"location":"extensions/api/modules/_renderer_api_components_/#const-menucontext","text":"\u2022 MenuContext : Context\u2039 Menu \u2039\u203a\u203a = React.createContext (null) Defined in src/renderer/components/menu/menu.tsx:10","title":"Const MenuContext"},{"location":"extensions/api/modules/_renderer_api_components_/#const-tablayout","text":"\u2022 TabLayout : (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { const currentLocation = navigation.location.pathname; const hasTabs = tabs.length > 0; const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null; return ( {hasTabs && ( navigate(url)}> {tabs.map(({ title, routePath, url = routePath, exact }) => { const isActive = !!matchPath(currentLocation, { path: routePath, exact }); return ; })} )}
{hasTabs && ( {tabs.map(({ routePath, exact, component }) => { return ; })} )} {children}
); }) Defined in src/renderer/components/layout/tab-layout.tsx:27","title":"Const TabLayout"},{"location":"extensions/api/modules/_renderer_api_components_/#const-kubedetailsurlparam","text":"\u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16","title":"Const kubeDetailsUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-kubeselectedurlparam","text":"\u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21","title":"Const kubeSelectedUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-notificationsstore","text":"\u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77","title":"Const notificationsStore"},{"location":"extensions/api/modules/_renderer_api_components_/#const-orderbyurlparam","text":"\u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49","title":"Const orderByUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-sortbyurlparam","text":"\u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44","title":"Const sortByUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-terminalstore","text":"\u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:122","title":"Const terminalStore"},{"location":"extensions/api/modules/_renderer_api_components_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a","title":"DrawerItemLabels"},{"location":"extensions/api/modules/_renderer_api_components_/#submenu","text":"\u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a","title":"SubMenu"},{"location":"extensions/api/modules/_renderer_api_components_/#createpodlogstab","text":"\u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:208 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab","title":"createPodLogsTab"},{"location":"extensions/api/modules/_renderer_api_components_/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab","title":"createTerminalTab"},{"location":"extensions/api/modules/_renderer_api_components_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_components_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_components_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_components_/#withtooltip","text":"\u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"withTooltip"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/","text":"Module: \"renderer-api/k8s-api\" # Index # Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore Interfaces # IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Type aliases # KubeObjectStatus Variables # apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi Functions # forCluster isAllowedResource Type aliases # KubeObjectStatus # \u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1 Type declaration: level : KubeObjectStatusLevel text : string timestamp ? : string Variables # Const apiManager # \u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:58 Const clusterRoleApi # \u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12 Const clusterRoleBindingApi # \u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10 Const configMapApi # \u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26 Const crdApi # \u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154 Const cronJobApi # \u2022 cronJobApi : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131 Const daemonSetApi # \u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74 Const deploymentApi # \u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:192 Const endpointApi # \u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127 Const eventApi # \u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59 Const hpaApi # \u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143 Const ingressApi # \u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177 Const jobApi # \u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110 Const namespacesApi # \u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25 Const networkPolicyApi # \u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71 Const nodesApi # \u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169 Const pdbApi # \u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47 Const persistentVolumeApi # \u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73 Const podsApi # \u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:487 Const pvcApi # \u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90 Const replicaSetApi # \u2022 replicaSetApi : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83 Const resourceQuotaApi # \u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66 Const roleApi # \u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21 Const roleBindingApi # \u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34 Const secretsApi # \u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48 Const serviceAccountsApi # \u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27 Const serviceApi # \u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101 Const statefulSetApi # \u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110 Const storageClassApi # \u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37 Functions # forCluster # \u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a isAllowedResource # \u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:42 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#module-renderer-apik8s-api","text":"","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#classes","text":"CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#interfaces","text":"IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases","text":"KubeObjectStatus","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables","text":"apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions","text":"forCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#kubeobjectstatus","text":"\u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1","title":"KubeObjectStatus"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-apimanager","text":"\u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:58","title":"Const apiManager"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterroleapi","text":"\u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12","title":"Const clusterRoleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterrolebindingapi","text":"\u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10","title":"Const clusterRoleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-configmapapi","text":"\u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26","title":"Const configMapApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-crdapi","text":"\u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154","title":"Const crdApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-cronjobapi","text":"\u2022 cronJobApi : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131","title":"Const cronJobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-daemonsetapi","text":"\u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74","title":"Const daemonSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-deploymentapi","text":"\u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:192","title":"Const deploymentApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-endpointapi","text":"\u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127","title":"Const endpointApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-eventapi","text":"\u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59","title":"Const eventApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-hpaapi","text":"\u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143","title":"Const hpaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-ingressapi","text":"\u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177","title":"Const ingressApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-jobapi","text":"\u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110","title":"Const jobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-namespacesapi","text":"\u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25","title":"Const namespacesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-networkpolicyapi","text":"\u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71","title":"Const networkPolicyApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-nodesapi","text":"\u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169","title":"Const nodesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pdbapi","text":"\u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47","title":"Const pdbApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-persistentvolumeapi","text":"\u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73","title":"Const persistentVolumeApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-podsapi","text":"\u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:487","title":"Const podsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pvcapi","text":"\u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90","title":"Const pvcApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-replicasetapi","text":"\u2022 replicaSetApi : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83","title":"Const replicaSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-resourcequotaapi","text":"\u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66","title":"Const resourceQuotaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-roleapi","text":"\u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21","title":"Const roleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-rolebindingapi","text":"\u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34","title":"Const roleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-secretsapi","text":"\u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48","title":"Const secretsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceaccountsapi","text":"\u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27","title":"Const serviceAccountsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceapi","text":"\u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101","title":"Const serviceApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-statefulsetapi","text":"\u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110","title":"Const statefulSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-storageclassapi","text":"\u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37","title":"Const storageClassApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#forcluster","text":"\u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a","title":"forCluster"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#isallowedresource","text":"\u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:42 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/_renderer_api_navigation_/","text":"Module: \"renderer-api/navigation\" # Index # Classes # PageParam Interfaces # IURLParams PageParamInit Functions # createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails Functions # createPageParam # \u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void isActiveRoute # \u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean navigate # \u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#module-renderer-apinavigation","text":"","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_navigation_/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_navigation_/#interfaces","text":"IURLParams PageParamInit","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions","text":"createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#createpageparam","text":"\u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a","title":"createPageParam"},{"location":"extensions/api/modules/_renderer_api_navigation_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_navigation_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_navigation_/#isactiveroute","text":"\u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/_renderer_api_navigation_/#navigate","text":"\u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void","title":"navigate"},{"location":"extensions/api/modules/_renderer_api_navigation_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_theming_/","text":"Module: \"renderer-api/theming\" # Index # Functions # getActiveTheme Functions # getActiveTheme # \u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#module-renderer-apitheming","text":"","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#getactivetheme","text":"\u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"getActiveTheme"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/color-reference/","text":"Theme Color Reference # You can use theme-based CSS Variables to style an extension according to the active theme. Base Colors # --blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color. Text Colors # --textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts. Border Colors # --borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color. Layout Colors # --mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs. Sidebar Colors # --sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar. Button Colors # --buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color. Table Colors # --tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table. Dock Colors # --dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel. Helm Chart Colors # --helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color. Terminal Colors # --terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color. Dialog Colors # --dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer. Detail Panel (Drawer) Colors # --drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer. Misc Colors # --logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Color Reference"},{"location":"extensions/capabilities/color-reference/#theme-color-reference","text":"You can use theme-based CSS Variables to style an extension according to the active theme.","title":"Theme Color Reference"},{"location":"extensions/capabilities/color-reference/#base-colors","text":"--blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color.","title":"Base Colors"},{"location":"extensions/capabilities/color-reference/#text-colors","text":"--textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts.","title":"Text Colors"},{"location":"extensions/capabilities/color-reference/#border-colors","text":"--borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color.","title":"Border Colors"},{"location":"extensions/capabilities/color-reference/#layout-colors","text":"--mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs.","title":"Layout Colors"},{"location":"extensions/capabilities/color-reference/#sidebar-colors","text":"--sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar.","title":"Sidebar Colors"},{"location":"extensions/capabilities/color-reference/#button-colors","text":"--buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color.","title":"Button Colors"},{"location":"extensions/capabilities/color-reference/#table-colors","text":"--tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table.","title":"Table Colors"},{"location":"extensions/capabilities/color-reference/#dock-colors","text":"--dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel.","title":"Dock Colors"},{"location":"extensions/capabilities/color-reference/#helm-chart-colors","text":"--helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color.","title":"Helm Chart Colors"},{"location":"extensions/capabilities/color-reference/#terminal-colors","text":"--terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color.","title":"Terminal Colors"},{"location":"extensions/capabilities/color-reference/#dialog-colors","text":"--dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer.","title":"Dialog Colors"},{"location":"extensions/capabilities/color-reference/#detail-panel-drawer-colors","text":"--drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer.","title":"Detail Panel (Drawer) Colors"},{"location":"extensions/capabilities/color-reference/#misc-colors","text":"--logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Misc Colors"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities. Main Extension # The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } App Menus # This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] } Renderer Extension # The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Cluster Features # This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#main-extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#app-menus","text":"This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] }","title":"App Menus"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#global-pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#cluster-features","text":"This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] }","title":"Cluster Features"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application. Layout # For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference . Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#styling-an-extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#layout-variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#theme-variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference .","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#injected-styles","text":"Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#css-in-js","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first. Extension Manifest # Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Extension Entry Files # Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#extension-entry-files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system. Recommended: # All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more. Extension Capabilities # In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page. Guides and Samples # Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading. First Extension # In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#first-extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx Samples # Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Overview"},{"location":"extensions/guides/#extension-guides","text":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/generator/","text":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Next Steps"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects. Get CRD objects # In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore ); Create CertificatePage component # Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } } Customize Details panel # We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } } Summary # Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process. LensMainExtension Class # onActivate() and onDeactivate() Methods # To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } For more details on accessing Lens state data, please see the Stores guide. appMenus # The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","text":"To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } For more details on accessing Lens state data, please see the Stores guide.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#appmenus","text":"The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"appMenus"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension # The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components. LensRendererExtension Class # To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data. clusterPageMenus # The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case globalPages # Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon. globalPageMenus # Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. clusterFeatures # Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation. appPreferences # The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore statusBarItems # The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called. kubeObjectMenuItems # An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension","text":"The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#lensrendererextension-class","text":"To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled.","title":"LensRendererExtension Class"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon.","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#globalpagemenus","text":"Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field.","title":"globalPageMenus"},{"location":"extensions/guides/renderer-extension/#clusterfeatures","text":"Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation.","title":"clusterFeatures"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#statusbaritems","text":"The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","text":"An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data. ExtensionStore # Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data.","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with mobx # Introduction # Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls. How mobx works: # mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"How mobx works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball. Places To Host Your Extension # We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package. Publishing via NPM # This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file. Making a NPM Tarball of Your Extension # While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#publishing-extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples. Main Process Unit Testing # Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests. Tips # Console.log # Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","text":"UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","text":"Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done. Installing an Extension # There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an Extension # Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run. Uninstalling an Extension # If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Uninstalling an Extension"},{"location":"faq/","text":"FAQ # What operating systems does Lens support? # Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options. Lens application is not opening, what might be wrong? # When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address. Why can't I add any clusters? # When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid. Why Cluster dashboard is not opening? # To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 . Why I don't see anything on Cluster dashboard? # Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig. Why I don't see any metrics or some of the metrics are not working? # In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this. Kubectl is not working in Lens terminal, what should I do? # Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead. How can I configure Helm repositories? # Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line. Where can I find application logs? # Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/ How can I see more verbose logs? # You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens Why Lens window rendering is broken? # MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"FAQ"},{"location":"faq/#faq","text":"","title":"FAQ"},{"location":"faq/#what-operating-systems-does-lens-support","text":"Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.","title":"What operating systems does Lens support?"},{"location":"faq/#lens-application-is-not-opening-what-might-be-wrong","text":"When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.","title":"Lens application is not opening, what might be wrong?"},{"location":"faq/#why-cant-i-add-any-clusters","text":"When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.","title":"Why can't I add any clusters?"},{"location":"faq/#why-cluster-dashboard-is-not-opening","text":"To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 .","title":"Why Cluster dashboard is not opening?"},{"location":"faq/#why-i-dont-see-anything-on-cluster-dashboard","text":"Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.","title":"Why I don't see anything on Cluster dashboard?"},{"location":"faq/#why-i-dont-see-any-metrics-or-some-of-the-metrics-are-not-working","text":"In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.","title":"Why I don't see any metrics or some of the metrics are not working?"},{"location":"faq/#kubectl-is-not-working-in-lens-terminal-what-should-i-do","text":"Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.","title":"Kubectl is not working in Lens terminal, what should I do?"},{"location":"faq/#how-can-i-configure-helm-repositories","text":"Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.","title":"How can I configure Helm repositories?"},{"location":"faq/#where-can-i-find-application-logs","text":"Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/","title":"Where can I find application logs?"},{"location":"faq/#how-can-i-see-more-verbose-logs","text":"You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"How can I see more verbose logs?"},{"location":"faq/#why-lens-window-rendering-is-broken","text":"MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"Why Lens window rendering is broken?"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System Requirements # Review the System Requirements to check if your computer configuration is supported. macOS # Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock . Windows # Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens . Linux # See the Download Lens page for a complete list of available installation options. Snap # Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic Update Cadence # Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System Requirements"},{"location":"getting-started/#macos","text":"Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"macOS"},{"location":"getting-started/#windows","text":"Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#snap","text":"Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Snap"},{"location":"getting-started/#update-cadence","text":"Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Update Cadence"},{"location":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. Getting started Get Lens Kubernetes IDE Running in 5 Minutes Duration 35 minutes Introducing Lens Lens Kubernetes IDE overview Duration 2 minutes Demo of Mirantis Lens The Best IDE For Kubernetes Duration 10 minutes","title":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color Themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & Usage Tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more. Disable Telemetry Reporting # If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color Themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & Usage Tracking"},{"location":"getting-started/preferences/#disable-telemetry-reporting","text":"If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Disable Telemetry Reporting"},{"location":"helm/","text":"Using Helm Charts # Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section. Managing Helm Reporistories # Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well. Installing a Helm Chart # Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster. Updating a Helm Release # To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button. Deleting a Helm Release # To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.","title":"Using Helm Charts"},{"location":"helm/#managing-helm-reporistories","text":"Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.","title":"Managing Helm Reporistories"},{"location":"helm/#installing-a-helm-chart","text":"Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster.","title":"Installing a Helm Chart"},{"location":"helm/#updating-a-helm-release","text":"To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button.","title":"Updating a Helm Release"},{"location":"helm/#deleting-a-helm-release","text":"To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Deleting a Helm Release"},{"location":"support/","text":"Support # Here you will find different ways of getting support for Lens IDE. Community Support # Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github. Commercial Support & Services # If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Support"},{"location":"support/#support","text":"Here you will find different ways of getting support for Lens IDE.","title":"Support"},{"location":"support/#community-support","text":"Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github.","title":"Community Support"},{"location":"support/#commercial-support-services","text":"If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Commercial Support & Services"},{"location":"supporting/requirements/","text":"Requirements for Lens # Hardware # Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM Platforms # Lens has been tested on the following platforms: macOS Windows Linux Additional Windows requirements # ... Additional Linux Requirements # ...","title":"Requirements for Lens"},{"location":"supporting/requirements/#requirements-for-lens","text":"","title":"Requirements for Lens"},{"location":"supporting/requirements/#hardware","text":"Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM","title":"Hardware"},{"location":"supporting/requirements/#platforms","text":"Lens has been tested on the following platforms: macOS Windows Linux","title":"Platforms"},{"location":"supporting/requirements/#additional-windows-requirements","text":"...","title":"Additional Windows requirements"},{"location":"supporting/requirements/#additional-linux-requirements","text":"...","title":"Additional Linux Requirements"}]} \ No newline at end of file +{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label
); }) Defined in src/renderer/components/layout/tab-layout.tsx:27 Const kubeDetailsUrlParam # \u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16 Const kubeSelectedUrlParam # \u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21 Const notificationsStore # \u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77 Const orderByUrlParam # \u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49 Const sortByUrlParam # \u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44 Const terminalStore # \u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:122 Functions # DrawerItemLabels # \u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a SubMenu # \u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a createPodLogsTab # \u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:208 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab createTerminalTab # \u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void withTooltip # \u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#module-renderer-apicomponents","text":"","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_components_/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_components_/#classes","text":"Badge Button Checkbox ConfirmDialog CubeSpinner Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress Menu MenuActions MenuItem NamespaceSelect NamespaceSelectFilter Notifications NotificationsStore PageLayout PodDetailsList Radio RadioGroup Select Slider Spinner StatusBrick Stepper Tab Table TableCell TableHead TableRow Tabs Tooltip Wizard WizardLayout WizardStep","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_components_/#interfaces","text":"BadgeProps ButtonProps CheckboxProps ConfirmDialogParams ConfirmDialogProps CubeSpinnerProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification PageLayoutProps RadioGroupProps SelectOption SelectProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps WizardProps WizardStepProps","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases","text":"InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortParams","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#variables","text":"InputValidators MenuContext TabLayout kubeDetailsUrlParam kubeSelectedUrlParam notificationsStore orderByUrlParam sortByUrlParam terminalStore","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#functions","text":"DrawerItemLabels SubMenu createPodLogsTab createTerminalTab getDetailsUrl hideDetails showDetails withTooltip","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#inputprops","text":"\u01ac InputProps : Omit\u2039InputElementProps, \"onChange\" | \"onSubmit\"\u203a & object Defined in src/renderer/components/input/input.tsx:21","title":"InputProps"},{"location":"extensions/api/modules/_renderer_api_components_/#menucontextvalue","text":"\u01ac MenuContextValue : Menu Defined in src/renderer/components/menu/menu.tsx:11","title":"MenuContextValue"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationid","text":"\u01ac NotificationId : string | number Defined in src/renderer/components/notifications/notifications.store.ts:7","title":"NotificationId"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationmessage","text":"\u01ac NotificationMessage : React.ReactNode | React.ReactNode[] | JsonApiErrorParsed Defined in src/renderer/components/notifications/notifications.store.ts:8","title":"NotificationMessage"},{"location":"extensions/api/modules/_renderer_api_components_/#radioprops","text":"\u01ac RadioProps : HTMLProps\u2039any\u203a & object Defined in src/renderer/components/radio/radio.tsx:40","title":"RadioProps"},{"location":"extensions/api/modules/_renderer_api_components_/#tablecellelem","text":"\u01ac TableCellElem : ReactElement\u2039 TableCellProps \u203a Defined in src/renderer/components/table/table-cell.tsx:9","title":"TableCellElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableheadelem","text":"\u01ac TableHeadElem : ReactElement\u2039 TableHeadProps \u203a Defined in src/renderer/components/table/table-head.tsx:6","title":"TableHeadElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\" | string Defined in src/renderer/components/table/table.tsx:16","title":"TableOrderBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablerowelem","text":"\u01ac TableRowElem : ReactElement\u2039 TableRowProps \u203a Defined in src/renderer/components/table/table-row.tsx:7","title":"TableRowElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortby","text":"\u01ac TableSortBy : string Defined in src/renderer/components/table/table.tsx:15","title":"TableSortBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortcallback","text":"\u01ac TableSortCallback : function Defined in src/renderer/components/table/table.tsx:18","title":"TableSortCallback"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortparams","text":"\u01ac TableSortParams : object Defined in src/renderer/components/table/table.tsx:17","title":"TableSortParams"},{"location":"extensions/api/modules/_renderer_api_components_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#inputvalidators","text":"\u2022 InputValidators : InputValidators Defined in src/renderer/components/input/input.tsx:14","title":"InputValidators"},{"location":"extensions/api/modules/_renderer_api_components_/#const-menucontext","text":"\u2022 MenuContext : Context\u2039 Menu \u2039\u203a\u203a = React.createContext (null) Defined in src/renderer/components/menu/menu.tsx:10","title":"Const MenuContext"},{"location":"extensions/api/modules/_renderer_api_components_/#const-tablayout","text":"\u2022 TabLayout : (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { const currentLocation = navigation.location.pathname; const hasTabs = tabs.length > 0; const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null; return ( {hasTabs && ( navigate(url)}> {tabs.map(({ title, routePath, url = routePath, exact }) => { const isActive = !!matchPath(currentLocation, { path: routePath, exact }); return ; })} )}
{hasTabs && ( {tabs.map(({ routePath, exact, component }) => { return ; })} )} {children}
); }) Defined in src/renderer/components/layout/tab-layout.tsx:27","title":"Const TabLayout"},{"location":"extensions/api/modules/_renderer_api_components_/#const-kubedetailsurlparam","text":"\u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16","title":"Const kubeDetailsUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-kubeselectedurlparam","text":"\u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21","title":"Const kubeSelectedUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-notificationsstore","text":"\u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77","title":"Const notificationsStore"},{"location":"extensions/api/modules/_renderer_api_components_/#const-orderbyurlparam","text":"\u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49","title":"Const orderByUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-sortbyurlparam","text":"\u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44","title":"Const sortByUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-terminalstore","text":"\u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:122","title":"Const terminalStore"},{"location":"extensions/api/modules/_renderer_api_components_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a","title":"DrawerItemLabels"},{"location":"extensions/api/modules/_renderer_api_components_/#submenu","text":"\u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a","title":"SubMenu"},{"location":"extensions/api/modules/_renderer_api_components_/#createpodlogstab","text":"\u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:208 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab","title":"createPodLogsTab"},{"location":"extensions/api/modules/_renderer_api_components_/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab","title":"createTerminalTab"},{"location":"extensions/api/modules/_renderer_api_components_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_components_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_components_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_components_/#withtooltip","text":"\u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"withTooltip"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/","text":"Module: \"renderer-api/k8s-api\" # Index # Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore Interfaces # IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Type aliases # KubeObjectStatus Variables # apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi Functions # forCluster isAllowedResource Type aliases # KubeObjectStatus # \u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1 Type declaration: level : KubeObjectStatusLevel text : string timestamp ? : string Variables # Const apiManager # \u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:58 Const clusterRoleApi # \u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12 Const clusterRoleBindingApi # \u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10 Const configMapApi # \u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26 Const crdApi # \u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154 Const cronJobApi # \u2022 cronJobApi : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131 Const daemonSetApi # \u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74 Const deploymentApi # \u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:192 Const endpointApi # \u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127 Const eventApi # \u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59 Const hpaApi # \u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143 Const ingressApi # \u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177 Const jobApi # \u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110 Const namespacesApi # \u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25 Const networkPolicyApi # \u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71 Const nodesApi # \u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169 Const pdbApi # \u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47 Const persistentVolumeApi # \u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73 Const podsApi # \u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:487 Const pvcApi # \u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90 Const replicaSetApi # \u2022 replicaSetApi : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83 Const resourceQuotaApi # \u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66 Const roleApi # \u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21 Const roleBindingApi # \u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34 Const secretsApi # \u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48 Const serviceAccountsApi # \u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27 Const serviceApi # \u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101 Const statefulSetApi # \u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110 Const storageClassApi # \u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37 Functions # forCluster # \u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a isAllowedResource # \u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:42 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#module-renderer-apik8s-api","text":"","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#classes","text":"CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#interfaces","text":"IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases","text":"KubeObjectStatus","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables","text":"apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions","text":"forCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#kubeobjectstatus","text":"\u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1","title":"KubeObjectStatus"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-apimanager","text":"\u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:58","title":"Const apiManager"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterroleapi","text":"\u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12","title":"Const clusterRoleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterrolebindingapi","text":"\u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10","title":"Const clusterRoleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-configmapapi","text":"\u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26","title":"Const configMapApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-crdapi","text":"\u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154","title":"Const crdApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-cronjobapi","text":"\u2022 cronJobApi : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131","title":"Const cronJobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-daemonsetapi","text":"\u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74","title":"Const daemonSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-deploymentapi","text":"\u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:192","title":"Const deploymentApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-endpointapi","text":"\u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127","title":"Const endpointApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-eventapi","text":"\u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59","title":"Const eventApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-hpaapi","text":"\u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143","title":"Const hpaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-ingressapi","text":"\u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177","title":"Const ingressApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-jobapi","text":"\u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110","title":"Const jobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-namespacesapi","text":"\u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25","title":"Const namespacesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-networkpolicyapi","text":"\u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71","title":"Const networkPolicyApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-nodesapi","text":"\u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169","title":"Const nodesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pdbapi","text":"\u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47","title":"Const pdbApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-persistentvolumeapi","text":"\u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73","title":"Const persistentVolumeApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-podsapi","text":"\u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:487","title":"Const podsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pvcapi","text":"\u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90","title":"Const pvcApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-replicasetapi","text":"\u2022 replicaSetApi : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83","title":"Const replicaSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-resourcequotaapi","text":"\u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66","title":"Const resourceQuotaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-roleapi","text":"\u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21","title":"Const roleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-rolebindingapi","text":"\u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34","title":"Const roleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-secretsapi","text":"\u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48","title":"Const secretsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceaccountsapi","text":"\u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27","title":"Const serviceAccountsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceapi","text":"\u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101","title":"Const serviceApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-statefulsetapi","text":"\u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110","title":"Const statefulSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-storageclassapi","text":"\u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37","title":"Const storageClassApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#forcluster","text":"\u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a","title":"forCluster"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#isallowedresource","text":"\u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:42 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/_renderer_api_navigation_/","text":"Module: \"renderer-api/navigation\" # Index # Classes # PageParam Interfaces # IURLParams PageParamInit Functions # createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails Functions # createPageParam # \u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void isActiveRoute # \u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean navigate # \u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#module-renderer-apinavigation","text":"","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_navigation_/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_navigation_/#interfaces","text":"IURLParams PageParamInit","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions","text":"createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#createpageparam","text":"\u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a","title":"createPageParam"},{"location":"extensions/api/modules/_renderer_api_navigation_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_navigation_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_navigation_/#isactiveroute","text":"\u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/_renderer_api_navigation_/#navigate","text":"\u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void","title":"navigate"},{"location":"extensions/api/modules/_renderer_api_navigation_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_theming_/","text":"Module: \"renderer-api/theming\" # Index # Functions # getActiveTheme Functions # getActiveTheme # \u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#module-renderer-apitheming","text":"","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#getactivetheme","text":"\u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"getActiveTheme"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/color-reference/","text":"Theme Color Reference # You can use theme-based CSS Variables to style an extension according to the active theme. Base Colors # --blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color. Text Colors # --textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts. Border Colors # --borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color. Layout Colors # --mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs. Sidebar Colors # --sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar. Button Colors # --buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color. Table Colors # --tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table. Dock Colors # --dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel. Helm Chart Colors # --helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color. Terminal Colors # --terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color. Dialog Colors # --dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer. Detail Panel (Drawer) Colors # --drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer. Misc Colors # --logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Color Reference"},{"location":"extensions/capabilities/color-reference/#theme-color-reference","text":"You can use theme-based CSS Variables to style an extension according to the active theme.","title":"Theme Color Reference"},{"location":"extensions/capabilities/color-reference/#base-colors","text":"--blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color.","title":"Base Colors"},{"location":"extensions/capabilities/color-reference/#text-colors","text":"--textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts.","title":"Text Colors"},{"location":"extensions/capabilities/color-reference/#border-colors","text":"--borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color.","title":"Border Colors"},{"location":"extensions/capabilities/color-reference/#layout-colors","text":"--mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs.","title":"Layout Colors"},{"location":"extensions/capabilities/color-reference/#sidebar-colors","text":"--sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar.","title":"Sidebar Colors"},{"location":"extensions/capabilities/color-reference/#button-colors","text":"--buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color.","title":"Button Colors"},{"location":"extensions/capabilities/color-reference/#table-colors","text":"--tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table.","title":"Table Colors"},{"location":"extensions/capabilities/color-reference/#dock-colors","text":"--dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel.","title":"Dock Colors"},{"location":"extensions/capabilities/color-reference/#helm-chart-colors","text":"--helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color.","title":"Helm Chart Colors"},{"location":"extensions/capabilities/color-reference/#terminal-colors","text":"--terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color.","title":"Terminal Colors"},{"location":"extensions/capabilities/color-reference/#dialog-colors","text":"--dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer.","title":"Dialog Colors"},{"location":"extensions/capabilities/color-reference/#detail-panel-drawer-colors","text":"--drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer.","title":"Detail Panel (Drawer) Colors"},{"location":"extensions/capabilities/color-reference/#misc-colors","text":"--logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Misc Colors"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities. Main Extension # The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } App Menus # This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] } Renderer Extension # The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Cluster Features # This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#main-extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#app-menus","text":"This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click () { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] }","title":"App Menus"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#global-pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#cluster-features","text":"This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] }","title":"Cluster Features"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application. Layout # For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); } A complete list of themable colors can be found in the Color Reference . Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#styling-an-extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#layout-variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( --padding ) * 2 ); border-radius : var ( --border-radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#theme-variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( --font-size-small ); background-color : var ( --colorSuccess ); } A complete list of themable colors can be found in the Color Reference .","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#injected-styles","text":"Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#css-in-js","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first. Extension Manifest # Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Extension Entry Files # Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#extension-entry-files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system. Recommended: # All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more. Extension Capabilities # In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page. Guides and Samples # Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading. First Extension # In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#first-extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx Samples # Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Overview"},{"location":"extensions/guides/#extension-guides","text":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/generator/","text":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Next Steps"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects. Get CRD objects # In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ?: string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore ); Create CertificatePage component # Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } } Customize Details panel # We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } } Summary # Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type ?: string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render () { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render () { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process. LensMainExtension Class # onActivate() and onDeactivate() Methods # To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate () { console . log ( 'custom main process extension code started' ); } onDeactivate () { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate () { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate () { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } For more details on accessing Lens state data, please see the Stores guide. appMenus # The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","text":"To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate () { console . log ( 'custom main process extension code started' ); } onDeactivate () { console . log ( 'custom main process extension de-activated' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate () { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate () { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } For more details on accessing Lens state data, please see the Stores guide.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#appmenus","text":"The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click () { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"appMenus"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension # The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components. LensRendererExtension Class # To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate () { console . log ( 'custom renderer process extension code started' ); } onDeactivate () { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data. clusterPageMenus # The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case globalPages # Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon. globalPageMenus # Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. clusterFeatures # Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation. appPreferences # The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render () { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore statusBarItems # The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called. kubeObjectMenuItems # An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount () { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render () { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render () { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension","text":"The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#lensrendererextension-class","text":"To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate () { console . log ( 'custom renderer process extension code started' ); } onDeactivate () { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled.","title":"LensRendererExtension Class"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon.","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#globalpagemenus","text":"Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render () { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field.","title":"globalPageMenus"},{"location":"extensions/guides/renderer-extension/#clusterfeatures","text":"Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation.","title":"clusterFeatures"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render () { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#statusbaritems","text":"The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","text":"An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount () { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render () { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render () { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data. ExtensionStore # Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate () { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate () { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render () { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data.","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate () { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate () { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render () { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render () { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with mobx # Introduction # Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls. How mobx works: # mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"How mobx works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball. Places To Host Your Extension # We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package. Publishing via NPM # This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file. Making a NPM Tarball of Your Extension # While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#publishing-extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples. Main Process Unit Testing # Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests. Tips # Console.log # Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","text":"UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","text":"Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done. Installing an Extension # There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an Extension # Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run. Uninstalling an Extension # If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Uninstalling an Extension"},{"location":"faq/","text":"FAQ # What operating systems does Lens support? # Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options. Lens application is not opening, what might be wrong? # When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address. Why can't I add any clusters? # When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid. Why Cluster dashboard is not opening? # To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 . Why I don't see anything on Cluster dashboard? # Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig. Why I don't see any metrics or some of the metrics are not working? # In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this. Kubectl is not working in Lens terminal, what should I do? # Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead. How can I configure Helm repositories? # Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line. Where can I find application logs? # Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/ How can I see more verbose logs? # You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens Why Lens window rendering is broken? # MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"FAQ"},{"location":"faq/#faq","text":"","title":"FAQ"},{"location":"faq/#what-operating-systems-does-lens-support","text":"Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.","title":"What operating systems does Lens support?"},{"location":"faq/#lens-application-is-not-opening-what-might-be-wrong","text":"When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.","title":"Lens application is not opening, what might be wrong?"},{"location":"faq/#why-cant-i-add-any-clusters","text":"When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.","title":"Why can't I add any clusters?"},{"location":"faq/#why-cluster-dashboard-is-not-opening","text":"To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 .","title":"Why Cluster dashboard is not opening?"},{"location":"faq/#why-i-dont-see-anything-on-cluster-dashboard","text":"Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.","title":"Why I don't see anything on Cluster dashboard?"},{"location":"faq/#why-i-dont-see-any-metrics-or-some-of-the-metrics-are-not-working","text":"In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.","title":"Why I don't see any metrics or some of the metrics are not working?"},{"location":"faq/#kubectl-is-not-working-in-lens-terminal-what-should-i-do","text":"Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.","title":"Kubectl is not working in Lens terminal, what should I do?"},{"location":"faq/#how-can-i-configure-helm-repositories","text":"Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.","title":"How can I configure Helm repositories?"},{"location":"faq/#where-can-i-find-application-logs","text":"Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/","title":"Where can I find application logs?"},{"location":"faq/#how-can-i-see-more-verbose-logs","text":"You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"How can I see more verbose logs?"},{"location":"faq/#why-lens-window-rendering-is-broken","text":"MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"Why Lens window rendering is broken?"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System Requirements # Review the System Requirements to check if your computer configuration is supported. macOS # Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock . Windows # Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens . Linux # See the Download Lens page for a complete list of available installation options. Snap # Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic Update Cadence # Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System Requirements"},{"location":"getting-started/#macos","text":"Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"macOS"},{"location":"getting-started/#windows","text":"Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#snap","text":"Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Snap"},{"location":"getting-started/#update-cadence","text":"Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Update Cadence"},{"location":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. Getting started Get Lens Kubernetes IDE Running in 5 Minutes Duration 35 minutes Introducing Lens Lens Kubernetes IDE overview Duration 2 minutes Demo of Mirantis Lens The Best IDE For Kubernetes Duration 10 minutes","title":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color Themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & Usage Tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more. Disable Telemetry Reporting # If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color Themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & Usage Tracking"},{"location":"getting-started/preferences/#disable-telemetry-reporting","text":"If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Disable Telemetry Reporting"},{"location":"helm/","text":"Using Helm Charts # Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section. Managing Helm Reporistories # Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well. Installing a Helm Chart # Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster. Updating a Helm Release # To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button. Deleting a Helm Release # To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.","title":"Using Helm Charts"},{"location":"helm/#managing-helm-reporistories","text":"Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.","title":"Managing Helm Reporistories"},{"location":"helm/#installing-a-helm-chart","text":"Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster.","title":"Installing a Helm Chart"},{"location":"helm/#updating-a-helm-release","text":"To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button.","title":"Updating a Helm Release"},{"location":"helm/#deleting-a-helm-release","text":"To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Deleting a Helm Release"},{"location":"support/","text":"Support # Here you will find different ways of getting support for Lens IDE. Community Support # Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github. Commercial Support & Services # If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Support"},{"location":"support/#support","text":"Here you will find different ways of getting support for Lens IDE.","title":"Support"},{"location":"support/#community-support","text":"Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github.","title":"Community Support"},{"location":"support/#commercial-support-services","text":"If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Commercial Support & Services"},{"location":"supporting/requirements/","text":"Requirements for Lens # Hardware # Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM Platforms # Lens has been tested on the following platforms: macOS Windows Linux Additional Windows requirements # ... Additional Linux Requirements # ...","title":"Requirements for Lens"},{"location":"supporting/requirements/#requirements-for-lens","text":"","title":"Requirements for Lens"},{"location":"supporting/requirements/#hardware","text":"Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM","title":"Hardware"},{"location":"supporting/requirements/#platforms","text":"Lens has been tested on the following platforms: macOS Windows Linux","title":"Platforms"},{"location":"supporting/requirements/#additional-windows-requirements","text":"...","title":"Additional Windows requirements"},{"location":"supporting/requirements/#additional-linux-requirements","text":"...","title":"Additional Linux Requirements"}]} \ No newline at end of file diff --git a/master/sitemap.xml.gz b/master/sitemap.xml.gz index 84ddaccf32..b73c485da9 100644 Binary files a/master/sitemap.xml.gz and b/master/sitemap.xml.gz differ