From 7f5364a7c2cf65b83e8a0e4ef6bc7407ac3f93a1 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 7 Dec 2020 11:45:52 +0000 Subject: [PATCH] Deployed 8f2755905 to master with MkDocs 1.1.2 and mike 0.5.5 --- .../index.html | 24 +- .../_core_api_stores_.cluster/index.html | 218 ++- .../_core_api_stores_.clusterstore/index.html | 1334 ++++++++++++++++ .../index.html | 54 +- .../_core_api_stores_.workspace/index.html | 34 +- .../index.html | 1358 +++++++++++++++++ .../_core_api_utils_.singleton/index.html | 6 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 30 +- .../index.html | 2 +- .../index.html | 50 +- .../index.html | 20 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.icon/index.html | 12 +- .../index.html | 52 +- .../index.html | 4 +- .../index.html | 14 +- .../index.html | 6 +- .../index.html | 14 +- .../index.html | 6 +- .../index.html | 12 +- .../_renderer_api_components_.menu/index.html | 44 +- .../index.html | 16 +- .../index.html | 18 +- .../index.html | 16 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 22 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 2 +- .../_renderer_api_components_.tab/index.html | 24 +- .../index.html | 28 +- .../index.html | 10 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.tabs/index.html | 6 +- .../index.html | 30 +- .../index.html | 2 +- .../index.html | 58 +- .../index.html | 62 +- .../index.html | 58 +- .../index.html | 88 +- .../index.html | 88 +- .../index.html | 94 +- .../_renderer_api_k8s_api_.cronjob/index.html | 64 +- .../index.html | 90 +- .../index.html | 86 +- .../index.html | 70 +- .../index.html | 94 +- .../index.html | 74 +- .../index.html | 68 +- .../index.html | 94 +- .../index.html | 60 +- .../index.html | 88 +- .../index.html | 94 +- .../index.html | 72 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.ingress/index.html | 66 +- .../index.html | 62 +- .../index.html | 92 +- .../_renderer_api_k8s_api_.job/index.html | 78 +- .../index.html | 92 +- .../_renderer_api_k8s_api_.kubeapi/index.html | 60 +- .../index.html | 84 +- .../index.html | 52 +- .../index.html | 88 +- .../index.html | 56 +- .../index.html | 106 +- .../index.html | 60 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.node/index.html | 78 +- .../index.html | 62 +- .../index.html | 106 +- .../index.html | 62 +- .../index.html | 66 +- .../index.html | 62 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.pod/index.html | 110 +- .../index.html | 66 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.podsapi/index.html | 64 +- .../index.html | 104 +- .../index.html | 70 +- .../index.html | 96 +- .../index.html | 58 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.role/index.html | 58 +- .../index.html | 62 +- .../index.html | 90 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.secret/index.html | 62 +- .../index.html | 88 +- .../_renderer_api_k8s_api_.service/index.html | 72 +- .../index.html | 62 +- .../index.html | 88 +- .../index.html | 88 +- .../index.html | 72 +- .../index.html | 94 +- .../index.html | 70 +- .../index.html | 88 +- .../index.html | 92 +- .../api/classes/lensmainextension/index.html | 34 +- .../classes/lensrendererextension/index.html | 54 +- .../index.html | 6 +- .../index.html | 16 +- .../index.html | 6 +- .../index.html | 8 +- .../_core_api_stores_.clustermodel/index.html | 18 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 8 +- .../index.html | 28 +- .../index.html | 14 +- .../index.html | 14 +- .../index.html | 4 +- .../index.html | 18 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 2 +- .../index.html | 20 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 30 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 4 +- .../index.html | 56 +- .../index.html | 18 +- .../index.html | 4 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 10 +- .../index.html | 8 +- .../index.html | 26 +- .../index.html | 8 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 12 +- .../index.html | 4 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 12 +- .../index.html | 18 +- .../index.html | 8 +- .../index.html | 34 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 20 +- .../index.html | 14 +- .../index.html | 2 +- .../index.html | 24 +- .../index.html | 16 +- .../index.html | 4 +- .../index.html | 4 +- .../api/modules/_core_api_app_/index.html | 18 +- .../modules/_core_api_event_bus_/index.html | 4 +- .../api/modules/_core_api_stores_/index.html | 14 +- .../api/modules/_core_api_utils_/index.html | 8 +- .../_renderer_api_components_/index.html | 44 +- .../modules/_renderer_api_k8s_api_/index.html | 64 +- .../_renderer_api_navigation_/index.html | 8 +- .../modules/_renderer_api_theming_/index.html | 2 +- master/search/search_index.json | 2 +- master/sitemap.xml.gz | Bin 480 -> 480 bytes 191 files changed, 6129 insertions(+), 3327 deletions(-) create mode 100644 master/extensions/api/classes/_core_api_stores_.clusterstore/index.html create mode 100644 master/extensions/api/classes/_core_api_stores_.workspacestore/index.html 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 3cb695c4e0..58e8d93d17 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 @@ -1012,13 +1012,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:

