Skip to content

Namespace: K8sApi#

Renderer.K8sApi

Table of contents#

Enumerations#

Classes#

Interfaces#

Type aliases#

Variables#

Functions#

Type aliases#

KubeObjectStatus#

Ƭ KubeObjectStatus: Object

Copyright (c) 2021 OpenLens Authors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Type declaration#

Name Type
level KubeObjectStatusLevel
text string
timestamp? string

Variables#

apiManager#

Const apiManager: ApiManager


clusterRoleApi#

Let clusterRoleApi: KubeApi<ClusterRole>

Only available within kubernetes cluster pages


clusterRoleBindingApi#

Let clusterRoleBindingApi: KubeApi<ClusterRoleBinding>

Only available within kubernetes cluster pages


configMapApi#

Let configMapApi: KubeApi<ConfigMap>

Only available within kubernetes cluster pages


crdApi#

Let crdApi: KubeApi<CustomResourceDefinition>

Only available within kubernetes cluster pages


cronJobApi#

Let cronJobApi: CronJobApi

Only available within kubernetes cluster pages


daemonSetApi#

Let daemonSetApi: DaemonSetApi

Only available within kubernetes cluster pages


deploymentApi#

Let deploymentApi: DeploymentApi


endpointApi#

Let endpointApi: KubeApi<Endpoint>


eventApi#

Let eventApi: KubeApi<KubeEvent>


hpaApi#

Let hpaApi: KubeApi<HorizontalPodAutoscaler>


ingressApi#

Let ingressApi: IngressApi


jobApi#

Let jobApi: JobApi


limitRangeApi#

Let limitRangeApi: KubeApi<LimitRange>


namespacesApi#

Let namespacesApi: NamespaceApi


networkPolicyApi#

Let networkPolicyApi: KubeApi<NetworkPolicy>


nodesApi#

Let nodesApi: NodesApi


pdbApi#

Let pdbApi: KubeApi<PodDisruptionBudget>


persistentVolumeApi#

Let persistentVolumeApi: KubeApi<PersistentVolume>


podsApi#

Let podsApi: PodsApi


pvcApi#

Let pvcApi: PersistentVolumeClaimsApi


replicaSetApi#

Let replicaSetApi: ReplicaSetApi


resourceQuotaApi#

Let resourceQuotaApi: KubeApi<ResourceQuota>


roleApi#

Let roleApi: KubeApi<Role>


roleBindingApi#

Let roleBindingApi: KubeApi<RoleBinding>


secretsApi#

Let secretsApi: KubeApi<Secret>


serviceAccountsApi#

Let serviceAccountsApi: KubeApi<ServiceAccount>


serviceApi#

Let serviceApi: KubeApi<Service>


statefulSetApi#

Let statefulSetApi: StatefulSetApi


storageClassApi#

Let storageClassApi: KubeApi<StorageClass>

Functions#

forCluster#

forCluster<T>(cluster, kubeClass): KubeApi<T>

Type parameters#

Name Type
T T: KubeObject<KubeObjectMetadata, any, any, T>

Parameters#

Name Type
cluster IKubeApiCluster
kubeClass KubeObjectConstructor<T>

Returns#

KubeApi<T>


isAllowedResource#

isAllowedResource(resource): boolean

Parameters#

Name Type
resource KubeResource | KubeResource[]

Returns#

boolean