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 ffa24e6ef1..f263add390 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 8710d00002..7002e2bf6b 100644 --- a/master/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/master/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -1006,6 +1006,13 @@ isAdmin + + +
  • + + isGlobalWatchEnabled + +
  • @@ -1179,6 +1186,13 @@ canI +
  • + +
  • + + canUseWatchApi + +
  • @@ -1410,6 +1424,7 @@
  • initialized
  • initializing
  • isAdmin
  • +
  • isGlobalWatchEnabled
  • kubeConfigPath
  • kubeCtl
  • kubeProxyUrl
  • @@ -1437,6 +1452,7 @@
  • activate
  • bindEvents
  • canI
  • +
  • canUseWatchApi
  • disconnect
  • ensureKubectl
  • getAllowedNamespaces
  • @@ -1466,7 +1482,7 @@

    Constructors#

    constructor#

    + new Cluster(model: ClusterModel): Cluster

    -

    Defined in src/main/cluster.ts:249

    +

    Defined in src/main/cluster.ts:255

    Parameters:

    @@ -1486,200 +1502,206 @@

    Properties#

    accessible#

    accessible: boolean = false

    -

    Defined in src/main/cluster.ts:149

    +

    Defined in src/main/cluster.ts:149

    Can user access cluster resources

    observable


    accessibleNamespaces#

    accessibleNamespaces: string[] = []

    Implementation of ClusterModel.accessibleNamespaces

    -

    Defined in src/main/cluster.ts:210

    +

    Defined in src/main/cluster.ts:216

    List of accessible namespaces provided by user in the Cluster Settings

    observable


    Protected activated#

    activated: boolean = false

    -

    Defined in src/main/cluster.ts:81

    +

    Defined in src/main/cluster.ts:82


    allowedNamespaces#

    allowedNamespaces: string[] = []

    -

    Defined in src/main/cluster.ts:197

    +

    Defined in src/main/cluster.ts:203

    List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

    observable


    allowedResources#

    allowedResources: string[] = []

    -

    Defined in src/main/cluster.ts:204

    +

    Defined in src/main/cluster.ts:210

    List of allowed resources

    observable

    internal


    apiUrl#

    apiUrl: string

    -

    Defined in src/main/cluster.ts:124

    +

    Defined in src/main/cluster.ts:124

    Kubernetes API server URL

    observable


    contextHandler#

    contextHandler: ContextHandler

    -

    Defined in src/main/cluster.ts:72

    +

    Defined in src/main/cluster.ts:73

    Context handler

    internal


    contextName#

    contextName: string

    Implementation of ClusterModel.contextName

    -

    Defined in src/main/cluster.ts:106

    +

    Defined in src/main/cluster.ts:106

    Kubeconfig context name

    observable


    disconnected#

    disconnected: boolean = true

    -

    Defined in src/main/cluster.ts:167

    +

    Defined in src/main/cluster.ts:167

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

    observable


    enabled#

    enabled: boolean = false

    -

    Defined in src/main/cluster.ts:137

    +

    Defined in src/main/cluster.ts:137

    Is cluster instance enabled (disabled clusters are currently hidden)

    observable


    Protected eventDisposers#

    eventDisposers: Function[] = []

    -

    Defined in src/main/cluster.ts:80

    +

    Defined in src/main/cluster.ts:81


    failureReason#

    failureReason: string

    -

    Defined in src/main/cluster.ts:173

    +

    Defined in src/main/cluster.ts:173

    Connection failure reason

    observable


    id#

    id: ClusterId

    Implementation of ClusterModel.id

    -

    Defined in src/main/cluster.ts:60

    +

    Defined in src/main/cluster.ts:61

    Unique id for a cluster


    initialized#

    initialized: boolean = false

    -

    Defined in src/main/cluster.ts:100

    +

    Defined in src/main/cluster.ts:100

    Is cluster object initialized

    observable


    initializing#

    initializing: boolean = false

    -

    Defined in src/main/cluster.ts:92

    +

    Defined in src/main/cluster.ts:93

    Is cluster object initializinng on-going

    observable


    isAdmin#

    isAdmin: boolean = false

    -

    Defined in src/main/cluster.ts:179

    +

    Defined in src/main/cluster.ts:179

    Does user have admin like access

    observable


    +

    isGlobalWatchEnabled#

    +

    isGlobalWatchEnabled: boolean = false

    +

    Defined in src/main/cluster.ts:185

    +

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

    +

    observable

    +

    kubeConfigPath#

    kubeConfigPath: string

    Implementation of ClusterModel.kubeConfigPath

    -

    Defined in src/main/cluster.ts:118

    +

    Defined in src/main/cluster.ts:118

    Path to kubeconfig

    observable


    kubeCtl#

    kubeCtl: Kubectl

    -

    Defined in src/main/cluster.ts:66

    +

    Defined in src/main/cluster.ts:67

    Kubectl

    internal


    kubeProxyUrl#

    kubeProxyUrl: string

    -

    Defined in src/main/cluster.ts:131

    +

    Defined in src/main/cluster.ts:131

    Internal authentication proxy URL

    observable

    internal


    Protected kubeconfigManager#

    kubeconfigManager: KubeconfigManager

    -

    Defined in src/main/cluster.ts:79

    +

    Defined in src/main/cluster.ts:80


    metadata#

    metadata: ClusterMetadata

    Implementation of ClusterModel.metadata

    -

    Defined in src/main/cluster.ts:191

    +

    Defined in src/main/cluster.ts:197

    Metadata

    observable


    online#

    online: boolean = false

    -

    Defined in src/main/cluster.ts:143

    +

    Defined in src/main/cluster.ts:143

    Is cluster online

    observable


    ownerRef#

    ownerRef: string

    Implementation of ClusterModel.ownerRef

    -

    Defined in src/main/cluster.ts:78

    +

    Defined in src/main/cluster.ts:79

    Owner reference

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


    preferences#

    preferences: ClusterPreferences

    Implementation of ClusterModel.preferences

    -

    Defined in src/main/cluster.ts:185

    +

    Defined in src/main/cluster.ts:191

    Preferences

    observable


    ready#

    ready: boolean = false

    -

    Defined in src/main/cluster.ts:155

    +

    Defined in src/main/cluster.ts:155

    Is cluster instance in usable state

    observable


    reconnecting#

    reconnecting: boolean = false

    -

    Defined in src/main/cluster.ts:161

    +

    Defined in src/main/cluster.ts:161

    Is cluster currently reconnecting

    observable


    whenInitialized#

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

    -

    Defined in src/main/cluster.ts:84

    +

    Defined in src/main/cluster.ts:85


    whenReady#

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

    -

    Defined in src/main/cluster.ts:85

    +

    Defined in src/main/cluster.ts:86


    workspace#

    workspace: WorkspaceId

    Implementation of ClusterModel.workspace

    -

    Defined in src/main/cluster.ts:112

    +

    Defined in src/main/cluster.ts:112

    Workspace id

    observable

    Accessors#

    available#

    get available(): boolean

    -

    Defined in src/main/cluster.ts:217

    +

    Defined in src/main/cluster.ts:223

    Is cluster available

    computed

    Returns: boolean


    isManaged#

    get isManaged(): boolean

    -

    Defined in src/main/cluster.ts:263

    +

    Defined in src/main/cluster.ts:269

    Is cluster managed by an extension

    Returns: boolean


    name#

    get name(): string

    -

    Defined in src/main/cluster.ts:226

    +

    Defined in src/main/cluster.ts:232

    Cluster name

    computed

    Returns: string


    prometheusPreferences#

    get prometheusPreferences(): ClusterPrometheusPreferences

    -

    Defined in src/main/cluster.ts:236

    +

    Defined in src/main/cluster.ts:242

    Prometheus preferences

    computed

    internal

    @@ -1687,13 +1709,13 @@

    version#

    get version(): string

    -

    Defined in src/main/cluster.ts:247

    +

    Defined in src/main/cluster.ts:253

    Kubernetes version

    Returns: string

    Methods#

    activate#

    activate(force: boolean): Promise‹void›

    -

    Defined in src/main/cluster.ts:339

    +

    Defined in src/main/cluster.ts:345

    internal

    Parameters:

    @@ -1718,13 +1740,13 @@

    Protected bindEvents#

    bindEvents(): void

    -

    Defined in src/main/cluster.ts:308

    +

    Defined in src/main/cluster.ts:314

    internal

    Returns: void


    canI#

    canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:545

    +

    Defined in src/main/cluster.ts:559

    internal

    Parameters:

    @@ -1745,41 +1767,64 @@

    Returns: Promise‹boolean›


    +

    canUseWatchApi#

    +

    canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:591

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    customizeResourceV1ResourceAttributes{}
    +

    Returns: Promise‹boolean›

    +

    disconnect#

    disconnect(): void

    -

    Defined in src/main/cluster.ts:389

    +

    Defined in src/main/cluster.ts:393

    internal

    Returns: void


    Protected ensureKubectl#

    ensureKubectl(): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:369

    +

    Defined in src/main/cluster.ts:373

    internal

    Returns: Promise‹boolean›


    Protected getAllowedNamespaces#

    getAllowedNamespaces(): Promise‹string[]›

    -

    Defined in src/main/cluster.ts:644

    +

    Defined in src/main/cluster.ts:670

    Returns: Promise‹string[]›


    Protected getAllowedResources#

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

    -

    Defined in src/main/cluster.ts:664

    +

    Defined in src/main/cluster.ts:690

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


    Protected getConnectionStatus#

    getConnectionStatus(): Promise‹ClusterStatus›

    -

    Defined in src/main/cluster.ts:501

    +

    Defined in src/main/cluster.ts:515

    Returns: Promise‹ClusterStatus›


    Protected getKubeconfig#

    getKubeconfig(): KubeConfig

    -

    Defined in src/main/cluster.ts:456

    +

    Defined in src/main/cluster.ts:470

    Returns: KubeConfig


    getMeta#

    getMeta(): object

    -

    Defined in src/main/cluster.ts:632

    +

    Defined in src/main/cluster.ts:658

    Returns: object