@@ -1046,7 +1046,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:

@@ -1070,7 +1070,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:

@@ -1095,7 +1095,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:

@@ -1119,7 +1119,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 @@ -1146,7 +1146,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:

@@ -1170,20 +1170,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 048fb97203..e66086b592 100644 --- a/master/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/master/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -1350,6 +1350,8 @@

Class: Cluster#

+

Cluster

+

beta

Hierarchy#

@@ -1456,152 +1458,209 @@

Properties#

accessible#

accessible: boolean = false

-

Defined in src/main/cluster.ts:72

+

Defined in src/main/cluster.ts:139

+

Can user access cluster resources

+

observable


accessibleNamespaces#

accessibleNamespaces: string[] = []

Implementation of ClusterModel.accessibleNamespaces

-

Defined in src/main/cluster.ts:82

+

Defined in src/main/cluster.ts:200

+

List of accessible namespaces

+

observable


Protected activated#

activated: boolean = false

-

Defined in src/main/cluster.ts:59

+

Defined in src/main/cluster.ts:80


allowedNamespaces#

allowedNamespaces: string[] = []

-

Defined in src/main/cluster.ts:80

+

Defined in src/main/cluster.ts:187

+

List of allowed namespaces

+

observable


allowedResources#

allowedResources: string[] = []

-

Defined in src/main/cluster.ts:81

+

Defined in src/main/cluster.ts:194

+

List of allowed resources

+

observable

+

internal


apiUrl#

apiUrl: string

-

Defined in src/main/cluster.ts:68

+

Defined in src/main/cluster.ts:114

+

Kubernetes API server URL

+

observable


contextHandler#

contextHandler: ContextHandler

-

Defined in src/main/cluster.ts:55

+

Defined in src/main/cluster.ts:71

+

Context handler

+

internal


contextName#

contextName: string

Implementation of ClusterModel.contextName

-

Defined in src/main/cluster.ts:65

+

Defined in src/main/cluster.ts:96

+

Kubeconfig context name

+

observable


disconnected#

disconnected: boolean = true

-

Defined in src/main/cluster.ts:75

+

Defined in src/main/cluster.ts:157

+

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

+

observable


enabled#

enabled: boolean = false

-

Defined in src/main/cluster.ts:70

+

Defined in src/main/cluster.ts:127

+

Is cluster instance enabled (disabled clusters are currently hidden)

+

observable


Protected eventDisposers#

eventDisposers: Function[] = []

-

Defined in src/main/cluster.ts:58

+

Defined in src/main/cluster.ts:79


failureReason#

failureReason: string

-

Defined in src/main/cluster.ts:76

+

Defined in src/main/cluster.ts:163

+

Connection failure reason

+

observable


id#

id: ClusterId

Implementation of ClusterModel.id

-

Defined in src/main/cluster.ts:53

+

Defined in src/main/cluster.ts:59

+

Unique id for a cluster


initialized#

initialized: boolean = false

-

Defined in src/main/cluster.ts:64

+

Defined in src/main/cluster.ts:90

+

Is cluster object initialized

+

observable


isAdmin#

isAdmin: boolean = false

-

Defined in src/main/cluster.ts:77

+

Defined in src/main/cluster.ts:169

+

Does user have admin like access

+

observable


kubeConfigPath#

kubeConfigPath: string

Implementation of ClusterModel.kubeConfigPath

-

Defined in src/main/cluster.ts:67

+

Defined in src/main/cluster.ts:108

+

Path to kubeconfig

+

observable


kubeCtl#

kubeCtl: Kubectl

-

Defined in src/main/cluster.ts:54

+

Defined in src/main/cluster.ts:65

+

Kubectl

+

internal


kubeProxyUrl#

kubeProxyUrl: string

-

Defined in src/main/cluster.ts:69

+

Defined in src/main/cluster.ts:121

+

Internal authentication proxy URL

+

observable

+

internal


Protected kubeconfigManager#

kubeconfigManager: KubeconfigManager

-

Defined in src/main/cluster.ts:57

+

