Namespace: K8sApi#
Renderer.K8sApi
Table of contents#
Enumerations#
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
- KubeJsonApi
- KubeObject
- KubeObjectStore
- KubeStatus
- LimitRange
- LimitRangesStore
- Namespace
- NamespaceStore
- NetworkPolicy
- NetworkPolicyStore
- Node
- NodesApi
- NodesStore
- PersistentVolume
- PersistentVolumeClaim
- PersistentVolumeClaimsApi
- PersistentVolumesStore
- Pod
- PodDisruptionBudget
- PodDisruptionBudgetsStore
- PodsApi
- PodsStore
- ReplicaSet
- ReplicaSetStore
- ResourceQuota
- ResourceQuotasStore
- ResourceStack
- Role
- RoleBinding
- RoleBindingsStore
- RolesStore
- Secret
- SecretsStore
- Service
- ServiceAccount
- ServiceAccountsStore
- ServiceStore
- StatefulSet
- StatefulSetStore
- StorageClass
- StorageClassStore
- VolumeClaimStore
Interfaces#
- IKubeApiCluster
- ILocalKubeApiConfig
- IPodContainer
- IPodContainerStatus
- IRemoteKubeApiConfig
- ISecretRef
- KubeObjectMetadata
- KubeObjectStoreLoadAllParams
- KubeObjectStoreLoadingParams
- KubeObjectStoreSubscribeParams
- KubeStatusData
Type aliases#
Variables#
- apiManager
- clusterRoleApi
- clusterRoleBindingApi
- configMapApi
- crdApi
- cronJobApi
- daemonSetApi
- deploymentApi
- endpointApi
- eventApi
- hpaApi
- ingressApi
- jobApi
- limitRangeApi
- namespacesApi
- networkPolicyApi
- nodesApi
- pdbApi
- persistentVolumeApi
- podsApi
- pvcApi
- replicaSetApi
- resourceQuotaApi
- roleApi
- roleBindingApi
- secretsApi
- serviceAccountsApi
- serviceApi
- statefulSetApi
- storageClassApi
Functions#
Type aliases#
KubeObjectStatus#
Ƭ KubeObjectStatus: Object
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
Type declaration#
| Name | Type |
|---|---|
level |
KubeObjectStatusLevel |
text |
string |
timestamp? |
string |
Variables#
apiManager#
• apiManager: ApiManager
clusterRoleApi#
• clusterRoleApi: KubeApi<ClusterRole>
Only available within kubernetes cluster pages
clusterRoleBindingApi#
• clusterRoleBindingApi: KubeApi<ClusterRoleBinding>
Only available within kubernetes cluster pages
configMapApi#
• configMapApi: KubeApi<ConfigMap>
Only available within kubernetes cluster pages
crdApi#
• crdApi: KubeApi<CustomResourceDefinition>
Only available within kubernetes cluster pages
cronJobApi#
• cronJobApi: CronJobApi
Only available within kubernetes cluster pages
daemonSetApi#
• daemonSetApi: DaemonSetApi
Only available within kubernetes cluster pages
deploymentApi#
• deploymentApi: DeploymentApi
endpointApi#
• endpointApi: KubeApi<Endpoint>
eventApi#
• eventApi: KubeApi<KubeEvent>
hpaApi#
• hpaApi: KubeApi<HorizontalPodAutoscaler>
ingressApi#
• ingressApi: IngressApi
jobApi#
• jobApi: JobApi
limitRangeApi#
• limitRangeApi: KubeApi<LimitRange>
namespacesApi#
• namespacesApi: NamespaceApi
networkPolicyApi#
• networkPolicyApi: KubeApi<NetworkPolicy>
nodesApi#
• nodesApi: NodesApi
pdbApi#
• pdbApi: KubeApi<PodDisruptionBudget>
persistentVolumeApi#
• persistentVolumeApi: KubeApi<PersistentVolume>
podsApi#
• podsApi: PodsApi
pvcApi#
• pvcApi: PersistentVolumeClaimsApi
replicaSetApi#
• replicaSetApi: ReplicaSetApi
resourceQuotaApi#
• resourceQuotaApi: KubeApi<ResourceQuota>
roleApi#
roleBindingApi#
• roleBindingApi: KubeApi<RoleBinding>
secretsApi#
serviceAccountsApi#
• serviceAccountsApi: KubeApi<ServiceAccount>
serviceApi#
• serviceApi: KubeApi<Service>
statefulSetApi#
• statefulSetApi: StatefulSetApi
storageClassApi#
• storageClassApi: KubeApi<StorageClass>
Functions#
forCluster#
▸ forCluster<T, Y>(cluster, kubeClass, apiClass?): KubeApi<T>
Type parameters#
| Name | Type |
|---|---|
T |
extends KubeObject<KubeObjectMetadata, any, any, T> |
Y |
extends KubeApi<T, Y>KubeApi<T> |
Parameters#
| Name | Type | Default value |
|---|---|---|
cluster |
ILocalKubeApiConfig |
undefined |
kubeClass |
KubeObjectConstructor<T> |
undefined |
apiClass |
(apiOpts: IKubeApiOptions<T>) => Y |
null |
Returns#
KubeApi<T>
forRemoteCluster#
▸ forRemoteCluster<T, Y>(config, kubeClass, apiClass?): Y
Type parameters#
| Name | Type |
|---|---|
T |
extends KubeObject<KubeObjectMetadata, any, any, T> |
Y |
extends KubeApi<T, Y>KubeApi<T> |
Parameters#
| Name | Type | Default value |
|---|---|---|
config |
IRemoteKubeApiConfig |
undefined |
kubeClass |
KubeObjectConstructor<T> |
undefined |
apiClass |
(apiOpts: IKubeApiOptions<T>) => Y |
null |
Returns#
Y
isAllowedResource#
▸ isAllowedResource(resource): boolean
Parameters#
| Name | Type |
|---|---|
resource |
KubeResource | KubeResource[] |
Returns#
boolean