Defined in src/main/cluster.ts:78


metadata#

metadata: ClusterMetadata

Implementation of ClusterModel.metadata

-

Defined in src/main/cluster.ts:79

+

Defined in src/main/cluster.ts:181

+

Metadata

+

observable


online#

online: boolean = false

-

Defined in src/main/cluster.ts:71

+

Defined in src/main/cluster.ts:133

+

Is cluster online

+

observable


ownerRef#

ownerRef: string

Implementation of ClusterModel.ownerRef

-

Defined in src/main/cluster.ts:56

+

Defined in src/main/cluster.ts:77

+

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

+

Defined in src/main/cluster.ts:175

+

Preferences

+

observable


ready#

ready: boolean = false

-

Defined in src/main/cluster.ts:73

+

Defined in src/main/cluster.ts:145

+

Is cluster instance in usable state

+

observable


reconnecting#

reconnecting: boolean = false

-

Defined in src/main/cluster.ts:74

+

Defined in src/main/cluster.ts:151

+

Is cluster currently reconnecting

+

observable


whenInitialized#

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

-

Defined in src/main/cluster.ts:61

+

Defined in src/main/cluster.ts:82


whenReady#

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

-

Defined in src/main/cluster.ts:62

+

Defined in src/main/cluster.ts:83


workspace#

workspace: WorkspaceId

Implementation of ClusterModel.workspace

-

Defined in src/main/cluster.ts:66

+

Defined in src/main/cluster.ts:102

+

Workspace id

+

observable

Accessors#

available#

get available(): boolean

-

Defined in src/main/cluster.ts:84

+

Defined in src/main/cluster.ts:207

+

Is cluster available

+

computed

Returns: boolean


isManaged#

get isManaged(): boolean

-

Defined in src/main/cluster.ts:113

+

Defined in src/main/cluster.ts:253

+

Is cluster managed by an extension

Returns: boolean


name#

get name(): string

-

Defined in src/main/cluster.ts:88

+

Defined in src/main/cluster.ts:216

+

Cluster name

+

computed

Returns: string


prometheusPreferences#

get prometheusPreferences(): ClusterPrometheusPreferences

-

Defined in src/main/cluster.ts:92

+

Defined in src/main/cluster.ts:226

+

Prometheus preferences

+

computed

+

internal

Returns: ClusterPrometheusPreferences


version#

get version(): string

-

Defined in src/main/cluster.ts:100

+

Defined in src/main/cluster.ts:237

+

Kubernetes version

Returns: string

Methods#

activate#

activate(force: boolean): Promise‹void›

-

Defined in src/main/cluster.ts:166

+

Defined in src/main/cluster.ts:324

+

internal

Parameters:

@@ -1609,6 +1668,7 @@ + @@ -1616,6 +1676,7 @@ +
Name Type DefaultDescription
force boolean falseforce activation
@@ -1623,24 +1684,28 @@

Protected bindEvents#

bindEvents(): void

-

Defined in src/main/cluster.ts:142

+

Defined in src/main/cluster.ts:294

+

internal

Returns: void


canI#

canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:332

+

Defined in src/main/cluster.ts:522

+

internal

Parameters:

+ +
Name TypeDescription
resourceAttributes V1ResourceAttributesresource attributes
@@ -1648,37 +1713,39 @@

disconnect#

disconnect(): void

-

Defined in src/main/cluster.ts:208

+

Defined in src/main/cluster.ts:373

+

internal

Returns: void


Protected ensureKubectl#

ensureKubectl(): Promise‹boolean›

-

Defined in src/main/cluster.ts:193

+

Defined in src/main/cluster.ts:354

+

internal

Returns: Promise‹boolean›


Protected getAllowedNamespaces#

getAllowedNamespaces(): Promise‹string[]›

-

Defined in src/main/cluster.ts:419

+

Defined in src/main/cluster.ts:621

Returns: Promise‹string[]›


Protected getAllowedResources#

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

-

Defined in src/main/cluster.ts:439

+

Defined in src/main/cluster.ts:641

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


Protected getConnectionStatus#

getConnectionStatus(): Promise‹ClusterStatus›

-

Defined in src/main/cluster.ts:294

+

Defined in src/main/cluster.ts:480

Returns: Promise‹ClusterStatus›


Protected getKubeconfig#

getKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:261

+

Defined in src/main/cluster.ts:435

Returns: KubeConfig


getMeta#

getMeta(): object

-

Defined in src/main/cluster.ts:407

+

Defined in src/main/cluster.ts:609

Returns: object